<!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>[31653] trunk: When passing `$full` to `get_posts_by_author_sql()`, make sure a 'post_type' clause is included in results.</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/31653">31653</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/31653","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-03-07 01:14:31 +0000 (Sat, 07 Mar 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'>When passing `$full` to `get_posts_by_author_sql()`, make sure a 'post_type' clause is included in results.
This change makes the 'post_type' clause in `wp_list_authors()` redundant, so
we remove it. Third-party plugins using `get_posts_by_author_sql()` may have
similarly redundant clauses, but this won't change the results returned by the
SQL queries.
Also adds unit tests for `get_posts_by_author_sql()`.
Props pbearne.
Fixes <a href="https://core.trac.wordpress.org/ticket/30354">#30354</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesauthortemplatephp">trunk/src/wp-includes/author-template.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestspostgetPostsByAuthorSqlphp">trunk/tests/phpunit/tests/post/getPostsByAuthorSql.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesauthortemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/author-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/author-template.php 2015-03-07 01:04:22 UTC (rev 31652)
+++ trunk/src/wp-includes/author-template.php 2015-03-07 01:14:31 UTC (rev 31653)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -337,7 +337,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $authors = get_users( $query_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $author_count = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( (array) $wpdb->get_results( "SELECT DISTINCT post_author, COUNT(ID) AS count FROM $wpdb->posts WHERE post_type = 'post' AND " . get_private_posts_cap_sql( 'post' ) . " GROUP BY post_author" ) as $row ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( (array) $wpdb->get_results( "SELECT DISTINCT post_author, COUNT(ID) AS count FROM $wpdb->posts WHERE " . get_private_posts_cap_sql( 'post' ) . " GROUP BY post_author" ) as $row ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $author_count[$row->post_author] = $row->count;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $authors as $author_id ) {
</span></span></pre></div>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2015-03-07 01:04:22 UTC (rev 31652)
+++ trunk/src/wp-includes/post.php 2015-03-07 01:14:31 UTC (rev 31653)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5344,36 +5344,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cap = $post_type_obj->cap->read_private_posts;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $full ) {
- if ( null === $post_author ) {
- $sql = $wpdb->prepare( 'WHERE post_type = %s AND ', $post_type );
- } else {
- $sql = $wpdb->prepare( 'WHERE post_author = %d AND post_type = %s AND ', $post_author, $post_type );
- }
- } else {
- $sql = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sql = $wpdb->prepare( 'post_type = %s', $post_type );
+
+ if ( null !== $post_author ) {
+ $sql .= $wpdb->prepare( ' AND post_author = %d', $post_author );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql .= "(post_status = 'publish'";
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Only need to check the cap if $public_only is false.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_status_sql = "post_status = 'publish'";
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false === $public_only ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( $cap ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Does the user have the capability to view private posts? Guess so.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql .= " OR post_status = 'private'";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_status_sql .= " OR post_status = 'private'";
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_user_logged_in() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Users can view their own private posts.
</span><span class="cx" style="display: block; padding: 0 10px"> $id = get_current_user_id();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null === $post_author || ! $full ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql .= " OR post_status = 'private' AND post_author = $id";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_status_sql .= " OR post_status = 'private' AND post_author = $id";
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $id == (int) $post_author ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql .= " OR post_status = 'private'";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_status_sql .= " OR post_status = 'private'";
</ins><span class="cx" style="display: block; padding: 0 10px"> } // else none
</span><span class="cx" style="display: block; padding: 0 10px"> } // else none
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $sql .= ')';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $sql .= " AND ($post_status_sql)";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $full ) {
+ $sql = 'WHERE ' . $sql;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $sql;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestspostgetPostsByAuthorSqlphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/post/getPostsByAuthorSql.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/getPostsByAuthorSql.php (rev 0)
+++ trunk/tests/phpunit/tests/post/getPostsByAuthorSql.php 2015-03-07 01:14:31 UTC (rev 31653)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,115 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group post
+ */
+class Tests_Post_GetPostsByAuthorSql extends WP_UnitTestCase {
+
+ public function test_post_type_post(){
+ $maybe_string = get_posts_by_author_sql( 'post' );
+ $this->assertContains( "post_type = 'post'", $maybe_string );
+ }
+
+ public function test_post_type_page(){
+ $maybe_string = get_posts_by_author_sql( 'page' );
+ $this->assertContains( "post_type = 'page'", $maybe_string );
+ }
+
+ public function test_non_existent_post_type(){
+ $maybe_string = get_posts_by_author_sql( 'non_existent_post_type' );
+ $this->assertContains( '1 = 0', $maybe_string );
+ }
+
+ public function test_full_true(){
+ $maybe_string = get_posts_by_author_sql( 'post', true );
+ $this->assertRegExp( '/^WHERE /', $maybe_string );
+ }
+
+ public function test_full_false(){
+ $maybe_string = get_posts_by_author_sql( 'post', false );
+ $this->assertNotRegExp( '/^WHERE /', $maybe_string );
+ }
+
+ public function test_post_type_clause_should_be_included_when_full_is_true(){
+ $maybe_string = get_posts_by_author_sql( 'post', true );
+ $this->assertContains( "post_type = 'post'", $maybe_string );
+ }
+
+ public function test_post_type_clause_should_be_included_when_full_is_false(){
+ $maybe_string = get_posts_by_author_sql( 'post', false );
+ $this->assertContains( "post_type = 'post'", $maybe_string );
+ }
+
+ public function test_post_author_should_create_post_author_clause(){
+ $maybe_string = get_posts_by_author_sql( 'post', true, 1 );
+ $this->assertContains( 'post_author = 1', $maybe_string );
+ }
+
+ public function test_public_only_true_should_not_allow_any_private_posts_for_loggedin_user(){
+ $current_user = get_current_user_id();
+ $u = $this->factory->user->create();
+ wp_set_current_user( $u );
+
+ $maybe_string = get_posts_by_author_sql( 'post', true, $u, true );
+ $this->assertNotContains( "post_status = 'private'", $maybe_string );
+
+ wp_set_current_user( $current_user );
+ }
+
+ public function test_public_only_should_default_to_false(){
+ $current_user = get_current_user_id();
+ $u = $this->factory->user->create();
+ wp_set_current_user( $u );
+
+ $this->assertSame( get_posts_by_author_sql( 'post', true, $u, false ), get_posts_by_author_sql( 'post', true, $u ) );
+
+ wp_set_current_user( $current_user );
+ }
+
+ public function test_public_only_false_should_allow_current_user_access_to_own_private_posts_when_current_user_matches_post_author(){
+ $current_user = get_current_user_id();
+ $u = $this->factory->user->create();
+ wp_set_current_user( $u );
+
+ $maybe_string = get_posts_by_author_sql( 'post', true, $u, false );
+ $this->assertContains( "post_status = 'private'", $maybe_string );
+
+ wp_set_current_user( $current_user );
+ }
+
+ public function test_public_only_false_should_not_allow_access_to_private_posts_if_current_user_is_not_post_author(){
+ $current_user = get_current_user_id();
+ $u1 = $this->factory->user->create();
+ $u2 = $this->factory->user->create();
+ wp_set_current_user( $u1 );
+
+ $maybe_string = get_posts_by_author_sql( 'post', true, $u2, false );
+ $this->assertNotContains( "post_status = 'private'", $maybe_string );
+
+ wp_set_current_user( $current_user );
+ }
+
+ public function test_public_only_false_should_allow_current_user_access_to_own_private_posts_when_post_author_is_not_provided(){
+ $current_user = get_current_user_id();
+ $u = $this->factory->user->create();
+ wp_set_current_user( $u );
+
+ $maybe_string = get_posts_by_author_sql( 'post', true, $u, false );
+ $this->assertContains( "post_status = 'private'", $maybe_string );
+ $this->assertContains( "post_author = $u", $maybe_string );
+
+ wp_set_current_user( $current_user );
+ }
+
+ public function test_administrator_should_have_access_to_private_posts_when_public_only_is_false(){
+ $current_user = get_current_user_id();
+ $u = $this->factory->user->create( array( 'role' => 'administrator' ) );
+ wp_set_current_user( $u );
+
+ $maybe_string = get_posts_by_author_sql( 'post', true, null, false );
+ $this->assertContains( "post_status = 'private'", $maybe_string );
+ $this->assertNotContains( 'post_author', $maybe_string );
+
+ wp_set_current_user( $current_user );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>