<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[34460] trunk: Allow `comment_exists()` to match based on GMT date.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/34460">34460</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/34460","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-09-23 18:15:39 +0000 (Wed, 23 Sep 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Allow `comment_exists()` to match based on GMT date.
The `comment_date_gmt` field of the `wp_comments` table is indexed, which makes
`WHERE` matches against the field much faster than against the unindexed
`comment_date`. For bulk operations like data import, the speed difference can
be meaningful.
We continue to default to 'blog' for `$timezone`, to preserve compatibility
with existing uses.
Props apokalyptik.
Fixes <a href="https://core.trac.wordpress.org/ticket/33871">#33871</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludescommentphp">trunk/src/wp-admin/includes/comment.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesCommentphp">trunk/tests/phpunit/tests/admin/includesComment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludescommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/comment.php 2015-09-23 15:59:42 UTC (rev 34459)
+++ trunk/src/wp-admin/includes/comment.php 2015-09-23 18:15:39 UTC (rev 34460)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -9,19 +9,30 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Determine if a comment exists based on author and date.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * For best performance, use `$timezone = 'gmt'`, which queries a field that is properly indexed. The default value
+ * for `$timezone` is 'blog' for legacy reasons.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.4.0 Added the `$timezone` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $comment_author Author of the comment
- * @param string $comment_date Date of the comment
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $comment_author Author of the comment.
+ * @param string $comment_date Date of the comment.
+ * @param string $timezone Timezone. Accepts 'blog' or 'gmt'. Default 'blog'.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return mixed Comment post ID on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function comment_exists($comment_author, $comment_date) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function comment_exists( $comment_author, $comment_date, $timezone = 'blog' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $date_field = 'comment_date';
+ if ( 'gmt' === $timezone ) {
+ $date_field = 'comment_date_gmt';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $wpdb->get_var( $wpdb->prepare("SELECT comment_post_ID FROM $wpdb->comments
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- WHERE comment_author = %s AND comment_date = %s",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ WHERE comment_author = %s AND $date_field = %s",
</ins><span class="cx" style="display: block; padding: 0 10px"> stripslashes( $comment_author ),
</span><span class="cx" style="display: block; padding: 0 10px"> stripslashes( $comment_date )
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesCommentphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesComment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesComment.php 2015-09-23 15:59:42 UTC (rev 34459)
+++ trunk/tests/phpunit/tests/admin/includesComment.php 2015-09-23 18:15:39 UTC (rev 34460)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,4 +23,64 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( comment_exists( 1, '2004-01-02 12:00:00' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $p1, comment_exists( 1, '2014-05-06 12:00:00' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 33871
+ */
+ public function test_default_value_of_timezone_should_be_blog() {
+ $p = $this->factory->post->create();
+ $c = $this->factory->comment->create( array(
+ 'comment_author' => 1,
+ 'comment_post_ID' => $p,
+ 'comment_date' => '2014-05-06 12:00:00',
+ 'comment_date_gmt' => '2014-05-06 07:00:00',
+ ) );
+
+ $this->assertEquals( $p, comment_exists( 1, '2014-05-06 12:00:00' ) );
+ }
+
+ /**
+ * @ticket 33871
+ */
+ public function test_should_respect_timezone_blog() {
+ $p = $this->factory->post->create();
+ $c = $this->factory->comment->create( array(
+ 'comment_author' => 1,
+ 'comment_post_ID' => $p,
+ 'comment_date' => '2014-05-06 12:00:00',
+ 'comment_date_gmt' => '2014-05-06 07:00:00',
+ ) );
+
+ $this->assertEquals( $p, comment_exists( 1, '2014-05-06 12:00:00', 'blog' ) );
+ }
+
+ /**
+ * @ticket 33871
+ */
+ public function test_should_respect_timezone_gmt() {
+ $p = $this->factory->post->create();
+ $c = $this->factory->comment->create( array(
+ 'comment_author' => 1,
+ 'comment_post_ID' => $p,
+ 'comment_date' => '2014-05-06 12:00:00',
+ 'comment_date_gmt' => '2014-05-06 07:00:00',
+ ) );
+
+ $this->assertEquals( $p, comment_exists( 1, '2014-05-06 07:00:00', 'gmt' ) );
+ }
+
+ /**
+ * @ticket 33871
+ */
+ public function test_invalid_timezone_should_fall_back_on_blog() {
+ $p = $this->factory->post->create();
+ $c = $this->factory->comment->create( array(
+ 'comment_author' => 1,
+ 'comment_post_ID' => $p,
+ 'comment_date' => '2014-05-06 12:00:00',
+ 'comment_date_gmt' => '2014-05-06 07:00:00',
+ ) );
+
+ $this->assertEquals( $p, comment_exists( 1, '2014-05-06 12:00:00', 'not_a_valid_value' ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>