WordPress 4.5
[autoinstalls/wordpress.git] / wp-includes / comment.php
1 <?php
2 /**
3  * Core Comment API
4  *
5  * @package WordPress
6  * @subpackage Comment
7  */
8
9 /**
10  * Check whether a comment passes internal checks to be allowed to add.
11  *
12  * If manual comment moderation is set in the administration, then all checks,
13  * regardless of their type and whitelist, will fail and the function will
14  * return false.
15  *
16  * If the number of links exceeds the amount in the administration, then the
17  * check fails. If any of the parameter contents match the blacklist of words,
18  * then the check fails.
19  *
20  * If the comment author was approved before, then the comment is automatically
21  * whitelisted.
22  *
23  * If all checks pass, the function will return true.
24  *
25  * @since 1.2.0
26  *
27  * @global wpdb $wpdb WordPress database abstraction object.
28  *
29  * @param string $author       Comment author name.
30  * @param string $email        Comment author email.
31  * @param string $url          Comment author URL.
32  * @param string $comment      Content of the comment.
33  * @param string $user_ip      Comment author IP address.
34  * @param string $user_agent   Comment author User-Agent.
35  * @param string $comment_type Comment type, either user-submitted comment,
36  *                                     trackback, or pingback.
37  * @return bool If all checks pass, true, otherwise false.
38  */
39 function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $comment_type) {
40         global $wpdb;
41
42         // If manual moderation is enabled, skip all checks and return false.
43         if ( 1 == get_option('comment_moderation') )
44                 return false;
45
46         /** This filter is documented in wp-includes/comment-template.php */
47         $comment = apply_filters( 'comment_text', $comment );
48
49         // Check for the number of external links if a max allowed number is set.
50         if ( $max_links = get_option( 'comment_max_links' ) ) {
51                 $num_links = preg_match_all( '/<a [^>]*href/i', $comment, $out );
52
53                 /**
54                  * Filter the maximum number of links allowed in a comment.
55                  *
56                  * @since 3.0.0
57                  *
58                  * @param int    $num_links The number of links allowed.
59                  * @param string $url       Comment author's URL. Included in allowed links total.
60                  */
61                 $num_links = apply_filters( 'comment_max_links_url', $num_links, $url );
62
63                 /*
64                  * If the number of links in the comment exceeds the allowed amount,
65                  * fail the check by returning false.
66                  */
67                 if ( $num_links >= $max_links )
68                         return false;
69         }
70
71         $mod_keys = trim(get_option('moderation_keys'));
72
73         // If moderation 'keys' (keywords) are set, process them.
74         if ( !empty($mod_keys) ) {
75                 $words = explode("\n", $mod_keys );
76
77                 foreach ( (array) $words as $word) {
78                         $word = trim($word);
79
80                         // Skip empty lines.
81                         if ( empty($word) )
82                                 continue;
83
84                         /*
85                          * Do some escaping magic so that '#' (number of) characters in the spam
86                          * words don't break things:
87                          */
88                         $word = preg_quote($word, '#');
89
90                         /*
91                          * Check the comment fields for moderation keywords. If any are found,
92                          * fail the check for the given field by returning false.
93                          */
94                         $pattern = "#$word#i";
95                         if ( preg_match($pattern, $author) ) return false;
96                         if ( preg_match($pattern, $email) ) return false;
97                         if ( preg_match($pattern, $url) ) return false;
98                         if ( preg_match($pattern, $comment) ) return false;
99                         if ( preg_match($pattern, $user_ip) ) return false;
100                         if ( preg_match($pattern, $user_agent) ) return false;
101                 }
102         }
103
104         /*
105          * Check if the option to approve comments by previously-approved authors is enabled.
106          *
107          * If it is enabled, check whether the comment author has a previously-approved comment,
108          * as well as whether there are any moderation keywords (if set) present in the author
109          * email address. If both checks pass, return true. Otherwise, return false.
110          */
111         if ( 1 == get_option('comment_whitelist')) {
112                 if ( 'trackback' != $comment_type && 'pingback' != $comment_type && $author != '' && $email != '' ) {
113                         // expected_slashed ($author, $email)
114                         $ok_to_comment = $wpdb->get_var("SELECT comment_approved FROM $wpdb->comments WHERE comment_author = '$author' AND comment_author_email = '$email' and comment_approved = '1' LIMIT 1");
115                         if ( ( 1 == $ok_to_comment ) &&
116                                 ( empty($mod_keys) || false === strpos( $email, $mod_keys) ) )
117                                         return true;
118                         else
119                                 return false;
120                 } else {
121                         return false;
122                 }
123         }
124         return true;
125 }
126
127 /**
128  * Retrieve the approved comments for post $post_id.
129  *
130  * @since 2.0.0
131  * @since 4.1.0 Refactored to leverage {@see WP_Comment_Query} over a direct query.
132  *
133  * @param  int   $post_id The ID of the post.
134  * @param  array $args    Optional. See {@see WP_Comment_Query::query()} for information
135  *                        on accepted arguments.
136  * @return int|array $comments The approved comments, or number of comments if `$count`
137  *                             argument is true.
138  */
139 function get_approved_comments( $post_id, $args = array() ) {
140         if ( ! $post_id ) {
141                 return array();
142         }
143
144         $defaults = array(
145                 'status'  => 1,
146                 'post_id' => $post_id,
147                 'order'   => 'ASC',
148         );
149         $r = wp_parse_args( $args, $defaults );
150
151         $query = new WP_Comment_Query;
152         return $query->query( $r );
153 }
154
155 /**
156  * Retrieves comment data given a comment ID or comment object.
157  *
158  * If an object is passed then the comment data will be cached and then returned
159  * after being passed through a filter. If the comment is empty, then the global
160  * comment variable will be used, if it is set.
161  *
162  * @since 2.0.0
163  *
164  * @global WP_Comment $comment
165  *
166  * @param WP_Comment|string|int $comment Comment to retrieve.
167  * @param string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants.
168  * @return WP_Comment|array|null Depends on $output value.
169  */
170 function get_comment( &$comment = null, $output = OBJECT ) {
171         if ( empty( $comment ) && isset( $GLOBALS['comment'] ) ) {
172                 $comment = $GLOBALS['comment'];
173         }
174
175         if ( $comment instanceof WP_Comment ) {
176                 $_comment = $comment;
177         } elseif ( is_object( $comment ) ) {
178                 $_comment = new WP_Comment( $comment );
179         } else {
180                 $_comment = WP_Comment::get_instance( $comment );
181         }
182
183         if ( ! $_comment ) {
184                 return null;
185         }
186
187         /**
188          * Fires after a comment is retrieved.
189          *
190          * @since 2.3.0
191          *
192          * @param mixed $_comment Comment data.
193          */
194         $_comment = apply_filters( 'get_comment', $_comment );
195
196         if ( $output == OBJECT ) {
197                 return $_comment;
198         } elseif ( $output == ARRAY_A ) {
199                 return $_comment->to_array();
200         } elseif ( $output == ARRAY_N ) {
201                 return array_values( $_comment->to_array() );
202         }
203         return $_comment;
204 }
205
206 /**
207  * Retrieve a list of comments.
208  *
209  * The comment list can be for the blog as a whole or for an individual post.
210  *
211  * @since 2.7.0
212  *
213  * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::parse_query()}
214  *                           for information on accepted arguments. Default empty.
215  * @return int|array List of comments or number of found comments if `$count` argument is true.
216  */
217 function get_comments( $args = '' ) {
218         $query = new WP_Comment_Query;
219         return $query->query( $args );
220 }
221
222 /**
223  * Retrieve all of the WordPress supported comment statuses.
224  *
225  * Comments have a limited set of valid status values, this provides the comment
226  * status values and descriptions.
227  *
228  * @since 2.7.0
229  *
230  * @return array List of comment statuses.
231  */
232 function get_comment_statuses() {
233         $status = array(
234                 'hold'          => __( 'Unapproved' ),
235                 'approve'       => _x( 'Approved', 'comment status' ),
236                 'spam'          => _x( 'Spam', 'comment status' ),
237                 'trash'         => _x( 'Trash', 'comment status' ),
238         );
239
240         return $status;
241 }
242
243 /**
244  * Gets the default comment status for a post type.
245  *
246  * @since 4.3.0
247  *
248  * @param string $post_type    Optional. Post type. Default 'post'.
249  * @param string $comment_type Optional. Comment type. Default 'comment'.
250  * @return string Expected return value is 'open' or 'closed'.
251  */
252 function get_default_comment_status( $post_type = 'post', $comment_type = 'comment' ) {
253         switch ( $comment_type ) {
254                 case 'pingback' :
255                 case 'trackback' :
256                         $supports = 'trackbacks';
257                         $option = 'ping';
258                         break;
259                 default :
260                         $supports = 'comments';
261                         $option = 'comment';
262         }
263
264         // Set the status.
265         if ( 'page' === $post_type ) {
266                 $status = 'closed';
267         } elseif ( post_type_supports( $post_type, $supports ) ) {
268                 $status = get_option( "default_{$option}_status" );
269         } else {
270                 $status = 'closed';
271         }
272
273         /**
274          * Filter the default comment status for the given post type.
275          *
276          * @since 4.3.0
277          *
278          * @param string $status       Default status for the given post type,
279          *                             either 'open' or 'closed'.
280          * @param string $post_type    Post type. Default is `post`.
281          * @param string $comment_type Type of comment. Default is `comment`.
282          */
283         return apply_filters( 'get_default_comment_status' , $status, $post_type, $comment_type );
284 }
285
286 /**
287  * The date the last comment was modified.
288  *
289  * @since 1.5.0
290  *
291  * @global wpdb $wpdb WordPress database abstraction object.
292  * @staticvar array $cache_lastcommentmodified
293  *
294  * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',
295  *              or 'server' locations.
296  * @return string Last comment modified date.
297  */
298 function get_lastcommentmodified($timezone = 'server') {
299         global $wpdb;
300         static $cache_lastcommentmodified = array();
301
302         if ( isset($cache_lastcommentmodified[$timezone]) )
303                 return $cache_lastcommentmodified[$timezone];
304
305         $add_seconds_server = date('Z');
306
307         switch ( strtolower($timezone)) {
308                 case 'gmt':
309                         $lastcommentmodified = $wpdb->get_var("SELECT comment_date_gmt FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1");
310                         break;
311                 case 'blog':
312                         $lastcommentmodified = $wpdb->get_var("SELECT comment_date FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1");
313                         break;
314                 case 'server':
315                         $lastcommentmodified = $wpdb->get_var($wpdb->prepare("SELECT DATE_ADD(comment_date_gmt, INTERVAL %s SECOND) FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1", $add_seconds_server));
316                         break;
317         }
318
319         $cache_lastcommentmodified[$timezone] = $lastcommentmodified;
320
321         return $lastcommentmodified;
322 }
323
324 /**
325  * The amount of comments in a post or total comments.
326  *
327  * A lot like {@link wp_count_comments()}, in that they both return comment
328  * stats (albeit with different types). The {@link wp_count_comments()} actual
329  * caches, but this function does not.
330  *
331  * @since 2.0.0
332  *
333  * @global wpdb $wpdb WordPress database abstraction object.
334  *
335  * @param int $post_id Optional. Comment amount in post if > 0, else total comments blog wide.
336  * @return array The amount of spam, approved, awaiting moderation, and total comments.
337  */
338 function get_comment_count( $post_id = 0 ) {
339         global $wpdb;
340
341         $post_id = (int) $post_id;
342
343         $where = '';
344         if ( $post_id > 0 ) {
345                 $where = $wpdb->prepare("WHERE comment_post_ID = %d", $post_id);
346         }
347
348         $totals = (array) $wpdb->get_results("
349                 SELECT comment_approved, COUNT( * ) AS total
350                 FROM {$wpdb->comments}
351                 {$where}
352                 GROUP BY comment_approved
353         ", ARRAY_A);
354
355         $comment_count = array(
356                 'approved'            => 0,
357                 'awaiting_moderation' => 0,
358                 'spam'                => 0,
359                 'trash'               => 0,
360                 'post-trashed'        => 0,
361                 'total_comments'      => 0,
362                 'all'                 => 0,
363         );
364
365         foreach ( $totals as $row ) {
366                 switch ( $row['comment_approved'] ) {
367                         case 'trash':
368                                 $comment_count['trash'] = $row['total'];
369                                 break;
370                         case 'post-trashed':
371                                 $comment_count['post-trashed'] = $row['total'];
372                                 break;
373                         case 'spam':
374                                 $comment_count['spam'] = $row['total'];
375                                 $comment_count['total_comments'] += $row['total'];
376                                 break;
377                         case '1':
378                                 $comment_count['approved'] = $row['total'];
379                                 $comment_count['total_comments'] += $row['total'];
380                                 $comment_count['all'] += $row['total'];
381                                 break;
382                         case '0':
383                                 $comment_count['awaiting_moderation'] = $row['total'];
384                                 $comment_count['total_comments'] += $row['total'];
385                                 $comment_count['all'] += $row['total'];
386                                 break;
387                         default:
388                                 break;
389                 }
390         }
391
392         return $comment_count;
393 }
394
395 //
396 // Comment meta functions
397 //
398
399 /**
400  * Add meta data field to a comment.
401  *
402  * @since 2.9.0
403  * @link https://codex.wordpress.org/Function_Reference/add_comment_meta
404  *
405  * @param int $comment_id Comment ID.
406  * @param string $meta_key Metadata name.
407  * @param mixed $meta_value Metadata value.
408  * @param bool $unique Optional, default is false. Whether the same key should not be added.
409  * @return int|bool Meta ID on success, false on failure.
410  */
411 function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false) {
412         return add_metadata('comment', $comment_id, $meta_key, $meta_value, $unique);
413 }
414
415 /**
416  * Remove metadata matching criteria from a comment.
417  *
418  * You can match based on the key, or key and value. Removing based on key and
419  * value, will keep from removing duplicate metadata with the same key. It also
420  * allows removing all metadata matching key, if needed.
421  *
422  * @since 2.9.0
423  * @link https://codex.wordpress.org/Function_Reference/delete_comment_meta
424  *
425  * @param int $comment_id comment ID
426  * @param string $meta_key Metadata name.
427  * @param mixed $meta_value Optional. Metadata value.
428  * @return bool True on success, false on failure.
429  */
430 function delete_comment_meta($comment_id, $meta_key, $meta_value = '') {
431         return delete_metadata('comment', $comment_id, $meta_key, $meta_value);
432 }
433
434 /**
435  * Retrieve comment meta field for a comment.
436  *
437  * @since 2.9.0
438  * @link https://codex.wordpress.org/Function_Reference/get_comment_meta
439  *
440  * @param int $comment_id Comment ID.
441  * @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
442  * @param bool $single Whether to return a single value.
443  * @return mixed Will be an array if $single is false. Will be value of meta data field if $single
444  *  is true.
445  */
446 function get_comment_meta($comment_id, $key = '', $single = false) {
447         return get_metadata('comment', $comment_id, $key, $single);
448 }
449
450 /**
451  * Update comment meta field based on comment ID.
452  *
453  * Use the $prev_value parameter to differentiate between meta fields with the
454  * same key and comment ID.
455  *
456  * If the meta field for the comment does not exist, it will be added.
457  *
458  * @since 2.9.0
459  * @link https://codex.wordpress.org/Function_Reference/update_comment_meta
460  *
461  * @param int $comment_id Comment ID.
462  * @param string $meta_key Metadata key.
463  * @param mixed $meta_value Metadata value.
464  * @param mixed $prev_value Optional. Previous value to check before removing.
465  * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
466  */
467 function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {
468         return update_metadata('comment', $comment_id, $meta_key, $meta_value, $prev_value);
469 }
470
471 /**
472  * Queues comments for metadata lazy-loading.
473  *
474  * @since 4.5.0
475  *
476  * @param array $comments Array of comment objects.
477  */
478 function wp_queue_comments_for_comment_meta_lazyload( $comments ) {
479         // Don't use `wp_list_pluck()` to avoid by-reference manipulation.
480         $comment_ids = array();
481         if ( is_array( $comments ) ) {
482                 foreach ( $comments as $comment ) {
483                         if ( $comment instanceof WP_Comment ) {
484                                 $comment_ids[] = $comment->comment_ID;
485                         }
486                 }
487         }
488
489         if ( $comment_ids ) {
490                 $lazyloader = wp_metadata_lazyloader();
491                 $lazyloader->queue_objects( 'comment', $comment_ids );
492         }
493 }
494
495 /**
496  * Sets the cookies used to store an unauthenticated commentator's identity. Typically used
497  * to recall previous comments by this commentator that are still held in moderation.
498  *
499  * @param WP_Comment $comment Comment object.
500  * @param object     $user    Comment author's object.
501  *
502  * @since 3.4.0
503  */
504 function wp_set_comment_cookies($comment, $user) {
505         if ( $user->exists() )
506                 return;
507
508         /**
509          * Filter the lifetime of the comment cookie in seconds.
510          *
511          * @since 2.8.0
512          *
513          * @param int $seconds Comment cookie lifetime. Default 30000000.
514          */
515         $comment_cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 );
516         $secure = ( 'https' === parse_url( home_url(), PHP_URL_SCHEME ) );
517         setcookie( 'comment_author_' . COOKIEHASH, $comment->comment_author, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
518         setcookie( 'comment_author_email_' . COOKIEHASH, $comment->comment_author_email, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
519         setcookie( 'comment_author_url_' . COOKIEHASH, esc_url($comment->comment_author_url), time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
520 }
521
522 /**
523  * Sanitizes the cookies sent to the user already.
524  *
525  * Will only do anything if the cookies have already been created for the user.
526  * Mostly used after cookies had been sent to use elsewhere.
527  *
528  * @since 2.0.4
529  */
530 function sanitize_comment_cookies() {
531         if ( isset( $_COOKIE['comment_author_' . COOKIEHASH] ) ) {
532                 /**
533                  * Filter the comment author's name cookie before it is set.
534                  *
535                  * When this filter hook is evaluated in wp_filter_comment(),
536                  * the comment author's name string is passed.
537                  *
538                  * @since 1.5.0
539                  *
540                  * @param string $author_cookie The comment author name cookie.
541                  */
542                 $comment_author = apply_filters( 'pre_comment_author_name', $_COOKIE['comment_author_' . COOKIEHASH] );
543                 $comment_author = wp_unslash($comment_author);
544                 $comment_author = esc_attr($comment_author);
545                 $_COOKIE['comment_author_' . COOKIEHASH] = $comment_author;
546         }
547
548         if ( isset( $_COOKIE['comment_author_email_' . COOKIEHASH] ) ) {
549                 /**
550                  * Filter the comment author's email cookie before it is set.
551                  *
552                  * When this filter hook is evaluated in wp_filter_comment(),
553                  * the comment author's email string is passed.
554                  *
555                  * @since 1.5.0
556                  *
557                  * @param string $author_email_cookie The comment author email cookie.
558                  */
559                 $comment_author_email = apply_filters( 'pre_comment_author_email', $_COOKIE['comment_author_email_' . COOKIEHASH] );
560                 $comment_author_email = wp_unslash($comment_author_email);
561                 $comment_author_email = esc_attr($comment_author_email);
562                 $_COOKIE['comment_author_email_'.COOKIEHASH] = $comment_author_email;
563         }
564
565         if ( isset( $_COOKIE['comment_author_url_' . COOKIEHASH] ) ) {
566                 /**
567                  * Filter the comment author's URL cookie before it is set.
568                  *
569                  * When this filter hook is evaluated in wp_filter_comment(),
570                  * the comment author's URL string is passed.
571                  *
572                  * @since 1.5.0
573                  *
574                  * @param string $author_url_cookie The comment author URL cookie.
575                  */
576                 $comment_author_url = apply_filters( 'pre_comment_author_url', $_COOKIE['comment_author_url_' . COOKIEHASH] );
577                 $comment_author_url = wp_unslash($comment_author_url);
578                 $_COOKIE['comment_author_url_'.COOKIEHASH] = $comment_author_url;
579         }
580 }
581
582 /**
583  * Validates whether this comment is allowed to be made.
584  *
585  * @since 2.0.0
586  *
587  * @global wpdb $wpdb WordPress database abstraction object.
588  *
589  * @param array $commentdata Contains information on the comment
590  * @return int|string Signifies the approval status (0|1|'spam')
591  */
592 function wp_allow_comment( $commentdata ) {
593         global $wpdb;
594
595         // Simple duplicate check
596         // expected_slashed ($comment_post_ID, $comment_author, $comment_author_email, $comment_content)
597         $dupe = $wpdb->prepare(
598                 "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_parent = %s AND comment_approved != 'trash' AND ( comment_author = %s ",
599                 wp_unslash( $commentdata['comment_post_ID'] ),
600                 wp_unslash( $commentdata['comment_parent'] ),
601                 wp_unslash( $commentdata['comment_author'] )
602         );
603         if ( $commentdata['comment_author_email'] ) {
604                 $dupe .= $wpdb->prepare(
605                         "OR comment_author_email = %s ",
606                         wp_unslash( $commentdata['comment_author_email'] )
607                 );
608         }
609         $dupe .= $wpdb->prepare(
610                 ") AND comment_content = %s LIMIT 1",
611                 wp_unslash( $commentdata['comment_content'] )
612         );
613
614         $dupe_id = $wpdb->get_var( $dupe );
615
616         /**
617          * Filters the ID, if any, of the duplicate comment found when creating a new comment.
618          *
619          * Return an empty value from this filter to allow what WP considers a duplicate comment.
620          *
621          * @since 4.4.0
622          *
623          * @param int   $dupe_id     ID of the comment identified as a duplicate.
624          * @param array $commentdata Data for the comment being created.
625          */
626         $dupe_id = apply_filters( 'duplicate_comment_id', $dupe_id, $commentdata );
627
628         if ( $dupe_id ) {
629                 /**
630                  * Fires immediately after a duplicate comment is detected.
631                  *
632                  * @since 3.0.0
633                  *
634                  * @param array $commentdata Comment data.
635                  */
636                 do_action( 'comment_duplicate_trigger', $commentdata );
637                 if ( defined( 'DOING_AJAX' ) ) {
638                         die( __('Duplicate comment detected; it looks as though you&#8217;ve already said that!') );
639                 }
640                 wp_die( __( 'Duplicate comment detected; it looks as though you&#8217;ve already said that!' ), 409 );
641         }
642
643         /**
644          * Fires immediately before a comment is marked approved.
645          *
646          * Allows checking for comment flooding.
647          *
648          * @since 2.3.0
649          *
650          * @param string $comment_author_IP    Comment author's IP address.
651          * @param string $comment_author_email Comment author's email.
652          * @param string $comment_date_gmt     GMT date the comment was posted.
653          */
654         do_action(
655                 'check_comment_flood',
656                 $commentdata['comment_author_IP'],
657                 $commentdata['comment_author_email'],
658                 $commentdata['comment_date_gmt']
659         );
660
661         if ( ! empty( $commentdata['user_id'] ) ) {
662                 $user = get_userdata( $commentdata['user_id'] );
663                 $post_author = $wpdb->get_var( $wpdb->prepare(
664                         "SELECT post_author FROM $wpdb->posts WHERE ID = %d LIMIT 1",
665                         $commentdata['comment_post_ID']
666                 ) );
667         }
668
669         if ( isset( $user ) && ( $commentdata['user_id'] == $post_author || $user->has_cap( 'moderate_comments' ) ) ) {
670                 // The author and the admins get respect.
671                 $approved = 1;
672         } else {
673                 // Everyone else's comments will be checked.
674                 if ( check_comment(
675                         $commentdata['comment_author'],
676                         $commentdata['comment_author_email'],
677                         $commentdata['comment_author_url'],
678                         $commentdata['comment_content'],
679                         $commentdata['comment_author_IP'],
680                         $commentdata['comment_agent'],
681                         $commentdata['comment_type']
682                 ) ) {
683                         $approved = 1;
684                 } else {
685                         $approved = 0;
686                 }
687
688                 if ( wp_blacklist_check(
689                         $commentdata['comment_author'],
690                         $commentdata['comment_author_email'],
691                         $commentdata['comment_author_url'],
692                         $commentdata['comment_content'],
693                         $commentdata['comment_author_IP'],
694                         $commentdata['comment_agent']
695                 ) ) {
696                         $approved = EMPTY_TRASH_DAYS ? 'trash' : 'spam';
697                 }
698         }
699
700         /**
701          * Filter a comment's approval status before it is set.
702          *
703          * @since 2.1.0
704          *
705          * @param bool|string $approved    The approval status. Accepts 1, 0, or 'spam'.
706          * @param array       $commentdata Comment data.
707          */
708         $approved = apply_filters( 'pre_comment_approved', $approved, $commentdata );
709         return $approved;
710 }
711
712 /**
713  * Check whether comment flooding is occurring.
714  *
715  * Won't run, if current user can manage options, so to not block
716  * administrators.
717  *
718  * @since 2.3.0
719  *
720  * @global wpdb $wpdb WordPress database abstraction object.
721  *
722  * @param string $ip Comment IP.
723  * @param string $email Comment author email address.
724  * @param string $date MySQL time string.
725  */
726 function check_comment_flood_db( $ip, $email, $date ) {
727         global $wpdb;
728         // don't throttle admins or moderators
729         if ( current_user_can( 'manage_options' ) || current_user_can( 'moderate_comments' ) ) {
730                 return;
731         }
732         $hour_ago = gmdate( 'Y-m-d H:i:s', time() - HOUR_IN_SECONDS );
733
734         if ( is_user_logged_in() ) {
735                 $user = get_current_user_id();
736                 $check_column = '`user_id`';
737         } else {
738                 $user = $ip;
739                 $check_column = '`comment_author_IP`';
740         }
741
742         $sql = $wpdb->prepare(
743                 "SELECT `comment_date_gmt` FROM `$wpdb->comments` WHERE `comment_date_gmt` >= %s AND ( $check_column = %s OR `comment_author_email` = %s ) ORDER BY `comment_date_gmt` DESC LIMIT 1",
744                 $hour_ago,
745                 $user,
746                 $email
747         );
748         $lasttime = $wpdb->get_var( $sql );
749         if ( $lasttime ) {
750                 $time_lastcomment = mysql2date('U', $lasttime, false);
751                 $time_newcomment  = mysql2date('U', $date, false);
752                 /**
753                  * Filter the comment flood status.
754                  *
755                  * @since 2.1.0
756                  *
757                  * @param bool $bool             Whether a comment flood is occurring. Default false.
758                  * @param int  $time_lastcomment Timestamp of when the last comment was posted.
759                  * @param int  $time_newcomment  Timestamp of when the new comment was posted.
760                  */
761                 $flood_die = apply_filters( 'comment_flood_filter', false, $time_lastcomment, $time_newcomment );
762                 if ( $flood_die ) {
763                         /**
764                          * Fires before the comment flood message is triggered.
765                          *
766                          * @since 1.5.0
767                          *
768                          * @param int $time_lastcomment Timestamp of when the last comment was posted.
769                          * @param int $time_newcomment  Timestamp of when the new comment was posted.
770                          */
771                         do_action( 'comment_flood_trigger', $time_lastcomment, $time_newcomment );
772
773                         if ( defined('DOING_AJAX') )
774                                 die( __('You are posting comments too quickly. Slow down.') );
775
776                         wp_die( __( 'You are posting comments too quickly. Slow down.' ), 429 );
777                 }
778         }
779 }
780
781 /**
782  * Separates an array of comments into an array keyed by comment_type.
783  *
784  * @since 2.7.0
785  *
786  * @param array $comments Array of comments
787  * @return array Array of comments keyed by comment_type.
788  */
789 function separate_comments(&$comments) {
790         $comments_by_type = array('comment' => array(), 'trackback' => array(), 'pingback' => array(), 'pings' => array());
791         $count = count($comments);
792         for ( $i = 0; $i < $count; $i++ ) {
793                 $type = $comments[$i]->comment_type;
794                 if ( empty($type) )
795                         $type = 'comment';
796                 $comments_by_type[$type][] = &$comments[$i];
797                 if ( 'trackback' == $type || 'pingback' == $type )
798                         $comments_by_type['pings'][] = &$comments[$i];
799         }
800
801         return $comments_by_type;
802 }
803
804 /**
805  * Calculate the total number of comment pages.
806  *
807  * @since 2.7.0
808  *
809  * @uses Walker_Comment
810  *
811  * @global WP_Query $wp_query
812  *
813  * @param array $comments Optional array of WP_Comment objects. Defaults to $wp_query->comments
814  * @param int   $per_page Optional comments per page.
815  * @param bool  $threaded Optional control over flat or threaded comments.
816  * @return int Number of comment pages.
817  */
818 function get_comment_pages_count( $comments = null, $per_page = null, $threaded = null ) {
819         global $wp_query;
820
821         if ( null === $comments && null === $per_page && null === $threaded && !empty($wp_query->max_num_comment_pages) )
822                 return $wp_query->max_num_comment_pages;
823
824         if ( ( ! $comments || ! is_array( $comments ) ) && ! empty( $wp_query->comments )  )
825                 $comments = $wp_query->comments;
826
827         if ( empty($comments) )
828                 return 0;
829
830         if ( ! get_option( 'page_comments' ) ) {
831                 return 1;
832         }
833
834         if ( !isset($per_page) )
835                 $per_page = (int) get_query_var('comments_per_page');
836         if ( 0 === $per_page )
837                 $per_page = (int) get_option('comments_per_page');
838         if ( 0 === $per_page )
839                 return 1;
840
841         if ( !isset($threaded) )
842                 $threaded = get_option('thread_comments');
843
844         if ( $threaded ) {
845                 $walker = new Walker_Comment;
846                 $count = ceil( $walker->get_number_of_root_elements( $comments ) / $per_page );
847         } else {
848                 $count = ceil( count( $comments ) / $per_page );
849         }
850
851         return $count;
852 }
853
854 /**
855  * Calculate what page number a comment will appear on for comment paging.
856  *
857  * @since 2.7.0
858  *
859  * @global wpdb $wpdb WordPress database abstraction object.
860  *
861  * @param int   $comment_ID Comment ID.
862  * @param array $args {
863  *      Array of optional arguments.
864  *      @type string     $type      Limit paginated comments to those matching a given type. Accepts 'comment',
865  *                                  'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'.
866  *                                  Default is 'all'.
867  *      @type int        $per_page  Per-page count to use when calculating pagination. Defaults to the value of the
868  *                                  'comments_per_page' option.
869  *      @type int|string $max_depth If greater than 1, comment page will be determined for the top-level parent of
870  *                                  `$comment_ID`. Defaults to the value of the 'thread_comments_depth' option.
871  * } *
872  * @return int|null Comment page number or null on error.
873  */
874 function get_page_of_comment( $comment_ID, $args = array() ) {
875         global $wpdb;
876
877         $page = null;
878
879         if ( !$comment = get_comment( $comment_ID ) )
880                 return;
881
882         $defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );
883         $args = wp_parse_args( $args, $defaults );
884         $original_args = $args;
885
886         // Order of precedence: 1. `$args['per_page']`, 2. 'comments_per_page' query_var, 3. 'comments_per_page' option.
887         if ( get_option( 'page_comments' ) ) {
888                 if ( '' === $args['per_page'] ) {
889                         $args['per_page'] = get_query_var( 'comments_per_page' );
890                 }
891
892                 if ( '' === $args['per_page'] ) {
893                         $args['per_page'] = get_option( 'comments_per_page' );
894                 }
895         }
896
897         if ( empty($args['per_page']) ) {
898                 $args['per_page'] = 0;
899                 $args['page'] = 0;
900         }
901
902         if ( $args['per_page'] < 1 ) {
903                 $page = 1;
904         }
905
906         if ( null === $page ) {
907                 if ( '' === $args['max_depth'] ) {
908                         if ( get_option('thread_comments') )
909                                 $args['max_depth'] = get_option('thread_comments_depth');
910                         else
911                                 $args['max_depth'] = -1;
912                 }
913
914                 // Find this comment's top level parent if threading is enabled
915                 if ( $args['max_depth'] > 1 && 0 != $comment->comment_parent )
916                         return get_page_of_comment( $comment->comment_parent, $args );
917
918                 $comment_args = array(
919                         'type'       => $args['type'],
920                         'post_id'    => $comment->comment_post_ID,
921                         'fields'     => 'ids',
922                         'count'      => true,
923                         'status'     => 'approve',
924                         'parent'     => 0,
925                         'date_query' => array(
926                                 array(
927                                         'column' => "$wpdb->comments.comment_date_gmt",
928                                         'before' => $comment->comment_date_gmt,
929                                 )
930                         ),
931                 );
932
933                 $comment_query = new WP_Comment_Query();
934                 $older_comment_count = $comment_query->query( $comment_args );
935
936                 // No older comments? Then it's page #1.
937                 if ( 0 == $older_comment_count ) {
938                         $page = 1;
939
940                 // Divide comments older than this one by comments per page to get this comment's page number
941                 } else {
942                         $page = ceil( ( $older_comment_count + 1 ) / $args['per_page'] );
943                 }
944         }
945
946         /**
947          * Filters the calculated page on which a comment appears.
948          *
949          * @since 4.4.0
950          *
951          * @param int   $page          Comment page.
952          * @param array $args {
953          *     Arguments used to calculate pagination. These include arguments auto-detected by the function,
954          *     based on query vars, system settings, etc. For pristine arguments passed to the function,
955          *     see `$original_args`.
956          *
957          *     @type string $type      Type of comments to count.
958          *     @type int    $page      Calculated current page.
959          *     @type int    $per_page  Calculated number of comments per page.
960          *     @type int    $max_depth Maximum comment threading depth allowed.
961          * }
962          * @param array $original_args {
963          *     Array of arguments passed to the function. Some or all of these may not be set.
964          *
965          *     @type string $type      Type of comments to count.
966          *     @type int    $page      Current comment page.
967          *     @type int    $per_page  Number of comments per page.
968          *     @type int    $max_depth Maximum comment threading depth allowed.
969          * }
970          */
971         return apply_filters( 'get_page_of_comment', (int) $page, $args, $original_args );
972 }
973
974 /**
975  * Retrieves the maximum character lengths for the comment form fields.
976  *
977  * @since 4.5.0
978  *
979  * @global wpdb $wpdb WordPress database abstraction object.
980  *
981  * @return array Maximum character length for the comment form fields.
982  */
983 function wp_get_comment_fields_max_lengths() {
984         global $wpdb;
985
986         $lengths = array(
987                 'comment_author'       => 245,
988                 'comment_author_email' => 100,
989                 'comment_author_url'   => 200,
990                 'comment_content'      => 65525,
991         );
992
993         if ( $wpdb->is_mysql ) {
994                 foreach ( $lengths as $column => $length ) {
995                         $col_length = $wpdb->get_col_length( $wpdb->comments, $column );
996                         $max_length = 0;
997
998                         // No point if we can't get the DB column lengths
999                         if ( is_wp_error( $col_length ) ) {
1000                                 break;
1001                         }
1002
1003                         if ( ! is_array( $col_length ) && (int) $col_length > 0 ) {
1004                                 $max_length = (int) $col_length;
1005                         } elseif ( is_array( $col_length ) && isset( $col_length['length'] ) && intval( $col_length['length'] ) > 0 ) {
1006                                 $max_length = (int) $col_length['length'];
1007
1008                                 if ( ! empty( $col_length['type'] ) && 'byte' === $col_length['type'] ) {
1009                                         $max_length = $max_length - 10;
1010                                 }
1011                         }
1012
1013                         if ( $max_length > 0 ) {
1014                                 $lengths[ $column ] = $max_length;
1015                         }
1016                 }
1017         }
1018
1019         /**
1020          * Filters the lengths for the comment form fields.
1021          *
1022          * @since 4.5.0
1023          *
1024          * @param array $lengths Associative array `'field_name' => 'maximum length'`.
1025          */
1026         return apply_filters( 'wp_get_comment_fields_max_lengths', $lengths );
1027 }
1028
1029 /**
1030  * Does comment contain blacklisted characters or words.
1031  *
1032  * @since 1.5.0
1033  *
1034  * @param string $author The author of the comment
1035  * @param string $email The email of the comment
1036  * @param string $url The url used in the comment
1037  * @param string $comment The comment content
1038  * @param string $user_ip The comment author IP address
1039  * @param string $user_agent The author's browser user agent
1040  * @return bool True if comment contains blacklisted content, false if comment does not
1041  */
1042 function wp_blacklist_check($author, $email, $url, $comment, $user_ip, $user_agent) {
1043         /**
1044          * Fires before the comment is tested for blacklisted characters or words.
1045          *
1046          * @since 1.5.0
1047          *
1048          * @param string $author     Comment author.
1049          * @param string $email      Comment author's email.
1050          * @param string $url        Comment author's URL.
1051          * @param string $comment    Comment content.
1052          * @param string $user_ip    Comment author's IP address.
1053          * @param string $user_agent Comment author's browser user agent.
1054          */
1055         do_action( 'wp_blacklist_check', $author, $email, $url, $comment, $user_ip, $user_agent );
1056
1057         $mod_keys = trim( get_option('blacklist_keys') );
1058         if ( '' == $mod_keys )
1059                 return false; // If moderation keys are empty
1060         $words = explode("\n", $mod_keys );
1061
1062         foreach ( (array) $words as $word ) {
1063                 $word = trim($word);
1064
1065                 // Skip empty lines
1066                 if ( empty($word) ) { continue; }
1067
1068                 // Do some escaping magic so that '#' chars in the
1069                 // spam words don't break things:
1070                 $word = preg_quote($word, '#');
1071
1072                 $pattern = "#$word#i";
1073                 if (
1074                            preg_match($pattern, $author)
1075                         || preg_match($pattern, $email)
1076                         || preg_match($pattern, $url)
1077                         || preg_match($pattern, $comment)
1078                         || preg_match($pattern, $user_ip)
1079                         || preg_match($pattern, $user_agent)
1080                  )
1081                         return true;
1082         }
1083         return false;
1084 }
1085
1086 /**
1087  * Retrieve total comments for blog or single post.
1088  *
1089  * The properties of the returned object contain the 'moderated', 'approved',
1090  * and spam comments for either the entire blog or single post. Those properties
1091  * contain the amount of comments that match the status. The 'total_comments'
1092  * property contains the integer of total comments.
1093  *
1094  * The comment stats are cached and then retrieved, if they already exist in the
1095  * cache.
1096  *
1097  * @since 2.5.0
1098  *
1099  * @param int $post_id Optional. Post ID.
1100  * @return object|array Comment stats.
1101  */
1102 function wp_count_comments( $post_id = 0 ) {
1103         $post_id = (int) $post_id;
1104
1105         /**
1106          * Filter the comments count for a given post.
1107          *
1108          * @since 2.7.0
1109          *
1110          * @param array $count   An empty array.
1111          * @param int   $post_id The post ID.
1112          */
1113         $filtered = apply_filters( 'wp_count_comments', array(), $post_id );
1114         if ( ! empty( $filtered ) ) {
1115                 return $filtered;
1116         }
1117
1118         $count = wp_cache_get( "comments-{$post_id}", 'counts' );
1119         if ( false !== $count ) {
1120                 return $count;
1121         }
1122
1123         $stats = get_comment_count( $post_id );
1124         $stats['moderated'] = $stats['awaiting_moderation'];
1125         unset( $stats['awaiting_moderation'] );
1126
1127         $stats_object = (object) $stats;
1128         wp_cache_set( "comments-{$post_id}", $stats_object, 'counts' );
1129
1130         return $stats_object;
1131 }
1132
1133 /**
1134  * Trashes or deletes a comment.
1135  *
1136  * The comment is moved to trash instead of permanently deleted unless trash is
1137  * disabled, item is already in the trash, or $force_delete is true.
1138  *
1139  * The post comment count will be updated if the comment was approved and has a
1140  * post ID available.
1141  *
1142  * @since 2.0.0
1143  *
1144  * @global wpdb $wpdb WordPress database abstraction object.
1145  *
1146  * @param int|WP_Comment $comment_id   Comment ID or WP_Comment object.
1147  * @param bool           $force_delete Whether to bypass trash and force deletion. Default is false.
1148  * @return bool True on success, false on failure.
1149  */
1150 function wp_delete_comment($comment_id, $force_delete = false) {
1151         global $wpdb;
1152         if (!$comment = get_comment($comment_id))
1153                 return false;
1154
1155         if ( !$force_delete && EMPTY_TRASH_DAYS && !in_array( wp_get_comment_status( $comment ), array( 'trash', 'spam' ) ) )
1156                 return wp_trash_comment($comment_id);
1157
1158         /**
1159          * Fires immediately before a comment is deleted from the database.
1160          *
1161          * @since 1.2.0
1162          *
1163          * @param int $comment_id The comment ID.
1164          */
1165         do_action( 'delete_comment', $comment->comment_ID );
1166
1167         // Move children up a level.
1168         $children = $wpdb->get_col( $wpdb->prepare("SELECT comment_ID FROM $wpdb->comments WHERE comment_parent = %d", $comment->comment_ID) );
1169         if ( !empty($children) ) {
1170                 $wpdb->update($wpdb->comments, array('comment_parent' => $comment->comment_parent), array('comment_parent' => $comment->comment_ID));
1171                 clean_comment_cache($children);
1172         }
1173
1174         // Delete metadata
1175         $meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->commentmeta WHERE comment_id = %d", $comment->comment_ID ) );
1176         foreach ( $meta_ids as $mid )
1177                 delete_metadata_by_mid( 'comment', $mid );
1178
1179         if ( ! $wpdb->delete( $wpdb->comments, array( 'comment_ID' => $comment->comment_ID ) ) )
1180                 return false;
1181
1182         /**
1183          * Fires immediately after a comment is deleted from the database.
1184          *
1185          * @since 2.9.0
1186          *
1187          * @param int $comment_id The comment ID.
1188          */
1189         do_action( 'deleted_comment', $comment->comment_ID );
1190
1191         $post_id = $comment->comment_post_ID;
1192         if ( $post_id && $comment->comment_approved == 1 )
1193                 wp_update_comment_count($post_id);
1194
1195         clean_comment_cache( $comment->comment_ID );
1196
1197         /** This action is documented in wp-includes/comment.php */
1198         do_action( 'wp_set_comment_status', $comment->comment_ID, 'delete' );
1199
1200         wp_transition_comment_status('delete', $comment->comment_approved, $comment);
1201         return true;
1202 }
1203
1204 /**
1205  * Moves a comment to the Trash
1206  *
1207  * If trash is disabled, comment is permanently deleted.
1208  *
1209  * @since 2.9.0
1210  *
1211  * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
1212  * @return bool True on success, false on failure.
1213  */
1214 function wp_trash_comment($comment_id) {
1215         if ( !EMPTY_TRASH_DAYS )
1216                 return wp_delete_comment($comment_id, true);
1217
1218         if ( !$comment = get_comment($comment_id) )
1219                 return false;
1220
1221         /**
1222          * Fires immediately before a comment is sent to the Trash.
1223          *
1224          * @since 2.9.0
1225          *
1226          * @param int $comment_id The comment ID.
1227          */
1228         do_action( 'trash_comment', $comment->comment_ID );
1229
1230         if ( wp_set_comment_status( $comment, 'trash' ) ) {
1231                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
1232                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
1233                 add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );
1234                 add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() );
1235
1236                 /**
1237                  * Fires immediately after a comment is sent to Trash.
1238                  *
1239                  * @since 2.9.0
1240                  *
1241                  * @param int $comment_id The comment ID.
1242                  */
1243                 do_action( 'trashed_comment', $comment->comment_ID );
1244                 return true;
1245         }
1246
1247         return false;
1248 }
1249
1250 /**
1251  * Removes a comment from the Trash
1252  *
1253  * @since 2.9.0
1254  *
1255  * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
1256  * @return bool True on success, false on failure.
1257  */
1258 function wp_untrash_comment($comment_id) {
1259         $comment = get_comment( $comment_id );
1260         if ( ! $comment ) {
1261                 return false;
1262         }
1263
1264         /**
1265          * Fires immediately before a comment is restored from the Trash.
1266          *
1267          * @since 2.9.0
1268          *
1269          * @param int $comment_id The comment ID.
1270          */
1271         do_action( 'untrash_comment', $comment->comment_ID );
1272
1273         $status = (string) get_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', true );
1274         if ( empty($status) )
1275                 $status = '0';
1276
1277         if ( wp_set_comment_status( $comment, $status ) ) {
1278                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
1279                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
1280                 /**
1281                  * Fires immediately after a comment is restored from the Trash.
1282                  *
1283                  * @since 2.9.0
1284                  *
1285                  * @param int $comment_id The comment ID.
1286                  */
1287                 do_action( 'untrashed_comment', $comment->comment_ID );
1288                 return true;
1289         }
1290
1291         return false;
1292 }
1293
1294 /**
1295  * Marks a comment as Spam
1296  *
1297  * @since 2.9.0
1298  *
1299  * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
1300  * @return bool True on success, false on failure.
1301  */
1302 function wp_spam_comment( $comment_id ) {
1303         $comment = get_comment( $comment_id );
1304         if ( ! $comment ) {
1305                 return false;
1306         }
1307
1308         /**
1309          * Fires immediately before a comment is marked as Spam.
1310          *
1311          * @since 2.9.0
1312          *
1313          * @param int $comment_id The comment ID.
1314          */
1315         do_action( 'spam_comment', $comment->comment_ID );
1316
1317         if ( wp_set_comment_status( $comment, 'spam' ) ) {
1318                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
1319                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
1320                 add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );
1321                 add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() );
1322                 /**
1323                  * Fires immediately after a comment is marked as Spam.
1324                  *
1325                  * @since 2.9.0
1326                  *
1327                  * @param int $comment_id The comment ID.
1328                  */
1329                 do_action( 'spammed_comment', $comment->comment_ID );
1330                 return true;
1331         }
1332
1333         return false;
1334 }
1335
1336 /**
1337  * Removes a comment from the Spam
1338  *
1339  * @since 2.9.0
1340  *
1341  * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
1342  * @return bool True on success, false on failure.
1343  */
1344 function wp_unspam_comment( $comment_id ) {
1345         $comment = get_comment( $comment_id );
1346         if ( ! $comment ) {
1347                 return false;
1348         }
1349
1350         /**
1351          * Fires immediately before a comment is unmarked as Spam.
1352          *
1353          * @since 2.9.0
1354          *
1355          * @param int $comment_id The comment ID.
1356          */
1357         do_action( 'unspam_comment', $comment->comment_ID );
1358
1359         $status = (string) get_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', true );
1360         if ( empty($status) )
1361                 $status = '0';
1362
1363         if ( wp_set_comment_status( $comment, $status ) ) {
1364                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
1365                 delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
1366                 /**
1367                  * Fires immediately after a comment is unmarked as Spam.
1368                  *
1369                  * @since 2.9.0
1370                  *
1371                  * @param int $comment_id The comment ID.
1372                  */
1373                 do_action( 'unspammed_comment', $comment->comment_ID );
1374                 return true;
1375         }
1376
1377         return false;
1378 }
1379
1380 /**
1381  * The status of a comment by ID.
1382  *
1383  * @since 1.0.0
1384  *
1385  * @param int|WP_Comment $comment_id Comment ID or WP_Comment object
1386  * @return false|string Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure.
1387  */
1388 function wp_get_comment_status($comment_id) {
1389         $comment = get_comment($comment_id);
1390         if ( !$comment )
1391                 return false;
1392
1393         $approved = $comment->comment_approved;
1394
1395         if ( $approved == null )
1396                 return false;
1397         elseif ( $approved == '1' )
1398                 return 'approved';
1399         elseif ( $approved == '0' )
1400                 return 'unapproved';
1401         elseif ( $approved == 'spam' )
1402                 return 'spam';
1403         elseif ( $approved == 'trash' )
1404                 return 'trash';
1405         else
1406                 return false;
1407 }
1408
1409 /**
1410  * Call hooks for when a comment status transition occurs.
1411  *
1412  * Calls hooks for comment status transitions. If the new comment status is not the same
1413  * as the previous comment status, then two hooks will be ran, the first is
1414  * 'transition_comment_status' with new status, old status, and comment data. The
1415  * next action called is 'comment_OLDSTATUS_to_NEWSTATUS' the NEWSTATUS is the
1416  * $new_status parameter and the OLDSTATUS is $old_status parameter; it has the
1417  * comment data.
1418  *
1419  * The final action will run whether or not the comment statuses are the same. The
1420  * action is named 'comment_NEWSTATUS_COMMENTTYPE', NEWSTATUS is from the $new_status
1421  * parameter and COMMENTTYPE is comment_type comment data.
1422  *
1423  * @since 2.7.0
1424  *
1425  * @param string $new_status New comment status.
1426  * @param string $old_status Previous comment status.
1427  * @param object $comment Comment data.
1428  */
1429 function wp_transition_comment_status($new_status, $old_status, $comment) {
1430         /*
1431          * Translate raw statuses to human readable formats for the hooks.
1432          * This is not a complete list of comment status, it's only the ones
1433          * that need to be renamed
1434          */
1435         $comment_statuses = array(
1436                 0         => 'unapproved',
1437                 'hold'    => 'unapproved', // wp_set_comment_status() uses "hold"
1438                 1         => 'approved',
1439                 'approve' => 'approved', // wp_set_comment_status() uses "approve"
1440         );
1441         if ( isset($comment_statuses[$new_status]) ) $new_status = $comment_statuses[$new_status];
1442         if ( isset($comment_statuses[$old_status]) ) $old_status = $comment_statuses[$old_status];
1443
1444         // Call the hooks
1445         if ( $new_status != $old_status ) {
1446                 /**
1447                  * Fires when the comment status is in transition.
1448                  *
1449                  * @since 2.7.0
1450                  *
1451                  * @param int|string $new_status The new comment status.
1452                  * @param int|string $old_status The old comment status.
1453                  * @param object     $comment    The comment data.
1454                  */
1455                 do_action( 'transition_comment_status', $new_status, $old_status, $comment );
1456                 /**
1457                  * Fires when the comment status is in transition from one specific status to another.
1458                  *
1459                  * The dynamic portions of the hook name, `$old_status`, and `$new_status`,
1460                  * refer to the old and new comment statuses, respectively.
1461                  *
1462                  * @since 2.7.0
1463                  *
1464                  * @param WP_Comment $comment Comment object.
1465                  */
1466                 do_action( "comment_{$old_status}_to_{$new_status}", $comment );
1467         }
1468         /**
1469          * Fires when the status of a specific comment type is in transition.
1470          *
1471          * The dynamic portions of the hook name, `$new_status`, and `$comment->comment_type`,
1472          * refer to the new comment status, and the type of comment, respectively.
1473          *
1474          * Typical comment types include an empty string (standard comment), 'pingback',
1475          * or 'trackback'.
1476          *
1477          * @since 2.7.0
1478          *
1479          * @param int        $comment_ID The comment ID.
1480          * @param WP_Comment $comment    Comment object.
1481          */
1482         do_action( "comment_{$new_status}_{$comment->comment_type}", $comment->comment_ID, $comment );
1483 }
1484
1485 /**
1486  * Get current commenter's name, email, and URL.
1487  *
1488  * Expects cookies content to already be sanitized. User of this function might
1489  * wish to recheck the returned array for validity.
1490  *
1491  * @see sanitize_comment_cookies() Use to sanitize cookies
1492  *
1493  * @since 2.0.4
1494  *
1495  * @return array Comment author, email, url respectively.
1496  */
1497 function wp_get_current_commenter() {
1498         // Cookies should already be sanitized.
1499
1500         $comment_author = '';
1501         if ( isset($_COOKIE['comment_author_'.COOKIEHASH]) )
1502                 $comment_author = $_COOKIE['comment_author_'.COOKIEHASH];
1503
1504         $comment_author_email = '';
1505         if ( isset($_COOKIE['comment_author_email_'.COOKIEHASH]) )
1506                 $comment_author_email = $_COOKIE['comment_author_email_'.COOKIEHASH];
1507
1508         $comment_author_url = '';
1509         if ( isset($_COOKIE['comment_author_url_'.COOKIEHASH]) )
1510                 $comment_author_url = $_COOKIE['comment_author_url_'.COOKIEHASH];
1511
1512         /**
1513          * Filter the current commenter's name, email, and URL.
1514          *
1515          * @since 3.1.0
1516          *
1517          * @param array $comment_author_data {
1518          *     An array of current commenter variables.
1519          *
1520          *     @type string $comment_author       The name of the author of the comment. Default empty.
1521          *     @type string $comment_author_email The email address of the `$comment_author`. Default empty.
1522          *     @type string $comment_author_url   The URL address of the `$comment_author`. Default empty.
1523          * }
1524          */
1525         return apply_filters( 'wp_get_current_commenter', compact('comment_author', 'comment_author_email', 'comment_author_url') );
1526 }
1527
1528 /**
1529  * Inserts a comment into the database.
1530  *
1531  * @since 2.0.0
1532  * @since 4.4.0 Introduced `$comment_meta` argument.
1533  *
1534  * @global wpdb $wpdb WordPress database abstraction object.
1535  *
1536  * @param array $commentdata {
1537  *     Array of arguments for inserting a new comment.
1538  *
1539  *     @type string     $comment_agent        The HTTP user agent of the `$comment_author` when
1540  *                                            the comment was submitted. Default empty.
1541  *     @type int|string $comment_approved     Whether the comment has been approved. Default 1.
1542  *     @type string     $comment_author       The name of the author of the comment. Default empty.
1543  *     @type string     $comment_author_email The email address of the `$comment_author`. Default empty.
1544  *     @type string     $comment_author_IP    The IP address of the `$comment_author`. Default empty.
1545  *     @type string     $comment_author_url   The URL address of the `$comment_author`. Default empty.
1546  *     @type string     $comment_content      The content of the comment. Default empty.
1547  *     @type string     $comment_date         The date the comment was submitted. To set the date
1548  *                                            manually, `$comment_date_gmt` must also be specified.
1549  *                                            Default is the current time.
1550  *     @type string     $comment_date_gmt     The date the comment was submitted in the GMT timezone.
1551  *                                            Default is `$comment_date` in the site's GMT timezone.
1552  *     @type int        $comment_karma        The karma of the comment. Default 0.
1553  *     @type int        $comment_parent       ID of this comment's parent, if any. Default 0.
1554  *     @type int        $comment_post_ID      ID of the post that relates to the comment, if any.
1555  *                                            Default 0.
1556  *     @type string     $comment_type         Comment type. Default empty.
1557  *     @type array      $comment_meta         Optional. Array of key/value pairs to be stored in commentmeta for the
1558  *                                            new comment.
1559  *     @type int        $user_id              ID of the user who submitted the comment. Default 0.
1560  * }
1561  * @return int|false The new comment's ID on success, false on failure.
1562  */
1563 function wp_insert_comment( $commentdata ) {
1564         global $wpdb;
1565         $data = wp_unslash( $commentdata );
1566
1567         $comment_author       = ! isset( $data['comment_author'] )       ? '' : $data['comment_author'];
1568         $comment_author_email = ! isset( $data['comment_author_email'] ) ? '' : $data['comment_author_email'];
1569         $comment_author_url   = ! isset( $data['comment_author_url'] )   ? '' : $data['comment_author_url'];
1570         $comment_author_IP    = ! isset( $data['comment_author_IP'] )    ? '' : $data['comment_author_IP'];
1571
1572         $comment_date     = ! isset( $data['comment_date'] )     ? current_time( 'mysql' )            : $data['comment_date'];
1573         $comment_date_gmt = ! isset( $data['comment_date_gmt'] ) ? get_gmt_from_date( $comment_date ) : $data['comment_date_gmt'];
1574
1575         $comment_post_ID  = ! isset( $data['comment_post_ID'] )  ? 0  : $data['comment_post_ID'];
1576         $comment_content  = ! isset( $data['comment_content'] )  ? '' : $data['comment_content'];
1577         $comment_karma    = ! isset( $data['comment_karma'] )    ? 0  : $data['comment_karma'];
1578         $comment_approved = ! isset( $data['comment_approved'] ) ? 1  : $data['comment_approved'];
1579         $comment_agent    = ! isset( $data['comment_agent'] )    ? '' : $data['comment_agent'];
1580         $comment_type     = ! isset( $data['comment_type'] )     ? '' : $data['comment_type'];
1581         $comment_parent   = ! isset( $data['comment_parent'] )   ? 0  : $data['comment_parent'];
1582
1583         $user_id  = ! isset( $data['user_id'] ) ? 0 : $data['user_id'];
1584
1585         $compacted = compact( 'comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_author_IP', 'comment_date', 'comment_date_gmt', 'comment_content', 'comment_karma', 'comment_approved', 'comment_agent', 'comment_type', 'comment_parent', 'user_id' );
1586         if ( ! $wpdb->insert( $wpdb->comments, $compacted ) ) {
1587                 return false;
1588         }
1589
1590         $id = (int) $wpdb->insert_id;
1591
1592         if ( $comment_approved == 1 ) {
1593                 wp_update_comment_count( $comment_post_ID );
1594         }
1595         $comment = get_comment( $id );
1596
1597         // If metadata is provided, store it.
1598         if ( isset( $commentdata['comment_meta'] ) && is_array( $commentdata['comment_meta'] ) ) {
1599                 foreach ( $commentdata['comment_meta'] as $meta_key => $meta_value ) {
1600                         add_comment_meta( $comment->comment_ID, $meta_key, $meta_value, true );
1601                 }
1602         }
1603
1604         /**
1605          * Fires immediately after a comment is inserted into the database.
1606          *
1607          * @since 2.8.0
1608          *
1609          * @param int        $id      The comment ID.
1610          * @param WP_Comment $comment Comment object.
1611          */
1612         do_action( 'wp_insert_comment', $id, $comment );
1613
1614         wp_cache_set( 'last_changed', microtime(), 'comment' );
1615
1616         return $id;
1617 }
1618
1619 /**
1620  * Filters and sanitizes comment data.
1621  *
1622  * Sets the comment data 'filtered' field to true when finished. This can be
1623  * checked as to whether the comment should be filtered and to keep from
1624  * filtering the same comment more than once.
1625  *
1626  * @since 2.0.0
1627  *
1628  * @param array $commentdata Contains information on the comment.
1629  * @return array Parsed comment information.
1630  */
1631 function wp_filter_comment($commentdata) {
1632         if ( isset( $commentdata['user_ID'] ) ) {
1633                 /**
1634                  * Filter the comment author's user id before it is set.
1635                  *
1636                  * The first time this filter is evaluated, 'user_ID' is checked
1637                  * (for back-compat), followed by the standard 'user_id' value.
1638                  *
1639                  * @since 1.5.0
1640                  *
1641                  * @param int $user_ID The comment author's user ID.
1642                  */
1643                 $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_ID'] );
1644         } elseif ( isset( $commentdata['user_id'] ) ) {
1645                 /** This filter is documented in wp-includes/comment.php */
1646                 $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_id'] );
1647         }
1648
1649         /**
1650          * Filter the comment author's browser user agent before it is set.
1651          *
1652          * @since 1.5.0
1653          *
1654          * @param string $comment_agent The comment author's browser user agent.
1655          */
1656         $commentdata['comment_agent'] = apply_filters( 'pre_comment_user_agent', ( isset( $commentdata['comment_agent'] ) ? $commentdata['comment_agent'] : '' ) );
1657         /** This filter is documented in wp-includes/comment.php */
1658         $commentdata['comment_author'] = apply_filters( 'pre_comment_author_name', $commentdata['comment_author'] );
1659         /**
1660          * Filter the comment content before it is set.
1661          *
1662          * @since 1.5.0
1663          *
1664          * @param string $comment_content The comment content.
1665          */
1666         $commentdata['comment_content'] = apply_filters( 'pre_comment_content', $commentdata['comment_content'] );
1667         /**
1668          * Filter the comment author's IP before it is set.
1669          *
1670          * @since 1.5.0
1671          *
1672          * @param string $comment_author_ip The comment author's IP.
1673          */
1674         $commentdata['comment_author_IP'] = apply_filters( 'pre_comment_user_ip', $commentdata['comment_author_IP'] );
1675         /** This filter is documented in wp-includes/comment.php */
1676         $commentdata['comment_author_url'] = apply_filters( 'pre_comment_author_url', $commentdata['comment_author_url'] );
1677         /** This filter is documented in wp-includes/comment.php */
1678         $commentdata['comment_author_email'] = apply_filters( 'pre_comment_author_email', $commentdata['comment_author_email'] );
1679         $commentdata['filtered'] = true;
1680         return $commentdata;
1681 }
1682
1683 /**
1684  * Whether a comment should be blocked because of comment flood.
1685  *
1686  * @since 2.1.0
1687  *
1688  * @param bool $block Whether plugin has already blocked comment.
1689  * @param int $time_lastcomment Timestamp for last comment.
1690  * @param int $time_newcomment Timestamp for new comment.
1691  * @return bool Whether comment should be blocked.
1692  */
1693 function wp_throttle_comment_flood($block, $time_lastcomment, $time_newcomment) {
1694         if ( $block ) // a plugin has already blocked... we'll let that decision stand
1695                 return $block;
1696         if ( ($time_newcomment - $time_lastcomment) < 15 )
1697                 return true;
1698         return false;
1699 }
1700
1701 /**
1702  * Adds a new comment to the database.
1703  *
1704  * Filters new comment to ensure that the fields are sanitized and valid before
1705  * inserting comment into database. Calls 'comment_post' action with comment ID
1706  * and whether comment is approved by WordPress. Also has 'preprocess_comment'
1707  * filter for processing the comment data before the function handles it.
1708  *
1709  * We use REMOTE_ADDR here directly. If you are behind a proxy, you should ensure
1710  * that it is properly set, such as in wp-config.php, for your environment.
1711  * See {@link https://core.trac.wordpress.org/ticket/9235}
1712  *
1713  * @since 1.5.0
1714  * @since 4.3.0 'comment_agent' and 'comment_author_IP' can be set via `$commentdata`.
1715  *
1716  * @see wp_insert_comment()
1717  * @global wpdb $wpdb WordPress database abstraction object.
1718  *
1719  * @param array $commentdata {
1720  *     Comment data.
1721  *
1722  *     @type string $comment_author       The name of the comment author.
1723  *     @type string $comment_author_email The comment author email address.
1724  *     @type string $comment_author_url   The comment author URL.
1725  *     @type string $comment_content      The content of the comment.
1726  *     @type string $comment_date         The date the comment was submitted. Default is the current time.
1727  *     @type string $comment_date_gmt     The date the comment was submitted in the GMT timezone.
1728  *                                        Default is `$comment_date` in the GMT timezone.
1729  *     @type int    $comment_parent       The ID of this comment's parent, if any. Default 0.
1730  *     @type int    $comment_post_ID      The ID of the post that relates to the comment.
1731  *     @type int    $user_id              The ID of the user who submitted the comment. Default 0.
1732  *     @type int    $user_ID              Kept for backward-compatibility. Use `$user_id` instead.
1733  *     @type string $comment_agent        Comment author user agent. Default is the value of 'HTTP_USER_AGENT'
1734  *                                        in the `$_SERVER` superglobal sent in the original request.
1735  *     @type string $comment_author_IP    Comment author IP address in IPv4 format. Default is the value of
1736  *                                        'REMOTE_ADDR' in the `$_SERVER` superglobal sent in the original request.
1737  * }
1738  * @return int|false The ID of the comment on success, false on failure.
1739  */
1740 function wp_new_comment( $commentdata ) {
1741         global $wpdb;
1742
1743         if ( isset( $commentdata['user_ID'] ) ) {
1744                 $commentdata['user_id'] = $commentdata['user_ID'] = (int) $commentdata['user_ID'];
1745         }
1746
1747         $prefiltered_user_id = ( isset( $commentdata['user_id'] ) ) ? (int) $commentdata['user_id'] : 0;
1748
1749         /**
1750          * Filter a comment's data before it is sanitized and inserted into the database.
1751          *
1752          * @since 1.5.0
1753          *
1754          * @param array $commentdata Comment data.
1755          */
1756         $commentdata = apply_filters( 'preprocess_comment', $commentdata );
1757
1758         $commentdata['comment_post_ID'] = (int) $commentdata['comment_post_ID'];
1759         if ( isset( $commentdata['user_ID'] ) && $prefiltered_user_id !== (int) $commentdata['user_ID'] ) {
1760                 $commentdata['user_id'] = $commentdata['user_ID'] = (int) $commentdata['user_ID'];
1761         } elseif ( isset( $commentdata['user_id'] ) ) {
1762                 $commentdata['user_id'] = (int) $commentdata['user_id'];
1763         }
1764
1765         $commentdata['comment_parent'] = isset($commentdata['comment_parent']) ? absint($commentdata['comment_parent']) : 0;
1766         $parent_status = ( 0 < $commentdata['comment_parent'] ) ? wp_get_comment_status($commentdata['comment_parent']) : '';
1767         $commentdata['comment_parent'] = ( 'approved' == $parent_status || 'unapproved' == $parent_status ) ? $commentdata['comment_parent'] : 0;
1768
1769         if ( ! isset( $commentdata['comment_author_IP'] ) ) {
1770                 $commentdata['comment_author_IP'] = $_SERVER['REMOTE_ADDR'];
1771         }
1772         $commentdata['comment_author_IP'] = preg_replace( '/[^0-9a-fA-F:., ]/', '', $commentdata['comment_author_IP'] );
1773
1774         if ( ! isset( $commentdata['comment_agent'] ) ) {
1775                 $commentdata['comment_agent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT']: '';
1776         }
1777         $commentdata['comment_agent'] = substr( $commentdata['comment_agent'], 0, 254 );
1778
1779         if ( empty( $commentdata['comment_date'] ) ) {
1780                 $commentdata['comment_date'] = current_time('mysql');
1781         }
1782
1783         if ( empty( $commentdata['comment_date_gmt'] ) ) {
1784                 $commentdata['comment_date_gmt'] = current_time( 'mysql', 1 );
1785         }
1786
1787         $commentdata = wp_filter_comment($commentdata);
1788
1789         $commentdata['comment_approved'] = wp_allow_comment($commentdata);
1790
1791         $comment_ID = wp_insert_comment($commentdata);
1792         if ( ! $comment_ID ) {
1793                 $fields = array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content' );
1794
1795                 foreach ( $fields as $field ) {
1796                         if ( isset( $commentdata[ $field ] ) ) {
1797                                 $commentdata[ $field ] = $wpdb->strip_invalid_text_for_column( $wpdb->comments, $field, $commentdata[ $field ] );
1798                         }
1799                 }
1800
1801                 $commentdata = wp_filter_comment( $commentdata );
1802
1803                 $commentdata['comment_approved'] = wp_allow_comment( $commentdata );
1804
1805                 $comment_ID = wp_insert_comment( $commentdata );
1806                 if ( ! $comment_ID ) {
1807                         return false;
1808                 }
1809         }
1810
1811         /**
1812          * Fires immediately after a comment is inserted into the database.
1813          *
1814          * @since 1.2.0
1815          * @since 4.5.0 The `$commentdata` parameter was added.
1816          *
1817          * @param int        $comment_ID       The comment ID.
1818          * @param int|string $comment_approved 1 if the comment is approved, 0 if not, 'spam' if spam.
1819          * @param array      $commentdata      Comment data.
1820          */
1821         do_action( 'comment_post', $comment_ID, $commentdata['comment_approved'], $commentdata );
1822
1823         return $comment_ID;
1824 }
1825
1826 /**
1827  * Send a comment moderation notification to the comment moderator.
1828  *
1829  * @since 4.4.0
1830  *
1831  * @param int $comment_ID ID of the comment.
1832  * @return bool True on success, false on failure.
1833  */
1834 function wp_new_comment_notify_moderator( $comment_ID ) {
1835         $comment = get_comment( $comment_ID );
1836
1837         // Only send notifications for pending comments.
1838         $maybe_notify = ( '0' == $comment->comment_approved );
1839
1840         /** This filter is documented in wp-includes/comment.php */
1841         $maybe_notify = apply_filters( 'notify_moderator', $maybe_notify, $comment_ID );
1842
1843         if ( ! $maybe_notify ) {
1844                 return false;
1845         }
1846
1847         return wp_notify_moderator( $comment_ID );
1848 }
1849
1850 /**
1851  * Send a notification of a new comment to the post author.
1852  *
1853  * @since 4.4.0
1854  *
1855  * Uses the {@see 'notify_post_author'} filter to determine whether the post author
1856  * should be notified when a new comment is added, overriding site setting.
1857  *
1858  * @param int $comment_ID Comment ID.
1859  * @return bool True on success, false on failure.
1860  */
1861 function wp_new_comment_notify_postauthor( $comment_ID ) {
1862         $comment = get_comment( $comment_ID );
1863
1864         $maybe_notify = get_option( 'comments_notify' );
1865
1866         /**
1867          * Filter whether to send the post author new comment notification emails,
1868          * overriding the site setting.
1869          *
1870          * @since 4.4.0
1871          *
1872          * @param bool $maybe_notify Whether to notify the post author about the new comment.
1873          * @param int  $comment_ID   The ID of the comment for the notification.
1874          */
1875         $maybe_notify = apply_filters( 'notify_post_author', $maybe_notify, $comment_ID );
1876
1877         /*
1878          * wp_notify_postauthor() checks if notifying the author of their own comment.
1879          * By default, it won't, but filters can override this.
1880          */
1881         if ( ! $maybe_notify ) {
1882                 return false;
1883         }
1884
1885         // Only send notifications for approved comments.
1886         if ( ! isset( $comment->comment_approved ) || '1' != $comment->comment_approved ) {
1887                 return false;
1888         }
1889
1890         return wp_notify_postauthor( $comment_ID );
1891 }
1892
1893 /**
1894  * Sets the status of a comment.
1895  *
1896  * The 'wp_set_comment_status' action is called after the comment is handled.
1897  * If the comment status is not in the list, then false is returned.
1898  *
1899  * @since 1.0.0
1900  *
1901  * @global wpdb $wpdb WordPress database abstraction object.
1902  *
1903  * @param int|WP_Comment $comment_id     Comment ID or WP_Comment object.
1904  * @param string         $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
1905  * @param bool           $wp_error       Whether to return a WP_Error object if there is a failure. Default is false.
1906  * @return bool|WP_Error True on success, false or WP_Error on failure.
1907  */
1908 function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) {
1909         global $wpdb;
1910
1911         switch ( $comment_status ) {
1912                 case 'hold':
1913                 case '0':
1914                         $status = '0';
1915                         break;
1916                 case 'approve':
1917                 case '1':
1918                         $status = '1';
1919                         add_action( 'wp_set_comment_status', 'wp_new_comment_notify_postauthor' );
1920                         break;
1921                 case 'spam':
1922                         $status = 'spam';
1923                         break;
1924                 case 'trash':
1925                         $status = 'trash';
1926                         break;
1927                 default:
1928                         return false;
1929         }
1930
1931         $comment_old = clone get_comment($comment_id);
1932
1933         if ( !$wpdb->update( $wpdb->comments, array('comment_approved' => $status), array( 'comment_ID' => $comment_old->comment_ID ) ) ) {
1934                 if ( $wp_error )
1935                         return new WP_Error('db_update_error', __('Could not update comment status'), $wpdb->last_error);
1936                 else
1937                         return false;
1938         }
1939
1940         clean_comment_cache( $comment_old->comment_ID );
1941
1942         $comment = get_comment( $comment_old->comment_ID );
1943
1944         /**
1945          * Fires immediately before transitioning a comment's status from one to another
1946          * in the database.
1947          *
1948          * @since 1.5.0
1949          *
1950          * @param int         $comment_id     Comment ID.
1951          * @param string|bool $comment_status Current comment status. Possible values include
1952          *                                    'hold', 'approve', 'spam', 'trash', or false.
1953          */
1954         do_action( 'wp_set_comment_status', $comment->comment_ID, $comment_status );
1955
1956         wp_transition_comment_status($comment_status, $comment_old->comment_approved, $comment);
1957
1958         wp_update_comment_count($comment->comment_post_ID);
1959
1960         return true;
1961 }
1962
1963 /**
1964  * Updates an existing comment in the database.
1965  *
1966  * Filters the comment and makes sure certain fields are valid before updating.
1967  *
1968  * @since 2.0.0
1969  *
1970  * @global wpdb $wpdb WordPress database abstraction object.
1971  *
1972  * @param array $commentarr Contains information on the comment.
1973  * @return int Comment was updated if value is 1, or was not updated if value is 0.
1974  */
1975 function wp_update_comment($commentarr) {
1976         global $wpdb;
1977
1978         // First, get all of the original fields
1979         $comment = get_comment($commentarr['comment_ID'], ARRAY_A);
1980         if ( empty( $comment ) ) {
1981                 return 0;
1982         }
1983
1984         // Make sure that the comment post ID is valid (if specified).
1985         if ( ! empty( $commentarr['comment_post_ID'] ) && ! get_post( $commentarr['comment_post_ID'] ) ) {
1986                 return 0;
1987         }
1988
1989         // Escape data pulled from DB.
1990         $comment = wp_slash($comment);
1991
1992         $old_status = $comment['comment_approved'];
1993
1994         // Merge old and new fields with new fields overwriting old ones.
1995         $commentarr = array_merge($comment, $commentarr);
1996
1997         $commentarr = wp_filter_comment( $commentarr );
1998
1999         // Now extract the merged array.
2000         $data = wp_unslash( $commentarr );
2001
2002         /**
2003          * Filter the comment content before it is updated in the database.
2004          *
2005          * @since 1.5.0
2006          *
2007          * @param string $comment_content The comment data.
2008          */
2009         $data['comment_content'] = apply_filters( 'comment_save_pre', $data['comment_content'] );
2010
2011         $data['comment_date_gmt'] = get_gmt_from_date( $data['comment_date'] );
2012
2013         if ( ! isset( $data['comment_approved'] ) ) {
2014                 $data['comment_approved'] = 1;
2015         } elseif ( 'hold' == $data['comment_approved'] ) {
2016                 $data['comment_approved'] = 0;
2017         } elseif ( 'approve' == $data['comment_approved'] ) {
2018                 $data['comment_approved'] = 1;
2019         }
2020
2021         $comment_ID = $data['comment_ID'];
2022         $comment_post_ID = $data['comment_post_ID'];
2023         $keys = array( 'comment_post_ID', 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_type', 'comment_parent', 'user_id', 'comment_agent', 'comment_author_IP' );
2024         $data = wp_array_slice_assoc( $data, $keys );
2025         $rval = $wpdb->update( $wpdb->comments, $data, compact( 'comment_ID' ) );
2026
2027         clean_comment_cache( $comment_ID );
2028         wp_update_comment_count( $comment_post_ID );
2029         /**
2030          * Fires immediately after a comment is updated in the database.
2031          *
2032          * The hook also fires immediately before comment status transition hooks are fired.
2033          *
2034          * @since 1.2.0
2035          *
2036          * @param int $comment_ID The comment ID.
2037          */
2038         do_action( 'edit_comment', $comment_ID );
2039         $comment = get_comment($comment_ID);
2040         wp_transition_comment_status($comment->comment_approved, $old_status, $comment);
2041         return $rval;
2042 }
2043
2044 /**
2045  * Whether to defer comment counting.
2046  *
2047  * When setting $defer to true, all post comment counts will not be updated
2048  * until $defer is set to false. When $defer is set to false, then all
2049  * previously deferred updated post comment counts will then be automatically
2050  * updated without having to call wp_update_comment_count() after.
2051  *
2052  * @since 2.5.0
2053  * @staticvar bool $_defer
2054  *
2055  * @param bool $defer
2056  * @return bool
2057  */
2058 function wp_defer_comment_counting($defer=null) {
2059         static $_defer = false;
2060
2061         if ( is_bool($defer) ) {
2062                 $_defer = $defer;
2063                 // flush any deferred counts
2064                 if ( !$defer )
2065                         wp_update_comment_count( null, true );
2066         }
2067
2068         return $_defer;
2069 }
2070
2071 /**
2072  * Updates the comment count for post(s).
2073  *
2074  * When $do_deferred is false (is by default) and the comments have been set to
2075  * be deferred, the post_id will be added to a queue, which will be updated at a
2076  * later date and only updated once per post ID.
2077  *
2078  * If the comments have not be set up to be deferred, then the post will be
2079  * updated. When $do_deferred is set to true, then all previous deferred post
2080  * IDs will be updated along with the current $post_id.
2081  *
2082  * @since 2.1.0
2083  * @see wp_update_comment_count_now() For what could cause a false return value
2084  *
2085  * @staticvar array $_deferred
2086  *
2087  * @param int|null $post_id     Post ID.
2088  * @param bool     $do_deferred Optional. Whether to process previously deferred
2089  *                              post comment counts. Default false.
2090  * @return bool|void True on success, false on failure or if post with ID does
2091  *                   not exist.
2092  */
2093 function wp_update_comment_count($post_id, $do_deferred=false) {
2094         static $_deferred = array();
2095
2096         if ( empty( $post_id ) && ! $do_deferred ) {
2097                 return false;
2098         }
2099
2100         if ( $do_deferred ) {
2101                 $_deferred = array_unique($_deferred);
2102                 foreach ( $_deferred as $i => $_post_id ) {
2103                         wp_update_comment_count_now($_post_id);
2104                         unset( $_deferred[$i] ); /** @todo Move this outside of the foreach and reset $_deferred to an array instead */
2105                 }
2106         }
2107
2108         if ( wp_defer_comment_counting() ) {
2109                 $_deferred[] = $post_id;
2110                 return true;
2111         }
2112         elseif ( $post_id ) {
2113                 return wp_update_comment_count_now($post_id);
2114         }
2115
2116 }
2117
2118 /**
2119  * Updates the comment count for the post.
2120  *
2121  * @since 2.5.0
2122  *
2123  * @global wpdb $wpdb WordPress database abstraction object.
2124  *
2125  * @param int $post_id Post ID
2126  * @return bool True on success, false on '0' $post_id or if post with ID does not exist.
2127  */
2128 function wp_update_comment_count_now($post_id) {
2129         global $wpdb;
2130         $post_id = (int) $post_id;
2131         if ( !$post_id )
2132                 return false;
2133
2134         wp_cache_delete( 'comments-0', 'counts' );
2135         wp_cache_delete( "comments-{$post_id}", 'counts' );
2136
2137         if ( !$post = get_post($post_id) )
2138                 return false;
2139
2140         $old = (int) $post->comment_count;
2141
2142         /**
2143          * Filters a post's comment count before it is updated in the database.
2144          *
2145          * @since 4.5.0
2146          *
2147          * @param int $new     The new comment count. Default null.
2148          * @param int $old     The old comment count.
2149          * @param int $post_id Post ID.
2150          */
2151         $new = apply_filters( 'pre_wp_update_comment_count_now', null, $old, $post_id );
2152
2153         if ( is_null( $new ) ) {
2154                 $new = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1'", $post_id ) );
2155         } else {
2156                 $new = (int) $new;
2157         }
2158
2159         $wpdb->update( $wpdb->posts, array('comment_count' => $new), array('ID' => $post_id) );
2160
2161         clean_post_cache( $post );
2162
2163         /**
2164          * Fires immediately after a post's comment count is updated in the database.
2165          *
2166          * @since 2.3.0
2167          *
2168          * @param int $post_id Post ID.
2169          * @param int $new     The new comment count.
2170          * @param int $old     The old comment count.
2171          */
2172         do_action( 'wp_update_comment_count', $post_id, $new, $old );
2173         /** This action is documented in wp-includes/post.php */
2174         do_action( 'edit_post', $post_id, $post );
2175
2176         return true;
2177 }
2178
2179 //
2180 // Ping and trackback functions.
2181 //
2182
2183 /**
2184  * Finds a pingback server URI based on the given URL.
2185  *
2186  * Checks the HTML for the rel="pingback" link and x-pingback headers. It does
2187  * a check for the x-pingback headers first and returns that, if available. The
2188  * check for the rel="pingback" has more overhead than just the header.
2189  *
2190  * @since 1.5.0
2191  *
2192  * @param string $url URL to ping.
2193  * @param int $deprecated Not Used.
2194  * @return false|string False on failure, string containing URI on success.
2195  */
2196 function discover_pingback_server_uri( $url, $deprecated = '' ) {
2197         if ( !empty( $deprecated ) )
2198                 _deprecated_argument( __FUNCTION__, '2.7' );
2199
2200         $pingback_str_dquote = 'rel="pingback"';
2201         $pingback_str_squote = 'rel=\'pingback\'';
2202
2203         /** @todo Should use Filter Extension or custom preg_match instead. */
2204         $parsed_url = parse_url($url);
2205
2206         if ( ! isset( $parsed_url['host'] ) ) // Not a URL. This should never happen.
2207                 return false;
2208
2209         //Do not search for a pingback server on our own uploads
2210         $uploads_dir = wp_get_upload_dir();
2211         if ( 0 === strpos($url, $uploads_dir['baseurl']) )
2212                 return false;
2213
2214         $response = wp_safe_remote_head( $url, array( 'timeout' => 2, 'httpversion' => '1.0' ) );
2215
2216         if ( is_wp_error( $response ) )
2217                 return false;
2218
2219         if ( wp_remote_retrieve_header( $response, 'x-pingback' ) )
2220                 return wp_remote_retrieve_header( $response, 'x-pingback' );
2221
2222         // Not an (x)html, sgml, or xml page, no use going further.
2223         if ( preg_match('#(image|audio|video|model)/#is', wp_remote_retrieve_header( $response, 'content-type' )) )
2224                 return false;
2225
2226         // Now do a GET since we're going to look in the html headers (and we're sure it's not a binary file)
2227         $response = wp_safe_remote_get( $url, array( 'timeout' => 2, 'httpversion' => '1.0' ) );
2228
2229         if ( is_wp_error( $response ) )
2230                 return false;
2231
2232         $contents = wp_remote_retrieve_body( $response );
2233
2234         $pingback_link_offset_dquote = strpos($contents, $pingback_str_dquote);
2235         $pingback_link_offset_squote = strpos($contents, $pingback_str_squote);
2236         if ( $pingback_link_offset_dquote || $pingback_link_offset_squote ) {
2237                 $quote = ($pingback_link_offset_dquote) ? '"' : '\'';
2238                 $pingback_link_offset = ($quote=='"') ? $pingback_link_offset_dquote : $pingback_link_offset_squote;
2239                 $pingback_href_pos = @strpos($contents, 'href=', $pingback_link_offset);
2240                 $pingback_href_start = $pingback_href_pos+6;
2241                 $pingback_href_end = @strpos($contents, $quote, $pingback_href_start);
2242                 $pingback_server_url_len = $pingback_href_end - $pingback_href_start;
2243                 $pingback_server_url = substr($contents, $pingback_href_start, $pingback_server_url_len);
2244
2245                 // We may find rel="pingback" but an incomplete pingback URL
2246                 if ( $pingback_server_url_len > 0 ) { // We got it!
2247                         return $pingback_server_url;
2248                 }
2249         }
2250
2251         return false;
2252 }
2253
2254 /**
2255  * Perform all pingbacks, enclosures, trackbacks, and send to pingback services.
2256  *
2257  * @since 2.1.0
2258  *
2259  * @global wpdb $wpdb WordPress database abstraction object.
2260  */
2261 function do_all_pings() {
2262         global $wpdb;
2263
2264         // Do pingbacks
2265         while ($ping = $wpdb->get_row("SELECT ID, post_content, meta_id FROM {$wpdb->posts}, {$wpdb->postmeta} WHERE {$wpdb->posts}.ID = {$wpdb->postmeta}.post_id AND {$wpdb->postmeta}.meta_key = '_pingme' LIMIT 1")) {
2266                 delete_metadata_by_mid( 'post', $ping->meta_id );
2267                 pingback( $ping->post_content, $ping->ID );
2268         }
2269
2270         // Do Enclosures
2271         while ($enclosure = $wpdb->get_row("SELECT ID, post_content, meta_id FROM {$wpdb->posts}, {$wpdb->postmeta} WHERE {$wpdb->posts}.ID = {$wpdb->postmeta}.post_id AND {$wpdb->postmeta}.meta_key = '_encloseme' LIMIT 1")) {
2272                 delete_metadata_by_mid( 'post', $enclosure->meta_id );
2273                 do_enclose( $enclosure->post_content, $enclosure->ID );
2274         }
2275
2276         // Do Trackbacks
2277         $trackbacks = $wpdb->get_col("SELECT ID FROM $wpdb->posts WHERE to_ping <> '' AND post_status = 'publish'");
2278         if ( is_array($trackbacks) )
2279                 foreach ( $trackbacks as $trackback )
2280                         do_trackbacks($trackback);
2281
2282         //Do Update Services/Generic Pings
2283         generic_ping();
2284 }
2285
2286 /**
2287  * Perform trackbacks.
2288  *
2289  * @since 1.5.0
2290  *
2291  * @global wpdb $wpdb WordPress database abstraction object.
2292  *
2293  * @param int $post_id Post ID to do trackbacks on.
2294  */
2295 function do_trackbacks($post_id) {
2296         global $wpdb;
2297
2298         $post = get_post( $post_id );
2299         $to_ping = get_to_ping($post_id);
2300         $pinged  = get_pung($post_id);
2301         if ( empty($to_ping) ) {
2302                 $wpdb->update($wpdb->posts, array('to_ping' => ''), array('ID' => $post_id) );
2303                 return;
2304         }
2305
2306         if ( empty($post->post_excerpt) ) {
2307                 /** This filter is documented in wp-includes/post-template.php */
2308                 $excerpt = apply_filters( 'the_content', $post->post_content, $post->ID );
2309         } else {
2310                 /** This filter is documented in wp-includes/post-template.php */
2311                 $excerpt = apply_filters( 'the_excerpt', $post->post_excerpt );
2312         }
2313
2314         $excerpt = str_replace(']]>', ']]&gt;', $excerpt);
2315         $excerpt = wp_html_excerpt($excerpt, 252, '&#8230;');
2316
2317         /** This filter is documented in wp-includes/post-template.php */
2318         $post_title = apply_filters( 'the_title', $post->post_title, $post->ID );
2319         $post_title = strip_tags($post_title);
2320
2321         if ( $to_ping ) {
2322                 foreach ( (array) $to_ping as $tb_ping ) {
2323                         $tb_ping = trim($tb_ping);
2324                         if ( !in_array($tb_ping, $pinged) ) {
2325                                 trackback($tb_ping, $post_title, $excerpt, $post_id);
2326                                 $pinged[] = $tb_ping;
2327                         } else {
2328                                 $wpdb->query( $wpdb->prepare("UPDATE $wpdb->posts SET to_ping = TRIM(REPLACE(to_ping, %s, '')) WHERE ID = %d", $tb_ping, $post_id) );
2329                         }
2330                 }
2331         }
2332 }
2333
2334 /**
2335  * Sends pings to all of the ping site services.
2336  *
2337  * @since 1.2.0
2338  *
2339  * @param int $post_id Post ID.
2340  * @return int Same as Post ID from parameter
2341  */
2342 function generic_ping( $post_id = 0 ) {
2343         $services = get_option('ping_sites');
2344
2345         $services = explode("\n", $services);
2346         foreach ( (array) $services as $service ) {
2347                 $service = trim($service);
2348                 if ( '' != $service )
2349                         weblog_ping($service);
2350         }
2351
2352         return $post_id;
2353 }
2354
2355 /**
2356  * Pings back the links found in a post.
2357  *
2358  * @since 0.71
2359  *
2360  * @global string $wp_version
2361  *
2362  * @param string $content Post content to check for links.
2363  * @param int $post_ID Post ID.
2364  */
2365 function pingback($content, $post_ID) {
2366         global $wp_version;
2367         include_once(ABSPATH . WPINC . '/class-IXR.php');
2368         include_once(ABSPATH . WPINC . '/class-wp-http-ixr-client.php');
2369
2370         // original code by Mort (http://mort.mine.nu:8080)
2371         $post_links = array();
2372
2373         $pung = get_pung($post_ID);
2374
2375         // Step 1
2376         // Parsing the post, external links (if any) are stored in the $post_links array
2377         $post_links_temp = wp_extract_urls( $content );
2378
2379         // Step 2.
2380         // Walking thru the links array
2381         // first we get rid of links pointing to sites, not to specific files
2382         // Example:
2383         // http://dummy-weblog.org
2384         // http://dummy-weblog.org/
2385         // http://dummy-weblog.org/post.php
2386         // We don't wanna ping first and second types, even if they have a valid <link/>
2387
2388         foreach ( (array) $post_links_temp as $link_test ) :
2389                 if ( !in_array($link_test, $pung) && (url_to_postid($link_test) != $post_ID) // If we haven't pung it already and it isn't a link to itself
2390                                 && !is_local_attachment($link_test) ) : // Also, let's never ping local attachments.
2391                         if ( $test = @parse_url($link_test) ) {
2392                                 if ( isset($test['query']) )
2393                                         $post_links[] = $link_test;
2394                                 elseif ( isset( $test['path'] ) && ( $test['path'] != '/' ) && ( $test['path'] != '' ) )
2395                                         $post_links[] = $link_test;
2396                         }
2397                 endif;
2398         endforeach;
2399
2400         $post_links = array_unique( $post_links );
2401         /**
2402          * Fires just before pinging back links found in a post.
2403          *
2404          * @since 2.0.0
2405          *
2406          * @param array &$post_links An array of post links to be checked, passed by reference.
2407          * @param array &$pung       Whether a link has already been pinged, passed by reference.
2408          * @param int   $post_ID     The post ID.
2409          */
2410         do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post_ID ) );
2411
2412         foreach ( (array) $post_links as $pagelinkedto ) {
2413                 $pingback_server_url = discover_pingback_server_uri( $pagelinkedto );
2414
2415                 if ( $pingback_server_url ) {
2416                         @ set_time_limit( 60 );
2417                         // Now, the RPC call
2418                         $pagelinkedfrom = get_permalink($post_ID);
2419
2420                         // using a timeout of 3 seconds should be enough to cover slow servers
2421                         $client = new WP_HTTP_IXR_Client($pingback_server_url);
2422                         $client->timeout = 3;
2423                         /**
2424                          * Filter the user agent sent when pinging-back a URL.
2425                          *
2426                          * @since 2.9.0
2427                          *
2428                          * @param string $concat_useragent    The user agent concatenated with ' -- WordPress/'
2429                          *                                    and the WordPress version.
2430                          * @param string $useragent           The useragent.
2431                          * @param string $pingback_server_url The server URL being linked to.
2432                          * @param string $pagelinkedto        URL of page linked to.
2433                          * @param string $pagelinkedfrom      URL of page linked from.
2434                          */
2435                         $client->useragent = apply_filters( 'pingback_useragent', $client->useragent . ' -- WordPress/' . $wp_version, $client->useragent, $pingback_server_url, $pagelinkedto, $pagelinkedfrom );
2436                         // when set to true, this outputs debug messages by itself
2437                         $client->debug = false;
2438
2439                         if ( $client->query('pingback.ping', $pagelinkedfrom, $pagelinkedto) || ( isset($client->error->code) && 48 == $client->error->code ) ) // Already registered
2440                                 add_ping( $post_ID, $pagelinkedto );
2441                 }
2442         }
2443 }
2444
2445 /**
2446  * Check whether blog is public before returning sites.
2447  *
2448  * @since 2.1.0
2449  *
2450  * @param mixed $sites Will return if blog is public, will not return if not public.
2451  * @return mixed Empty string if blog is not public, returns $sites, if site is public.
2452  */
2453 function privacy_ping_filter($sites) {
2454         if ( '0' != get_option('blog_public') )
2455                 return $sites;
2456         else
2457                 return '';
2458 }
2459
2460 /**
2461  * Send a Trackback.
2462  *
2463  * Updates database when sending trackback to prevent duplicates.
2464  *
2465  * @since 0.71
2466  *
2467  * @global wpdb $wpdb WordPress database abstraction object.
2468  *
2469  * @param string $trackback_url URL to send trackbacks.
2470  * @param string $title Title of post.
2471  * @param string $excerpt Excerpt of post.
2472  * @param int $ID Post ID.
2473  * @return int|false|void Database query from update.
2474  */
2475 function trackback($trackback_url, $title, $excerpt, $ID) {
2476         global $wpdb;
2477
2478         if ( empty($trackback_url) )
2479                 return;
2480
2481         $options = array();
2482         $options['timeout'] = 10;
2483         $options['body'] = array(
2484                 'title' => $title,
2485                 'url' => get_permalink($ID),
2486                 'blog_name' => get_option('blogname'),
2487                 'excerpt' => $excerpt
2488         );
2489
2490         $response = wp_safe_remote_post( $trackback_url, $options );
2491
2492         if ( is_wp_error( $response ) )
2493                 return;
2494
2495         $wpdb->query( $wpdb->prepare("UPDATE $wpdb->posts SET pinged = CONCAT(pinged, '\n', %s) WHERE ID = %d", $trackback_url, $ID) );
2496         return $wpdb->query( $wpdb->prepare("UPDATE $wpdb->posts SET to_ping = TRIM(REPLACE(to_ping, %s, '')) WHERE ID = %d", $trackback_url, $ID) );
2497 }
2498
2499 /**
2500  * Send a pingback.
2501  *
2502  * @since 1.2.0
2503  *
2504  * @global string $wp_version
2505  *
2506  * @param string $server Host of blog to connect to.
2507  * @param string $path Path to send the ping.
2508  */
2509 function weblog_ping($server = '', $path = '') {
2510         global $wp_version;
2511         include_once(ABSPATH . WPINC . '/class-IXR.php');
2512         include_once(ABSPATH . WPINC . '/class-wp-http-ixr-client.php');
2513
2514         // using a timeout of 3 seconds should be enough to cover slow servers
2515         $client = new WP_HTTP_IXR_Client($server, ((!strlen(trim($path)) || ('/' == $path)) ? false : $path));
2516         $client->timeout = 3;
2517         $client->useragent .= ' -- WordPress/'.$wp_version;
2518
2519         // when set to true, this outputs debug messages by itself
2520         $client->debug = false;
2521         $home = trailingslashit( home_url() );
2522         if ( !$client->query('weblogUpdates.extendedPing', get_option('blogname'), $home, get_bloginfo('rss2_url') ) ) // then try a normal ping
2523                 $client->query('weblogUpdates.ping', get_option('blogname'), $home);
2524 }
2525
2526 /**
2527  * Default filter attached to pingback_ping_source_uri to validate the pingback's Source URI
2528  *
2529  * @since 3.5.1
2530  * @see wp_http_validate_url()
2531  *
2532  * @param string $source_uri
2533  * @return string
2534  */
2535 function pingback_ping_source_uri( $source_uri ) {
2536         return (string) wp_http_validate_url( $source_uri );
2537 }
2538
2539 /**
2540  * Default filter attached to xmlrpc_pingback_error.
2541  *
2542  * Returns a generic pingback error code unless the error code is 48,
2543  * which reports that the pingback is already registered.
2544  *
2545  * @since 3.5.1
2546  * @link http://www.hixie.ch/specs/pingback/pingback#TOC3
2547  *
2548  * @param IXR_Error $ixr_error
2549  * @return IXR_Error
2550  */
2551 function xmlrpc_pingback_error( $ixr_error ) {
2552         if ( $ixr_error->code === 48 )
2553                 return $ixr_error;
2554         return new IXR_Error( 0, '' );
2555 }
2556
2557 //
2558 // Cache
2559 //
2560
2561 /**
2562  * Removes a comment from the object cache.
2563  *
2564  * @since 2.3.0
2565  *
2566  * @param int|array $ids Comment ID or an array of comment IDs to remove from cache.
2567  */
2568 function clean_comment_cache($ids) {
2569         foreach ( (array) $ids as $id ) {
2570                 wp_cache_delete( $id, 'comment' );
2571
2572                 /**
2573                  * Fires immediately after a comment has been removed from the object cache.
2574                  *
2575                  * @since 4.5.0
2576                  *
2577                  * @param int $id Comment ID.
2578                  */
2579                 do_action( 'clean_comment_cache', $id );
2580         }
2581
2582         wp_cache_set( 'last_changed', microtime(), 'comment' );
2583 }
2584
2585 /**
2586  * Updates the comment cache of given comments.
2587  *
2588  * Will add the comments in $comments to the cache. If comment ID already exists
2589  * in the comment cache then it will not be updated. The comment is added to the
2590  * cache using the comment group with the key using the ID of the comments.
2591  *
2592  * @since 2.3.0
2593  * @since 4.4.0 Introduced the `$update_meta_cache` parameter.
2594  *
2595  * @param array $comments          Array of comment row objects
2596  * @param bool  $update_meta_cache Whether to update commentmeta cache. Default true.
2597  */
2598 function update_comment_cache( $comments, $update_meta_cache = true ) {
2599         foreach ( (array) $comments as $comment )
2600                 wp_cache_add($comment->comment_ID, $comment, 'comment');
2601
2602         if ( $update_meta_cache ) {
2603                 // Avoid `wp_list_pluck()` in case `$comments` is passed by reference.
2604                 $comment_ids = array();
2605                 foreach ( $comments as $comment ) {
2606                         $comment_ids[] = $comment->comment_ID;
2607                 }
2608                 update_meta_cache( 'comment', $comment_ids );
2609         }
2610 }
2611
2612 /**
2613  * Adds any comments from the given IDs to the cache that do not already exist in cache.
2614  *
2615  * @since 4.4.0
2616  * @access private
2617  *
2618  * @see update_comment_cache()
2619  * @global wpdb $wpdb WordPress database abstraction object.
2620  *
2621  * @param array $comment_ids       Array of comment IDs.
2622  * @param bool  $update_meta_cache Optional. Whether to update the meta cache. Default true.
2623  */
2624 function _prime_comment_caches( $comment_ids, $update_meta_cache = true ) {
2625         global $wpdb;
2626
2627         $non_cached_ids = _get_non_cached_ids( $comment_ids, 'comment' );
2628         if ( !empty( $non_cached_ids ) ) {
2629                 $fresh_comments = $wpdb->get_results( sprintf( "SELECT $wpdb->comments.* FROM $wpdb->comments WHERE comment_ID IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
2630
2631                 update_comment_cache( $fresh_comments, $update_meta_cache );
2632         }
2633 }
2634
2635 //
2636 // Internal
2637 //
2638
2639 /**
2640  * Close comments on old posts on the fly, without any extra DB queries. Hooked to the_posts.
2641  *
2642  * @access private
2643  * @since 2.7.0
2644  *
2645  * @param WP_Post  $posts Post data object.
2646  * @param WP_Query $query Query object.
2647  * @return array
2648  */
2649 function _close_comments_for_old_posts( $posts, $query ) {
2650         if ( empty( $posts ) || ! $query->is_singular() || ! get_option( 'close_comments_for_old_posts' ) )
2651                 return $posts;
2652
2653         /**
2654          * Filter the list of post types to automatically close comments for.
2655          *
2656          * @since 3.2.0
2657          *
2658          * @param array $post_types An array of registered post types. Default array with 'post'.
2659          */
2660         $post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
2661         if ( ! in_array( $posts[0]->post_type, $post_types ) )
2662                 return $posts;
2663
2664         $days_old = (int) get_option( 'close_comments_days_old' );
2665         if ( ! $days_old )
2666                 return $posts;
2667
2668         if ( time() - strtotime( $posts[0]->post_date_gmt ) > ( $days_old * DAY_IN_SECONDS ) ) {
2669                 $posts[0]->comment_status = 'closed';
2670                 $posts[0]->ping_status = 'closed';
2671         }
2672
2673         return $posts;
2674 }
2675
2676 /**
2677  * Close comments on an old post. Hooked to comments_open and pings_open.
2678  *
2679  * @access private
2680  * @since 2.7.0
2681  *
2682  * @param bool $open Comments open or closed
2683  * @param int $post_id Post ID
2684  * @return bool $open
2685  */
2686 function _close_comments_for_old_post( $open, $post_id ) {
2687         if ( ! $open )
2688                 return $open;
2689
2690         if ( !get_option('close_comments_for_old_posts') )
2691                 return $open;
2692
2693         $days_old = (int) get_option('close_comments_days_old');
2694         if ( !$days_old )
2695                 return $open;
2696
2697         $post = get_post($post_id);
2698
2699         /** This filter is documented in wp-includes/comment.php */
2700         $post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
2701         if ( ! in_array( $post->post_type, $post_types ) )
2702                 return $open;
2703
2704         // Undated drafts should not show up as comments closed.
2705         if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {
2706                 return $open;
2707         }
2708
2709         if ( time() - strtotime( $post->post_date_gmt ) > ( $days_old * DAY_IN_SECONDS ) )
2710                 return false;
2711
2712         return $open;
2713 }
2714
2715 /**
2716  * Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
2717  *
2718  * This function expects unslashed data, as opposed to functions such as `wp_new_comment()` which
2719  * expect slashed data.
2720  *
2721  * @since 4.4.0
2722  *
2723  * @param array $comment_data {
2724  *     Comment data.
2725  *
2726  *     @type string|int $comment_post_ID             The ID of the post that relates to the comment.
2727  *     @type string     $author                      The name of the comment author.
2728  *     @type string     $email                       The comment author email address.
2729  *     @type string     $url                         The comment author URL.
2730  *     @type string     $comment                     The content of the comment.
2731  *     @type string|int $comment_parent              The ID of this comment's parent, if any. Default 0.
2732  *     @type string     $_wp_unfiltered_html_comment The nonce value for allowing unfiltered HTML.
2733  * }
2734  * @return WP_Comment|WP_Error A WP_Comment object on success, a WP_Error object on failure.
2735  */
2736 function wp_handle_comment_submission( $comment_data ) {
2737
2738         $comment_post_ID = $comment_parent = 0;
2739         $comment_author = $comment_author_email = $comment_author_url = $comment_content = $_wp_unfiltered_html_comment = null;
2740
2741         if ( isset( $comment_data['comment_post_ID'] ) ) {
2742                 $comment_post_ID = (int) $comment_data['comment_post_ID'];
2743         }
2744         if ( isset( $comment_data['author'] ) && is_string( $comment_data['author'] ) ) {
2745                 $comment_author = trim( strip_tags( $comment_data['author'] ) );
2746         }
2747         if ( isset( $comment_data['email'] ) && is_string( $comment_data['email'] ) ) {
2748                 $comment_author_email = trim( $comment_data['email'] );
2749         }
2750         if ( isset( $comment_data['url'] ) && is_string( $comment_data['url'] ) ) {
2751                 $comment_author_url = trim( $comment_data['url'] );
2752         }
2753         if ( isset( $comment_data['comment'] ) && is_string( $comment_data['comment'] ) ) {
2754                 $comment_content = trim( $comment_data['comment'] );
2755         }
2756         if ( isset( $comment_data['comment_parent'] ) ) {
2757                 $comment_parent = absint( $comment_data['comment_parent'] );
2758         }
2759         if ( isset( $comment_data['_wp_unfiltered_html_comment'] ) && is_string( $comment_data['_wp_unfiltered_html_comment'] ) ) {
2760                 $_wp_unfiltered_html_comment = trim( $comment_data['_wp_unfiltered_html_comment'] );
2761         }
2762
2763         $post = get_post( $comment_post_ID );
2764
2765         if ( empty( $post->comment_status ) ) {
2766
2767                 /**
2768                  * Fires when a comment is attempted on a post that does not exist.
2769                  *
2770                  * @since 1.5.0
2771                  *
2772                  * @param int $comment_post_ID Post ID.
2773                  */
2774                 do_action( 'comment_id_not_found', $comment_post_ID );
2775
2776                 return new WP_Error( 'comment_id_not_found' );
2777
2778         }
2779
2780         // get_post_status() will get the parent status for attachments.
2781         $status = get_post_status( $post );
2782
2783         if ( ( 'private' == $status ) && ! current_user_can( 'read_post', $comment_post_ID ) ) {
2784                 return new WP_Error( 'comment_id_not_found' );
2785         }
2786
2787         $status_obj = get_post_status_object( $status );
2788
2789         if ( ! comments_open( $comment_post_ID ) ) {
2790
2791                 /**
2792                  * Fires when a comment is attempted on a post that has comments closed.
2793                  *
2794                  * @since 1.5.0
2795                  *
2796                  * @param int $comment_post_ID Post ID.
2797                  */
2798                 do_action( 'comment_closed', $comment_post_ID );
2799
2800                 return new WP_Error( 'comment_closed', __( 'Sorry, comments are closed for this item.' ), 403 );
2801
2802         } elseif ( 'trash' == $status ) {
2803
2804                 /**
2805                  * Fires when a comment is attempted on a trashed post.
2806                  *
2807                  * @since 2.9.0
2808                  *
2809                  * @param int $comment_post_ID Post ID.
2810                  */
2811                 do_action( 'comment_on_trash', $comment_post_ID );
2812
2813                 return new WP_Error( 'comment_on_trash' );
2814
2815         } elseif ( ! $status_obj->public && ! $status_obj->private ) {
2816
2817                 /**
2818                  * Fires when a comment is attempted on a post in draft mode.
2819                  *
2820                  * @since 1.5.1
2821                  *
2822                  * @param int $comment_post_ID Post ID.
2823                  */
2824                 do_action( 'comment_on_draft', $comment_post_ID );
2825
2826                 return new WP_Error( 'comment_on_draft' );
2827
2828         } elseif ( post_password_required( $comment_post_ID ) ) {
2829
2830                 /**
2831                  * Fires when a comment is attempted on a password-protected post.
2832                  *
2833                  * @since 2.9.0
2834                  *
2835                  * @param int $comment_post_ID Post ID.
2836                  */
2837                 do_action( 'comment_on_password_protected', $comment_post_ID );
2838
2839                 return new WP_Error( 'comment_on_password_protected' );
2840
2841         } else {
2842
2843                 /**
2844                  * Fires before a comment is posted.
2845                  *
2846                  * @since 2.8.0
2847                  *
2848                  * @param int $comment_post_ID Post ID.
2849                  */
2850                 do_action( 'pre_comment_on_post', $comment_post_ID );
2851
2852         }
2853
2854         // If the user is logged in
2855         $user = wp_get_current_user();
2856         if ( $user->exists() ) {
2857                 if ( empty( $user->display_name ) ) {
2858                         $user->display_name=$user->user_login;
2859                 }
2860                 $comment_author       = $user->display_name;
2861                 $comment_author_email = $user->user_email;
2862                 $comment_author_url   = $user->user_url;
2863                 $user_ID              = $user->ID;
2864                 if ( current_user_can( 'unfiltered_html' ) ) {
2865                         if ( ! isset( $comment_data['_wp_unfiltered_html_comment'] )
2866                                 || ! wp_verify_nonce( $comment_data['_wp_unfiltered_html_comment'], 'unfiltered-html-comment_' . $comment_post_ID )
2867                         ) {
2868                                 kses_remove_filters(); // start with a clean slate
2869                                 kses_init_filters(); // set up the filters
2870                         }
2871                 }
2872         } else {
2873                 if ( get_option( 'comment_registration' ) ) {
2874                         return new WP_Error( 'not_logged_in', __( 'Sorry, you must be logged in to post a comment.' ), 403 );
2875                 }
2876         }
2877
2878         $comment_type = '';
2879         $max_lengths = wp_get_comment_fields_max_lengths();
2880
2881         if ( get_option( 'require_name_email' ) && ! $user->exists() ) {
2882                 if ( 6 > strlen( $comment_author_email ) || '' == $comment_author ) {
2883                         return new WP_Error( 'require_name_email', __( '<strong>ERROR</strong>: please fill the required fields (name, email).' ), 200 );
2884                 } elseif ( ! is_email( $comment_author_email ) ) {
2885                         return new WP_Error( 'require_valid_email', __( '<strong>ERROR</strong>: please enter a valid email address.' ), 200 );
2886                 }
2887         }
2888
2889         if ( isset( $comment_author ) && $max_lengths['comment_author'] < mb_strlen( $comment_author, '8bit' ) ) {
2890                 return new WP_Error( 'comment_author_column_length', __( '<strong>ERROR</strong>: your name is too long.' ), 200 );
2891         }
2892
2893         if ( isset( $comment_author_email ) && $max_lengths['comment_author_email'] < strlen( $comment_author_email ) ) {
2894                 return new WP_Error( 'comment_author_email_column_length', __( '<strong>ERROR</strong>: your email address is too long.' ), 200 );
2895         }
2896
2897         if ( isset( $comment_author_url ) && $max_lengths['comment_author_url'] < strlen( $comment_author_url ) ) {
2898                 return new WP_Error( 'comment_author_url_column_length', __( '<strong>ERROR</strong>: your url is too long.' ), 200 );
2899         }
2900
2901         if ( '' == $comment_content ) {
2902                 return new WP_Error( 'require_valid_comment', __( '<strong>ERROR</strong>: please type a comment.' ), 200 );
2903         } elseif ( $max_lengths['comment_content'] < mb_strlen( $comment_content, '8bit' ) ) {
2904                 return new WP_Error( 'comment_content_column_length', __( '<strong>ERROR</strong>: your comment is too long.' ), 200 );
2905         }
2906
2907         $commentdata = compact(
2908                 'comment_post_ID',
2909                 'comment_author',
2910                 'comment_author_email',
2911                 'comment_author_url',
2912                 'comment_content',
2913                 'comment_type',
2914                 'comment_parent',
2915                 'user_ID'
2916         );
2917
2918         $comment_id = wp_new_comment( wp_slash( $commentdata ) );
2919         if ( ! $comment_id ) {
2920                 return new WP_Error( 'comment_save_error', __( '<strong>ERROR</strong>: The comment could not be saved. Please try again later.' ), 500 );
2921         }
2922
2923         return get_comment( $comment_id );
2924
2925 }