Changeset 54534

Timestamp:

10/17/2022 12:24:45 PM (2 years ago)

Author:

audrasjb

Message:

Media: Refactor search by filename within the admin.

Props vortfu, xknown, peterwilsoncc, paulkevan.
Merges [54524] to the 6.0 branch.

Location:

branches/6.0

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/ajax-actions.php (modified) (1 diff)
• src/wp-admin/includes/post.php (modified) (1 diff)
• src/wp-includes/class-wp-query.php (modified) (5 diffs)
• src/wp-includes/deprecated.php (modified) (1 diff)
• src/wp-includes/post.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (1 diff)
• tests/phpunit/tests/query/search.php (modified) (5 diffs)

branches/6.0/src/wp-admin/includes/ajax-actions.php

@@ -2995 +2995 @@
     // Filter query clauses to include filenames.
     if ( isset( $query['s'] ) ) {
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+        add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
     }
 

branches/6.0/src/wp-admin/includes/post.php

@@ -1303 +1303 @@
     // Filter query clauses to include filenames.
     if ( isset( $q['s'] ) ) {
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+        add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
     }
 

branches/6.0/src/wp-includes/class-wp-query.php

@@ -444 +444 @@
      */
     public $thumbnails_cached = false;
+
+    /**
+     * Controls whether an attachment query should include filenames or not.
+     *
+     * @since 6.0.3
+     * @var bool
+     */
+    protected $allow_query_attachment_by_filename = false;
 
     /**
@@ -1415 +1423 @@
             }
 
-            $like      = $n . $wpdb->esc_like( $term ) . $n;
-            $search   .= $wpdb->prepare( "{$searchand}(({$wpdb->posts}.post_title $like_op %s) $andor_op ({$wpdb->posts}.post_excerpt $like_op %s) $andor_op ({$wpdb->posts}.post_content $like_op %s))", $like, $like, $like );
+            $like = $n . $wpdb->esc_like( $term ) . $n;
+
+            if ( ! empty( $this->allow_query_attachment_by_filename ) ) {
+                $search .= $wpdb->prepare( "{$searchand}(({$wpdb->posts}.post_title $like_op %s) $andor_op ({$wpdb->posts}.post_excerpt $like_op %s) $andor_op ({$wpdb->posts}.post_content $like_op %s) $andor_op (sq1.meta_value $like_op %s))", $like, $like, $like, $like );
+            } else {
+                $search .= $wpdb->prepare( "{$searchand}(({$wpdb->posts}.post_title $like_op %s) $andor_op ({$wpdb->posts}.post_excerpt $like_op %s) $andor_op ({$wpdb->posts}.post_content $like_op %s))", $like, $like, $like );
+            }
             $searchand = ' AND ';
         }
@@ -1811 +1824 @@
         $q = $this->fill_query_vars( $q );
 
+        /**
+         * Filters whether an attachment query should include filenames or not.
+         *
+         * @since 6.0.3
+         *
+         * @param bool $allow_query_attachment_by_filename Whether or not to include filenames.
+         */
+        $this->allow_query_attachment_by_filename = apply_filters( 'wp_allow_query_attachment_by_filename', false );
+        remove_all_filters( 'wp_allow_query_attachment_by_filename' );
+
         // Parse meta query.
         $this->meta_query = new WP_Meta_Query();
@@ -2242 +2265 @@
         }
 
-        if ( ! empty( $this->tax_query->queries ) || ! empty( $this->meta_query->queries ) ) {
+        if ( ! empty( $this->tax_query->queries ) || ! empty( $this->meta_query->queries ) || ! empty( $this->allow_query_attachment_by_filename ) ) {
             $groupby = "{$wpdb->posts}.ID";
         }
@@ -2318 +2341 @@
         }
         $where .= $search . $whichauthor . $whichmimetype;
+
+        if ( ! empty( $this->allow_query_attachment_by_filename ) ) {
+            $join .= " LEFT JOIN {$wpdb->postmeta} AS sq1 ON ( {$wpdb->posts}.ID = sq1.post_id AND sq1.meta_key = '_wp_attached_file' )";
+        }
 
         if ( ! empty( $this->meta_query->queries ) ) {

branches/6.0/src/wp-includes/deprecated.php

@@ -4312 +4312 @@
     _deprecated_function( __FUNCTION__, '6.0.0' );
 }
