<!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>[13162] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php: Plugin Directory: Readme: Parse readme's that lack a plugin header.</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 { white-space: pre-line; 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/13162">13162</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/13162","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>2024-02-01 04:11:12 +0000 (Thu, 01 Feb 2024)</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: Parse readme's that lack a plugin header.
Fixes <a href="http://meta.trac.wordpress.org/ticket/7428">#7428</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryreadmeclassparserphp"></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/readme/class-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/readme/class-parser.php 2024-01-31 15:30:40 UTC (rev 13161)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/readme/class-parser.php 2024-02-01 04:11:12 UTC (rev 13162)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -227,15 +227,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'plugin name' == strtolower( $this->name ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->warnings['invalid_plugin_name_header'] = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->name = $line = $this->get_first_nonwhitespace( $contents );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->name = false;
+ $line = $this->get_first_nonwhitespace( $contents );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Ensure that the line read wasn't an actual header or description.
- if ( strlen( $line ) > 50 || preg_match( '~^(' . implode( '|', array_keys( $this->valid_headers ) ) . ')\s*:~i', $line ) ) {
- $this->name = false;
- array_unshift( $contents, $line );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure that the line read doesn't look like a description.
+ if ( strlen( $line ) < 50 && ! $this->parse_possible_header( $line, true /* only valid headers */ ) ) {
+ $this->name = $this->sanitize_text( trim( $line, "#= \t\0\x0B" ) );
</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">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // It's possible to leave the plugin name header off entirely.
+ if ( $this->parse_possible_header( $this->name, true /* only valid headers */ ) ) {
+ array_unshift( $contents, $line );
+
+ $this->warnings['invalid_plugin_name_header'] = true;
+ $this->name = false;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Parse headers.
</span><span class="cx" style="display: block; padding: 0 10px"> $headers = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -242,9 +250,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $line = $this->get_first_nonwhitespace( $contents );
</span><span class="cx" style="display: block; padding: 0 10px"> $last_line_was_blank = false;
</span><span class="cx" style="display: block; padding: 0 10px"> do {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $value = null;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = null;
+ $header = $this->parse_possible_header( $line );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If it doesn't look like a header value, maybe break to the next section.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! str_contains( $line, ':' ) || str_starts_with( $line, '#' ) || str_starts_with( $line, '=' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $header ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $line ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Some plugins have line-breaks within the headers...
</span><span class="cx" style="display: block; padding: 0 10px"> $last_line_was_blank = true;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -255,12 +265,10 @@
</span><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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $bits = explode( ':', trim( $line ), 2 );
- list( $key, $value ) = $bits;
- $key = strtolower( trim( $key, " \t*-\r\n" ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ list( $key, $value ) = $header;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $this->valid_headers[ $key ] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $headers[ $this->valid_headers[ $key ] ] = trim( $value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $headers[ $this->valid_headers[ $key ] ] = $value;
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $last_line_was_blank ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // If we skipped over a blank line, and then ended up with an unexpected header, assume we parsed too far and ended up in the Short Description.
</span><span class="cx" style="display: block; padding: 0 10px"> // This final line will be added back into the stack after the loop for further parsing.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -522,8 +530,33 @@
</span><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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Parse a line to see if it's a header.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access protected
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $line The line from the readme to parse.
+ * @param bool $only_valid Whether to only return a valid known header.
+ * @return false|array
+ */
+ protected function parse_possible_header( $line, $only_valid = false ) {
+ if ( ! str_contains( $line, ':' ) || str_starts_with( $line, '#' ) || str_starts_with( $line, '=' ) ) {
+ return false;
+ }
+
+ list( $key, $value ) = explode( ':', $line, 2 );
+ $key = strtolower( trim( $key, " \t*-\r\n" ) );
+ $value = trim( $value, " \t*-\r\n" );
+
+ if ( $only_valid && ! isset( $this->valid_headers[ $key ] ) ) {
+ return false;
+ }
+
+ return [ $key, $value ];
+ }
+
+ /**
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $text
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>