+ tested ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->tested ) ), $api->tested, '>' ) )
+ echo '
' . __('Warning: This plugin has not been tested with your current version of WordPress.') . '
';
+
+ elseif ( !empty( $api->requires ) && version_compare( substr( $GLOBALS['wp_version'], 0, strlen( $api->requires ) ), $api->requires, '<' ) )
+ echo '
' . __('Warning: This plugin has not been marked as compatible with your version of WordPress.') . '
';
+
+ foreach ( (array) $api->sections as $section_name => $content ) {
+ if ( isset( $plugins_section_titles[ $section_name ] ) )
+ $title = $plugins_section_titles[ $section_name ];
+ else
+ $title = ucwords( str_replace( '_', ' ', $section_name ) );
+
+ $content = links_add_target($content, '_blank');
+ $san_section = esc_attr( $section_name );
+ $display = ( $section_name == $section ) ? 'block' : 'none';
+ ?>
+
+
+
+
+ \n";
+ iframe_footer();
+ exit;
+}
+add_action('install_plugins_pre_plugin-readme', 'plugin_readme_information');
Index: wp-admin/includes/class-wp-plugin-install-list-table.php
===================================================================
--- wp-admin/includes/class-wp-plugin-install-list-table.php (revision 21100)
+++ wp-admin/includes/class-wp-plugin-install-list-table.php (working copy)
@@ -34,7 +34,7 @@
$tabs['popular'] = _x( 'Popular','Plugin Installer' );
$tabs['new'] = _x( 'Newest','Plugin Installer' );
- $nonmenu_tabs = array( 'plugin-information' ); //Valid actions to perform which do not have a Menu item.
+ $nonmenu_tabs = array( 'plugin-information', 'plugin-readme' ); //Valid actions to perform which do not have a Menu item.
$tabs = apply_filters( 'install_plugins_tabs', $tabs );
$nonmenu_tabs = apply_filters( 'install_plugins_nonmenu_tabs', $nonmenu_tabs );
Index: wp-admin/includes/class-wp-plugin-readme-parser.php
===================================================================
--- wp-admin/includes/class-wp-plugin-readme-parser.php (revision 0)
+++ wp-admin/includes/class-wp-plugin-readme-parser.php (working copy)
@@ -0,0 +1,464 @@
+ '/Requires at least:[ \t]*(.+)/i',
+ 'tested_up_to' => '/Tested up to:[ \t]*(.+)/i',
+ 'stable_tag' => '/Stable tag:[ \t]*(.+)/i',
+ 'tags' => '/Tags:[ \t]*(.+)/i',
+ 'contributors' => '/Contributors:[ \t]*(.+)/i',
+ 'donate_link' => '/Donate link:[ \t]*(.+)/i',
+ 'license' => '/License:[ \t]*(.+)/i'
+ );
+
+ /**
+ * Is the description a copy of the short description?
+ * @var bool
+ */
+ protected $_is_excerpt = false;
+
+ /**
+ * Was the short description truncated to 150 characters?
+ * @var bool
+ */
+ protected $_is_truncated = false;
+
+ /**
+ * Short description of the plugin
+ * @var string
+ */
+ protected $_short_description = '';
+
+ /**
+ * List of the plugin's screenshots
+ * @var array
+ */
+ protected $_screenshots = array();
+
+ /**
+ * Content outside of the standard sections
+ * @var string
+ */
+ protected $_remaining_content = '';
+
+ /**
+ * Upgrade notices for users
+ * Key = version, value = message. Example:
+ * 1.0 => Please upgrade
+ * 1.1 => Dire security bug
+ * 1.2 => Minor UI issue
+ * @var array
+ */
+ protected $_upgrade_notice = array();
+
+ /**
+ * Allowed tags in sections
+ * @var array
+ */
+ private $_allowed_tags = array(
+ 'a' => array(
+ 'href' => array(),
+ 'title' => array(),
+ 'rel' => array()
+ ),
+ 'blockquote' => array( 'cite' => array() ),
+ 'br' => array(),
+ 'cite' => array(),
+ 'p' => array(),
+ 'code' => array(),
+ 'pre' => array(),
+ 'em' => array(),
+ 'strong' => array(),
+ 'ul' => array(),
+ 'ol' => array(),
+ 'li' => array(),
+ 'h3' => array(),
+ 'h4' => array()
+ );
+
+ /**
+ * Parse a plugin's readme.txt file. Expects a path to the file.
+ * @param string $file
+ * @return string
+ */
+ public function parse_readme_file ( $file ) {
+ if ( !file_exists( $file ) ) {
+ throw new Exception('File not found');
+ }
+ $this->_readme_contents = file_get_contents( $file );
+ return $this->_parse_readme();
+ }
+
+ /**
+ * Parse a plugin's readme.txt. Expect's the file contents as string.
+ * @param type $file_contents
+ * @return type
+ */
+ public function parse_readme_contents( $file_contents ) {
+ $this->_readme_contents = $file_contents;
+ return $this->_parse_readme();
+ }
+
+ /**
+ * Extract sections
+ * @return array
+ */
+ private function _exract_sections( ) {
+ $ret = array();
+
+ $sections = preg_split( '/^[\s]*==[\s]*(.+?)[\s]*==/m', $this->_readme_contents, -1, PREG_SPLIT_DELIM_CAPTURE|PREG_SPLIT_NO_EMPTY );
+
+ // Check if the first element is a short description
+ $this->_short_description = '';
+ $this->_is_truncated = false;
+ $this->_is_excerpt = true;
+ if ( '==' != substr($sections[0][0], 0, 2) ) {
+ $short_description = array_shift( $sections );
+
+ // If the user doesn't include a full description, this will be used, not truncated, and converted to markdown. If they
+ // do include a full description, this field will be overwritten
+ $ret['description'] = $this->_markdown( $short_description );
+
+ $short_description = $this->_sanitize_text( $short_description );
+ if ( strlen( $short_description ) > 150 )
+ $this->_is_truncated = true;
+ $this->_short_description = substr( $short_description, 0, 150 );
+ }
+
+ // Sanitize titles / sections
+ for ( $i = 0 ; $i < count( $sections ) ; $i += 2 ) {
+ $title = $this->_sanitize_text( $sections[$i] );
+ $contents = preg_replace( '/^[\s]*=[\s]+(.+?)[\s]+=/m', '
$1
', $sections[$i+1] );
+ $contents = $this->_markdown( $contents );
+ $ret[$title] = $contents;
+ if ( $this->_is_excerpt && 'description' == strtolower( strip_tags( $title ) ) )
+ $this->_is_excerpt = false;
+ }
+
+ // Remove the sections from the readme file
+ $this->_readme_contents = trim( str_replace( $sections, '', $this->_readme_contents ) );
+
+ // Done
+ return $this->_process_sections( $ret );
+ }
+
+ /**
+ * Post-process sections
+ * Any special business logic (e.g. change_log -> changelog) is done here
+ * @param array $sections
+ * @return array
+ */
+ private function _process_sections( $sections ) {
+
+ // Rename sections to lower-case-underscore notation relegate non-special
+ // content to the "remaining content" section
+ $_sections = array();
+ $this->_remaining_content = '';
+ foreach ( (array) $sections as $k => $v ) {
+ $name = strtolower( preg_replace( '/[^a-zA-Z_]/', '_', $k ) );
+ $_sections[$name] = $v;
+
+ // Is this "remaining content" ?
+ if ( !in_array( $name, $this->_special_sections ) ) {
+ $title_id = esc_attr( $k );
+ $title_id = str_replace( ' ', '-', $title_id );
+ $this->_remaining_content .= sprintf("\n
%s
\n%s", $name, $k, $v);
+ }
+ }
+ $sections = $_sections;
+
+ // Upgrade notice section
+ $this->_upgrade_notice = array();
+ if ( array_key_exists( 'upgrade_notice', $sections ) ) {
+ $upgrade_notice = array();
+ $notices = preg_split( '/
(.*?)<\/h4>/', $sections['upgrade_notice'], -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY );
+ if ( empty( $notices ) && count( $notices ) > 1 ) {
+ for ( $i = 0 ; $i < count( $notices ) ; $i += 2 )
+ $upgrade_notice[$notices[$i]] = substr( $this->_sanitize_text( @$notices[$i+1] ), 0, 300 );
+ } elseif ( is_array( $notices ) && 1 == count( $notices ) ) {
+ $upgrade_notice[ $this->_stable_tag ] = $notices[0];
+ }
+ $this->_upgrade_notice = $upgrade_notice;
+ unset( $sections['upgrade_notice'] );
+ }
+
+ // Screenshots
+ $this->_screenshots = array();
+ if ( array_key_exists( 'screenshots', $sections ) ) {
+ preg_match_all( '/
(.*?)<\/li>/s', $sections['screenshots'], $screenshots, PREG_SET_ORDER);
+ if ( $screenshots ) {
+ foreach ( (array) $screenshots as $screenshot )
+ $this->_screenshots[] = $screenshot[1];
+ }
+ }
+
+ // Fix change_log -> changelog
+ if ( array_key_exists( 'change_log', $sections ) )
+ $sections['changelog'] = $sections['change_log'];
+
+ return $sections;
+ }
+
+ /**
+ * Post-process records
+ * Any special business logic (e.g. splitting tags, contributors) is done here
+ * @param array $records
+ * @return array
+ */
+ private function _process_records( $records ) {
+
+ // Escape donate link URL
+ if ( !empty( $records['donate_link'] ) )
+ $records['donate_link'] = esc_url( $records['donate_link'] );
+
+ // Split up tags
+ $tags = preg_split('/,[\s]*?/', trim( $records['tags'] ) );
+ foreach ( (array) $tags as $k => $v ) {
+ $v = $this->_sanitize_text( $v );
+ if ( !empty( $v ) )
+ $tags[$k] = $this->_sanitize_text( $v );
+ else
+ unset( $tags[$k] );
+ }
+ $records['tags'] = $tags;
+
+ // Split up contributors
+ $contributors = preg_split( '/,[\s]*/', trim( $records['contributors'] ) );
+ foreach ( (array) $contributors as $k => $v ) {
+ $v = $this->_sanitize_text( $v );
+ if ( !empty( $v ) )
+ $contributors[$k] = sanitize_user( $v );
+ else
+ unset( $contributors[$k] );
+ }
+ $records['contributors'] = $contributors;
+
+ // Assign records to object properties
+ foreach ( (array) $records as $k => $v )
+ if (in_array( $k , array_keys( $this->_keys ) ) )
+ $this->{"_$k"} = $v;
+
+ // Done
+ return $records;
+ }
+
+ /**
+ * Extract key-value pairs
+ * @return array
+ */
+ private function _extract_records( ) {
+ $ret = array();
+ foreach ( (array) $this->_keys as $k => $v ) {
+ if ( preg_match( $v, $this->_readme_contents, $matches ) ) {
+ $ret[$k] = $this->_sanitize_text( $matches[1] );
+ $this->_readme_contents = trim( str_replace( $matches[0], '', $this->_readme_contents ) );
+ }
+ }
+ return $this->_process_records( $ret );
+ }
+
+ /**
+ * Parse a readme file into an associative array
+ * @return string
+ */
+ protected function _parse_readme() {
+
+ // Normalize white-space
+ $file_contents = str_replace( array( "\r\n", "\r" ), "\n", $this->_readme_contents );
+ $this->_readme_contents = trim( $this->_readme_contents );
+
+ // Remove UTF-8 byte-order-mark
+ if ( 0 === strpos( $this->_readme_contents, "\xEF\xBB\xBF" ) )
+ $this->_readme_contents = substr( $this->_readme_contents, 3 );
+
+ // === Plugin Name ===
+ // Must be the very first thing.
+ if ( !preg_match( '/^===(.*)===/', $this->_readme_contents, $_name ) )
+ return array(); // require a name
+ $name = trim( $_name[1], '=' );
+ $name = $this->_sanitize_text( $name );
+ $this->_readme_contents = str_replace( $_name[0], '', $this->_readme_contents );
+
+ // Extract the "key: value" records to the local scope
+ extract( $this->_extract_records() );
+
+ // Extract the sections (e.g. == HEADING == .... text ...)
+ $sections = $this->_exract_sections();
+ extract( $sections );
+
+ // Compile the final array
+ return array(
+ 'name' => isset( $name ) ? $name : '',
+ 'tags' => isset( $tags ) ? $tags : array(),
+ 'requires_at_least' => isset( $requires_at_least ) ? $requires_at_least : '',
+ 'tested_up_to' => isset( $tested_up_to ) ? $tested_up_to : '',
+ 'stable_tag' => isset( $stable_tag ) ? $stable_tag : 'trunk',
+ 'contributors' => isset( $contributors ) ? $contributors : array(),
+ 'donate_link' => isset( $donate_link ) ? $donate_link : '',
+ 'short_description' => $this->_short_description,
+ 'screenshots' => $this->_screenshots,
+ 'is_excerpt' => $this->_is_excerpt,
+ 'is_truncated' => $this->_is_truncated,
+ 'sections' => $sections,
+ 'remaining_content' => $this->_remaining_content,
+ 'upgrade_notice' => $this->_upgrade_notice
+ );
+ }
+
+ /**
+ * Make the text safe for use in a browser
+ * @param string $text
+ * @return string
+ */
+ private function _sanitize_text( $text ) {
+ $text = strip_tags( $text );
+ $text = esc_html( $text );
+ $text = trim( $text );
+ return $text;
+ }
+
+ /**
+ * Format text. Use markdown, with some extra code -> backtick formatting.
+ * @param type $text
+ * @return type
+ */
+ private function _markdown( $text ) {
+ $text = trim( $text );
+ $text = $this->_convert_code( $text );
+ $text = Markdown( $text );
+ $text = balanceTags( $text );
+ $text = wp_kses( $text, $this->_allowed_tags );
+ $text = trim( $text );
+ return $text;
+ }
+
+ /**
+ * First take any user formatted code blocks and turn them into backticks so that
+ * markdown will preserve things like underscores in code blocks
+ * @param type $text
+ * @param type $markdown
+ * @return type
+ */
+ private function _convert_code( $text ) {
+ $text = preg_replace_callback( '/(|)(.*?)(<\/code>\/pre>|<\/code>)/s', array( $this, '_decodeit' ), $text );
+ $text = str_replace( array("\r\n", "\r"), "\n", $text );
+ // Markdown seems to be choking on block level stuff too. Let's just encode it and be done with it.
+ $text = preg_replace_callback( '/(^|\n)`(.*?)`/s', array( $this, '_encodeit' ), $text );
+ return $text;
+ }
+
+ /**
+ * Encode Markdown to HTML
+ * @param array $matches Output from preg_replace_callback
+ * @return string
+ */
+ private function _encodeit( $matches ) {
+ $text = trim( $matches[2] );
+ $text = htmlspecialchars( $text, ENT_QUOTES );
+ $text = str_replace( array( "\r\n", "\r" ), "\n", $text );
+ $text = preg_replace( "|\n\n\n+|", "\n\n", $text );
+ $text = str_replace(
+ array( '<', '&> ' ),
+ array( '<' , '>' ),
+ $text
+ );
+ $text = "$text";
+ if ( "`" != $matches[1] )
+ $text = "$text
";
+ return $text;
+ }
+
+ /**
+ * De-code HTML, turn it back into markdown
+ * @param array $matches Output from preg_replace_callback
+ * @return string
+ */
+ private function _decodeit( $matches ) {
+ $text = $matches[2];
+ $text = html_entity_decode( $text );
+ $text = str_replace(
+ array( '
', '&', '''),
+ array( '' , '&' , "'" ),
+ $text
+ );
+ if ( '' == $matches[1] )
+ $text = "\n$text\n";
+ return "`$text`";
+ }
+}