π Viewing: class-jquery-migrate-helper.php
<?php
/**
* Class jQuery_Migrate_Helper,
*
*/
if ( ! defined( 'ABSPATH' ) ) {
die( 'Invalid request.' );
}
class jQuery_Migrate_Helper {
private function __construct() {}
public static function init_actions() {
$public_deprecations = get_option( '_jquery_migrate_public_deprecation_logging', 'no' );
/*
* To be able to replace the src, scripts should not be concatenated.
*
* Concatenation is only forcefully disabled if the user is logged in, or public deprecation logging
* has been enabled, to reduce the performance impact of the plugin.
*/
if ( is_user_logged_in() || 'yes' === $public_deprecations ) {
if ( ! defined( 'CONCATENATE_SCRIPTS' ) ) {
define( 'CONCATENATE_SCRIPTS', false );
}
$GLOBALS['concatenate_scripts'] = false;
}
add_action( 'wp_default_scripts', array( __CLASS__, 'replace_scripts' ), -1 );
// We need our own script for displaying warnings to run as late as possible.
// Print it separately after the footer scripts.
add_action( 'admin_enqueue_scripts', array( __CLASS__, 'register_scripts' ) );
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'register_scripts' ) );
add_action( 'admin_print_footer_scripts', array( __CLASS__, 'print_scripts' ), 100 );
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueue_scripts_frontend' ), 100 );
add_action( 'admin_menu', array( __CLASS__, 'admin_menu' ) );
add_action( '_admin_menu', array( __CLASS__, 'append_tools_menu_counter' ) );
add_action( '_user_admin_menu', array( __CLASS__, 'append_tools_menu_counter' ) );
add_action( 'admin_bar_menu', array( __CLASS__, 'admin_bar_menu' ), 100 );
add_action( 'admin_init', array( __CLASS__, 'admin_settings' ) );
add_action( 'admin_notices', array( __CLASS__, 'admin_notices' ) );
add_action( 'wp_ajax_jquery-migrate-dismiss-notice', array( __CLASS__, 'admin_notices_dismiss' ) );
add_action( 'wp_ajax_jquery-migrate-log-notice', array( __CLASS__, 'log_migrate_notice' ) );
add_action( 'wp_ajax_nopriv_jquery-migrate-log-notice', array( __CLASS__, 'log_migrate_notice' ) );
add_action( 'wp_ajax_jquery-migrate-downgrade-version', array( __CLASS__, 'downgrade_jquery_version' ) );
add_action( 'wp_head', array( __CLASS__, 'fatal_error_handler' ) );
add_action( 'admin_head', array( __CLASS__, 'fatal_error_handler' ) );
add_filter( 'site_status_tests', array( __CLASS__, 'site_health_check' ) );
// Set up our scheduled weekly notification.
if ( ! wp_next_scheduled( 'enable_jquery_migrate_helper_notification' ) && ! wp_installing() ) {
wp_schedule_event( time() + DAY_IN_SECONDS, 'weekly', 'enable_jquery_migrate_helper_notification' );
}
add_action( 'enable_jquery_migrate_helper_notification', array( __CLASS__, 'scheduled_event_handler' ) );
}
/**
* Run the scheduled event ot send an email summary to the site admin.
*/
public static function scheduled_event_handler() {
self::send_message( 'weekly' );
}
/**
* Appends the count of migration notices to the `Tools` menu item.
*
* This is done to indicate that a submenu item has actionable content.
*
* @global array $menu
*/
public static function append_tools_menu_counter() {
global $menu;
$count = self::logged_migration_notice_count();
// Don't add extra markup if not needed.
if ( $count < 1 ) {
return;
}
// Menu position 75 is the Tools menu.
$menu[75][0] .= sprintf(
' <span class="update-plugins jqmh-deprecations count-%1$d"><span class="plugin-count">%1$d</span></span>',
self::logged_migration_notice_count()
);
}
/**
* Add the jQuery Migrate plugin to the Tools sub-menu.
*/
public static function admin_menu() {
add_submenu_page(
'tools.php',
__( 'jQuery Migrate', 'enable-jquery-migrate-helper' ),
sprintf(
'%1$s <span class="update-plugins jqmh-deprecations count-%2$d"><span class="plugin-count">%2$d</span></span>',
__( 'jQuery Migrate', 'enable-jquery-migrate-helper' ),
self::logged_migration_notice_count()
),
'manage_options',
'jqmh',
array( __CLASS__, 'admin_page' )
);
}
/**
* Render the plugin tools page.
*/
public static function admin_page() {
echo '<div class="wrap">';
include_once __DIR__ . '/admin/header.php';
echo '</div>';
}
/**
* Settings page save handler.
*/
public static function admin_settings() {
if ( ! isset( $_POST['jqmh-settings'] ) || ! current_user_can( 'manage_options' ) ) {
return;
}
if ( ! wp_verify_nonce( $_POST['_wpnonce'], 'jqmh-settings' ) ) {
return;
}
$previous_downgrade = get_option( '_jquery_migrate_downgrade_version', 'no' );
if ( isset( $_POST['live-deprecations'] ) ) {
delete_option( '_jquery_migrate_deprecations_dismissed_notice' );
} else {
update_option( '_jquery_migrate_deprecations_dismissed_notice', time() );
}
if ( ! empty( $_POST['jquery-version'] ) && 'yes' === $_POST['jquery-version'] ) {
update_option( '_jquery_migrate_downgrade_version', 'yes' );
} else {
update_option( '_jquery_migrate_downgrade_version', 'no' );
// Disable logging by default when enabling modern jQuery versions.
if ( 'yes' === $previous_downgrade ) {
update_option( '_jquery_migrate_modern_deprecations', 'no' );
update_option( '_jquery_migrate_deprecations_dismissed_notice', time() );
}
}
if ( isset( $_POST['public-deprecation-logging'] ) ) {
update_option( '_jquery_migrate_public_deprecation_logging', 'yes' );
} else {
update_option( '_jquery_migrate_public_deprecation_logging', 'no' );
}
if ( isset( $_POST['modern-deprecations'] ) ) {
update_option( '_jquery_migrate_modern_deprecations', 'yes' );
} else {
update_option( '_jquery_migrate_modern_deprecations', 'no' );
}
if ( isset( $_POST['automatic-downgrade'] ) ) {
update_option( '_jquery_migrate_has_auto_downgraded', 'no' );
} else {
update_option( '_jquery_migrate_has_auto_downgraded', 'yes' );
}
}
public static function site_health_check( $tests ) {
$tests['direct']['enable-jquery-migrate-helper'] = array(
'label' => __( 'WordPress jQuery Version', 'enable-jquery-migrate-helper' ),
'test' => array( __CLASS__, 'site_health_test' ),
);
return $tests;
}
public static function site_health_test() {
$result = array(
'label' => __( 'WordPress jQuery Version', 'enable-jquery-migrate-helper' ),
'status' => 'good',
'badge' => array(
'label' => __( 'Performance' ),
'color' => 'blue',
),
'description' => sprintf(
'<p>%s</p>',
__( 'Your site is using the latest jQuery version that comes with WordPress.', 'enable-jquery-migrate-helper' )
),
'actions' => '',
'test' => 'enable-jquery-migrate-helper',
);
$downgrade_state = get_option( '_jquery_migrate_downgrade_version', 'no' );
if ( 'no' !== $downgrade_state ) {
$result['label'] = __( 'You are using a legacy version of jQuery', 'enable-jquery-migrate-helper' );
$result['status'] = 'critical';
$result['description'] = sprintf(
'<p>%s</p>',
__( 'Your site is using a legacy version of jQuery, 1.12.4-wp, probably in order to fix problems that were experienced with your plugins or themes after an update of WordPress. Please make sure that your plugins and themes become compatible with WordPress 5.6 by contacting the authors.', 'enable-jquery-migrate-helper' )
);
$result['actions'] = sprintf(
'<a href="%s">%s</a>',
esc_url( admin_url( 'tools.php?page=jqmh' ) ),
__( 'Plugin settings', 'enable-jquery-migrate-helper' )
);
}
return $result;
}
/**
* Ajax handler for automatic downgrades.
*/
public static function downgrade_jquery_version() {
/*
* Only allow the downgrade to be triggered automatically by site visitors if an admin hasn't
* changed the option themselves; in that case only an admin should be able to set the version.
*/
$has_auto_downgraded = get_option( '_jquery_migrate_has_auto_downgraded', 'no' );
if ( 'no' !== $has_auto_downgraded ) {
return;
}
if ( ! wp_verify_nonce( $_POST['_wpnonce'], 'jquery-migrate-automatic-downgrade' ) ) {
return;
}
update_option( '_jquery_migrate_downgrade_version', 'yes' );
update_option( '_jquery_migrate_has_auto_downgraded', 'yes' );
self::send_message( 'automatic-downgrade' );
wp_send_json_success( array( 'reload' => true ) );
}
/**
* Add a fatal error handler for uncaught errors.
*
* This will look for deprecated jQuery functions, and send an AJAX call letting the plugin
* know that it should serve future requests as a downgraded version of jQuery.
*
* Vanilla JavaScript is used here to remove all dependencies on libraries, even though they
* all look very pretty, this ensures that code can run no matter the circumstances.
*/
public static function fatal_error_handler() {
// If an auto-downgraded has already been performed, do not output the error handler.
if ( 'no' !== get_option( '_jquery_migrate_has_auto_downgraded', 'no' ) ) {
return;
}
?>
<script type="text/javascript">
var jQueryMigrateHelperHasSentDowngrade = false;
window.onerror = function( msg, url, line, col, error ) {
// Break out early, do not processing if a downgrade reqeust was already sent.
if ( jQueryMigrateHelperHasSentDowngrade ) {
return true;
}
var xhr = new XMLHttpRequest();
var nonce = '<?php echo esc_js( wp_create_nonce( 'jquery-migrate-automatic-downgrade' ) ); ?>';
var jQueryFunctions = [
'andSelf',
'browser',
'live',
'boxModel',
'support.boxModel',
'size',
'swap',
'clean',
'sub',
];
var match_pattern = /\)\.(.+?) is not a function/;
var erroredFunction = msg.match( match_pattern );
// If there was no matching functions, do not try to downgrade.
if ( null === erroredFunction || typeof erroredFunction !== 'object' || typeof erroredFunction[1] === "undefined" || -1 === jQueryFunctions.indexOf( erroredFunction[1] ) ) {
return true;
}
// Set that we've now attempted a downgrade request.
jQueryMigrateHelperHasSentDowngrade = true;
xhr.open( 'POST', '<?php echo esc_js( admin_url( 'admin-ajax.php' ) ); ?>' );
xhr.setRequestHeader( 'Content-Type', 'application/x-www-form-urlencoded' );
xhr.onload = function () {
var response,
reload = false;
if ( 200 === xhr.status ) {
try {
response = JSON.parse( xhr.response );
reload = response.data.reload;
} catch ( e ) {
reload = false;
}
}
// Automatically reload the page if a deprecation caused an automatic downgrade, ensure visitors get the best possible experience.
if ( reload ) {
location.reload();
}
};
xhr.send( encodeURI( 'action=jquery-migrate-downgrade-version&_wpnonce=' + nonce ) );
// Suppress error alerts in older browsers
return true;
}
</script>
<?php
}
// Pre-register scripts on 'wp_default_scripts' action, they won't be overwritten by $wp_scripts->add().
private static function set_script( $scripts, $handle, $src, $deps = array(), $ver = false, $in_footer = false ) {
$script = $scripts->query( $handle, 'registered' );
if ( $script ) {
// If already added
$script->src = $src;
$script->deps = $deps;
$script->ver = $ver;
$script->args = $in_footer;
unset( $script->extra['group'] );
if ( $in_footer ) {
$script->add_data( 'group', 1 );
}
} else {
// Add the script
if ( $in_footer ) {
$scripts->add( $handle, $src, $deps, $ver, 1 );
} else {
$scripts->add( $handle, $src, $deps, $ver );
}
}
}
/*
* Enqueue jQuery migrate, and force it to be the development version.
*
* This will ensure that console errors are generated that we can surface to the
* end user in a responsible manner so that they can update their plugins and theme,
* or make a decision to switch to other plugin/theme if no updates are available.
*/
public static function replace_scripts( $scripts ) {
$assets_url = plugins_url( 'js/', __FILE__ );
if ( version_compare( $GLOBALS['wp_version'], '5.6-alpha', '<' ) || 'yes' === get_option( '_jquery_migrate_downgrade_version', 'no' ) ) {
self::set_script( $scripts, 'jquery-migrate', $assets_url . 'jquery-migrate/jquery-migrate-1.4.1-wp.js', array(), '1.4.1-wp' );
self::set_script( $scripts, 'jquery-core', $assets_url . 'jquery/jquery-1.12.4-wp.js', array(), '1.12.4-wp' );
self::set_script( $scripts, 'jquery', false, array( 'jquery-core', 'jquery-migrate' ), '1.12.4-wp' );
// All the jQuery UI stuff comes here.
// self::set_script( $scripts, '', $assets_url . 'jquery-ui/', array(), '' );
self::set_script( $scripts, 'jquery-ui-core', $assets_url . 'jquery-ui/core.min.js', array( 'jquery' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-core', $assets_url . 'jquery-ui/effect.min.js', array( 'jquery' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-blind', $assets_url . 'jquery-ui/effect-blind.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-bounce', $assets_url . 'jquery-ui/effect-bounce.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-clip', $assets_url . 'jquery-ui/effect-clip.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-drop', $assets_url . 'jquery-ui/effect-drop.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-explode', $assets_url . 'jquery-ui/effect-explode.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-fade', $assets_url . 'jquery-ui/effect-fade.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-fold', $assets_url . 'jquery-ui/effect-fold.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-highlight', $assets_url . 'jquery-ui/effect-highlight.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-puff', $assets_url . 'jquery-ui/effect-puff.min.js', array( 'jquery-effects-core', 'jquery-effects-scale' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-pulsate', $assets_url . 'jquery-ui/effect-pulsate.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-scale', $assets_url . 'jquery-ui/effect-scale.min.js', array( 'jquery-effects-core', 'jquery-effects-size' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-shake', $assets_url . 'jquery-ui/effect-shake.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-size', $assets_url . 'jquery-ui/effect-size.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-slide', $assets_url . 'jquery-ui/effect-slide.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-effects-transfer', $assets_url . 'jquery-ui/effect-transfer.min.js', array( 'jquery-effects-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-accordion', $assets_url . 'jquery-ui/accordion.min.js', array( 'jquery-ui-core', 'jquery-ui-widget' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-autocomplete', $assets_url . 'jquery-ui/autocomplete.min.js', array( 'jquery-ui-menu', 'wp-a11y' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-button', $assets_url . 'jquery-ui/button.min.js', array( 'jquery-ui-core', 'jquery-ui-widget' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-datepicker', $assets_url . 'jquery-ui/datepicker.min.js', array( 'jquery-ui-core' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-dialog', $assets_url . 'jquery-ui/dialog.min.js', array( 'jquery-ui-resizable', 'jquery-ui-draggable', 'jquery-ui-button', 'jquery-ui-position' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-draggable', $assets_url . 'jquery-ui/draggable.min.js', array( 'jquery-ui-mouse' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-droppable', $assets_url . 'jquery-ui/droppable.min.js', array( 'jquery-ui-draggable' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-menu', $assets_url . 'jquery-ui/menu.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-position' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-mouse', $assets_url . 'jquery-ui/mouse.min.js', array( 'jquery-ui-core', 'jquery-ui-widget' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-position', $assets_url . 'jquery-ui/position.min.js', array( 'jquery' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-progressbar', $assets_url . 'jquery-ui/progressbar.min.js', array( 'jquery-ui-core', 'jquery-ui-widget' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-resizable', $assets_url . 'jquery-ui/resizable.min.js', array( 'jquery-ui-mouse' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-selectable', $assets_url . 'jquery-ui/selectable.min.js', array( 'jquery-ui-mouse' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-selectmenu', $assets_url . 'jquery-ui/selectmenu.min.js', array( 'jquery-ui-menu' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-slider', $assets_url . 'jquery-ui/slider.min.js', array( 'jquery-ui-mouse' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-sortable', $assets_url . 'jquery-ui/sortable.min.js', array( 'jquery-ui-mouse' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-spinner', $assets_url . 'jquery-ui/spinner.min.js', array( 'jquery-ui-button' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-tabs', $assets_url . 'jquery-ui/tabs.min.js', array( 'jquery-ui-core', 'jquery-ui-widget' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-tooltip', $assets_url . 'jquery-ui/tooltip.min.js', array( 'jquery-ui-core', 'jquery-ui-widget', 'jquery-ui-position' ), '1.11.4-wp', 1 );
self::set_script( $scripts, 'jquery-ui-widget', $assets_url . 'jquery-ui/widget.min.js', array( 'jquery' ), '1.11.4-wp', 1 );
// This just updates the dependency of `jquery-touch-punch`.
self::set_script( $scripts, 'jquery-touch-punch', false, array( 'jquery-ui-widget', 'jquery-ui-mouse' ), '0.2.2', 1 );
} else {
if ( 'yes' === get_option( '_jquery_migrate_modern_deprecations', 'no' ) ) {
self::set_script( $scripts, 'jquery-migrate', $assets_url . 'jquery-migrate/jquery-migrate-3.4.1-wp.js', array(), '3.4.1-wp' );
self::set_script( $scripts, 'jquery', false, array( 'jquery-core', 'jquery-migrate' ), '3.7.1' );
}
}
}
/**
* Register the deprecation notice capture handler script.
*/
public static function register_scripts() {
wp_register_script( 'jquery-migrate-deprecation-notices', plugins_url( 'js/deprecation-notice.js', __FILE__ ), array( 'jquery', 'jquery-migrate' ), false, true );
wp_localize_script(
'jquery-migrate-deprecation-notices',
'JQMH',
array(
'ajaxurl' => admin_url( 'admin-ajax.php' ),
'report_nonce' => wp_create_nonce( 'jquery-migrate-report-deprecation' ),
'backend' => is_admin(),
'plugin_slug' => dirname( plugin_basename( __FILE__ ) ),
'capture_deprecations' => ( 'yes' === get_option( '_jquery_migrate_downgrade_version', 'no' ) || 'yes' === get_option( '_jquery_migrate_modern_deprecations', 'no' ) ),
'single_instance_log' => ( 'no' === get_option( '_jquery_migrate_downgrade_version', 'no' ) ), // Only show one instance of deprecations in jQuery 3.5
)
);
}
/**
* Output/print the deprecation notice script. Needs to be last in the footer.
*/
public static function print_scripts() {
wp_print_scripts( 'jquery-migrate-deprecation-notices' );
}
public static function enqueue_scripts_frontend() {
// Only load the asset for users who can act on them.
if ( ! current_user_can( 'manage_options' ) && 'no' === get_option( '_jquery_migrate_public_deprecation_logging', 'no' ) ) {
return;
}
wp_enqueue_script( 'jquery-migrate-deprecation-notices' );
}
/**
* HTML for jQuery Migrate deprecated notices.
*
* This notice is only displayed if there are JS migration deprecation notices
* for scripts loaded on the current screen.
*
* @since 1.0.0
*/
public static function deprecated_scripts_notice() {
// If the message has been dismissed, and it has been less than two weeks since it was seen,
// then skip displaying the deprecation lister for now.
if ( ! self::show_deprecated_scripts_notice() ) {
return;
}
include_once __DIR__ . '/templates/admin-notices/deprecated-scripts.php';
}
public static function show_deprecated_scripts_notice() {
return false === get_option( '_jquery_migrate_deprecations_dismissed_notice', false );
}
/**
* HTML for the Dashboard notice.
*/
public static function dashboard_notice() {
if ( ! self::show_dashboard_notice() ) {
return;
}
include_once __DIR__ . '/templates/admin-notices/welcome.php';
}
public static function show_dashboard_notice() {
// Show again in two weeks if the user has dismissed this notice.
$is_dismissed = get_option( '_jquery_migrate_dismissed_notice', false );
$recurrence = 1 * WEEK_IN_SECONDS;
// Force show the admin notice if using a downgraded jQuery version.
if ( 'no' !== get_option( '_jquery_migrate_downgrade_version', 'no' ) ) {
// Do not add this message to the plugins own admin page since it already contains
// a permanent notice.
if ( 'tools_page_jqmh' !== get_current_screen()->id) {
return true;
}
}
// Normally only show this warning on the dashboard page.
if ( 'dashboard' !== get_current_screen()->id ) {
return false;
}
// If the message has been dismissed, and it has been less than two weeks since it was seen,
// then skip showing the admin notice for now.
if ( false !== $is_dismissed && $is_dismissed > ( time() - $recurrence ) ) {
return false;
}
return true;
}
/**
* Display a dashboard notice if no deprecations have been logged in a while.
*
* This encourages users to remove the plugin when no longer needed, this will help gauge the jQuery
* migrations, and also remove the potential false-positive reports of jQuery issues caused by
* an unrelated core bug fixed in WordPress 5.5.1 that inflates the plugin numbers.
*/
public static function plugin_obsolete_message() {
$last_log = get_option( 'jqmh_last_log_time', null );
$recurrence = 1 * WEEK_IN_SECONDS;
/*
* If no log time is recorded, this is likely a recently installed or udpated plugin, set value to now,
* to give a buffer, and avoid showing the notice when we have no data telling if itβs needed or not.
*/
if ( null === $last_log ) {
update_option( 'jqmh_last_log_time', time() );
return;
}
if ( $last_log > ( time() - $recurrence ) ) {
return;
}
include_once __DIR__ . '/templates/admin-notices/no-longer-needed.php';
}
public static function admin_notices() {
// Show only to admins.
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
self::dashboard_notice();
self::plugin_obsolete_message();
self::deprecated_scripts_notice();
}
public static function log_migrate_notice() {
if ( ! current_user_can( 'manage_options' ) && 'no' === get_option( '_jquery_migrate_public_deprecation_logging', 'no' ) ) {
status_header( 403 );
die();
}
if ( ! wp_verify_nonce( $_POST['nonce'], 'jquery-migrate-report-deprecation' ) ) {
status_header( 406, 'Invalid nonce' );
die();
}
$required_fields = array(
'notice',
);
foreach ( $required_fields as $required_field ) {
if ( ! isset( $_POST[ $required_field ] ) ) {
status_header( 400, 'Missing required fields' );
die();
}
}
$logs = get_option( 'jqmh_logs', array() );
$deprecation_data = array(
'notice' => wp_kses( $_POST['notice'], array() ),
);
/*
* Creating a hash of the deprecation data lets us ensure it is only reported once, to avoid
* filling the database with duplicates on busy sites.
*/
$deprecation_hash = md5( wp_json_encode( $deprecation_data ) );
if ( ! isset( $logs[ $deprecation_hash ] ) ) {
$logs[ $deprecation_hash ] = array_merge( array(
'registered' => date_i18n( 'Y-m-d H:i:s' ),
'page' => ( isset( $_POST['url'] ) ? esc_url_raw( $_POST['url'] ) : '' ),
'backend' => isset( $_POST['backend'] ) && $_POST['backend'],
), $deprecation_data );
update_option( 'jqmh_logs', $logs );
update_option( 'jqmh_last_log_time', time() );
}
wp_send_json_success();
}
/**
* Check if any errors have been logged to the database.
*
* @return int|null
*/
public static function logged_migration_notice_count() {
$logs = get_option( 'jqmh_logs', array() );
return count( $logs );
}
/**
* Handle ajax requests to dismiss a notice, and remember the dismissal.
*
* @return void
*/
public static function admin_notices_dismiss() {
if ( empty( $_POST['dismiss-notice-nonce'] ) || ! current_user_can( 'manage_options' ) ) {
return;
}
if ( ! wp_verify_nonce( $_POST['dismiss-notice-nonce'], $_POST['notice'] ) ) {
return;
}
switch ( $_POST['notice'] ) {
case 'jquery-migrate-deprecation-list':
update_option( '_jquery_migrate_deprecations_dismissed_notice', time() );
break;
case 'jquery-migrate-previous-deprecations':
delete_option( 'jqmh_logs' );
break;
case 'jquery-migrate-notice':
update_option( '_jquery_migrate_dismissed_notice', time() );
break;
case 'jquery-migrate-no-deprecations-notice':
update_option( 'jqmh_last_log_time', time() );
break;
}
}
/**
* Add this plugin to the admin bar as a menu item.
*
* This entry allows users to re-surface previously hidden notices from the plugin,
* and also allows for alerting of issues detected in the frontend, where we avoid
* notices.
*
* @param $wp_menu
*/
public static function admin_bar_menu( $wp_menu ) {
// Show only to those with the right capabilities.
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
$deprecation_count = self::logged_migration_notice_count();
$wp_menu->add_menu(
array(
'id' => 'enable-jquery-migrate-helper',
'title' => sprintf(
// translators: %s: Parenthesis with issue count.
__( 'jQuery Migrate %s', 'enable-jquery-migrate-helper' ),
sprintf(
'<span class="count-wrapper jqmh-deprecations" style="' . ( $deprecation_count > 0 ? '' : 'display:none;' ) . '">%s</span>',
sprintf(
// translators: 1: Total number of existing issues. 2: Issues discovered on currently loaded page.
__( '(Previously known: %1$d Discovered on this page: %2$s)', 'enable-jquery-migrate-helper' ),
$deprecation_count,
sprintf(
'<span class="count">%d</span>',
0
)
)
)
),
'href' => '#',
)
);
$wp_menu->add_node(
array(
'id' => 'enable-jquery-migrate-helper-page',
'title' => _x( 'Settings Page', 'Admin bar menu link', 'enable-jquery-migrate-helper' ),
'parent' => 'enable-jquery-migrate-helper',
'href' => get_admin_url( null, 'tools.php?page=jqmh' ),
)
);
$wp_menu->add_node(
array(
'id' => 'enable-jquery-migrate-helper-deprecation-logs',
'title' => _x( 'Logged deprecations', 'Admin bar menu link', 'enable-jquery-migrate-helper' ),
'parent' => 'enable-jquery-migrate-helper',
'href' => get_admin_url( null, 'tools.php?page=jqmh&tab=logs' ),
)
);
}
/**
* Send a pre-defined email to the site admin.
*
* @param string $template The template of the email to be sent.
* @return bool If the email was sent or not.
*/
private static function send_message( $template ) {
$file = null;
switch ( $template ) {
case 'weekly':
$title = __( 'Weekly jQuery Migrate Status Update', 'enable-jquery-migrate-helper' );
$file = 'weekly.php';
break;
case 'automatic-downgrade':
$title = __( 'Automatic jQuery version change', 'enable-jquery-migrate-helper' );
$file = 'automatic-downgrade.php';
break;
}
$file_path = __DIR__ . '/templates/email/' . $file;
if ( ! $file || ! file_exists( $file_path ) ) {
return false;
}
$recipient = get_bloginfo( 'admin_email' );
ob_start();
include $file_path;
$message = ob_get_clean();
/**
* Filter the contents of the notification email.
*
* If an empty value is returned, the email notice will not be sent.
*
* @since 1.2.0
*
* @param string $message The message that will be sent ot the site admin.
* @param string $template The currently invoked email template.
*/
$message = apply_filters( 'jqmh_email_message', $message, $template );
if ( empty( $message ) ) {
return false;
}
add_filter( 'wp_mail_content_type', function() {
return 'text/html';
} );
return wp_mail( $recipient, $title, $message );
}
}
π DarkStealth β WP Plugin Edition
Directory: /home/httpd/html/zenmodels.org/public_html_hacked/wp-content/plugins/enable-jquery-migrate-helper