<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[2969] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory: Plugin Directory: Readme Parser: Support readme's which have line breaks between the headers, invalid headers, and also which never list the plugin name in the readme.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/2969">2969</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/2969","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-04-18 06:07:23 +0000 (Mon, 18 Apr 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Plugin Directory: Readme Parser: Support readme's which have line breaks between the headers, invalid headers, and also which never list the plugin name in the readme.
Example:
{{{
=== Plugin Name ===
Contributors: me, A user who doesn't exist
Version 1337
Tags: super, awesome, plugin
This is a plugin that does pretty amazing things!
}}}</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassreadmeparserphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-readme-parser.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassimportphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassreadmeparserphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-readme-parser.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-readme-parser.php 2016-04-18 05:03:32 UTC (rev 2968)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-readme-parser.php 2016-04-18 06:07:23 UTC (rev 2969)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -40,6 +40,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'screenshot' => 'screenshots',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // These are the valid header mappings for the header
+ private $valid_headers = array(
+ 'tested' => 'tested',
+ 'tested up to' => 'tested',
+ 'requires' => 'requires',
+ 'requires at least' => 'requires',
+ 'tags' => 'tags',
+ 'contributors' => 'contributors',
+ 'donate_link' => 'donate_link',
+ 'stable_tag' => 'stable_tag',
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $file ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->parse_readme( $file );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,7 +76,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Handle readme's which do `=== Plugin Name ===\nMy SuperAwesomePlugin Name\n...`
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'plugin name' == strtolower( $this->name ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->name = $this->get_first_nonwhitespace( $contents );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->name = $line = $this->get_first_nonwhitespace( $contents );
+ // Ensure that the line read wasn't an actual header
+ if ( preg_match( '~^(' . implode( '|', array_keys( $this->valid_headers ) ) . ')\s*:~i', $line ) ) {
+ $this->name = false;
+ array_unshift( $contents, $line );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Parse headers
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -74,27 +91,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do {
</span><span class="cx" style="display: block; padding: 0 10px"> $key = $value = null;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( strpos( $line, ':' ) === false ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- break;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Some plugins have line-breaks within the headers.
+ if ( ! empty( $line ) ) {
+ break;
+ } else {
+ continue;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bits = explode( ':', $line, 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $bits = explode( ':', trim( $line ), 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> list( $key, $value ) = $bits;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $key = strtolower( str_replace( ' ', '_', trim( $key, " \t*-" ) ) );
- $headers[ $key ] = trim( $value );
- } while ( ( $line = array_shift( $contents ) ) !== null && ( $line = trim( $line ) ) && ! empty( $line ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $key = strtolower( trim( $key, " \t*-\r\n" ) );
+ if ( isset( $this->valid_headers[ $key ] ) ) {
+ $headers[ $this->valid_headers[ $key ] ] = trim( $value );
+ }
+ } while ( ( $line = array_shift( $contents ) ) !== null );
</ins><span class="cx" style="display: block; padding: 0 10px"> array_unshift( $contents, $line );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['tags'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tags = explode( ',', $headers['tags'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->tags = array_map( 'trim', $this->tags );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $headers['requires_at_least'] ) ) {
- $this->requires = $headers['requires_at_least'];
- } elseif ( ! empty( $headers['requires'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $headers['requires'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->requires = $headers['requires'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $headers['tested_up_to'] ) ) {
- $this->tested = $headers['tested_up_to'];
- } elseif ( ! empty( $headers['tested'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $headers['tested'] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->tested = $headers['tested'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $headers['contributors'] ) ) {
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorycliclassimportphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2016-04-18 05:03:32 UTC (rev 2968)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/cli/class-import.php 2016-04-18 06:07:23 UTC (rev 2969)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,7 +76,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $content .= "\n\n<!--section={$section}-->\n{$section_content}";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $plugin->post_title = trim( $readme->name );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Fallback to the plugin title if the readme didn't contain it.
+ $plugin->post_title = trim( $readme->name ) ?: strip_tags( $headers->Name );
</ins><span class="cx" style="display: block; padding: 0 10px"> $plugin->post_content = trim( $content );
</span><span class="cx" style="display: block; padding: 0 10px"> $plugin->post_excerpt = trim( $readme->short_description );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -179,7 +180,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $filename = $asset['filename'];
</span><span class="cx" style="display: block; padding: 0 10px"> $revision = $asset['revision'];
</span><span class="cx" style="display: block; padding: 0 10px"> $location = 'assets';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $resolution = $m['resolution'] ?: false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $resolution = isset( $m['resolution'] ) ? $m['resolution'] : false;
</ins><span class="cx" style="display: block; padding: 0 10px"> $assets[ $type ][ $asset['filename'] ] = compact( 'filename', 'revision', 'resolution', 'location' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>