7 Plugin URI: http://akismet.com/?return=true
8 Description: Used by millions, Akismet is quite possibly the best way in the world to <strong>protect your blog from comment and trackback spam</strong>. It keeps your site protected from spam even while you sleep. To get started: 1) Click the "Activate" link to the left of this description, 2) <a href="http://akismet.com/get/?return=true">Sign up for an Akismet API key</a>, and 3) Go to your Akismet configuration page, and save your API key.
11 Author URI: http://automattic.com/wordpress-plugins/
12 License: GPLv2 or later
16 This program is free software; you can redistribute it and/or
17 modify it under the terms of the GNU General Public License
18 as published by the Free Software Foundation; either version 2
19 of the License, or (at your option) any later version.
21 This program is distributed in the hope that it will be useful,
22 but WITHOUT ANY WARRANTY; without even the implied warranty of
23 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 GNU General Public License for more details.
26 You should have received a copy of the GNU General Public License
27 along with this program; if not, write to the Free Software
28 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
31 // Make sure we don't expose any info if called directly
32 if ( !function_exists( 'add_action' ) ) {
33 echo 'Hi there! I\'m just a plugin, not much I can do when called directly.';
37 define('AKISMET_VERSION', '2.5.9');
38 define('AKISMET_PLUGIN_URL', plugin_dir_url( __FILE__ ));
40 /** If you hardcode a WP.com API key here, all key config screens will be hidden */
41 if ( defined('WPCOM_API_KEY') )
42 $wpcom_api_key = constant('WPCOM_API_KEY');
46 if ( isset($wp_db_version) && $wp_db_version <= 9872 )
47 include_once dirname( __FILE__ ) . '/legacy.php';
49 include_once dirname( __FILE__ ) . '/widget.php';
52 require_once dirname( __FILE__ ) . '/admin.php';
54 function akismet_init() {
55 global $wpcom_api_key, $akismet_api_host, $akismet_api_port;
58 $akismet_api_host = $wpcom_api_key . '.rest.akismet.com';
60 $akismet_api_host = get_option('wordpress_api_key') . '.rest.akismet.com';
62 $akismet_api_port = 80;
64 add_action('init', 'akismet_init');
66 function akismet_get_key() {
67 global $wpcom_api_key;
68 if ( !empty($wpcom_api_key) )
69 return $wpcom_api_key;
70 return get_option('wordpress_api_key');
73 function akismet_check_key_status( $key, $ip = null ) {
74 global $akismet_api_host, $akismet_api_port, $wpcom_api_key;
75 $blog = urlencode( get_option('home') );
77 $key = $wpcom_api_key;
78 $response = akismet_http_post("key=$key&blog=$blog", 'rest.akismet.com', '/1.1/verify-key', $akismet_api_port, $ip);
82 // given a response from an API call like akismet_check_key_status(), update the alert code options if an alert is present.
83 function akismet_update_alert( $response ) {
85 if ( isset($response[0]['x-akismet-alert-code']) ) {
86 $code = $response[0]['x-akismet-alert-code'];
87 $msg = $response[0]['x-akismet-alert-msg'];
90 // only call update_option() if the value has changed
91 if ( $code != get_option( 'akismet_alert_code' ) ) {
92 update_option( 'akismet_alert_code', $code );
93 update_option( 'akismet_alert_msg', $msg );
97 function akismet_verify_key( $key, $ip = null ) {
98 $response = akismet_check_key_status( $key, $ip );
99 akismet_update_alert( $response );
100 if ( !is_array($response) || !isset($response[1]) || $response[1] != 'valid' && $response[1] != 'invalid' )
105 // if we're in debug or test modes, use a reduced service level so as not to polute training or stats data
106 function akismet_test_mode() {
107 if ( defined('AKISMET_TEST_MODE') && AKISMET_TEST_MODE )
112 // return a comma-separated list of role names for the given user
113 function akismet_get_user_roles( $user_id ) {
116 if ( !class_exists('WP_User') )
119 if ( $user_id > 0 ) {
120 $comment_user = new WP_User($user_id);
121 if ( isset($comment_user->roles) )
122 $roles = join(',', $comment_user->roles);
125 if ( is_multisite() && is_super_admin( $user_id ) ) {
126 if ( empty( $roles ) ) {
127 $roles = 'super_admin';
129 $comment_user->roles[] = 'super_admin';
130 $roles = join( ',', $comment_user->roles );
137 // Returns array with headers in $response[0] and body in $response[1]
138 function akismet_http_post($request, $host, $path, $port = 80, $ip=null) {
141 $akismet_ua = "WordPress/{$wp_version} | ";
142 $akismet_ua .= 'Akismet/' . constant( 'AKISMET_VERSION' );
144 $akismet_ua = apply_filters( 'akismet_ua', $akismet_ua );
146 $content_length = strlen( $request );
149 // use a specific IP if provided
150 // needed by akismet_check_server_connectivity()
151 if ( $ip && long2ip( ip2long( $ip ) ) ) {
157 // use the WP HTTP class if it is available
158 if ( function_exists( 'wp_remote_post' ) ) {
162 'Content-Type' => 'application/x-www-form-urlencoded; ' .
163 'charset=' . get_option( 'blog_charset' ),
165 'User-Agent' => $akismet_ua
167 'httpversion' => '1.0',
170 $akismet_url = "http://{$http_host}{$path}";
171 $response = wp_remote_post( $akismet_url, $http_args );
172 if ( is_wp_error( $response ) )
175 return array( $response['headers'], $response['body'] );
177 $http_request = "POST $path HTTP/1.0\r\n";
178 $http_request .= "Host: $host\r\n";
179 $http_request .= 'Content-Type: application/x-www-form-urlencoded; charset=' . get_option('blog_charset') . "\r\n";
180 $http_request .= "Content-Length: {$content_length}\r\n";
181 $http_request .= "User-Agent: {$akismet_ua}\r\n";
182 $http_request .= "\r\n";
183 $http_request .= $request;
186 if( false != ( $fs = @fsockopen( $http_host, $port, $errno, $errstr, 10 ) ) ) {
187 fwrite( $fs, $http_request );
189 while ( !feof( $fs ) )
190 $response .= fgets( $fs, 1160 ); // One TCP-IP packet
192 $response = explode( "\r\n\r\n", $response, 2 );
198 // filter handler used to return a spam result to pre_comment_approved
199 function akismet_result_spam( $approved ) {
200 // bump the counter here instead of when the filter is added to reduce the possibility of overcounting
201 if ( $incr = apply_filters('akismet_spam_count_incr', 1) )
202 update_option( 'akismet_spam_count', get_option('akismet_spam_count') + $incr );
203 // this is a one-shot deal
204 remove_filter( 'pre_comment_approved', 'akismet_result_spam' );
208 function akismet_result_hold( $approved ) {
210 remove_filter( 'pre_comment_approved', 'akismet_result_hold' );
214 // how many approved comments does this author have?
215 function akismet_get_user_comments_approved( $user_id, $comment_author_email, $comment_author, $comment_author_url ) {
218 if ( !empty($user_id) )
219 return $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->comments WHERE user_id = %d AND comment_approved = 1", $user_id ) );
221 if ( !empty($comment_author_email) )
222 return $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 ) );
227 function akismet_microtime() {
228 $mtime = explode( ' ', microtime() );
229 return $mtime[1] + $mtime[0];
232 // log an event for a given comment, storing it in comment_meta
233 function akismet_update_comment_history( $comment_id, $message, $event=null ) {
234 global $current_user;
236 // failsafe for old WP versions
237 if ( !function_exists('add_comment_meta') )
241 if ( is_object($current_user) && isset($current_user->user_login) )
242 $user = $current_user->user_login;
245 'time' => akismet_microtime(),
246 'message' => $message,
251 // $unique = false so as to allow multiple values per comment
252 $r = add_comment_meta( $comment_id, 'akismet_history', $event, false );
255 // get the full comment history for a given comment, as an array in reverse chronological order
256 function akismet_get_comment_history( $comment_id ) {
258 // failsafe for old WP versions
259 if ( !function_exists('add_comment_meta') )
262 $history = get_comment_meta( $comment_id, 'akismet_history', false );
263 usort( $history, 'akismet_cmp_time' );
267 function akismet_cmp_time( $a, $b ) {
268 return $a['time'] > $b['time'] ? -1 : 1;
271 // this fires on wp_insert_comment. we can't update comment_meta when akismet_auto_check_comment() runs
272 // because we don't know the comment ID at that point.
273 function akismet_auto_check_update_meta( $id, $comment ) {
274 global $akismet_last_comment;
276 // failsafe for old WP versions
277 if ( !function_exists('add_comment_meta') )
280 if ( !isset( $akismet_last_comment['comment_author_email'] ) )
281 $akismet_last_comment['comment_author_email'] = '';
283 // wp_insert_comment() might be called in other contexts, so make sure this is the same comment
284 // as was checked by akismet_auto_check_comment
285 if ( is_object($comment) && !empty($akismet_last_comment) && is_array($akismet_last_comment) ) {
286 if ( isset($akismet_last_comment['comment_post_ID']) && intval($akismet_last_comment['comment_post_ID']) == intval($comment->comment_post_ID)
287 && $akismet_last_comment['comment_author'] == $comment->comment_author
288 && $akismet_last_comment['comment_author_email'] == $comment->comment_author_email ) {
289 // normal result: true or false
290 if ( $akismet_last_comment['akismet_result'] == 'true' ) {
291 update_comment_meta( $comment->comment_ID, 'akismet_result', 'true' );
292 akismet_update_comment_history( $comment->comment_ID, __('Akismet caught this comment as spam'), 'check-spam' );
293 if ( $comment->comment_approved != 'spam' )
294 akismet_update_comment_history( $comment->comment_ID, sprintf( __('Comment status was changed to %s'), $comment->comment_approved), 'status-changed'.$comment->comment_approved );
295 } elseif ( $akismet_last_comment['akismet_result'] == 'false' ) {
296 update_comment_meta( $comment->comment_ID, 'akismet_result', 'false' );
297 akismet_update_comment_history( $comment->comment_ID, __('Akismet cleared this comment'), 'check-ham' );
298 if ( $comment->comment_approved == 'spam' ) {
299 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) )
300 akismet_update_comment_history( $comment->comment_ID, __('Comment was caught by wp_blacklist_check'), 'wp-blacklisted' );
302 akismet_update_comment_history( $comment->comment_ID, sprintf( __('Comment status was changed to %s'), $comment->comment_approved), 'status-changed-'.$comment->comment_approved );
304 // abnormal result: error
306 update_comment_meta( $comment->comment_ID, 'akismet_error', time() );
307 akismet_update_comment_history( $comment->comment_ID, sprintf( __('Akismet was unable to check this comment (response: %s), will automatically retry again later.'), substr($akismet_last_comment['akismet_result'], 0, 50)), 'check-error' );
310 // record the complete original data as submitted for checking
311 if ( isset($akismet_last_comment['comment_as_submitted']) )
312 update_comment_meta( $comment->comment_ID, 'akismet_as_submitted', $akismet_last_comment['comment_as_submitted'] );
317 add_action( 'wp_insert_comment', 'akismet_auto_check_update_meta', 10, 2 );
320 function akismet_auto_check_comment( $commentdata ) {
321 global $akismet_api_host, $akismet_api_port, $akismet_last_comment;
323 $comment = $commentdata;
324 $comment['user_ip'] = $_SERVER['REMOTE_ADDR'];
325 $comment['user_agent'] = isset($_SERVER['HTTP_USER_AGENT']) ? $_SERVER['HTTP_USER_AGENT'] : null;
326 $comment['referrer'] = isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : null;
327 $comment['blog'] = get_option('home');
328 $comment['blog_lang'] = get_locale();
329 $comment['blog_charset'] = get_option('blog_charset');
330 $comment['permalink'] = get_permalink($comment['comment_post_ID']);
332 if ( !empty( $comment['user_ID'] ) ) {
333 $comment['user_role'] = akismet_get_user_roles( $comment['user_ID'] );
336 $akismet_nonce_option = apply_filters( 'akismet_comment_nonce', get_option( 'akismet_comment_nonce' ) );
337 $comment['akismet_comment_nonce'] = 'inactive';
338 if ( $akismet_nonce_option == 'true' || $akismet_nonce_option == '' ) {
339 $comment['akismet_comment_nonce'] = 'failed';
340 if ( isset( $_POST['akismet_comment_nonce'] ) && wp_verify_nonce( $_POST['akismet_comment_nonce'], 'akismet_comment_nonce_' . $comment['comment_post_ID'] ) )
341 $comment['akismet_comment_nonce'] = 'passed';
343 // comment reply in wp-admin
344 if ( isset( $_POST['_ajax_nonce-replyto-comment'] ) && check_ajax_referer( 'replyto-comment', '_ajax_nonce-replyto-comment' ) )
345 $comment['akismet_comment_nonce'] = 'passed';
349 if ( akismet_test_mode() )
350 $comment['is_test'] = 'true';
352 foreach ($_POST as $key => $value ) {
353 if ( is_string($value) )
354 $comment["POST_{$key}"] = $value;
357 $ignore = array( 'HTTP_COOKIE', 'HTTP_COOKIE2', 'PHP_AUTH_PW' );
359 foreach ( $_SERVER as $key => $value ) {
360 if ( !in_array( $key, $ignore ) && is_string($value) )
361 $comment["$key"] = $value;
363 $comment["$key"] = '';
366 $post = get_post( $comment['comment_post_ID'] );
367 $comment[ 'comment_post_modified_gmt' ] = $post->post_modified_gmt;
370 foreach ( $comment as $key => $data )
371 $query_string .= $key . '=' . urlencode( stripslashes($data) ) . '&';
373 $commentdata['comment_as_submitted'] = $comment;
375 $response = akismet_http_post($query_string, $akismet_api_host, '/1.1/comment-check', $akismet_api_port);
376 do_action( 'akismet_comment_check_response', $response );
377 akismet_update_alert( $response );
378 $commentdata['akismet_result'] = $response[1];
379 if ( 'true' == $response[1] ) {
380 // akismet_spam_count will be incremented later by akismet_result_spam()
381 add_filter('pre_comment_approved', 'akismet_result_spam');
383 do_action( 'akismet_spam_caught' );
385 $last_updated = strtotime( $post->post_modified_gmt );
386 $diff = time() - $last_updated;
387 $diff = $diff / 86400;
389 if ( $post->post_type == 'post' && $diff > 30 && get_option( 'akismet_discard_month' ) == 'true' && empty($comment['user_ID']) ) {
390 // akismet_result_spam() won't be called so bump the counter here
391 if ( $incr = apply_filters('akismet_spam_count_incr', 1) )
392 update_option( 'akismet_spam_count', get_option('akismet_spam_count') + $incr );
393 $redirect_to = isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : get_permalink( $post );
394 wp_safe_redirect( $redirect_to );
399 // if the response is neither true nor false, hold the comment for moderation and schedule a recheck
400 if ( 'true' != $response[1] && 'false' != $response[1] ) {
401 if ( !current_user_can('moderate_comments') ) {
402 add_filter('pre_comment_approved', 'akismet_result_hold');
404 if ( !wp_next_scheduled( 'akismet_schedule_cron_recheck' ) ) {
405 wp_schedule_single_event( time() + 1200, 'akismet_schedule_cron_recheck' );
409 if ( function_exists('wp_next_scheduled') && function_exists('wp_schedule_event') ) {
410 // WP 2.1+: delete old comments daily
411 if ( !wp_next_scheduled('akismet_scheduled_delete') )
412 wp_schedule_event(time(), 'daily', 'akismet_scheduled_delete');
413 } elseif ( (mt_rand(1, 10) == 3) ) {
414 // WP 2.0: run this one time in ten
415 akismet_delete_old();
417 $akismet_last_comment = $commentdata;
419 akismet_fix_scheduled_recheck();
423 add_action('preprocess_comment', 'akismet_auto_check_comment', 1);
425 function akismet_delete_old() {
427 $now_gmt = current_time('mysql', 1);
428 $comment_ids = $wpdb->get_col("SELECT comment_id FROM $wpdb->comments WHERE DATE_SUB('$now_gmt', INTERVAL 15 DAY) > comment_date_gmt AND comment_approved = 'spam'");
429 if ( empty( $comment_ids ) )
432 $comma_comment_ids = implode( ', ', array_map('intval', $comment_ids) );
434 do_action( 'delete_comment', $comment_ids );
435 $wpdb->query("DELETE FROM $wpdb->comments WHERE comment_id IN ( $comma_comment_ids )");
436 $wpdb->query("DELETE FROM $wpdb->commentmeta WHERE comment_id IN ( $comma_comment_ids )");
437 clean_comment_cache( $comment_ids );
438 $n = mt_rand(1, 5000);
439 if ( apply_filters('akismet_optimize_table', ($n == 11)) ) // lucky number
440 $wpdb->query("OPTIMIZE TABLE $wpdb->comments");
444 function akismet_delete_old_metadata() {
447 $now_gmt = current_time( 'mysql', 1 );
448 $interval = apply_filters( 'akismet_delete_commentmeta_interval', 15 );
450 # enfore a minimum of 1 day
451 $interval = absint( $interval );
452 if ( $interval < 1 ) {
456 // akismet_as_submitted meta values are large, so expire them
457 // after $interval days regardless of the comment status
459 $comment_ids = $wpdb->get_col( "SELECT $wpdb->comments.comment_id FROM $wpdb->commentmeta INNER JOIN $wpdb->comments USING(comment_id) WHERE meta_key = 'akismet_as_submitted' AND DATE_SUB('$now_gmt', INTERVAL {$interval} DAY) > comment_date_gmt LIMIT 10000" );
461 if ( empty( $comment_ids ) ) {
465 foreach ( $comment_ids as $comment_id ) {
466 delete_comment_meta( $comment_id, 'akismet_as_submitted' );
471 $n = mt_rand( 1, 5000 );
472 if ( apply_filters( 'akismet_optimize_table', ( $n == 11 ), 'commentmeta' ) ) { // lucky number
473 $wpdb->query( "OPTIMIZE TABLE $wpdb->commentmeta" );
478 add_action('akismet_scheduled_delete', 'akismet_delete_old');
479 add_action('akismet_scheduled_delete', 'akismet_delete_old_metadata');
481 function akismet_check_db_comment( $id, $recheck_reason = 'recheck_queue' ) {
482 global $wpdb, $akismet_api_host, $akismet_api_port;
485 $c = $wpdb->get_row( "SELECT * FROM $wpdb->comments WHERE comment_ID = '$id'", ARRAY_A );
489 $c['user_ip'] = $c['comment_author_IP'];
490 $c['user_agent'] = $c['comment_agent'];
492 $c['blog'] = get_option('home');
493 $c['blog_lang'] = get_locale();
494 $c['blog_charset'] = get_option('blog_charset');
495 $c['permalink'] = get_permalink($c['comment_post_ID']);
496 $id = $c['comment_ID'];
497 if ( akismet_test_mode() )
498 $c['is_test'] = 'true';
499 $c['recheck_reason'] = $recheck_reason;
502 foreach ( $c as $key => $data )
503 $query_string .= $key . '=' . urlencode( stripslashes($data) ) . '&';
505 $response = akismet_http_post($query_string, $akismet_api_host, '/1.1/comment-check', $akismet_api_port);
506 return ( is_array( $response ) && isset( $response[1] ) ) ? $response[1] : false;
509 function akismet_cron_recheck() {
512 $status = akismet_verify_key( akismet_get_key() );
513 if ( get_option( 'akismet_alert_code' ) || $status == 'invalid' ) {
514 // since there is currently a problem with the key, reschedule a check for 6 hours hence
515 wp_schedule_single_event( time() + 21600, 'akismet_schedule_cron_recheck' );
519 delete_option('akismet_available_servers');
521 $comment_errors = $wpdb->get_col( "
523 FROM {$wpdb->prefix}commentmeta
524 WHERE meta_key = 'akismet_error'
528 foreach ( (array) $comment_errors as $comment_id ) {
529 // if the comment no longer exists, or is too old, remove the meta entry from the queue to avoid getting stuck
530 $comment = get_comment( $comment_id );
531 if ( !$comment || strtotime( $comment->comment_date_gmt ) < strtotime( "-15 days" ) ) {
532 delete_comment_meta( $comment_id, 'akismet_error' );
536 add_comment_meta( $comment_id, 'akismet_rechecking', true );
537 $status = akismet_check_db_comment( $comment_id, 'retry' );
540 if ( $status == 'true' ) {
541 $msg = __( 'Akismet caught this comment as spam during an automatic retry.' );
542 } elseif ( $status == 'false' ) {
543 $msg = __( 'Akismet cleared this comment during an automatic retry.' );
546 // If we got back a legit response then update the comment history
547 // other wise just bail now and try again later. No point in
548 // re-trying all the comments once we hit one failure.
549 if ( !empty( $msg ) ) {
550 delete_comment_meta( $comment_id, 'akismet_error' );
551 akismet_update_comment_history( $comment_id, $msg, 'cron-retry' );
552 update_comment_meta( $comment_id, 'akismet_result', $status );
553 // make sure the comment status is still pending. if it isn't, that means the user has already moved it elsewhere.
554 $comment = get_comment( $comment_id );
555 if ( $comment && 'unapproved' == wp_get_comment_status( $comment_id ) ) {
556 if ( $status == 'true' ) {
557 wp_spam_comment( $comment_id );
558 } elseif ( $status == 'false' ) {
559 // comment is good, but it's still in the pending queue. depending on the moderation settings
560 // we may need to change it to approved.
561 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) )
562 wp_set_comment_status( $comment_id, 1 );
566 delete_comment_meta( $comment_id, 'akismet_rechecking' );
567 wp_schedule_single_event( time() + 1200, 'akismet_schedule_cron_recheck' );
570 delete_comment_meta( $comment_id, 'akismet_rechecking' );
573 $remaining = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->commentmeta WHERE meta_key = 'akismet_error'" );
574 if ( $remaining && !wp_next_scheduled('akismet_schedule_cron_recheck') ) {
575 wp_schedule_single_event( time() + 1200, 'akismet_schedule_cron_recheck' );
578 add_action( 'akismet_schedule_cron_recheck', 'akismet_cron_recheck' );
580 function akismet_add_comment_nonce( $post_id ) {
581 echo '<p style="display: none;">';
582 wp_nonce_field( 'akismet_comment_nonce_' . $post_id, 'akismet_comment_nonce', FALSE );
586 $akismet_comment_nonce_option = apply_filters( 'akismet_comment_nonce', get_option( 'akismet_comment_nonce' ) );
588 if ( $akismet_comment_nonce_option == 'true' || $akismet_comment_nonce_option == '' )
589 add_action( 'comment_form', 'akismet_add_comment_nonce' );
592 if ( '3.0.5' == $wp_version ) {
593 remove_filter( 'comment_text', 'wp_kses_data' );
595 add_filter( 'comment_text', 'wp_kses_post' );
598 function akismet_fix_scheduled_recheck() {
599 $future_check = wp_next_scheduled( 'akismet_schedule_cron_recheck' );
600 if ( !$future_check ) {
604 if ( get_option( 'akismet_alert_code' ) > 0 ) {
608 $check_range = time() + 1200;
609 if ( $future_check > $check_range ) {
610 wp_clear_scheduled_hook( 'akismet_schedule_cron_recheck' );
611 wp_schedule_single_event( time() + 300, 'akismet_schedule_cron_recheck' );