+
+/**
+ * Filter the SQL clauses of an attachment query to include filenames.
+ *
+ * @since 4.7.0
+ * @deprecated 6.0.3
+ * @access private
+ *
+ * @param array $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
+ *                       DISTINCT, fields (SELECT), and LIMITS clauses.
+ * @return array The unmodified clauses.
+ */
+function _filter_query_attachment_filenames( $clauses ) {
+    _deprecated_function( __FUNCTION__, '4.9.9', 'add_filter( "wp_allow_query_attachment_by_filename", "__return_true" )' );
+    remove_filter( 'posts_clauses', __FUNCTION__ );
+    return $clauses;
+}

branches/6.0/src/wp-includes/post.php

@@ -7920 +7920 @@
 
 /**
- * Filters the SQL clauses of an attachment query to include filenames.
- *
- * @since 4.7.0
- * @access private
- *
- * @global wpdb $wpdb WordPress database abstraction object.
- *
- * @param string[] $clauses An array including WHERE, GROUP BY, JOIN, ORDER BY,
- *                          DISTINCT, fields (SELECT), and LIMITS clauses.
- * @return string[] The modified array of clauses.
- */
-function _filter_query_attachment_filenames( $clauses ) {
-    global $wpdb;
-    remove_filter( 'posts_clauses', __FUNCTION__ );
-
-    // Add a LEFT JOIN of the postmeta table so we don't trample existing JOINs.
-    $clauses['join'] .= " LEFT JOIN {$wpdb->postmeta} AS sq1 ON ( {$wpdb->posts}.ID = sq1.post_id AND sq1.meta_key = '_wp_attached_file' )";
-
-    $clauses['groupby'] = "{$wpdb->posts}.ID";
-
-    $clauses['where'] = preg_replace(
-        "/\({$wpdb->posts}.post_content (NOT LIKE|LIKE) (\'[^']+\')\)/",
-        '$0 OR ( sq1.meta_value $1 $2 )',
-        $clauses['where']
-    );
-
-    return $clauses;
-}
-
-/**
  * Sets the last changed time for the 'posts' cache group.
  *

branches/6.0/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -98 +98 @@
         // Filter query clauses to include filenames.
         if ( isset( $query_args['s'] ) ) {
-            add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+            add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
         }
 

branches/6.0/tests/phpunit/tests/query/search.php

@@ -455 +455 @@
 
         add_post_meta( $attachment, '_wp_attached_file', 'some-image1.png', true );
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+        add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
 
         // Pass post_type a string value.
@@ -485 +485 @@
 
         add_post_meta( $attachment, '_wp_attached_file', 'some-image2.png', true );
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+        add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
 
         // Pass post_type an array value.
@@ -544 +544 @@
         add_post_meta( $attachment, '_wp_attached_file', 'some-image4.png', true );
         add_post_meta( $attachment, '_test_meta_key', 'value', true );
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+        add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
 
         // Pass post_type a string value.
@@ -584 +584 @@
 
         add_post_meta( $attachment, '_wp_attached_file', 'some-image5.png', true );
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
+        add_filter( 'wp_allow_query_attachment_by_filename', '__return_true' );
 
         // Pass post_type a string value.
@@ -609 +609 @@
      * @ticket 22744
      */
-    public function test_filter_query_attachment_filenames_unhooks_itself() {
-        add_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
-
-        apply_filters(
-            'posts_clauses',
-            array(
-                'where'    => '',
-                'groupby'  => '',
-                'join'     => '',
-                'orderby'  => '',
-                'distinct' => '',
-                'fields'   => '',
-                'limit'    => '',
-            )
-        );
-
-        $result = has_filter( 'posts_clauses', '_filter_query_attachment_filenames' );
-
-        $this->assertFalse( $result );
+    public function test_wp_query_removes_filter_wp_allow_query_attachment_by_filename() {
+        $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( 'wp_allow_query_attachment_by_filename', '__return_true' );
+
+        $q = new WP_Query(
+            array(
+                's'           => 'image1',
+                'fields'      => 'ids',
+                'post_type'   => 'attachment',
+                'post_status' => 'inherit',
+            )
+        );
+
+        $this->assertSame( array( $attachment ), $q->posts );
+
+        /*
+         * WP_Query should have removed the wp_allow_query_attachment_by_filename filter
+         * and thus not match the attachment created above.
+         */
+        $q->get_posts();
+        $this->assertEmpty( $q->posts );
     }