<!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>[38625] trunk: Media: Make media library searchable by filename.</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/38625">38625</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/38625","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>joemcgill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-09-20 01:44:07 +0000 (Tue, 20 Sep 2016)</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'>Media: Make media library searchable by filename.
This applies a new private function, `_filter_query_attachment_filenames()`,
to the `post_clauses` filter hook during `wp_ajax_query_attachments()` and
`wp_edit_attachments_query_vars()` to include `_wp_attached_file` post meta
in search queries performed from the media library or in a `WP_Media_List_Table`.
Props wonderboymusic, DrewAPicture, joemcgill, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/22744">#22744</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpadminincludespostphp">trunk/src/wp-admin/includes/post.php</a></li>
<li><a href="#trunktestsphpunittestsquerysearchphp">trunk/tests/phpunit/tests/query/search.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesajaxactionsphp"></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/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2016-09-20 00:46:54 UTC (rev 38624)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2016-09-20 01:44:07 UTC (rev 38625)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2397,6 +2397,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( get_post_type_object( 'attachment' )->cap->read_private_posts ) )
</span><span class="cx" style="display: block; padding: 0 10px"> $query['post_status'] .= ',private';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Filter query clauses to include filenames.
+ add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the arguments passed to WP_Query during an Ajax
</span><span class="cx" style="display: block; padding: 0 10px"> * call for querying attachments.
</span></span></pre></div>
<a id="trunksrcwpadminincludespostphp"></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/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/post.php 2016-09-20 00:46:54 UTC (rev 38624)
+++ trunk/src/wp-admin/includes/post.php 2016-09-20 01:44:07 UTC (rev 38625)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1144,10 +1144,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $q['post_parent'] = 0;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Filter query clauses to include filenames.
+ add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $q;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the SQL clauses of an attachment query to include filenames.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @param array $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
+ * DISTINCT, fields (SELECT), and LIMITS clauses.
+ * @return array The modified clauses.
+ */
+function _filter_query_attachment_filenames( $clauses ) {
+ global $wpdb;
+ remove_filter( 'posts_clauses', __FUNCTION__ );
+
+ $clauses['join'] = " INNER JOIN {$wpdb->postmeta} ON ( {$wpdb->posts}.ID = {$wpdb->postmeta}.post_id )";
+ $clauses['groupby'] = "{$wpdb->posts}.ID";
+
+ $clauses['where'] = preg_replace(
+ "/\({$wpdb->posts}.post_content (NOT LIKE|LIKE) (\'[^']+\')\)/",
+ "$0 OR ( {$wpdb->postmeta}.meta_key = '_wp_attached_file' AND {$wpdb->postmeta}.meta_value $1 $2 )",
+ $clauses['where'] );
+
+ return $clauses;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Executes a query for attachments. An array of WP_Query arguments
</span><span class="cx" style="display: block; padding: 0 10px"> * can be passed in, which will override the arguments set by this function.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunittestsquerysearchphp"></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/query/search.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/query/search.php 2016-09-20 00:46:54 UTC (rev 38624)
+++ trunk/tests/phpunit/tests/query/search.php 2016-09-20 01:44:07 UTC (rev 38625)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -280,6 +280,110 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array( $p1, $p3, $p2 ), $q->posts );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Unfiltered search queries for attachment post types should not inlcude
+ * filenames to ensure the postmeta JOINs don't happen on the front end.
+ *
+ * @ticket 22744
+ */
+ public function test_exclude_file_names_in_attachment_search_by_default() {
+ $attachment = self::factory()->post->create( array(
+ 'post_type' => 'attachment',
+ 'post_status' => 'publish',
+ 'post_title' => 'bar foo',
+ 'post_content' => 'foo bar',
+ 'post_excerpt' => 'This post has foo',
+ ) );
+
+ add_post_meta( $attachment, '_wp_attached_file', 'some-image2.png', true );
+
+ // Pass post_type an array value.
+ $q = new WP_Query( array(
+ 's' => 'image2',
+ 'fields' => 'ids',
+ 'post_type' => 'attachment',
+ 'post_status' => 'inherit',
+ ) );
+
+ $this->assertNotEquals( array( $attachment ), $q->posts );
+ }
+
+ /**
+ * @ticket 22744
+ */
+ public function test_include_file_names_in_attachment_search_as_string() {
+ $attachment = self::factory()->post->create( array(
+ 'post_type' => 'attachment',
+ 'post_status' => 'publish',
+ 'post_title' => 'bar foo',
+ 'post_content' => 'foo bar',
+ 'post_excerpt' => 'This post has foo',
+ ) );
+
+ add_post_meta( $attachment, '_wp_attached_file', 'some-image1.png', true );
+ add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
+ // Pass post_type a string value.
+ $q = new WP_Query( array(
+ 's' => 'image1',
+ 'fields' => 'ids',
+ 'post_type' => 'attachment',
+ 'post_status' => 'inherit',
+ ) );
+
+ $this->assertSame( array( $attachment ), $q->posts );
+ }
+
+ /**
+ * @ticket 22744
+ */
+ public function test_include_file_names_in_attachment_search_as_array() {
+ $attachment = self::factory()->post->create( array(
+ 'post_type' => 'attachment',
+ 'post_status' => 'publish',
+ 'post_title' => 'bar foo',
+ 'post_content' => 'foo bar',
+ 'post_excerpt' => 'This post has foo',
+ ) );
+
+ add_post_meta( $attachment, '_wp_attached_file', 'some-image2.png', true );
+ add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+
+ // Pass post_type an array value.
+ $q = new WP_Query( array(
+ 's' => 'image2',
+ 'fields' => 'ids',
+ 'post_type' => array( 'attachment' ),
+ 'post_status' => 'inherit',
+ ) );
+
+ $this->assertSame( array( $attachment ), $q->posts );
+ }
+
+ /**
+ * @ticket 22744
+ */
+ public function test_exclude_attachment_file_names_in_general_searches() {
+ $attachment = self::factory()->post->create( array(
+ 'post_type' => 'attachment',
+ 'post_status' => 'publish',
+ 'post_title' => 'bar foo',
+ 'post_content' => 'foo bar',
+ 'post_excerpt' => 'This post has foo',
+ ) );
+
+ add_post_meta( $attachment, '_wp_attached_file', 'some-image3.png', true );
+
+ $q = new WP_Query( array(
+ 's' => 'image3',
+ 'fields' => 'ids',
+ 'post_type' => array( 'post', 'page', 'attachment' ),
+ 'post_status' => 'inherit',
+ ) );
+
+ $this->assertNotEquals( array( $attachment ), $q->posts );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function filter_posts_search( $sql ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $sql . ' /* posts_search */';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>