Changeset 2983

Timestamp:

04/19/2016 08:09:35 PM (10 years ago)

Author:

obenland

Message:

Plugin Directory: Add meta data on plugin submission.

Adds readme meta data to the plugin post after uploading a new plugin.

See #1570, #1571.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• admin/metabox/class-custom-fields.php (modified) (2 diffs)
• class-plugin-directory.php (modified) (2 diffs)
• shortcodes/class-upload-handler.php (modified) (5 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/admin/metabox/class-custom-fields.php

@@ -9 +9 @@
 class Custom_Fields {
         static function display() {
-                $post = get_post();
+                $post   = get_post();
                 $fields = array(
                         'version' => 'Latest Plugin Version',
@@ -22 +22 @@
                         'header_description' => 'Plugin Description',
                 );
+
                 echo '<dl>';
                 foreach ( $fields as $field => $text ) {
-                        if ( ! ($value = get_post_meta( $post->ID, $field, true ) ) ) {
+                        if ( ! $value = get_post_meta( $post->ID, $field, true ) ) {
                                 continue;
                         }
                         printf( '<dt>%s</dt><dd>%s</dd>', esc_html( $text ), make_clickable( esc_html( $value ) ) );
                 }
-                // Description is stored in the post_excerpt rather than meta
-                printf( '<dt>%s</dt><dd>%s</dd>', esc_html( $fields['header_description'] ), get_the_excerpt() );
                 echo '</dl>';
         }

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php

@@ -467 +467 @@
          *     @type int    $author      The ID of the plugin author.
          *     @type string $description The short description of the plugin.
+         *     @type string $content     The long description of the plugin.
+         *     @type array  $tags        The tags associated with the plugin.
+         *     @type array  $tags        The meta information of the plugin.
          * }
          * @return \WP_Post|\WP_Error
          */
         static public function create_plugin_post( array $plugin_info ) {
-                $title  = !empty( $plugin_info['title'] )       ? $plugin_info['title']       : '';
-                $slug   = !empty( $plugin_info['slug'] )        ? $plugin_info['slug']        : sanitize_title( $title );
-                $status = !empty( $plugin_info['status'] )      ? $plugin_info['status']      : 'pending';
-                $author = !empty( $plugin_info['author'] )      ? $plugin_info['author']      : 0;
-                $desc   = !empty( $plugin_info['description'] ) ? $plugin_info['description'] : '';
+                $title   = ! empty( $plugin_info['title'] )       ? $plugin_info['title']       : '';
+                $slug    = ! empty( $plugin_info['slug'] )        ? $plugin_info['slug']        : sanitize_title( $title );
+                $status  = ! empty( $plugin_info['status'] )      ? $plugin_info['status']      : 'pending';
+                $author  = ! empty( $plugin_info['author'] )      ? $plugin_info['author']      : 0;
+                $desc    = ! empty( $plugin_info['description'] ) ? $plugin_info['description'] : '';
+                $content = ! empty( $plugin_info['content'] )     ? $plugin_info['content']     : '';
+                $tags    = ! empty( $plugin_info['tags'] )        ? $plugin_info['tags']        : array();
+                $meta    = ! empty( $plugin_info['meta'] )        ? $plugin_info['meta']        : array();
 
                 $id = wp_insert_post( array(
@@ -483 +489 @@
                         'post_title'   => $title ?: $slug,
                         'post_author'  => $author,
-                        'post_content' => '',
+                        'post_content' => $content,
                         'post_excerpt' => $desc,
+                        'tags_input'   => $tags,
+                        'meta_input'   => $meta,
                 ), true );
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/shortcodes/class-upload-handler.php

@@ -1 +1 @@
 <?php
 namespace WordPressdotorg\Plugin_Directory\Shortcodes;
+use WordPressdotorg\Plugin_Directory\Readme_Parser;
 use WordPressdotorg\Plugin_Directory\Plugin_Directory;
 use WordPressdotorg\Plugin_Directory\Tools\Filesystem;
@@ -122 +123 @@
 
                 if ( preg_match( '|[^\d\.]|', $this->plugin['Version'] ) ) {
-                        /* translators: %s: style.css */
+                        /* translators: %s: Version header */
                         return sprintf( __( 'Version strings can only contain numeric and period characters (like 1.2). Please fix your %s line in your main plugin file and upload the plugin again.', 'wporg-plugins' ),
                                 '<code>Version:</code>'
@@ -129 +130 @@
 
                 // Prevent duplicate URLs.
-                $plugin_uri = $this->plugin['PluginURI'];
-                $author_uri = $this->plugin['AuthorURI'];
-                if ( ! empty( $plugin_uri ) && ! empty( $author_uri ) && $plugin_uri == $author_uri ) {
+                if ( ! empty( $this->plugin['PluginURI'] ) && ! empty( $this->plugin['AuthorURI'] ) && $this->plugin['PluginURI'] == $this->plugin['AuthorURI'] ) {
                         return __( 'Duplicate plugin and author URLs. A plugin URL is a page/site that provides details about this specific plugin. An author URL is a page/site that provides information about the author of the plugin. You aren&rsquo;t required to provide both, so pick the one that best applies to your URL.', 'wporg-plugins' );
                 }
+
+                $readme = $this->find_readme_file();
+                if ( empty( $readme ) ) {
+                        /* translators: 1: readme.txt, 2: readme.md */
+                        return sprintf( __( 'The zip file must include a file named %1$s or %2$s.', 'wporg-plugins' ),
+                                '<code>readme.txt</code>',
+                                '<code>readme.md</code>'
+                        );
+                }
+                $readme = new Readme_Parser( $readme );
 
                 // Pass it through Plugin Check and see how great this plugin really is.
@@ -149 +158 @@
                 // Let's save everything and get things wrapped up.
 
+                $content = '';
+                foreach ( $readme->sections as $section => $section_content ) {
+                        $content .= "\n\n<!--section={$section}-->\n{$section_content}";
+                }
+
                 // Add a Plugin Directory entry for this plugin.
                 $plugin_post = Plugin_Directory::create_plugin_post( array(
                         'title'       => $this->plugin['Name'],
                         'slug'        => $this->plugin_slug,
-                        'status'      => 'pending',
+                        'status'      => 'draft',
                         'author'      => get_current_user_id(),
-                        'description' => $this->plugin['Description']
+                        'content'     => $content,
+                        'description' => $this->plugin['Description'],
+                        'tags'        => $readme->tags,
+                        'meta'        => array(
+                                'stable_tag'          => $readme->stable_tag,
+                                'tested'              => $readme->tested,
+                                'requires'            => $readme->requires,
+                                'donate_link'         => $readme->donate_link,
+                                'version'             => $this->plugin['Version'],
+                                'header_plugin_uri'   => $this->plugin['PluginURI'],
+                                'header_author'       => $this->plugin['Author'],
+                                'header_author_uri'   => $this->plugin['AuthorURI'],
+                                'header_textdomain'   => $this->plugin['TextDomain'],
+                                'header_description'  => $this->plugin['Description'],
+                                'support_resolutions' => 0,
+                        ),
                 ) );
                 if ( is_wp_error( $plugin_post ) ) {
@@ -195 +224 @@
                         'new',
                         'updated',
+                        'about',
+                        'admin',
+                        'wp-admin',
                 );
 
                 return in_array( $this->plugin_slug, $reserved_slugs );
+        }
+
+        /**
+         * Find the plugin readme file.
+         *
+         * Looks for either a readme.txt or readme.md file, prioritizing readme.txt.
+         *
+         * @return string The plugin readme.txt or readme.md filename.
+         */
+        protected function find_readme_file() {
+                $files = Filesystem::list_files( "{$this->plugin_dir}/{$this->plugin_slug}", false /* non-recursive */, '!^readme\.(txt|md)$!i' );
+
+                // Prioritize readme.txt
+                foreach ( $files as $file ) {
+                        if ( '.txt' === strtolower( substr( $file, -4 ) ) ) {
+                                return $file;
+                        }
+                }
+
+                return reset( $files );
         }