Changeset 41806

Timestamp:

10/10/2017 05:33:57 AM (7 years ago)

Author:

pento

Message:

File Editor: Add support for more than one sub-directory level.

The theme and plugin editors now list all files in the selected theme or plugin, recursing through subdirectories as necessary.

Props WraithKenny, schlessera, chsxf, MikeHansenMe, Daedalon, valendesigns, westonruter, pento.
Fixes #6531.

Location:

trunk

Files:

• src/wp-admin/includes/file.php (modified) (1 diff)
• src/wp-admin/includes/plugin.php (modified) (1 diff)
• src/wp-admin/theme-editor.php (modified) (1 diff)
• src/wp-includes/class-wp-theme.php (modified) (5 diffs)
• tests/phpunit/tests/admin/includesPlugin.php (modified) (1 diff)
• tests/phpunit/tests/functions/listFiles.php (added)

trunk/src/wp-admin/includes/file.php

@@ -121 +121 @@
  *
  * @since 2.6.0
+
  *
  * @param string $folder Optional. Full path to folder. Default empty.
  * @param int    $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
+
  * @return bool|array False on failure, Else array of files
  */
-function list_files( $folder = '', $levels = 100 ) {
-    if ( empty($folder) )
+function list_files( $folder = '', $levels = 100 ) {
+    if ( empty(
         return false;
-
-    if ( ! $levels )
+    }
+
+    $folder = trailingslashit( $folder );
+
+    if ( ! $levels ) {
         return false;
+
 
     $files = array();
-    if ( $dir = @opendir( $folder ) ) {
-        while (($file = readdir( $dir ) ) !== false ) {
-            if ( in_array($file, array('.', '..') ) )
+
+    $dir = @opendir( $folder );
+    if ( $dir ) {
+        while ( ( $file = readdir( $dir ) ) !== false ) {
+            // Skip current and parent folder links.
+            if ( in_array( $file, array( '.', '..' ), true ) ) {
                 continue;
-            if ( is_dir( $folder . '/' . $file ) ) {
-                $files2 = list_files( $folder . '/' . $file, $levels - 1);
-                if ( $files2 )
+            }
+
+            // Skip hidden and excluded files.
+            if ( '.' === $file[0] || in_array( $file, $exclusions, true ) ) {
+                continue;
+            }
+
+            if ( is_dir( $folder . $file ) ) {
+                $files2 = list_files( $folder . $file, $levels - 1 );
+                if ( $files2 ) {
                     $files = array_merge($files, $files2 );
-                else
-                    $files[] = $folder . '/' . $file . '/';
+                } else {
+                    $files[] = $folder . $file . '/';
+                }
             } else {
-                $files[] = $folder . '/' . $file;
+                $files[] = $folder . $file;
             }
         }
     }
     @closedir( $dir );
+
     return $files;
 }

trunk/src/wp-admin/includes/plugin.php

@@ -191 +191 @@
  * @return array List of files relative to the plugin root.
  */
-function get_plugin_files($plugin) {
+function get_plugin_files() {
     $plugin_file = WP_PLUGIN_DIR . '/' . $plugin;
-    $dir = dirname($plugin_file);
-    $plugin_files = array($plugin);
-    if ( is_dir($dir) && $dir != WP_PLUGIN_DIR ) {
-        $plugins_dir = @ opendir( $dir );
-        if ( $plugins_dir ) {
-            while (($file = readdir( $plugins_dir ) ) !== false ) {
-                if ( substr($file, 0, 1) == '.' )
-                    continue;
-                if ( is_dir( $dir . '/' . $file ) ) {
-                    $plugins_subdir = @ opendir( $dir . '/' . $file );
-                    if ( $plugins_subdir ) {
-                        while (($subfile = readdir( $plugins_subdir ) ) !== false ) {
-                            if ( substr($subfile, 0, 1) == '.' )
-                                continue;
-                            $plugin_files[] = plugin_basename("$dir/$file/$subfile");
-                        }
-                        @closedir( $plugins_subdir );
-                    }
-                } else {
-                    if ( plugin_basename("$dir/$file") != $plugin )
-                        $plugin_files[] = plugin_basename("$dir/$file");
-                }
-            }
-            @closedir( $plugins_dir );
-        }
-    }
+    $dir = dirname( $plugin_file );
+
+    $data = get_plugin_data( $plugin_file );
+    $label = isset( $data['Version'] )
+        ? sanitize_key( 'files_' . $plugin . '-' . $data['Version'] )
+        : sanitize_key( 'files_' . $plugin );
+    $transient_key = substr( $label, 0, 29 ) . md5( $label );
+
+    $plugin_files = get_transient( $transient_key );
+    if ( false !== $plugin_files ) {
+        return $plugin_files;
+    }
+
+    $plugin_files = array( plugin_basename( $plugin_file ) );
+
+    if ( is_dir( $dir ) && WP_PLUGIN_DIR !== $dir ) {
+
+        /**
+         * Filters the array of excluded directories and files while scanning the folder.
+         *
+         * @since 4.9.0
+         *
+         * @param array $exclusions Array of excluded directories and files.
+         */
+        $exclusions = (array) apply_filters( 'plugin_files_exclusions', array( 'CVS', 'node_modules', 'vendor', 'bower_components' ) );
+
+        $list_files = list_files( $dir, 100, $exclusions );
+        $list_files = array_map( 'plugin_basename', $list_files );
+
+        $plugin_files = array_merge( $plugin_files, $list_files );
+        $plugin_files = array_values( array_unique( $plugin_files ) );
+    }
+
+    set_transient( $transient_key, $plugin_files, HOUR_IN_SECONDS );
 
     return $plugin_files;

trunk/src/wp-admin/theme-editor.php

@@ -76 +76 @@
     switch ( $type ) {
         case 'php':
-            $allowed_files += $theme->get_files( 'php', 1 );
+            $allowed_files += $theme->get_files( 'php', 1 );
             $has_templates = ! empty( $allowed_files );
             break;
         case 'css':
-            $style_files = $theme->get_files( 'css' );
+            $style_files = $theme->get_files( 'css' );
             $allowed_files['style.css'] = $style_files['style.css'];
             $allowed_files += $style_files;
             break;
         default:
-            $allowed_files += $theme->get_files( $type );
+            $allowed_files += $theme->get_files( $type );
             break;
     }

trunk/src/wp-includes/class-wp-theme.php

@@ -982 +982 @@
      * @param bool $search_parent Optional. Whether to return parent files. Defaults to false.
      * @return array Array of files, keyed by the path to the file relative to the theme's directory, with the values
-     *               being absolute paths.
+     *              being absolute paths.
      */
     public function get_files( $type = null, $depth = 0, $search_parent = false ) {
-        $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth );
-
-        if ( $search_parent && $this->parent() )
-            $files += (array) self::scandir( $this->get_template_directory(), $type, $depth );
+        // get and cache all theme files to start with.
+        $label = sanitize_key( 'files_' . $this->cache_hash . '-' . $this->get( 'Version' ) );
+        $transient_key = substr( $label, 0, 29 ) . md5( $label );
+
+        $all_files = get_transient( $transient_key );
+        if ( false === $all_files ) {
+            $all_files = (array) self::scandir( $this->get_stylesheet_directory(), null, -1 );
+
+            if ( $search_parent && $this->parent() ) {
+                $all_files += (array) self::scandir( $this->get_template_directory(), null, -1 );
+            }
+
+            set_transient( $transient_key, $all_files, HOUR_IN_SECONDS );
+        }
+
+        // Filter $all_files by $type & $depth.
+        $files = array();
+        if ( $type ) {
+            $type = (array) $type;
+            $_extensions = implode( '|', $type );
+        }
+        foreach ( $all_files as $key => $file ) {
+            if ( $depth >= 0 && substr_count( $key, '/' ) > $depth ) {
+                continue; // Filter by depth.
+            }
+            if ( ! $type || preg_match( '~\.(' . $_extensions . ')$~', $file ) ) { // Filter by type.
+                $files[ $key ] = $file;
+            }
+        }
 
         return $files;
@@ -1108 +1133 @@
      */
     private static function scandir( $path, $extensions = null, $depth = 0, $relative_path = '' ) {
-        if ( ! is_dir( $path ) )
+        if ( ! is_dir( $path ) )
             return false;
+
 
         if ( $extensions ) {
@@ -1117 +1143 @@
 
         $relative_path = trailingslashit( $relative_path );
-        if ( '/' == $relative_path )
+        if ( '/' == $relative_path )
             $relative_path = '';
+
 
         $results = scandir( $path );
@@ -1126 +1153 @@
          * Filters the array of excluded directories and files while scanning theme folder.
          *
-         * @since 4.7.4
+         * @since 4.7.4
          *
          * @param array $exclusions Array of excluded directories and files.
          */
-        $exclusions = (array) apply_filters( 'theme_scandir_exclusions', array( 'CVS', 'node_modules' ) );
+        $exclusions = (array) apply_filters( 'theme_scandir_exclusions', array( 'CVS', 'node_modules' ) );
 
         foreach ( $results as $result ) {
@@ -1137 +1164 @@
             }
             if ( is_dir( $path . '/' . $result ) ) {
-                if ( ! $depth )
+                if ( ! $depth )
                     continue;
+
                 $found = self::scandir( $path . '/' . $result, $extensions, $depth - 1 , $relative_path . $result );
                 $files = array_merge_recursive( $files, $found );

trunk/tests/phpunit/tests/admin/includesPlugin.php

@@ -95 +95 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * @covers ::get_mu_plugins
      */