4 const API_HOST = 'rest.akismet.com';
6 const MAX_DELAY_BEFORE_MODERATION_EMAIL = 86400; // One day in seconds
8 private static $last_comment = '';
9 private static $initiated = false;
10 private static $prevent_moderation_email_for_these_comments = array();
11 private static $last_comment_result = null;
12 private static $comment_as_submitted_allowed_keys = array( 'blog' => '', 'blog_charset' => '', 'blog_lang' => '', 'blog_ua' => '', 'comment_agent' => '', 'comment_author' => '', 'comment_author_IP' => '', 'comment_author_email' => '', 'comment_author_url' => '', 'comment_content' => '', 'comment_date_gmt' => '', 'comment_tags' => '', 'comment_type' => '', 'guid' => '', 'is_test' => '', 'permalink' => '', 'reporter' => '', 'site_domain' => '', 'submit_referer' => '', 'submit_uri' => '', 'user_ID' => '', 'user_agent' => '', 'user_id' => '', 'user_ip' => '' );
14 public static function init() {
15 if ( ! self::$initiated ) {
21 * Initializes WordPress hooks
23 private static function init_hooks() {
24 self::$initiated = true;
26 add_action( 'wp_insert_comment', array( 'Akismet', 'auto_check_update_meta' ), 10, 2 );
27 add_filter( 'preprocess_comment', array( 'Akismet', 'auto_check_comment' ), 1 );
28 add_action( 'akismet_scheduled_delete', array( 'Akismet', 'delete_old_comments' ) );
29 add_action( 'akismet_scheduled_delete', array( 'Akismet', 'delete_old_comments_meta' ) );
30 add_action( 'akismet_schedule_cron_recheck', array( 'Akismet', 'cron_recheck' ) );
33 * To disable the Akismet comment nonce, add a filter for the 'akismet_comment_nonce' tag
34 * and return any string value that is not 'true' or '' (empty string).
36 * Don't return boolean false, because that implies that the 'akismet_comment_nonce' option
37 * has not been set and that Akismet should just choose the default behavior for that
40 $akismet_comment_nonce_option = apply_filters( 'akismet_comment_nonce', get_option( 'akismet_comment_nonce' ) );
42 if ( $akismet_comment_nonce_option == 'true' || $akismet_comment_nonce_option == '' )
43 add_action( 'comment_form', array( 'Akismet', 'add_comment_nonce' ), 1 );
45 add_action( 'admin_head-edit-comments.php', array( 'Akismet', 'load_form_js' ) );
46 add_action( 'comment_form', array( 'Akismet', 'load_form_js' ) );
47 add_action( 'comment_form', array( 'Akismet', 'inject_ak_js' ) );
49 add_filter( 'comment_moderation_recipients', array( 'Akismet', 'disable_moderation_emails_if_unreachable' ), 1000, 2 );
50 add_filter( 'pre_comment_approved', array( 'Akismet', 'last_comment_status' ), 10, 2 );
52 add_action( 'transition_comment_status', array( 'Akismet', 'transition_comment_status' ), 10, 3 );
54 // Run this early in the pingback call, before doing a remote fetch of the source uri
55 add_action( 'xmlrpc_call', array( 'Akismet', 'pre_check_pingback' ) );
57 // Jetpack compatibility
58 add_filter( 'jetpack_options_whitelist', array( 'Akismet', 'add_to_jetpack_options_whitelist' ) );
59 add_action( 'update_option_wordpress_api_key', array( 'Akismet', 'updated_option' ), 10, 2 );
62 public static function get_api_key() {
63 return apply_filters( 'akismet_get_api_key', defined('WPCOM_API_KEY') ? constant('WPCOM_API_KEY') : get_option('wordpress_api_key') );
66 public static function check_key_status( $key, $ip = null ) {
67 return self::http_post( Akismet::build_query( array( 'key' => $key, 'blog' => get_option('home') ) ), 'verify-key', $ip );
70 public static function verify_key( $key, $ip = null ) {
71 $response = self::check_key_status( $key, $ip );
73 if ( $response[1] != 'valid' && $response[1] != 'invalid' )
79 public static function deactivate_key( $key ) {
80 $response = self::http_post( Akismet::build_query( array( 'key' => $key, 'blog' => get_option('home') ) ), 'deactivate' );
82 if ( $response[1] != 'deactivated' )
89 * Add the akismet option to the Jetpack options management whitelist.
91 * @param array $options The list of whitelisted option names.
92 * @return array The updated whitelist
94 public static function add_to_jetpack_options_whitelist( $options ) {
95 $options[] = 'wordpress_api_key';
100 * When the akismet option is updated, run the registration call.
102 * This should only be run when the option is updated from the Jetpack/WP.com
103 * API call, and only if the new key is different than the old key.
105 * @param mixed $old_value The old option value.
106 * @param mixed $value The new option value.
108 public static function updated_option( $old_value, $value ) {
110 if ( ! class_exists( 'WPCOM_JSON_API_Update_Option_Endpoint' ) ) {
113 // Only run the registration if the old key is different.
114 if ( $old_value !== $value ) {
115 self::verify_key( $value );
119 public static function auto_check_comment( $commentdata ) {
120 self::$last_comment_result = null;
122 $comment = $commentdata;
124 $comment['user_ip'] = self::get_ip_address();
125 $comment['user_agent'] = self::get_user_agent();
126 $comment['referrer'] = self::get_referer();
127 $comment['blog'] = get_option('home');
128 $comment['blog_lang'] = get_locale();
129 $comment['blog_charset'] = get_option('blog_charset');
130 $comment['permalink'] = get_permalink( $comment['comment_post_ID'] );
132 if ( !empty( $comment['user_ID'] ) )
133 $comment['user_role'] = Akismet::get_user_roles( $comment['user_ID'] );
135 /** See filter documentation in init_hooks(). */
136 $akismet_nonce_option = apply_filters( 'akismet_comment_nonce', get_option( 'akismet_comment_nonce' ) );
137 $comment['akismet_comment_nonce'] = 'inactive';
138 if ( $akismet_nonce_option == 'true' || $akismet_nonce_option == '' ) {
139 $comment['akismet_comment_nonce'] = 'failed';
140 if ( isset( $_POST['akismet_comment_nonce'] ) && wp_verify_nonce( $_POST['akismet_comment_nonce'], 'akismet_comment_nonce_' . $comment['comment_post_ID'] ) )
141 $comment['akismet_comment_nonce'] = 'passed';
143 // comment reply in wp-admin
144 if ( isset( $_POST['_ajax_nonce-replyto-comment'] ) && check_ajax_referer( 'replyto-comment', '_ajax_nonce-replyto-comment' ) )
145 $comment['akismet_comment_nonce'] = 'passed';
149 if ( self::is_test_mode() )
150 $comment['is_test'] = 'true';
152 foreach( $_POST as $key => $value ) {
153 if ( is_string( $value ) )
154 $comment["POST_{$key}"] = $value;
157 foreach ( $_SERVER as $key => $value ) {
158 if ( ! is_string( $value ) ) {
162 if ( preg_match( "/^HTTP_COOKIE/", $key ) ) {
166 // Send any potentially useful $_SERVER vars, but avoid sending junk we don't need.
167 if ( preg_match( "/^(HTTP_|REMOTE_ADDR|REQUEST_URI|DOCUMENT_URI)/", $key ) ) {
168 $comment[ "$key" ] = $value;
172 $post = get_post( $comment['comment_post_ID'] );
173 $comment[ 'comment_post_modified_gmt' ] = $post->post_modified_gmt;
175 $response = self::http_post( Akismet::build_query( $comment ), 'comment-check' );
177 do_action( 'akismet_comment_check_response', $response );
179 $commentdata['comment_as_submitted'] = array_intersect_key( $comment, self::$comment_as_submitted_allowed_keys );
180 $commentdata['akismet_result'] = $response[1];
182 if ( isset( $response[0]['x-akismet-pro-tip'] ) )
183 $commentdata['akismet_pro_tip'] = $response[0]['x-akismet-pro-tip'];
185 if ( isset( $response[0]['x-akismet-error'] ) ) {
186 // An error occurred that we anticipated (like a suspended key) and want the user to act on.
187 // Send to moderation.
188 self::$last_comment_result = '0';
190 else if ( 'true' == $response[1] ) {
191 // akismet_spam_count will be incremented later by comment_is_spam()
192 self::$last_comment_result = 'spam';
194 $discard = ( isset( $commentdata['akismet_pro_tip'] ) && $commentdata['akismet_pro_tip'] === 'discard' && self::allow_discard() );
196 do_action( 'akismet_spam_caught', $discard );
199 // akismet_result_spam() won't be called so bump the counter here
200 if ( $incr = apply_filters('akismet_spam_count_incr', 1) )
201 update_option( 'akismet_spam_count', get_option('akismet_spam_count') + $incr );
202 $redirect_to = isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : get_permalink( $post );
203 wp_safe_redirect( esc_url_raw( $redirect_to ) );
208 // if the response is neither true nor false, hold the comment for moderation and schedule a recheck
209 if ( 'true' != $response[1] && 'false' != $response[1] ) {
210 if ( !current_user_can('moderate_comments') ) {
211 // Comment status should be moderated
212 self::$last_comment_result = '0';
214 if ( function_exists('wp_next_scheduled') && function_exists('wp_schedule_single_event') ) {
215 if ( !wp_next_scheduled( 'akismet_schedule_cron_recheck' ) ) {
216 wp_schedule_single_event( time() + 1200, 'akismet_schedule_cron_recheck' );
217 do_action( 'akismet_scheduled_recheck', 'invalid-response-' . $response[1] );
221 self::$prevent_moderation_email_for_these_comments[] = $commentdata;
224 if ( function_exists('wp_next_scheduled') && function_exists('wp_schedule_event') ) {
225 // WP 2.1+: delete old comments daily
226 if ( !wp_next_scheduled( 'akismet_scheduled_delete' ) )
227 wp_schedule_event( time(), 'daily', 'akismet_scheduled_delete' );
229 elseif ( (mt_rand(1, 10) == 3) ) {
230 // WP 2.0: run this one time in ten
231 self::delete_old_comments();
234 self::set_last_comment( $commentdata );
235 self::fix_scheduled_recheck();
240 public static function get_last_comment() {
241 return self::$last_comment;
244 public static function set_last_comment( $comment ) {
245 if ( is_null( $comment ) ) {
246 self::$last_comment = null;
249 // We filter it here so that it matches the filtered comment data that we'll have to compare against later.
250 // wp_filter_comment expects comment_author_IP
251 self::$last_comment = wp_filter_comment(
253 array( 'comment_author_IP' => self::get_ip_address() ),
260 // this fires on wp_insert_comment. we can't update comment_meta when auto_check_comment() runs
261 // because we don't know the comment ID at that point.
262 public static function auto_check_update_meta( $id, $comment ) {
264 // failsafe for old WP versions
265 if ( !function_exists('add_comment_meta') )
268 if ( !isset( self::$last_comment['comment_author_email'] ) )
269 self::$last_comment['comment_author_email'] = '';
271 // wp_insert_comment() might be called in other contexts, so make sure this is the same comment
272 // as was checked by auto_check_comment
273 if ( is_object( $comment ) && !empty( self::$last_comment ) && is_array( self::$last_comment ) ) {
274 if ( self::matches_last_comment( $comment ) ) {
276 load_plugin_textdomain( 'akismet' );
278 // normal result: true or false
279 if ( self::$last_comment['akismet_result'] == 'true' ) {
280 update_comment_meta( $comment->comment_ID, 'akismet_result', 'true' );
281 self::update_comment_history( $comment->comment_ID, '', 'check-spam' );
282 if ( $comment->comment_approved != 'spam' )
283 self::update_comment_history(
284 $comment->comment_ID,
286 'status-changed-'.$comment->comment_approved
289 elseif ( self::$last_comment['akismet_result'] == 'false' ) {
290 update_comment_meta( $comment->comment_ID, 'akismet_result', 'false' );
291 self::update_comment_history( $comment->comment_ID, '', 'check-ham' );
292 // Status could be spam or trash, depending on the WP version and whether this change applies:
293 // https://core.trac.wordpress.org/changeset/34726
294 if ( $comment->comment_approved == 'spam' || $comment->comment_approved == 'trash' ) {
295 if ( wp_blacklist_check($comment->comment_author, $comment->comment_author_email, $comment->comment_author_url, $comment->comment_content, $comment->comment_author_IP, $comment->comment_agent) )
296 self::update_comment_history( $comment->comment_ID, '', 'wp-blacklisted' );
298 self::update_comment_history( $comment->comment_ID, '', 'status-changed-'.$comment->comment_approved );
300 } // abnormal result: error
302 update_comment_meta( $comment->comment_ID, 'akismet_error', time() );
303 self::update_comment_history(
304 $comment->comment_ID,
307 array( 'response' => substr( self::$last_comment['akismet_result'], 0, 50 ) )
311 // record the complete original data as submitted for checking
312 if ( isset( self::$last_comment['comment_as_submitted'] ) )
313 update_comment_meta( $comment->comment_ID, 'akismet_as_submitted', self::$last_comment['comment_as_submitted'] );
315 if ( isset( self::$last_comment['akismet_pro_tip'] ) )
316 update_comment_meta( $comment->comment_ID, 'akismet_pro_tip', self::$last_comment['akismet_pro_tip'] );
321 public static function delete_old_comments() {
325 * Determines how many comments will be deleted in each batch.
327 * @param int The default, as defined by AKISMET_DELETE_LIMIT.
329 $delete_limit = apply_filters( 'akismet_delete_comment_limit', defined( 'AKISMET_DELETE_LIMIT' ) ? AKISMET_DELETE_LIMIT : 10000 );
330 $delete_limit = max( 1, intval( $delete_limit ) );
333 * Determines how many days a comment will be left in the Spam queue before being deleted.
335 * @param int The default number of days.
337 $delete_interval = apply_filters( 'akismet_delete_comment_interval', 15 );
338 $delete_interval = max( 1, intval( $delete_interval ) );
340 while ( $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT comment_id FROM {$wpdb->comments} WHERE DATE_SUB(NOW(), INTERVAL %d DAY) > comment_date_gmt AND comment_approved = 'spam' LIMIT %d", $delete_interval, $delete_limit ) ) ) {
341 if ( empty( $comment_ids ) )
344 $wpdb->queries = array();
346 foreach ( $comment_ids as $comment_id ) {
347 do_action( 'delete_comment', $comment_id );
350 $comma_comment_ids = implode( ', ', array_map('intval', $comment_ids) );
352 $wpdb->query("DELETE FROM {$wpdb->comments} WHERE comment_id IN ( $comma_comment_ids )");
353 $wpdb->query("DELETE FROM {$wpdb->commentmeta} WHERE comment_id IN ( $comma_comment_ids )");
355 clean_comment_cache( $comment_ids );
358 if ( apply_filters( 'akismet_optimize_table', ( mt_rand(1, 5000) == 11), $wpdb->comments ) ) // lucky number
359 $wpdb->query("OPTIMIZE TABLE {$wpdb->comments}");
362 public static function delete_old_comments_meta() {
365 $interval = apply_filters( 'akismet_delete_commentmeta_interval', 15 );
367 # enfore a minimum of 1 day
368 $interval = absint( $interval );
372 // akismet_as_submitted meta values are large, so expire them
373 // after $interval days regardless of the comment status
374 while ( $comment_ids = $wpdb->get_col( $wpdb->prepare( "SELECT m.comment_id FROM {$wpdb->commentmeta} as m INNER JOIN {$wpdb->comments} as c USING(comment_id) WHERE m.meta_key = 'akismet_as_submitted' AND DATE_SUB(NOW(), INTERVAL %d DAY) > c.comment_date_gmt LIMIT 10000", $interval ) ) ) {
375 if ( empty( $comment_ids ) )
378 $wpdb->queries = array();
380 foreach ( $comment_ids as $comment_id ) {
381 delete_comment_meta( $comment_id, 'akismet_as_submitted' );
385 if ( apply_filters( 'akismet_optimize_table', ( mt_rand(1, 5000) == 11), $wpdb->commentmeta ) ) // lucky number
386 $wpdb->query("OPTIMIZE TABLE {$wpdb->commentmeta}");
389 // how many approved comments does this author have?
390 public static function get_user_comments_approved( $user_id, $comment_author_email, $comment_author, $comment_author_url ) {
393 if ( !empty( $user_id ) )
394 return (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM {$wpdb->comments} WHERE user_id = %d AND comment_approved = 1", $user_id ) );
396 if ( !empty( $comment_author_email ) )
397 return (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM {$wpdb->comments} WHERE comment_author_email = %s AND comment_author = %s AND comment_author_url = %s AND comment_approved = 1", $comment_author_email, $comment_author, $comment_author_url ) );
402 // get the full comment history for a given comment, as an array in reverse chronological order
403 public static function get_comment_history( $comment_id ) {
405 // failsafe for old WP versions
406 if ( !function_exists('add_comment_meta') )
409 $history = get_comment_meta( $comment_id, 'akismet_history', false );
410 usort( $history, array( 'Akismet', '_cmp_time' ) );
415 * Log an event for a given comment, storing it in comment_meta.
417 * @param int $comment_id The ID of the relevant comment.
418 * @param string $message The string description of the event. No longer used.
419 * @param string $event The event code.
420 * @param array $meta Metadata about the history entry. e.g., the user that reported or changed the status of a given comment.
422 public static function update_comment_history( $comment_id, $message, $event=null, $meta=null ) {
423 global $current_user;
425 // failsafe for old WP versions
426 if ( !function_exists('add_comment_meta') )
432 'time' => self::_get_microtime(),
436 if ( is_object( $current_user ) && isset( $current_user->user_login ) ) {
437 $event['user'] = $current_user->user_login;
440 if ( ! empty( $meta ) ) {
441 $event['meta'] = $meta;
444 // $unique = false so as to allow multiple values per comment
445 $r = add_comment_meta( $comment_id, 'akismet_history', $event, false );
448 public static function check_db_comment( $id, $recheck_reason = 'recheck_queue' ) {
451 $c = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->comments} WHERE comment_ID = %d", $id ), ARRAY_A );
455 $c['user_ip'] = $c['comment_author_IP'];
456 $c['user_agent'] = $c['comment_agent'];
458 $c['blog'] = get_option('home');
459 $c['blog_lang'] = get_locale();
460 $c['blog_charset'] = get_option('blog_charset');
461 $c['permalink'] = get_permalink($c['comment_post_ID']);
462 $c['recheck_reason'] = $recheck_reason;
464 if ( self::is_test_mode() )
465 $c['is_test'] = 'true';
467 $response = self::http_post( Akismet::build_query( $c ), 'comment-check' );
469 return ( is_array( $response ) && ! empty( $response[1] ) ) ? $response[1] : false;
474 public static function transition_comment_status( $new_status, $old_status, $comment ) {
476 if ( $new_status == $old_status )
479 # we don't need to record a history item for deleted comments
480 if ( $new_status == 'delete' )
483 if ( !current_user_can( 'edit_post', $comment->comment_post_ID ) && !current_user_can( 'moderate_comments' ) )
486 if ( defined('WP_IMPORTING') && WP_IMPORTING == true )
489 // if this is present, it means the status has been changed by a re-check, not an explicit user action
490 if ( get_comment_meta( $comment->comment_ID, 'akismet_rechecking' ) )
493 global $current_user;
495 if ( is_object( $current_user ) )
496 $reporter = $current_user->user_login;
499 // We want to submit comments to Akismet only when a moderator explicitly spams or approves it - not if the status
500 // is changed automatically by another plugin. Unfortunately WordPress doesn't provide an unambiguous way to
501 // determine why the transition_comment_status action was triggered. And there are several different ways by which
502 // to spam and unspam comments: bulk actions, ajax, links in moderation emails, the dashboard, and perhaps others.
503 // We'll assume that this is an explicit user action if certain POST/GET variables exist.
504 if ( ( isset( $_POST['status'] ) && in_array( $_POST['status'], array( 'spam', 'unspam' ) ) ) ||
505 ( isset( $_POST['spam'] ) && (int) $_POST['spam'] == 1 ) ||
506 ( isset( $_POST['unspam'] ) && (int) $_POST['unspam'] == 1 ) ||
507 ( isset( $_POST['comment_status'] ) && in_array( $_POST['comment_status'], array( 'spam', 'unspam' ) ) ) ||
508 ( isset( $_GET['action'] ) && in_array( $_GET['action'], array( 'spam', 'unspam' ) ) ) ||
509 ( isset( $_POST['action'] ) && in_array( $_POST['action'], array( 'editedcomment' ) ) )
511 if ( $new_status == 'spam' && ( $old_status == 'approved' || $old_status == 'unapproved' || !$old_status ) ) {
512 return self::submit_spam_comment( $comment->comment_ID );
513 } elseif ( $old_status == 'spam' && ( $new_status == 'approved' || $new_status == 'unapproved' ) ) {
514 return self::submit_nonspam_comment( $comment->comment_ID );
518 self::update_comment_history( $comment->comment_ID, '', 'status-' . $new_status );
521 public static function submit_spam_comment( $comment_id ) {
522 global $wpdb, $current_user, $current_site;
524 $comment_id = (int) $comment_id;
526 $comment = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->comments} WHERE comment_ID = %d", $comment_id ) );
528 if ( !$comment ) // it was deleted
531 if ( 'spam' != $comment->comment_approved )
534 // use the original version stored in comment_meta if available
535 $as_submitted = self::sanitize_comment_as_submitted( get_comment_meta( $comment_id, 'akismet_as_submitted', true ) );
537 if ( $as_submitted && is_array( $as_submitted ) && isset( $as_submitted['comment_content'] ) )
538 $comment = (object) array_merge( (array)$comment, $as_submitted );
540 $comment->blog = get_bloginfo('url');
541 $comment->blog_lang = get_locale();
542 $comment->blog_charset = get_option('blog_charset');
543 $comment->permalink = get_permalink($comment->comment_post_ID);
545 if ( is_object($current_user) )
546 $comment->reporter = $current_user->user_login;
548 if ( is_object($current_site) )
549 $comment->site_domain = $current_site->domain;
551 $comment->user_role = '';
552 if ( isset( $comment->user_ID ) )
553 $comment->user_role = Akismet::get_user_roles( $comment->user_ID );
555 if ( self::is_test_mode() )
556 $comment->is_test = 'true';
558 $post = get_post( $comment->comment_post_ID );
559 $comment->comment_post_modified_gmt = $post->post_modified_gmt;
561 $response = Akismet::http_post( Akismet::build_query( $comment ), 'submit-spam' );
562 if ( $comment->reporter ) {
563 self::update_comment_history( $comment_id, '', 'report-spam' );
564 update_comment_meta( $comment_id, 'akismet_user_result', 'true' );
565 update_comment_meta( $comment_id, 'akismet_user', $comment->reporter );
568 do_action('akismet_submit_spam_comment', $comment_id, $response[1]);
571 public static function submit_nonspam_comment( $comment_id ) {
572 global $wpdb, $current_user, $current_site;
574 $comment_id = (int) $comment_id;
576 $comment = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->comments} WHERE comment_ID = %d", $comment_id ) );
577 if ( !$comment ) // it was deleted
580 // use the original version stored in comment_meta if available
581 $as_submitted = self::sanitize_comment_as_submitted( get_comment_meta( $comment_id, 'akismet_as_submitted', true ) );
583 if ( $as_submitted && is_array($as_submitted) && isset($as_submitted['comment_content']) )
584 $comment = (object) array_merge( (array)$comment, $as_submitted );
586 $comment->blog = get_bloginfo('url');
587 $comment->blog_lang = get_locale();
588 $comment->blog_charset = get_option('blog_charset');
589 $comment->permalink = get_permalink( $comment->comment_post_ID );
590 $comment->user_role = '';
592 if ( is_object($current_user) )
593 $comment->reporter = $current_user->user_login;
595 if ( is_object($current_site) )
596 $comment->site_domain = $current_site->domain;
598 if ( isset( $comment->user_ID ) )
599 $comment->user_role = Akismet::get_user_roles($comment->user_ID);
601 if ( Akismet::is_test_mode() )
602 $comment->is_test = 'true';
604 $post = get_post( $comment->comment_post_ID );
605 $comment->comment_post_modified_gmt = $post->post_modified_gmt;
607 $response = self::http_post( Akismet::build_query( $comment ), 'submit-ham' );
608 if ( $comment->reporter ) {
609 self::update_comment_history( $comment_id, '', 'report-ham' );
610 update_comment_meta( $comment_id, 'akismet_user_result', 'false' );
611 update_comment_meta( $comment_id, 'akismet_user', $comment->reporter );
614 do_action('akismet_submit_nonspam_comment', $comment_id, $response[1]);
617 public static function cron_recheck() {
620 $api_key = self::get_api_key();
622 $status = self::verify_key( $api_key );
623 if ( get_option( 'akismet_alert_code' ) || $status == 'invalid' ) {
624 // since there is currently a problem with the key, reschedule a check for 6 hours hence
625 wp_schedule_single_event( time() + 21600, 'akismet_schedule_cron_recheck' );
626 do_action( 'akismet_scheduled_recheck', 'key-problem-' . get_option( 'akismet_alert_code' ) . '-' . $status );
630 delete_option('akismet_available_servers');
632 $comment_errors = $wpdb->get_col( "SELECT comment_id FROM {$wpdb->commentmeta} WHERE meta_key = 'akismet_error' LIMIT 100" );
634 load_plugin_textdomain( 'akismet' );
636 foreach ( (array) $comment_errors as $comment_id ) {
637 // if the comment no longer exists, or is too old, remove the meta entry from the queue to avoid getting stuck
638 $comment = get_comment( $comment_id );
639 if ( !$comment || strtotime( $comment->comment_date_gmt ) < strtotime( "-15 days" ) ) {
640 delete_comment_meta( $comment_id, 'akismet_error' );
641 delete_comment_meta( $comment_id, 'akismet_delayed_moderation_email' );
645 add_comment_meta( $comment_id, 'akismet_rechecking', true );
646 $status = self::check_db_comment( $comment_id, 'retry' );
649 if ( $status == 'true' ) {
650 $event = 'cron-retry-spam';
651 } elseif ( $status == 'false' ) {
652 $event = 'cron-retry-ham';
655 // If we got back a legit response then update the comment history
656 // other wise just bail now and try again later. No point in
657 // re-trying all the comments once we hit one failure.
658 if ( !empty( $event ) ) {
659 delete_comment_meta( $comment_id, 'akismet_error' );
660 self::update_comment_history( $comment_id, '', $event );
661 update_comment_meta( $comment_id, 'akismet_result', $status );
662 // make sure the comment status is still pending. if it isn't, that means the user has already moved it elsewhere.
663 $comment = get_comment( $comment_id );
664 if ( $comment && 'unapproved' == wp_get_comment_status( $comment_id ) ) {
665 if ( $status == 'true' ) {
666 wp_spam_comment( $comment_id );
667 } elseif ( $status == 'false' ) {
668 // comment is good, but it's still in the pending queue. depending on the moderation settings
669 // we may need to change it to approved.
670 if ( check_comment($comment->comment_author, $comment->comment_author_email, $comment->comment_author_url, $comment->comment_content, $comment->comment_author_IP, $comment->comment_agent, $comment->comment_type) )
671 wp_set_comment_status( $comment_id, 1 );
672 else if ( get_comment_meta( $comment_id, 'akismet_delayed_moderation_email', true ) )
673 wp_notify_moderator( $comment_id );
677 delete_comment_meta( $comment_id, 'akismet_delayed_moderation_email' );
679 // If this comment has been pending moderation for longer than MAX_DELAY_BEFORE_MODERATION_EMAIL,
680 // send a moderation email now.
681 if ( ( intval( gmdate( 'U' ) ) - strtotime( $comment->comment_date_gmt ) ) < self::MAX_DELAY_BEFORE_MODERATION_EMAIL ) {
682 delete_comment_meta( $comment_id, 'akismet_delayed_moderation_email' );
683 wp_notify_moderator( $comment_id );
686 delete_comment_meta( $comment_id, 'akismet_rechecking' );
687 wp_schedule_single_event( time() + 1200, 'akismet_schedule_cron_recheck' );
688 do_action( 'akismet_scheduled_recheck', 'check-db-comment-' . $status );
691 delete_comment_meta( $comment_id, 'akismet_rechecking' );
694 $remaining = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->commentmeta} WHERE meta_key = 'akismet_error'" );
695 if ( $remaining && !wp_next_scheduled('akismet_schedule_cron_recheck') ) {
696 wp_schedule_single_event( time() + 1200, 'akismet_schedule_cron_recheck' );
697 do_action( 'akismet_scheduled_recheck', 'remaining' );
701 public static function fix_scheduled_recheck() {
702 $future_check = wp_next_scheduled( 'akismet_schedule_cron_recheck' );
703 if ( !$future_check ) {
707 if ( get_option( 'akismet_alert_code' ) > 0 ) {
711 $check_range = time() + 1200;
712 if ( $future_check > $check_range ) {
713 wp_clear_scheduled_hook( 'akismet_schedule_cron_recheck' );
714 wp_schedule_single_event( time() + 300, 'akismet_schedule_cron_recheck' );
715 do_action( 'akismet_scheduled_recheck', 'fix-scheduled-recheck' );
719 public static function add_comment_nonce( $post_id ) {
720 echo '<p style="display: none;">';
721 wp_nonce_field( 'akismet_comment_nonce_' . $post_id, 'akismet_comment_nonce', FALSE );
725 public static function is_test_mode() {
726 return defined('AKISMET_TEST_MODE') && AKISMET_TEST_MODE;
729 public static function allow_discard() {
730 if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
732 if ( is_user_logged_in() )
735 return ( get_option( 'akismet_strictness' ) === '1' );
738 public static function get_ip_address() {
739 return isset( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : null;
743 * Do these two comments, without checking the comment_ID, "match"?
745 * @param mixed $comment1 A comment object or array.
746 * @param mixed $comment2 A comment object or array.
747 * @return bool Whether the two comments should be treated as the same comment.
749 private static function comments_match( $comment1, $comment2 ) {
750 $comment1 = (array) $comment1;
751 $comment2 = (array) $comment2;
754 isset( $comment1['comment_post_ID'], $comment2['comment_post_ID'] )
755 && intval( $comment1['comment_post_ID'] ) == intval( $comment2['comment_post_ID'] )
757 // The comment author length max is 255 characters, limited by the TINYTEXT column type.
758 // If the comment author includes multibyte characters right around the 255-byte mark, they
759 // may be stripped when the author is saved in the DB, so a 300+ char author may turn into
760 // a 253-char author when it's saved, not 255 exactly. The longest possible character is
761 // theoretically 6 bytes, so we'll only look at the first 248 bytes to be safe.
762 substr( $comment1['comment_author'], 0, 248 ) == substr( $comment2['comment_author'], 0, 248 )
763 || substr( stripslashes( $comment1['comment_author'] ), 0, 248 ) == substr( $comment2['comment_author'], 0, 248 )
764 || substr( $comment1['comment_author'], 0, 248 ) == substr( stripslashes( $comment2['comment_author'] ), 0, 248 )
765 // Certain long comment author names will be truncated to nothing, depending on their encoding.
766 || ( ! $comment1['comment_author'] && strlen( $comment2['comment_author'] ) > 248 )
767 || ( ! $comment2['comment_author'] && strlen( $comment1['comment_author'] ) > 248 )
770 // The email max length is 100 characters, limited by the VARCHAR(100) column type.
771 // Same argument as above for only looking at the first 93 characters.
772 substr( $comment1['comment_author_email'], 0, 93 ) == substr( $comment2['comment_author_email'], 0, 93 )
773 || substr( stripslashes( $comment1['comment_author_email'] ), 0, 93 ) == substr( $comment2['comment_author_email'], 0, 93 )
774 || substr( $comment1['comment_author_email'], 0, 93 ) == substr( stripslashes( $comment2['comment_author_email'] ), 0, 93 )
775 // Very long emails can be truncated and then stripped if the [0:100] substring isn't a valid address.
776 || ( ! $comment1['comment_author_email'] && strlen( $comment2['comment_author_email'] ) > 100 )
777 || ( ! $comment2['comment_author_email'] && strlen( $comment1['comment_author_email'] ) > 100 )
781 return $comments_match;
784 // Does the supplied comment match the details of the one most recently stored in self::$last_comment?
785 public static function matches_last_comment( $comment ) {
786 if ( is_object( $comment ) )
787 $comment = (array) $comment;
789 return self::comments_match( self::$last_comment, $comment );
792 private static function get_user_agent() {
793 return isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT'] : null;
796 private static function get_referer() {
797 return isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : null;
800 // return a comma-separated list of role names for the given user
801 public static function get_user_roles( $user_id ) {
804 if ( !class_exists('WP_User') )
807 if ( $user_id > 0 ) {
808 $comment_user = new WP_User( $user_id );
809 if ( isset( $comment_user->roles ) )
810 $roles = join( ',', $comment_user->roles );
813 if ( is_multisite() && is_super_admin( $user_id ) ) {
814 if ( empty( $roles ) ) {
815 $roles = 'super_admin';
817 $comment_user->roles[] = 'super_admin';
818 $roles = join( ',', $comment_user->roles );
825 // filter handler used to return a spam result to pre_comment_approved
826 public static function last_comment_status( $approved, $comment ) {
827 // Only do this if it's the correct comment
828 if ( is_null(self::$last_comment_result) || ! self::matches_last_comment( $comment ) ) {
829 self::log( "comment_is_spam mismatched comment, returning unaltered $approved" );
833 // bump the counter here instead of when the filter is added to reduce the possibility of overcounting
834 if ( $incr = apply_filters('akismet_spam_count_incr', 1) )
835 update_option( 'akismet_spam_count', get_option('akismet_spam_count') + $incr );
837 return self::$last_comment_result;
841 * If Akismet is temporarily unreachable, we don't want to "spam" the blogger with
842 * moderation emails for comments that will be automatically cleared or spammed on
845 * For comments that will be rechecked later, empty the list of email addresses that
846 * the moderation email would be sent to.
848 * @param array $emails An array of email addresses that the moderation email will be sent to.
849 * @param int $comment_id The ID of the relevant comment.
850 * @return array An array of email addresses that the moderation email will be sent to.
852 public static function disable_moderation_emails_if_unreachable( $emails, $comment_id ) {
853 if ( ! empty( self::$prevent_moderation_email_for_these_comments ) && ! empty( $emails ) ) {
854 $comment = get_comment( $comment_id );
856 foreach ( self::$prevent_moderation_email_for_these_comments as $possible_match ) {
857 if ( self::comments_match( $possible_match, $comment ) ) {
858 update_comment_meta( $comment_id, 'akismet_delayed_moderation_email', true );
867 public static function _cmp_time( $a, $b ) {
868 return $a['time'] > $b['time'] ? -1 : 1;
871 public static function _get_microtime() {
872 $mtime = explode( ' ', microtime() );
873 return $mtime[1] + $mtime[0];
877 * Make a POST request to the Akismet API.
879 * @param string $request The body of the request.
880 * @param string $path The path for the request.
881 * @param string $ip The specific IP address to hit.
882 * @return array A two-member array consisting of the headers and the response body, both empty in the case of a failure.
884 public static function http_post( $request, $path, $ip=null ) {
886 $akismet_ua = sprintf( 'WordPress/%s | Akismet/%s', $GLOBALS['wp_version'], constant( 'AKISMET_VERSION' ) );
887 $akismet_ua = apply_filters( 'akismet_ua', $akismet_ua );
889 $content_length = strlen( $request );
891 $api_key = self::get_api_key();
892 $host = self::API_HOST;
894 if ( !empty( $api_key ) )
895 $host = $api_key.'.'.$host;
898 // use a specific IP if provided
899 // needed by Akismet_Admin::check_server_connectivity()
900 if ( $ip && long2ip( ip2long( $ip ) ) ) {
907 'Content-Type' => 'application/x-www-form-urlencoded; charset=' . get_option( 'blog_charset' ),
909 'User-Agent' => $akismet_ua,
911 'httpversion' => '1.0',
915 $akismet_url = $http_akismet_url = "http://{$http_host}/1.1/{$path}";
918 * Try SSL first; if that fails, try without it and don't try it again for a while.
921 $ssl = $ssl_failed = false;
923 // Check if SSL requests were disabled fewer than X hours ago.
924 $ssl_disabled = get_option( 'akismet_ssl_disabled' );
926 if ( $ssl_disabled && $ssl_disabled < ( time() - 60 * 60 * 24 ) ) { // 24 hours
927 $ssl_disabled = false;
928 delete_option( 'akismet_ssl_disabled' );
930 else if ( $ssl_disabled ) {
931 do_action( 'akismet_ssl_disabled' );
934 if ( ! $ssl_disabled && function_exists( 'wp_http_supports') && ( $ssl = wp_http_supports( array( 'ssl' ) ) ) ) {
935 $akismet_url = set_url_scheme( $akismet_url, 'https' );
937 do_action( 'akismet_https_request_pre' );
940 $response = wp_remote_post( $akismet_url, $http_args );
942 Akismet::log( compact( 'akismet_url', 'http_args', 'response' ) );
944 if ( $ssl && is_wp_error( $response ) ) {
945 do_action( 'akismet_https_request_failure', $response );
947 // Intermittent connection problems may cause the first HTTPS
948 // request to fail and subsequent HTTP requests to succeed randomly.
949 // Retry the HTTPS request once before disabling SSL for a time.
950 $response = wp_remote_post( $akismet_url, $http_args );
952 Akismet::log( compact( 'akismet_url', 'http_args', 'response' ) );
954 if ( is_wp_error( $response ) ) {
957 do_action( 'akismet_https_request_failure', $response );
959 do_action( 'akismet_http_request_pre' );
961 // Try the request again without SSL.
962 $response = wp_remote_post( $http_akismet_url, $http_args );
964 Akismet::log( compact( 'http_akismet_url', 'http_args', 'response' ) );
968 if ( is_wp_error( $response ) ) {
969 do_action( 'akismet_request_failure', $response );
971 return array( '', '' );
975 // The request failed when using SSL but succeeded without it. Disable SSL for future requests.
976 update_option( 'akismet_ssl_disabled', time() );
978 do_action( 'akismet_https_disabled' );
981 $simplified_response = array( $response['headers'], $response['body'] );
983 self::update_alert( $simplified_response );
985 return $simplified_response;
988 // given a response from an API call like check_key_status(), update the alert code options if an alert is present.
989 private static function update_alert( $response ) {
991 if ( isset( $response[0]['x-akismet-alert-code'] ) ) {
992 $code = $response[0]['x-akismet-alert-code'];
993 $msg = $response[0]['x-akismet-alert-msg'];
996 // only call update_option() if the value has changed
997 if ( $code != get_option( 'akismet_alert_code' ) ) {
999 delete_option( 'akismet_alert_code' );
1000 delete_option( 'akismet_alert_msg' );
1003 update_option( 'akismet_alert_code', $code );
1004 update_option( 'akismet_alert_msg', $msg );
1009 public static function load_form_js() {
1010 // WP < 3.3 can't enqueue a script this late in the game and still have it appear in the footer.
1011 // Once we drop support for everything pre-3.3, this can change back to a single enqueue call.
1012 wp_register_script( 'akismet-form', plugin_dir_url( __FILE__ ) . '_inc/form.js', array(), AKISMET_VERSION, true );
1013 add_action( 'wp_footer', array( 'Akismet', 'print_form_js' ) );
1014 add_action( 'admin_footer', array( 'Akismet', 'print_form_js' ) );
1017 public static function print_form_js() {
1018 wp_print_scripts( 'akismet-form' );
1021 public static function inject_ak_js( $fields ) {
1022 echo '<p style="display: none;">';
1023 echo '<input type="hidden" id="ak_js" name="ak_js" value="' . mt_rand( 0, 250 ) . '"/>';
1027 private static function bail_on_activation( $message, $deactivate = true ) {
1032 <meta charset="<?php bloginfo( 'charset' ); ?>">
1038 font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
1046 <p><?php echo esc_html( $message ); ?></p>
1050 if ( $deactivate ) {
1051 $plugins = get_option( 'active_plugins' );
1052 $akismet = plugin_basename( AKISMET__PLUGIN_DIR . 'akismet.php' );
1054 foreach ( $plugins as $i => $plugin ) {
1055 if ( $plugin === $akismet ) {
1056 $plugins[$i] = false;
1062 update_option( 'active_plugins', array_filter( $plugins ) );
1068 public static function view( $name, array $args = array() ) {
1069 $args = apply_filters( 'akismet_view_arguments', $args, $name );
1071 foreach ( $args AS $key => $val ) {
1075 load_plugin_textdomain( 'akismet' );
1077 $file = AKISMET__PLUGIN_DIR . 'views/'. $name . '.php';
1083 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
1086 public static function plugin_activation() {
1087 if ( version_compare( $GLOBALS['wp_version'], AKISMET__MINIMUM_WP_VERSION, '<' ) ) {
1088 load_plugin_textdomain( 'akismet' );
1090 $message = '<strong>'.sprintf(esc_html__( 'Akismet %s requires WordPress %s or higher.' , 'akismet'), AKISMET_VERSION, AKISMET__MINIMUM_WP_VERSION ).'</strong> '.sprintf(__('Please <a href="%1$s">upgrade WordPress</a> to a current version, or <a href="%2$s">downgrade to version 2.4 of the Akismet plugin</a>.', 'akismet'), 'https://codex.wordpress.org/Upgrading_WordPress', 'http://wordpress.org/extend/plugins/akismet/download/');
1092 Akismet::bail_on_activation( $message );
1097 * Removes all connection options
1100 public static function plugin_deactivation( ) {
1101 return self::deactivate_key( self::get_api_key() );
1105 * Essentially a copy of WP's build_query but one that doesn't expect pre-urlencoded values.
1107 * @param array $args An array of key => value pairs
1108 * @return string A string ready for use as a URL query string.
1110 public static function build_query( $args ) {
1111 return _http_build_query( $args, '', '&' );
1115 * Log debugging info to the error log.
1117 * Enabled when WP_DEBUG_LOG is enabled, but can be disabled via the akismet_debug_log filter.
1119 * @param mixed $akismet_debug The data to log.
1121 public static function log( $akismet_debug ) {
1122 if ( apply_filters( 'akismet_debug_log', defined( 'WP_DEBUG_LOG' ) && WP_DEBUG_LOG ) ) {
1123 error_log( print_r( compact( 'akismet_debug' ), true ) );
1127 public static function pre_check_pingback( $method ) {
1128 if ( $method !== 'pingback.ping' )
1131 global $wp_xmlrpc_server;
1133 if ( !is_object( $wp_xmlrpc_server ) )
1136 // Lame: tightly coupled with the IXR class.
1137 $args = $wp_xmlrpc_server->message->params;
1139 if ( !empty( $args[1] ) ) {
1140 $post_id = url_to_postid( $args[1] );
1142 // If this gets through the pre-check, make sure we properly identify the outbound request as a pingback verification
1143 Akismet::pingback_forwarded_for( null, $args[0] );
1144 add_filter( 'http_request_args', array( 'Akismet', 'pingback_forwarded_for' ), 10, 2 );
1147 'comment_author_url' => $args[0],
1148 'comment_post_ID' => $post_id,
1149 'comment_author' => '',
1150 'comment_author_email' => '',
1151 'comment_content' => '',
1152 'comment_type' => 'pingback',
1153 'akismet_pre_check' => '1',
1154 'comment_pingback_target' => $args[1],
1157 $comment = Akismet::auto_check_comment( $comment );
1159 if ( isset( $comment['akismet_result'] ) && 'true' == $comment['akismet_result'] ) {
1160 // Lame: tightly coupled with the IXR classes. Unfortunately the action provides no context and no way to return anything.
1161 $wp_xmlrpc_server->error( new IXR_Error( 0, 'Invalid discovery target' ) );
1166 public static function pingback_forwarded_for( $r, $url ) {
1167 static $urls = array();
1169 // Call this with $r == null to prime the callback to add headers on a specific URL
1170 if ( is_null( $r ) && !in_array( $url, $urls ) ) {
1174 // Add X-Pingback-Forwarded-For header, but only for requests to a specific URL (the apparent pingback source)
1175 if ( is_array( $r ) && is_array( $r['headers'] ) && !isset( $r['headers']['X-Pingback-Forwarded-For'] ) && in_array( $url, $urls ) ) {
1176 $remote_ip = preg_replace( '/[^a-fx0-9:.,]/i', '', $_SERVER['REMOTE_ADDR'] );
1178 // Note: this assumes REMOTE_ADDR is correct, and it may not be if a reverse proxy or CDN is in use
1179 $r['headers']['X-Pingback-Forwarded-For'] = $remote_ip;
1181 // Also identify the request as a pingback verification in the UA string so it appears in logs
1182 $r['user-agent'] .= '; verifying pingback from ' . $remote_ip;
1189 * Ensure that we are loading expected scalar values from akismet_as_submitted commentmeta.
1191 * @param mixed $meta_value
1194 private static function sanitize_comment_as_submitted( $meta_value ) {
1195 if ( empty( $meta_value ) ) {
1199 $meta_value = (array) $meta_value;
1201 foreach ( $meta_value as $key => $value ) {
1202 if ( ! isset( self::$comment_as_submitted_allowed_keys[$key] ) || ! is_scalar( $value ) ) {
1203 unset( $meta_value[$key] );