Changeset 13263

Timestamp:

03/15/2022 11:21:26 PM (3 years ago)

Author:

imath

Message:

Attachments: introduce a new function to retrieve a media mime type

bp_attachements_get_mime_type() returns a media mime type if it is supported by WordPress, false if not. This function was mainly introduced to replace the mime_content_type() PHP function which appeared to be problematic for some end users (Some hosts are disabling it, causing an error during the Avatar crop step).

This commit also introduces bp_attachments_get_file_object(), a function to avoid code duplication about getting a BP Attachment object.

Props Nihanthk, maleemuse

See #8646 (trunk)

Location:

trunk

Files:

• src/bp-core/bp-core-attachments.php (modified) (3 diffs)
• tests/phpunit/testcases/core/attachments.php (modified) (1 diff)

trunk/src/bp-core/bp-core-attachments.php

@@ -1640 +1640 @@
 
 /**
+ * Returns a file's mime type.
+ *
+ * @since 10.2.0
+ *
+ * @param string $file Absolute path of a file or directory.
+ * @return false|string False if the mime type is not supported by WordPress.
+ *                      The mime type of a file or 'directory' for a directory.
+ */
+function bp_attachements_get_mime_type( $file = '' ) {
+    $file_type = wp_check_filetype( $file, wp_get_mime_types() );
+    $file_mime = $file_type['type'];
+
+    if ( false === $file_mime && is_dir( $file ) ) {
+        $file_mime = 'directory';
+    }
+
+    return $file_mime;
+}
+
+/**
+ * Returns a BP Attachments file object.
+ *
+ * @since 10.2.0
+ *
+ * @param SplFileInfo $file The SplFileInfo file object.
+ * @return null|object      Null if the file is not supported by WordPress.
+ *                          A BP Attachments file object otherwise.
+ */
+function bp_attachments_get_file_object( SplFileInfo $file ) {
+    $path      = $file->getPathname();
+    $mime_type = bp_attachements_get_mime_type( $path );
+
+    // Mime type not supported by WordPress.
+    if ( false === $mime_type ) {
+        return null;
+    }
+
+    $_file = new stdClass();
+
+    $_file->name               = $file->getfilename();
+    $_file->path               = $path;
+    $_file->size               = $file->getSize();
+    $_file->type               = $file->getType();
+    $_file->mime_type          = bp_attachements_get_mime_type( $_file->path );
+    $_file->last_modified      = $file->getMTime();
+    $_file->latest_access_date = $file->getATime();
+    $_file->id                 = pathinfo( $_file->name, PATHINFO_FILENAME );
+
+    return $_file;
+}
+
+/**
  * List the files of a directory.
  *
@@ -1656 +1708 @@
 
     foreach ( $iterator as $file ) {
-        $_file = new stdClass();
-
-        $_file->name               = $file->getfilename();
-        $_file->path               = $file->getPathname();
-        $_file->size               = $file->getSize();
-        $_file->type               = $file->getType();
-        $_file->mime_type          = mime_content_type( $_file->path );
-        $_file->last_modified      = $file->getMTime();
-        $_file->latest_access_date = $file->getATime();
-        $_file->id                 = pathinfo( $_file->name, PATHINFO_FILENAME );
-        $files[ $_file->id ]       = $_file;
+        $supported_file = bp_attachments_get_file_object( $file );
+
+        if ( is_null( $supported_file) ) {
+            continue;
+        }
+
+        $files[ $supported_file->id ] = $supported_file;
     }
 
@@ -1693 +1741 @@
 
     foreach ( $iterator as $file ) {
-        $_file = new stdClass();
-
-        $_file->name               = $file->getfilename();
-        $_file->path               = $file->getPathname();
-        $_file->size               = $file->getSize();
-        $_file->type               = $file->getType();
-        $_file->mime_type          = mime_content_type( $_file->path );
-        $_file->last_modified      = $file->getMTime();
-        $_file->latest_access_date = $file->getATime();
-        $_file->parent_dir_path    = str_replace( '\\', '/', dirname( $_file->path ) );
-        $_file->parent_dir_url     = str_replace( $basedir, $bp_upload['baseurl'], $_file->parent_dir_path );
-        $_file->id                 = pathinfo( $_file->name, PATHINFO_FILENAME );
+        $supported_file = bp_attachments_get_file_object( $file );
+
+        if ( is_null( $supported_file) ) {
+            continue;
+        }
+
+        $supported_file->parent_dir_path = str_replace( '\\', '/', dirname( $supported_file->path ) );
+        $supported_file->parent_dir_url  = str_replace( $basedir, $bp_upload['baseurl'], $supported_file->parent_dir_path );
 
         // Ensure URL is https if SSL is set/forced.
         if ( is_ssl() ) {
-            $_file->parent_dir_url = str_replace( 'http://', 'https://', $_file->parent_dir_url );
-        }
-
-        $file_id = $_file->id;
-        if ( $_file->parent_dir_path !== $directory_path ) {
-            $file_id = trailingslashit( str_replace( trailingslashit( $directory_path ), '', $_file->parent_dir_path ) ) . $file_id;
-        }
-
-        $files[ $file_id ] = $_file;
+            $supported_file->parent_dir_url = str_replace( 'http://', 'https://', $supported_file->parent_dir_url );
+        }
+
+        $file_id = $supported_file->id;
+        if ( $supported_file->parent_dir_path !== $directory_path ) {
+            $file_id = trailingslashit( str_replace( trailingslashit( $directory_path ), '', $supported_file->parent_dir_path ) ) . $file_id;
+        }
+
+        $files[ $file_id ] = $supported_file;
     }
 

trunk/tests/phpunit/testcases/core/attachments.php

@@ -7 +7 @@
 class BP_Tests_Core_Attachments extends BP_UnitTestCase {
     /**
+     * @group bp_attachments_list_directory_files
+     */
+    public function test_bp_attachments_list_directory_files() {
+        $files = bp_attachments_list_directory_files( BP_TESTS_DIR . 'assets' );
+
+        $expected_keys = array( 'name', 'path', 'size', 'type', 'mime_type', 'last_modified', 'latest_access_date', 'id' );
+
+        $directories = wp_filter_object_list( $files, array( 'mime_type' => 'directory' ) );
+        $directory   = reset( $directories );
+
+        $keys = array_keys( get_object_vars( $directory ) );
+        sort( $keys );
+        sort( $expected_keys );
+
+        $this->assertSame( $keys, $expected_keys );
+
+        $images = wp_filter_object_list( $files, array( 'mime_type' => 'image/jpeg' ) );
+        $this->assertNotEmpty( $images );
+
+        $scripts = wp_filter_object_list( $files, array( 'mime_type' => 'text/x-php' ) );
+        $this->assertEmpty( $scripts );
+    }
+
+    /**
      * @group bp_attachments_list_directory_files_recursively
      */
     public function test_bp_attachments_list_directory_files_recursively() {
+        add_filter( 'mime_types', array( $this, 'filter_mime_types' ) );
         $files = bp_attachments_list_directory_files_recursively( BP_TESTS_DIR . 'assets', 'index' );
+        remove_filter( 'mime_types', array( $this, 'filter_mime_types' ) );
 
         $this->assertTrue( 1 === count( $files ) );
         $this->assertTrue( isset( $files['templates/index'] ) );
     }
+
+    public function filter_mime_types( $mime_types ) {
+        $mime_types['php'] = 'text/x-php';
+        return $mime_types;
+    }
 }