Changeset 8789

Timestamp:

05/14/2019 06:58:26 AM (7 years ago)

Author:

dd32

Message:

Theme Directory: Start extracting headers from the readme.txt file in themes.

This is an MVP and does not use a proper readme parser as used in the Plugin Directory.
This is intended to collect the minimal header data we current have a need for.

In the future it's likely this will be expanded to allow more data from readme.txt to be utilised, but that's not the current priority.

See #3718

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/class-wporg-themes-upload.php (modified) (6 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/class-wporg-themes-upload.php

@@ -64 +64 @@
 
         /**
+         * The theme readme.txt data.
+         *
+         * @var array
+         */
+         protected $readme;
+
+        /**
          * Trac ticket information.
          *
@@ -76 +83 @@
          */
         protected $trac;
+
+        /**
+         * The list of headers to extract from readme.txt.
+         *
+         * @var array
+         */
+        protected $readme_header_fields = array(
+                'tested'       => 'tested up to',
+                'requires'     => 'requires at least',
+                'requires_php' => 'requires php',
+                'readme_tags'  => 'tags',
+                'contributors' => 'contributors',
+                'license'      => 'license',
+                'license_uri'  => 'license uri',
+        );
 
         /**
@@ -108 +130 @@
                         );
                 }
+
+                // Do we have a readme.txt? Fetch extra data from there too.
+                $this->readme = $this->get_readme_data( $theme_files );
 
                 // We have a stylesheet, let's set up the theme, theme post, and author.
@@ -371 +396 @@
 
                 return (string) array_pop( $stylesheets );
+        }
+
+        /**
+         * Find the first readme.txt file, and extract it's headers.
+         *
+         * @param array $theme_files The theme files.
+         * @return array Array of headers if present.
+         */
+        public function get_readme_data( $theme_files ) {
+                $readmes = preg_grep( '/readme.txt/i', $theme_files );
+                usort( $readmes, array( $this, 'sort_by_string_length' ) );
+
+                if ( ! $readmes ) {
+                        return array();
+                }
+
+                $readme_txt = (string) array_pop( $readmes );
+
+                // WARNING: This function call will be changed in the future to a readme parser.
+                $data = get_file_data( $readme_txt, $this->readme_header_fields );
+                $data = array_filter( $data, 'strlen' );
+
+                // Sanitize Contributors down to a user_nicename
+                if ( isset( $data['contributors'] ) ) {
+                        $data['contributors'] = explode( ',', $data['contributors'] );
+                        $data['contributors'] = array_map( 'trim', $data['contributors'] );
+                        foreach ( $data['contributors'] as $i => $name ) {
+                                $user = get_user_by( 'login', $name ) ?: get_user_by( 'slug', $name );
+
+                                if ( $user ) {
+                                        $data['contributors'][ $i ] = $user->user_nicename;
+                                } else {
+                                        unset( $data['contributors'][ $i ] );
+                                }
+                        }
+
+                        if ( ! $data['contributors'] ) {
+                                unset( $data['contributors'] );
+                        }
+                }
+
+                return $data;
         }
 
@@ -724 +791 @@
 
                 // Finally, add post meta.
-                $post_meta   = array(
+                $post_meta = array(
                         '_theme_url'   => $this->theme->get( 'ThemeURI' ),
                         '_author_url'  => $this->theme->get( 'AuthorURI' ),
@@ -731 +798 @@
                         '_screenshot'  => $this->theme->screenshot,
                 );
+
+                // Store readme.txt data if present.
+                foreach ( $this->readme as $field => $data ) {
+                        $post_meta[ "_{$field}" ] = $data;
+                }
 
                 foreach ( $post_meta as $meta_key => $meta_value ) {