<!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>[20229] trunk/wp-admin/includes/plugin.php: Clean up get_plugin_data() and _get_plugin_data_markup_translate(), and standardize sanitization.</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, #logmsg > ol { margin-left: 0; 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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/20229">20229</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2012-03-20 23:04:59 +0000 (Tue, 20 Mar 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Clean up get_plugin_data() and _get_plugin_data_markup_translate(), and standardize sanitization. fixes <a href="http://core.trac.wordpress.org/ticket/20266">#20266</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludespluginphp">trunk/wp-admin/includes/plugin.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludespluginphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/plugin.php (20228 => 20229)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/plugin.php 2012-03-20 22:16:13 UTC (rev 20228)
+++ trunk/wp-admin/includes/plugin.php 2012-03-20 23:04:59 UTC (rev 20229)
</span><span class="lines">@@ -65,8 +65,8 @@
</span><span class="cx"> * @since 1.5.0
</span><span class="cx"> *
</span><span class="cx"> * @param string $plugin_file Path to the plugin file
</span><del>- * @param bool $markup If the returned data should have HTML markup applied
- * @param bool $translate If the returned data should be translated
</del><ins>+ * @param bool $markup Optional. If the returned data should have HTML markup applied. Defaults to true.
+ * @param bool $translate Optional. If the returned data should be translated. Defaults to true.
</ins><span class="cx"> * @return array See above for description.
</span><span class="cx"> */
</span><span class="cx"> function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
</span><span class="lines">@@ -88,30 +88,36 @@
</span><span class="cx"> $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
</span><span class="cx">
</span><span class="cx"> // Site Wide Only is the old header for Network
</span><del>- if ( empty( $plugin_data['Network'] ) && ! empty( $plugin_data['_sitewide'] ) ) {
</del><ins>+ if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
</ins><span class="cx"> _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The <code>%1$s</code> plugin header is deprecated. Use <code>%2$s</code> instead.' ), 'Site Wide Only: true', 'Network: true' ) );
</span><span class="cx"> $plugin_data['Network'] = $plugin_data['_sitewide'];
</span><span class="cx"> }
</span><span class="cx"> $plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
</span><span class="cx"> unset( $plugin_data['_sitewide'] );
</span><span class="cx">
</span><del>- //For backward compatibility by default Title is the same as Name.
- $plugin_data['Title'] = $plugin_data['Name'];
-
- if ( $markup || $translate )
</del><ins>+ if ( $markup || $translate ) {
</ins><span class="cx"> $plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
</span><del>- else
</del><ins>+ } else {
+ $plugin_data['Title'] = $plugin_data['Name'];
</ins><span class="cx"> $plugin_data['AuthorName'] = $plugin_data['Author'];
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return $plugin_data;
</span><span class="cx"> }
</span><span class="cx">
</span><del>-function _get_plugin_data_markup_translate($plugin_file, $plugin_data, $markup = true, $translate = true) {
</del><ins>+/**
+ * Sanitizes plugin data, optionally adds markup, optionally translates.
+ *
+ * @since 2.7.0
+ * @access private
+ * @see get_plugin_data()
+ */
+function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
</ins><span class="cx">
</span><del>- //Translate fields
</del><ins>+ // Translate fields
</ins><span class="cx"> if ( $translate ) {
</span><span class="cx"> if ( $textdomain = $plugin_data['TextDomain'] ) {
</span><del>- if ( ! empty( $plugin_data['DomainPath'] ) )
</del><ins>+ if ( $plugin_data['DomainPath'] )
</ins><span class="cx"> load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );
</span><span class="cx"> else
</span><span class="cx"> load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );
</span><span class="lines">@@ -124,38 +130,44 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $plugins_allowedtags = array(
- 'a' => array( 'href' => array(), 'title' => array() ),
- 'abbr' => array( 'title' => array() ),
- 'acronym' => array( 'title' => array() ),
- 'code' => array(),
- 'em' => array(),
- 'strong' => array(),
</del><ins>+ // Sanitize fields
+ $allowed_tags = $allowed_tags_in_links = array(
+ 'abbr' => array( 'title' => true ),
+ 'acronym' => array( 'title' => true ),
+ 'code' => true,
+ 'em' => true,
+ 'strong' => true,
</ins><span class="cx"> );
</span><ins>+ $allowed_tags['a'] = array( 'href' => true, 'title' => true );
</ins><span class="cx">
</span><del>- $plugin_data['AuthorName'] = $plugin_data['Author'] = wp_kses( $plugin_data['Author'], $plugins_allowedtags );
</del><ins>+ // Name is marked up inside <a> tags. Don't allow these.
+ // Author is too, but some plugins have used <a> here (omitting Author URI).
+ $plugin_data['Name'] = wp_kses( $plugin_data['Name'], $allowed_tags_in_links );
+ $plugin_data['Author'] = wp_kses( $plugin_data['Author'], $allowed_tags );
</ins><span class="cx">
</span><del>- //Apply Markup
</del><ins>+ $plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags );
+ $plugin_data['Version'] = wp_kses( $plugin_data['Version'], $allowed_tags );
+
+ $plugin_data['PluginURI'] = esc_url( $plugin_data['PluginURI'] );
+ $plugin_data['AuthorURI'] = esc_url( $plugin_data['AuthorURI'] );
+
+ $plugin_data['Title'] = $plugin_data['Name'];
+ $plugin_data['AuthorName'] = $plugin_data['Author'];
+
+ // Apply markup
</ins><span class="cx"> if ( $markup ) {
</span><del>- if ( ! empty($plugin_data['PluginURI']) && ! empty($plugin_data['Name']) )
</del><ins>+ if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )
</ins><span class="cx"> $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin homepage' ) . '">' . $plugin_data['Name'] . '</a>';
</span><del>- else
- $plugin_data['Title'] = $plugin_data['Name'];
</del><span class="cx">
</span><del>- if ( ! empty($plugin_data['AuthorURI']) && ! empty($plugin_data['Author']) )
</del><ins>+ if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )
</ins><span class="cx"> $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '" title="' . esc_attr__( 'Visit author homepage' ) . '">' . $plugin_data['Author'] . '</a>';
</span><span class="cx">
</span><span class="cx"> $plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
</span><del>- if ( ! empty($plugin_data['Author']) )
- $plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s'), $plugin_data['Author'] ) . '.</cite>';
</del><ins>+
+ if ( $plugin_data['Author'] )
+ $plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '</cite>';
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- // Sanitize all displayed data. Author and AuthorName sanitized above.
- $plugin_data['Title'] = wp_kses( $plugin_data['Title'], $plugins_allowedtags );
- $plugin_data['Version'] = wp_kses( $plugin_data['Version'], $plugins_allowedtags );
- $plugin_data['Description'] = wp_kses( $plugin_data['Description'], $plugins_allowedtags );
- $plugin_data['Name'] = wp_kses( $plugin_data['Name'], $plugins_allowedtags );
-
</del><span class="cx"> return $plugin_data;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>