4 const NONCE = 'akismet-update-key';
6 private static $initiated = false;
7 private static $notices = array();
8 private static $allowed = array(
27 public static function init() {
28 if ( ! self::$initiated ) {
32 if ( isset( $_POST['action'] ) && $_POST['action'] == 'enter-key' ) {
33 self::enter_api_key();
37 public static function init_hooks() {
38 // The standalone stats page was removed in 3.0 for an all-in-one config and stats page.
39 // Redirect any links that might have been bookmarked or in browser history.
40 if ( isset( $_GET['page'] ) && 'akismet-stats-display' == $_GET['page'] ) {
41 wp_safe_redirect( esc_url_raw( self::get_page_url( 'stats' ) ), 301 );
45 self::$initiated = true;
47 add_action( 'admin_init', array( 'Akismet_Admin', 'admin_init' ) );
48 add_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 ); # Priority 5, so it's called before Jetpack's admin_menu.
49 add_action( 'admin_notices', array( 'Akismet_Admin', 'display_notice' ) );
50 add_action( 'admin_enqueue_scripts', array( 'Akismet_Admin', 'load_resources' ) );
51 add_action( 'activity_box_end', array( 'Akismet_Admin', 'dashboard_stats' ) );
52 add_action( 'rightnow_end', array( 'Akismet_Admin', 'rightnow_stats' ) );
53 add_action( 'manage_comments_nav', array( 'Akismet_Admin', 'check_for_spam_button' ) );
54 add_action( 'admin_action_akismet_recheck_queue', array( 'Akismet_Admin', 'recheck_queue' ) );
55 add_action( 'wp_ajax_akismet_recheck_queue', array( 'Akismet_Admin', 'recheck_queue' ) );
56 add_action( 'wp_ajax_comment_author_deurl', array( 'Akismet_Admin', 'remove_comment_author_url' ) );
57 add_action( 'wp_ajax_comment_author_reurl', array( 'Akismet_Admin', 'add_comment_author_url' ) );
58 add_action( 'jetpack_auto_activate_akismet', array( 'Akismet_Admin', 'connect_jetpack_user' ) );
60 add_filter( 'plugin_action_links', array( 'Akismet_Admin', 'plugin_action_links' ), 10, 2 );
61 add_filter( 'comment_row_actions', array( 'Akismet_Admin', 'comment_row_action' ), 10, 2 );
63 add_filter( 'plugin_action_links_'.plugin_basename( plugin_dir_path( __FILE__ ) . 'akismet.php'), array( 'Akismet_Admin', 'admin_plugin_settings_link' ) );
65 add_filter( 'wxr_export_skip_commentmeta', array( 'Akismet_Admin', 'exclude_commentmeta_from_export' ), 10, 3 );
68 public static function admin_init() {
69 load_plugin_textdomain( 'akismet' );
70 add_meta_box( 'akismet-status', __('Comment History', 'akismet'), array( 'Akismet_Admin', 'comment_status_meta_box' ), 'comment', 'normal' );
73 public static function admin_menu() {
74 if ( class_exists( 'Jetpack' ) )
75 add_action( 'jetpack_admin_menu', array( 'Akismet_Admin', 'load_menu' ) );
80 public static function admin_head() {
81 if ( !current_user_can( 'manage_options' ) )
85 public static function admin_plugin_settings_link( $links ) {
86 $settings_link = '<a href="'.esc_url( self::get_page_url() ).'">'.__('Settings', 'akismet').'</a>';
87 array_unshift( $links, $settings_link );
91 public static function load_menu() {
92 if ( class_exists( 'Jetpack' ) )
93 $hook = add_submenu_page( 'jetpack', __( 'Akismet' , 'akismet'), __( 'Akismet' , 'akismet'), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
95 $hook = add_options_page( __('Akismet', 'akismet'), __('Akismet', 'akismet'), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
97 if ( version_compare( $GLOBALS['wp_version'], '3.3', '>=' ) ) {
98 add_action( "load-$hook", array( 'Akismet_Admin', 'admin_help' ) );
102 public static function load_resources() {
105 if ( in_array( $hook_suffix, array(
106 'index.php', # dashboard
110 'settings_page_akismet-key-config',
111 'jetpack_page_akismet-key-config',
114 wp_register_style( 'akismet.css', plugin_dir_url( __FILE__ ) . '_inc/akismet.css', array(), AKISMET_VERSION );
115 wp_enqueue_style( 'akismet.css');
117 wp_register_script( 'akismet.js', plugin_dir_url( __FILE__ ) . '_inc/akismet.js', array('jquery','postbox'), AKISMET_VERSION );
118 wp_enqueue_script( 'akismet.js' );
119 wp_localize_script( 'akismet.js', 'WPAkismet', array(
120 'comment_author_url_nonce' => wp_create_nonce( 'comment_author_url_nonce' ),
122 'Remove this URL' => __( 'Remove this URL' , 'akismet'),
123 'Removing...' => __( 'Removing...' , 'akismet'),
124 'URL removed' => __( 'URL removed' , 'akismet'),
125 '(undo)' => __( '(undo)' , 'akismet'),
126 'Re-adding...' => __( 'Re-adding...' , 'akismet'),
133 * Add help to the Akismet page
135 * @return false if not the Akismet page
137 public static function admin_help() {
138 $current_screen = get_current_screen();
141 if ( current_user_can( 'manage_options' ) ) {
142 if ( !Akismet::get_api_key() || ( isset( $_GET['view'] ) && $_GET['view'] == 'start' ) ) {
144 $current_screen->add_help_tab(
147 'title' => __( 'Overview' , 'akismet'),
149 '<p><strong>' . esc_html__( 'Akismet Setup' , 'akismet') . '</strong></p>' .
150 '<p>' . esc_html__( 'Akismet filters out spam, so you can focus on more important things.' , 'akismet') . '</p>' .
151 '<p>' . esc_html__( 'On this page, you are able to set up the Akismet plugin.' , 'akismet') . '</p>',
155 $current_screen->add_help_tab(
157 'id' => 'setup-signup',
158 'title' => __( 'New to Akismet' , 'akismet'),
160 '<p><strong>' . esc_html__( 'Akismet Setup' , 'akismet') . '</strong></p>' .
161 '<p>' . esc_html__( 'You need to enter an API key to activate the Akismet service on your site.' , 'akismet') . '</p>' .
162 '<p>' . sprintf( __( 'Sign up for an account on %s to get an API Key.' , 'akismet'), '<a href="https://akismet.com/plugin-signup/" target="_blank">Akismet.com</a>' ) . '</p>',
166 $current_screen->add_help_tab(
168 'id' => 'setup-manual',
169 'title' => __( 'Enter an API Key' , 'akismet'),
171 '<p><strong>' . esc_html__( 'Akismet Setup' , 'akismet') . '</strong></p>' .
172 '<p>' . esc_html__( 'If you already have an API key' , 'akismet') . '</p>' .
174 '<li>' . esc_html__( 'Copy and paste the API key into the text field.' , 'akismet') . '</li>' .
175 '<li>' . esc_html__( 'Click the Use this Key button.' , 'akismet') . '</li>' .
180 elseif ( isset( $_GET['view'] ) && $_GET['view'] == 'stats' ) {
182 $current_screen->add_help_tab(
185 'title' => __( 'Overview' , 'akismet'),
187 '<p><strong>' . esc_html__( 'Akismet Stats' , 'akismet') . '</strong></p>' .
188 '<p>' . esc_html__( 'Akismet filters out spam, so you can focus on more important things.' , 'akismet') . '</p>' .
189 '<p>' . esc_html__( 'On this page, you are able to view stats on spam filtered on your site.' , 'akismet') . '</p>',
195 $current_screen->add_help_tab(
198 'title' => __( 'Overview' , 'akismet'),
200 '<p><strong>' . esc_html__( 'Akismet Configuration' , 'akismet') . '</strong></p>' .
201 '<p>' . esc_html__( 'Akismet filters out spam, so you can focus on more important things.' , 'akismet') . '</p>' .
202 '<p>' . esc_html__( 'On this page, you are able to enter/remove an API key, view account information and view spam stats.' , 'akismet') . '</p>',
206 $current_screen->add_help_tab(
209 'title' => __( 'Settings' , 'akismet'),
211 '<p><strong>' . esc_html__( 'Akismet Configuration' , 'akismet') . '</strong></p>' .
212 '<p><strong>' . esc_html__( 'API Key' , 'akismet') . '</strong> - ' . esc_html__( 'Enter/remove an API key.' , 'akismet') . '</p>' .
213 '<p><strong>' . esc_html__( 'Comments' , 'akismet') . '</strong> - ' . esc_html__( 'Show the number of approved comments beside each comment author in the comments list page.' , 'akismet') . '</p>' .
214 '<p><strong>' . esc_html__( 'Strictness' , 'akismet') . '</strong> - ' . esc_html__( 'Choose to either discard the worst spam automatically or to always put all spam in spam folder.' , 'akismet') . '</p>',
218 $current_screen->add_help_tab(
221 'title' => __( 'Account' , 'akismet'),
223 '<p><strong>' . esc_html__( 'Akismet Configuration' , 'akismet') . '</strong></p>' .
224 '<p><strong>' . esc_html__( 'Subscription Type' , 'akismet') . '</strong> - ' . esc_html__( 'The Akismet subscription plan' , 'akismet') . '</p>' .
225 '<p><strong>' . esc_html__( 'Status' , 'akismet') . '</strong> - ' . esc_html__( 'The subscription status - active, cancelled or suspended' , 'akismet') . '</p>',
232 $current_screen->set_help_sidebar(
233 '<p><strong>' . esc_html__( 'For more information:' , 'akismet') . '</strong></p>' .
234 '<p><a href="https://akismet.com/faq/" target="_blank">' . esc_html__( 'Akismet FAQ' , 'akismet') . '</a></p>' .
235 '<p><a href="https://akismet.com/support/" target="_blank">' . esc_html__( 'Akismet Support' , 'akismet') . '</a></p>'
239 public static function enter_api_key() {
240 if ( function_exists('current_user_can') && !current_user_can('manage_options') )
241 die(__('Cheatin’ uh?', 'akismet'));
243 if ( !wp_verify_nonce( $_POST['_wpnonce'], self::NONCE ) )
246 foreach( array( 'akismet_strictness', 'akismet_show_user_comments_approved' ) as $option ) {
247 update_option( $option, isset( $_POST[$option] ) && (int) $_POST[$option] == 1 ? '1' : '0' );
250 if ( defined( 'WPCOM_API_KEY' ) )
251 return false; //shouldn't have option to save key if already defined
253 $new_key = preg_replace( '/[^a-f0-9]/i', '', $_POST['key'] );
254 $old_key = Akismet::get_api_key();
256 if ( empty( $new_key ) ) {
257 if ( !empty( $old_key ) ) {
258 delete_option( 'wordpress_api_key' );
259 self::$notices[] = 'new-key-empty';
262 elseif ( $new_key != $old_key ) {
263 self::save_key( $new_key );
269 public static function save_key( $api_key ) {
270 $key_status = Akismet::verify_key( $api_key );
272 if ( $key_status == 'valid' ) {
273 $akismet_user = self::get_akismet_user( $api_key );
275 if ( $akismet_user ) {
276 if ( in_array( $akismet_user->status, array( 'active', 'active-dunning', 'no-sub' ) ) )
277 update_option( 'wordpress_api_key', $api_key );
279 if ( $akismet_user->status == 'active' )
280 self::$notices['status'] = 'new-key-valid';
281 elseif ( $akismet_user->status == 'notice' )
282 self::$notices['status'] = $akismet_user;
284 self::$notices['status'] = $akismet_user->status;
287 self::$notices['status'] = 'new-key-invalid';
289 elseif ( in_array( $key_status, array( 'invalid', 'failed' ) ) )
290 self::$notices['status'] = 'new-key-'.$key_status;
293 public static function dashboard_stats() {
294 if ( !function_exists('did_action') || did_action( 'rightnow_end' ) )
295 return; // We already displayed this info in the "Right Now" section
297 if ( !$count = get_option('akismet_spam_count') )
302 echo '<h3>' . esc_html( _x( 'Spam', 'comments' , 'akismet') ) . '</h3>';
304 echo '<p>'.sprintf( _n(
305 '<a href="%1$s">Akismet</a> has protected your site from <a href="%2$s">%3$s spam comment</a>.',
306 '<a href="%1$s">Akismet</a> has protected your site from <a href="%2$s">%3$s spam comments</a>.',
308 , 'akismet'), 'https://akismet.com/wordpress/', esc_url( add_query_arg( array( 'page' => 'akismet-admin' ), admin_url( isset( $submenu['edit-comments.php'] ) ? 'edit-comments.php' : 'edit.php' ) ) ), number_format_i18n($count) ).'</p>';
312 public static function rightnow_stats() {
313 if ( $count = get_option('akismet_spam_count') ) {
314 $intro = sprintf( _n(
315 '<a href="%1$s">Akismet</a> has protected your site from %2$s spam comment already. ',
316 '<a href="%1$s">Akismet</a> has protected your site from %2$s spam comments already. ',
318 , 'akismet'), 'https://akismet.com/wordpress/', number_format_i18n( $count ) );
320 $intro = sprintf( __('<a href="%s">Akismet</a> blocks spam from getting to your blog. ', 'akismet'), 'https://akismet.com/wordpress/' );
323 $link = add_query_arg( array( 'comment_status' => 'spam' ), admin_url( 'edit-comments.php' ) );
325 if ( $queue_count = self::get_spam_count() ) {
326 $queue_text = sprintf( _n(
327 'There’s <a href="%2$s">%1$s comment</a> in your spam queue right now.',
328 'There are <a href="%2$s">%1$s comments</a> in your spam queue right now.',
330 , 'akismet'), number_format_i18n( $queue_count ), esc_url( $link ) );
332 $queue_text = sprintf( __( "There’s nothing in your <a href='%s'>spam queue</a> at the moment." , 'akismet'), esc_url( $link ) );
335 $text = $intro . '<br />' . $queue_text;
336 echo "<p class='akismet-right-now'>$text</p>\n";
339 public static function check_for_spam_button( $comment_status ) {
340 // The "Check for Spam" button should only appear when the page might be showing
341 // a comment with comment_approved=0, which means an un-trashed, un-spammed,
342 // not-yet-moderated comment.
343 if ( 'all' != $comment_status && 'moderated' != $comment_status ) {
347 if ( function_exists('plugins_url') )
348 $link = add_query_arg( array( 'action' => 'akismet_recheck_queue' ), admin_url( 'admin.php' ) );
350 $link = add_query_arg( array( 'page' => 'akismet-admin', 'recheckqueue' => 'true', 'noheader' => 'true' ), admin_url( 'edit-comments.php' ) );
352 echo '</div><div class="alignleft"><a class="button-secondary checkforspam" href="' . esc_url( $link ) . '">' . esc_html__('Check for Spam', 'akismet') . '</a><span class="checkforspam-spinner"></span>';
355 public static function recheck_queue() {
358 Akismet::fix_scheduled_recheck();
360 if ( ! ( isset( $_GET['recheckqueue'] ) || ( isset( $_REQUEST['action'] ) && 'akismet_recheck_queue' == $_REQUEST['action'] ) ) ) {
364 $result_counts = self::recheck_queue_portion( empty( $_POST['offset'] ) ? 0 : $_POST['offset'], empty( $_POST['limit'] ) ? 100 : $_POST['limit'] );
366 if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
368 'counts' => $result_counts,
372 $redirect_to = isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : admin_url( 'edit-comments.php' );
373 wp_safe_redirect( $redirect_to );
378 public static function recheck_queue_portion( $start = 0, $limit = 100 ) {
391 $moderation = $wpdb->get_col( $wpdb->prepare( "SELECT * FROM {$wpdb->comments} WHERE comment_approved = '0' LIMIT %d OFFSET %d", $limit, $start ) );
393 $result_counts = array(
394 'processed' => count( $moderation ),
400 foreach ( $moderation as $comment_id ) {
401 $api_response = Akismet::recheck_comment( $comment_id, 'recheck_queue' );
403 if ( 'true' === $api_response ) {
404 ++$result_counts['spam'];
406 elseif ( 'false' === $api_response ) {
407 ++$result_counts['ham'];
410 ++$result_counts['error'];
414 return $result_counts;
417 // Adds an 'x' link next to author URLs, clicking will remove the author URL and show an undo link
418 public static function remove_comment_author_url() {
419 if ( !empty( $_POST['id'] ) && check_admin_referer( 'comment_author_url_nonce' ) ) {
420 $comment_id = intval( $_POST['id'] );
421 $comment = get_comment( $comment_id, ARRAY_A );
422 if ( $comment && current_user_can( 'edit_comment', $comment['comment_ID'] ) ) {
423 $comment['comment_author_url'] = '';
424 do_action( 'comment_remove_author_url' );
425 print( wp_update_comment( $comment ) );
431 public static function add_comment_author_url() {
432 if ( !empty( $_POST['id'] ) && !empty( $_POST['url'] ) && check_admin_referer( 'comment_author_url_nonce' ) ) {
433 $comment_id = intval( $_POST['id'] );
434 $comment = get_comment( $comment_id, ARRAY_A );
435 if ( $comment && current_user_can( 'edit_comment', $comment['comment_ID'] ) ) {
436 $comment['comment_author_url'] = esc_url( $_POST['url'] );
437 do_action( 'comment_add_author_url' );
438 print( wp_update_comment( $comment ) );
444 public static function comment_row_action( $a, $comment ) {
446 // failsafe for old WP versions
447 if ( !function_exists('add_comment_meta') )
450 $akismet_result = get_comment_meta( $comment->comment_ID, 'akismet_result', true );
451 $akismet_error = get_comment_meta( $comment->comment_ID, 'akismet_error', true );
452 $user_result = get_comment_meta( $comment->comment_ID, 'akismet_user_result', true);
453 $comment_status = wp_get_comment_status( $comment->comment_ID );
455 if ( $akismet_error ) {
456 $desc = __( 'Awaiting spam check' , 'akismet');
457 } elseif ( !$user_result || $user_result == $akismet_result ) {
458 // Show the original Akismet result if the user hasn't overridden it, or if their decision was the same
459 if ( $akismet_result == 'true' && $comment_status != 'spam' && $comment_status != 'trash' )
460 $desc = __( 'Flagged as spam by Akismet' , 'akismet');
461 elseif ( $akismet_result == 'false' && $comment_status == 'spam' )
462 $desc = __( 'Cleared by Akismet' , 'akismet');
464 $who = get_comment_meta( $comment->comment_ID, 'akismet_user', true );
465 if ( $user_result == 'true' )
466 $desc = sprintf( __('Flagged as spam by %s', 'akismet'), $who );
468 $desc = sprintf( __('Un-spammed by %s', 'akismet'), $who );
471 // add a History item to the hover links, just after Edit
472 if ( $akismet_result ) {
474 foreach ( $a as $k => $item ) {
478 || ( $k == 'unspam' && $GLOBALS['wp_version'] >= 3.4 )
480 $b['history'] = '<a href="comment.php?action=editcomment&c='.$comment->comment_ID.'#akismet-status" title="'. esc_attr__( 'View comment history' , 'akismet') . '"> '. esc_html__('History', 'akismet') . '</a>';
488 echo '<span class="akismet-status" commentid="'.$comment->comment_ID.'"><a href="comment.php?action=editcomment&c='.$comment->comment_ID.'#akismet-status" title="' . esc_attr__( 'View comment history' , 'akismet') . '">'.esc_html( $desc ).'</a></span>';
490 $show_user_comments = apply_filters( 'akismet_show_user_comments_approved', get_option('akismet_show_user_comments_approved') );
491 $show_user_comments = $show_user_comments === 'false' ? false : $show_user_comments; //option used to be saved as 'false' / 'true'
493 if ( $show_user_comments ) {
494 $comment_count = Akismet::get_user_comments_approved( $comment->user_id, $comment->comment_author_email, $comment->comment_author, $comment->comment_author_url );
495 $comment_count = intval( $comment_count );
496 echo '<span class="akismet-user-comment-count" commentid="'.$comment->comment_ID.'" style="display:none;"><br><span class="akismet-user-comment-counts">'. sprintf( esc_html( _n( '%s approved', '%s approved', $comment_count , 'akismet') ), number_format_i18n( $comment_count ) ) . '</span></span>';
502 public static function comment_status_meta_box( $comment ) {
503 $history = Akismet::get_comment_history( $comment->comment_ID );
506 echo '<div class="akismet-history" style="margin: 13px;">';
508 foreach ( $history as $row ) {
509 $time = date( 'D d M Y @ h:i:m a', $row['time'] ) . ' GMT';
513 if ( ! empty( $row['message'] ) ) {
514 // Old versions of Akismet stored the message as a literal string in the commentmeta.
515 // New versions don't do that for two reasons:
517 // 2) The message can be translated into the current language of the blog, not stuck
518 // in the language of the blog when the comment was made.
519 $message = $row['message'];
522 // If possible, use a current translation.
523 switch ( $row['event'] ) {
525 $message = __( 'Akismet re-checked and caught this comment as spam.', 'akismet' );
528 $message = __( 'Akismet caught this comment as spam.', 'akismet' );
531 $message = __( 'Akismet re-checked and cleared this comment.', 'akismet' );
534 $message = __( 'Akismet cleared this comment.', 'akismet' );
536 case 'wp-blacklisted':
537 $message = __( 'Comment was caught by wp_blacklist_check.', 'akismet' );
540 if ( isset( $row['user'] ) ) {
541 $message = sprintf( __( '%s reported this comment as spam.', 'akismet' ), $row['user'] );
543 else if ( ! $message ) {
544 $message = __( 'This comment was reported as spam.', 'akismet' );
548 if ( isset( $row['user'] ) ) {
549 $message = sprintf( __( '%s reported this comment as not spam.', 'akismet' ), $row['user'] );
551 else if ( ! $message ) {
552 $message = __( 'This comment was reported as not spam.', 'akismet' );
555 case 'cron-retry-spam':
556 $message = __( 'Akismet caught this comment as spam during an automatic retry.' , 'akismet');
558 case 'cron-retry-ham':
559 $message = __( 'Akismet cleared this comment during an automatic retry.', 'akismet');
562 if ( isset( $row['meta'], $row['meta']['response'] ) ) {
563 $message = sprintf( __( 'Akismet was unable to check this comment (response: %s) but will automatically retry later.', 'akismet'), $row['meta']['response'] );
566 case 'recheck-error':
567 if ( isset( $row['meta'], $row['meta']['response'] ) ) {
568 $message = sprintf( __( 'Akismet was unable to recheck this comment (response: %s).', 'akismet'), $row['meta']['response'] );
572 if ( preg_match( '/^status-changed/', $row['event'] ) ) {
573 // Half of these used to be saved without the dash after 'status-changed'.
574 // See https://plugins.trac.wordpress.org/changeset/1150658/akismet/trunk
575 $new_status = preg_replace( '/^status-changed-?/', '', $row['event'] );
576 $message = sprintf( __( 'Comment status was changed to %s', 'akismet' ), $new_status );
578 else if ( preg_match( '/^status-/', $row['event'] ) ) {
579 $new_status = preg_replace( '/^status-/', '', $row['event'] );
581 if ( isset( $row['user'] ) ) {
582 $message = sprintf( __( '%1$s changed the comment status to %2$s.', 'akismet' ), $row['user'], $new_status );
589 echo '<div style="margin-bottom: 13px;">';
590 echo '<span style="color: #999;" alt="' . $time . '" title="' . $time . '">' . sprintf( esc_html__('%s ago', 'akismet'), human_time_diff( $row['time'] ) ) . '</span>';
592 echo esc_html( $message );
600 public static function plugin_action_links( $links, $file ) {
601 if ( $file == plugin_basename( plugin_dir_url( __FILE__ ) . '/akismet.php' ) ) {
602 $links[] = '<a href="' . esc_url( self::get_page_url() ) . '">'.esc_html__( 'Settings' , 'akismet').'</a>';
608 // Total spam in queue
609 // get_option( 'akismet_spam_count' ) is the total caught ever
610 public static function get_spam_count( $type = false ) {
613 if ( !$type ) { // total
614 $count = wp_cache_get( 'akismet_spam_count', 'widget' );
615 if ( false === $count ) {
616 if ( function_exists('wp_count_comments') ) {
617 $count = wp_count_comments();
618 $count = $count->spam;
620 $count = (int) $wpdb->get_var("SELECT COUNT(comment_ID) FROM {$wpdb->comments} WHERE comment_approved = 'spam'");
622 wp_cache_set( 'akismet_spam_count', $count, 'widget', 3600 );
625 } elseif ( 'comments' == $type || 'comment' == $type ) { // comments
629 return (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(comment_ID) FROM {$wpdb->comments} WHERE comment_approved = 'spam' AND comment_type = %s", $type ) );
632 // Check connectivity between the WordPress blog and Akismet's servers.
633 // Returns an associative array of server IP addresses, where the key is the IP address, and value is true (available) or false (unable to connect).
634 public static function check_server_ip_connectivity() {
636 $servers = $ips = array();
638 // Some web hosts may disable this function
639 if ( function_exists('gethostbynamel') ) {
641 $ips = gethostbynamel( 'rest.akismet.com' );
642 if ( $ips && is_array($ips) && count($ips) ) {
643 $api_key = Akismet::get_api_key();
645 foreach ( $ips as $ip ) {
646 $response = Akismet::verify_key( $api_key, $ip );
647 // even if the key is invalid, at least we know we have connectivity
648 if ( $response == 'valid' || $response == 'invalid' )
649 $servers[$ip] = 'connected';
651 $servers[$ip] = $response ? $response : 'unable to connect';
659 // Simpler connectivity check
660 public static function check_server_connectivity($cache_timeout = 86400) {
663 $debug[ 'PHP_VERSION' ] = PHP_VERSION;
664 $debug[ 'WORDPRESS_VERSION' ] = $GLOBALS['wp_version'];
665 $debug[ 'AKISMET_VERSION' ] = AKISMET_VERSION;
666 $debug[ 'AKISMET__PLUGIN_DIR' ] = AKISMET__PLUGIN_DIR;
667 $debug[ 'SITE_URL' ] = site_url();
668 $debug[ 'HOME_URL' ] = home_url();
670 $servers = get_option('akismet_available_servers');
671 if ( (time() - get_option('akismet_connectivity_time') < $cache_timeout) && $servers !== false ) {
672 $servers = self::check_server_ip_connectivity();
673 update_option('akismet_available_servers', $servers);
674 update_option('akismet_connectivity_time', time());
677 if ( function_exists( 'wp_http_supports' ) && ( wp_http_supports( array( 'ssl' ) ) ) ) {
678 $response = wp_remote_get( 'https://rest.akismet.com/1.1/test' );
681 $response = wp_remote_get( 'http://rest.akismet.com/1.1/test' );
684 $debug[ 'gethostbynamel' ] = function_exists('gethostbynamel') ? 'exists' : 'not here';
685 $debug[ 'Servers' ] = $servers;
686 $debug[ 'Test Connection' ] = $response;
688 Akismet::log( $debug );
690 if ( $response && 'connected' == wp_remote_retrieve_body( $response ) )
696 // Check the server connectivity and store the available servers in an option.
697 public static function get_server_connectivity($cache_timeout = 86400) {
698 return self::check_server_connectivity( $cache_timeout );
701 public static function get_number_spam_waiting() {
703 return (int) $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->commentmeta} WHERE meta_key = 'akismet_error'" );
706 public static function get_page_url( $page = 'config' ) {
708 $args = array( 'page' => 'akismet-key-config' );
710 if ( $page == 'stats' )
711 $args = array( 'page' => 'akismet-key-config', 'view' => 'stats' );
712 elseif ( $page == 'delete_key' )
713 $args = array( 'page' => 'akismet-key-config', 'view' => 'start', 'action' => 'delete-key', '_wpnonce' => wp_create_nonce( self::NONCE ) );
715 $url = add_query_arg( $args, class_exists( 'Jetpack' ) ? admin_url( 'admin.php' ) : admin_url( 'options-general.php' ) );
720 public static function get_akismet_user( $api_key ) {
721 $akismet_user = false;
723 $subscription_verification = Akismet::http_post( Akismet::build_query( array( 'key' => $api_key, 'blog' => get_option( 'home' ) ) ), 'get-subscription' );
725 if ( ! empty( $subscription_verification[1] ) ) {
726 if ( 'invalid' !== $subscription_verification[1] ) {
727 $akismet_user = json_decode( $subscription_verification[1] );
731 return $akismet_user;
734 public static function get_stats( $api_key ) {
735 $stat_totals = array();
737 foreach( array( '6-months', 'all' ) as $interval ) {
738 $response = Akismet::http_post( Akismet::build_query( array( 'blog' => get_option( 'home' ), 'key' => $api_key, 'from' => $interval ) ), 'get-stats' );
740 if ( ! empty( $response[1] ) ) {
741 $stat_totals[$interval] = json_decode( $response[1] );
748 public static function verify_wpcom_key( $api_key, $user_id, $extra = array() ) {
749 $akismet_account = Akismet::http_post( Akismet::build_query( array_merge( array(
750 'user_id' => $user_id,
751 'api_key' => $api_key,
752 'get_account_type' => 'true'
753 ), $extra ) ), 'verify-wpcom-key' );
755 if ( ! empty( $akismet_account[1] ) )
756 $akismet_account = json_decode( $akismet_account[1] );
758 Akismet::log( compact( 'akismet_account' ) );
760 return $akismet_account;
763 public static function connect_jetpack_user() {
765 if ( $jetpack_user = self::get_jetpack_user() ) {
766 if ( isset( $jetpack_user['user_id'] ) && isset( $jetpack_user['api_key'] ) ) {
767 $akismet_user = self::verify_wpcom_key( $jetpack_user['api_key'], $jetpack_user['user_id'], array( 'action' => 'connect_jetpack_user' ) );
769 if ( is_object( $akismet_user ) ) {
770 self::save_key( $akismet_user->api_key );
771 return in_array( $akismet_user->status, array( 'active', 'active-dunning', 'no-sub' ) );
779 public static function display_alert() {
780 Akismet::view( 'notice', array(
782 'code' => (int) get_option( 'akismet_alert_code' ),
783 'msg' => get_option( 'akismet_alert_msg' )
787 public static function display_spam_check_warning() {
788 Akismet::fix_scheduled_recheck();
790 if ( wp_next_scheduled('akismet_schedule_cron_recheck') > time() && self::get_number_spam_waiting() > 0 ) {
791 $link_text = apply_filters( 'akismet_spam_check_warning_link_text', sprintf( __( 'Please check your <a href="%s">Akismet configuration</a> and contact your web host if problems persist.', 'akismet'), esc_url( self::get_page_url() ) ) );
792 Akismet::view( 'notice', array( 'type' => 'spam-check', 'link_text' => $link_text ) );
796 public static function display_invalid_version() {
797 Akismet::view( 'notice', array( 'type' => 'version' ) );
800 public static function display_api_key_warning() {
801 Akismet::view( 'notice', array( 'type' => 'plugin' ) );
804 public static function display_page() {
805 if ( !Akismet::get_api_key() || ( isset( $_GET['view'] ) && $_GET['view'] == 'start' ) )
806 self::display_start_page();
807 elseif ( isset( $_GET['view'] ) && $_GET['view'] == 'stats' )
808 self::display_stats_page();
810 self::display_configuration_page();
813 public static function display_start_page() {
814 if ( isset( $_GET['action'] ) ) {
815 if ( $_GET['action'] == 'delete-key' ) {
816 if ( isset( $_GET['_wpnonce'] ) && wp_verify_nonce( $_GET['_wpnonce'], self::NONCE ) )
817 delete_option( 'wordpress_api_key' );
821 if ( $api_key = Akismet::get_api_key() && ( empty( self::$notices['status'] ) || 'existing-key-invalid' != self::$notices['status'] ) ) {
822 self::display_configuration_page();
826 //the user can choose to auto connect their API key by clicking a button on the akismet done page
827 //if jetpack, get verified api key by using connected wpcom user id
828 //if no jetpack, get verified api key by using an akismet token
830 $akismet_user = false;
832 if ( isset( $_GET['token'] ) && preg_match('/^(\d+)-[0-9a-f]{20}$/', $_GET['token'] ) )
833 $akismet_user = self::verify_wpcom_key( '', '', array( 'token' => $_GET['token'] ) );
834 elseif ( $jetpack_user = self::get_jetpack_user() )
835 $akismet_user = self::verify_wpcom_key( $jetpack_user['api_key'], $jetpack_user['user_id'] );
837 if ( isset( $_GET['action'] ) ) {
838 if ( $_GET['action'] == 'save-key' ) {
839 if ( is_object( $akismet_user ) ) {
840 self::save_key( $akismet_user->api_key );
841 self::display_notice();
842 self::display_configuration_page();
848 echo '<h2 class="ak-header">'.esc_html__('Akismet', 'akismet').'</h2>';
850 self::display_status();
852 Akismet::view( 'start', compact( 'akismet_user' ) );
855 public static function display_stats_page() {
856 Akismet::view( 'stats' );
859 public static function display_configuration_page() {
860 $api_key = Akismet::get_api_key();
861 $akismet_user = self::get_akismet_user( $api_key );
863 if ( ! $akismet_user ) {
864 // This could happen if the user's key became invalid after it was previously valid and successfully set up.
865 self::$notices['status'] = 'existing-key-invalid';
866 self::display_start_page();
870 $stat_totals = self::get_stats( $api_key );
872 // If unset, create the new strictness option using the old discard option to determine its default
873 if ( get_option( 'akismet_strictness' ) === false )
874 add_option( 'akismet_strictness', (get_option('akismet_discard_month') === 'true' ? '1' : '0') );
876 if ( empty( self::$notices ) ) {
878 if ( ! empty( $stat_totals['all'] ) && isset( $stat_totals['all']->time_saved ) && $akismet_user->status == 'active' && $akismet_user->account_type == 'free-api-key' ) {
882 if ( $stat_totals['all']->time_saved > 1800 ) {
883 $total_in_minutes = round( $stat_totals['all']->time_saved / 60 );
884 $total_in_hours = round( $total_in_minutes / 60 );
885 $total_in_days = round( $total_in_hours / 8 );
886 $cleaning_up = __( 'Cleaning up spam takes time.' , 'akismet');
888 if ( $total_in_days > 1 )
889 $time_saved = $cleaning_up . ' ' . sprintf( _n( 'Akismet has saved you %s day!', 'Akismet has saved you %s days!', $total_in_days, 'akismet' ), number_format_i18n( $total_in_days ) );
890 elseif ( $total_in_hours > 1 )
891 $time_saved = $cleaning_up . ' ' . sprintf( _n( 'Akismet has saved you %d hour!', 'Akismet has saved you %d hours!', $total_in_hours, 'akismet' ), $total_in_hours );
892 elseif ( $total_in_minutes >= 30 )
893 $time_saved = $cleaning_up . ' ' . sprintf( _n( 'Akismet has saved you %d minute!', 'Akismet has saved you %d minutes!', $total_in_minutes, 'akismet' ), $total_in_minutes );
896 Akismet::view( 'notice', array( 'type' => 'active-notice', 'time_saved' => $time_saved ) );
899 if ( !empty( $akismet_user->limit_reached ) && in_array( $akismet_user->limit_reached, array( 'yellow', 'red' ) ) ) {
900 Akismet::view( 'notice', array( 'type' => 'limit-reached', 'level' => $akismet_user->limit_reached ) );
904 if ( !isset( self::$notices['status'] ) && in_array( $akismet_user->status, array( 'cancelled', 'suspended', 'missing', 'no-sub' ) ) )
905 Akismet::view( 'notice', array( 'type' => $akismet_user->status ) );
907 Akismet::log( compact( 'stat_totals', 'akismet_user' ) );
908 Akismet::view( 'config', compact( 'api_key', 'akismet_user', 'stat_totals' ) );
911 public static function display_notice() {
914 if ( in_array( $hook_suffix, array( 'jetpack_page_akismet-key-config', 'settings_page_akismet-key-config', 'edit-comments.php' ) ) && (int) get_option( 'akismet_alert_code' ) > 0 ) {
915 Akismet::verify_key( Akismet::get_api_key() ); //verify that the key is still in alert state
917 if ( get_option( 'akismet_alert_code' ) > 0 )
918 self::display_alert();
920 elseif ( $hook_suffix == 'plugins.php' && !Akismet::get_api_key() ) {
921 self::display_api_key_warning();
923 elseif ( $hook_suffix == 'edit-comments.php' && wp_next_scheduled( 'akismet_schedule_cron_recheck' ) ) {
924 self::display_spam_check_warning();
926 elseif ( in_array( $hook_suffix, array( 'jetpack_page_akismet-key-config', 'settings_page_akismet-key-config' ) ) && Akismet::get_api_key() ) {
927 self::display_status();
931 public static function display_status() {
934 if ( !self::get_server_connectivity() )
935 $type = 'servers-be-down';
937 if ( !empty( $type ) )
938 Akismet::view( 'notice', compact( 'type' ) );
939 elseif ( !empty( self::$notices ) ) {
940 foreach ( self::$notices as $type ) {
941 if ( is_object( $type ) ) {
942 $notice_header = $notice_text = '';
944 if ( property_exists( $type, 'notice_header' ) )
945 $notice_header = wp_kses( $type->notice_header, self::$allowed );
947 if ( property_exists( $type, 'notice_text' ) )
948 $notice_text = wp_kses( $type->notice_text, self::$allowed );
950 if ( property_exists( $type, 'status' ) ) {
951 $type = wp_kses( $type->status, self::$allowed );
952 Akismet::view( 'notice', compact( 'type', 'notice_header', 'notice_text' ) );
956 Akismet::view( 'notice', compact( 'type' ) );
961 private static function get_jetpack_user() {
962 if ( !class_exists('Jetpack') )
965 Jetpack::load_xml_rpc_client();
966 $xml = new Jetpack_IXR_ClientMulticall( array( 'user_id' => get_current_user_id() ) );
968 $xml->addCall( 'wpcom.getUserID' );
969 $xml->addCall( 'akismet.getAPIKey' );
972 Akismet::log( compact( 'xml' ) );
974 if ( !$xml->isError() ) {
975 $responses = $xml->getResponse();
976 if ( count( $responses ) > 1 ) {
977 $api_key = array_shift( $responses[0] );
978 $user_id = (int) array_shift( $responses[1] );
979 return compact( 'api_key', 'user_id' );
986 * Some commentmeta isn't useful in an export file. Suppress it (when supported).
988 * @param bool $exclude
989 * @param string $key The meta key
990 * @param object $meta The meta object
991 * @return bool Whether to exclude this meta entry from the export.
993 public static function exclude_commentmeta_from_export( $exclude, $key, $meta ) {
994 if ( in_array( $key, array( 'akismet_as_submitted', 'akismet_rechecking', 'akismet_delayed_moderation_email' ) ) ) {