<!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>[37747] trunk: Permalinks: Validate custom permalink structures.</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="https://core.trac.wordpress.org/changeset/37747">37747</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37747","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>swissspidy</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-06-19 12:01:11 +0000 (Sun, 19 Jun 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'>Permalinks: Validate custom permalink structures.
Custom permalink structures require at least one valid structure tag, e.g. `%postname%`. If none is included, it would leave users with broken permalinks.
Let's make sure this won't happen by validating the permalink structure.
Adds unit tests.
Props rockwell15 for initial patch.
Fixes <a href="https://core.trac.wordpress.org/ticket/35936">#35936</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminoptionspermalinkphp">trunk/src/wp-admin/options-permalink.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunktestsphpunittestsoptionsanitizeoptionphp">trunk/tests/phpunit/tests/option/sanitize-option.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminoptionspermalinkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/options-permalink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/options-permalink.php 2016-06-18 10:09:26 UTC (rev 37746)
+++ trunk/src/wp-admin/options-permalink.php 2016-06-19 12:01:11 UTC (rev 37747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -82,6 +82,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> else
</span><span class="cx" style="display: block; padding: 0 10px"> $permalink_structure = $blog_prefix . $permalink_structure;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $permalink_structure = sanitize_option( 'permalink_structure', $permalink_structure );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_rewrite->set_permalink_structure( $permalink_structure );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,6 +102,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rewrite->set_tag_base( $tag_base );
</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">+ $message = __( 'Permalink structure updated.' );
+
+ if ( $iis7_permalinks ) {
+ if ( $permalink_structure && ! $usingpi && ! $writable ) {
+ $message = __( 'You should update your web.config now.' );
+ } elseif ( $permalink_structure && ! $usingpi && $writable ) {
+ $message = __( 'Permalink structure updated. Remove write access on web.config file now!' );
+ }
+ } elseif ( ! $is_nginx && $permalink_structure && ! $usingpi && ! $writable && $update_required ) {
+ $message = __( 'You should update your .htaccess now.' );
+ }
+
+ if ( ! get_settings_errors() ) {
+ add_settings_error( 'general', 'settings_updated', $message, 'updated' );
+ }
+
+ set_transient( 'settings_errors', get_settings_errors(), 30 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_redirect( admin_url( 'options-permalink.php?settings-updated=true' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -125,42 +146,12 @@
</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">-if ( $wp_rewrite->using_index_permalinks() )
- $usingpi = true;
-else
- $usingpi = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$usingpi = $wp_rewrite->using_index_permalinks();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> flush_rewrite_rules();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> require( ABSPATH . 'wp-admin/admin-header.php' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-if ( ! empty( $_GET['settings-updated'] ) ) : ?>
-<div id="message" class="updated notice is-dismissible"><p><?php
-if ( ! is_multisite() ) {
- if ( $iis7_permalinks ) {
- if ( $permalink_structure && ! $usingpi && ! $writable ) {
- _e('You should update your web.config now.');
- } elseif ( $permalink_structure && ! $usingpi && $writable ) {
- _e('Permalink structure updated. Remove write access on web.config file now!');
- } else {
- _e('Permalink structure updated.');
- }
- } elseif ( $is_nginx ) {
- _e('Permalink structure updated.');
- } else {
- if ( $permalink_structure && ! $usingpi && ! $writable && $update_required ) {
- _e('You should update your .htaccess now.');
- } else {
- _e('Permalink structure updated.');
- }
- }
-} else {
- _e('Permalink structure updated.');
-}
</del><span class="cx" style="display: block; padding: 0 10px"> ?>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-</p></div>
-<?php endif; ?>
-
</del><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="cx" style="display: block; padding: 0 10px"> <h1><?php echo esc_html( $title ); ?></h1>
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2016-06-18 10:09:26 UTC (rev 37746)
+++ trunk/src/wp-includes/formatting.php 2016-06-19 12:01:11 UTC (rev 37747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4204,6 +4204,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = esc_url_raw( $value );
</span><span class="cx" style="display: block; padding: 0 10px"> $value = str_replace( 'http://', '', $value );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( 'permalink_structure' === $option && '' !== $value && ! preg_match( '/%[^\/%]+%/', $value ) ) {
+ $error = sprintf(
+ /* translators: %s: Codex URL */
+ __( 'A structure tag is required when using custom permalinks. <a href="%s">Learn more</a>' ),
+ __( 'https://codex.wordpress.org/Using_Permalinks#Choosing_your_permalink_structure' )
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'default_role' :
</span></span></pre></div>
<a id="trunktestsphpunittestsoptionsanitizeoptionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/option/sanitize-option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/sanitize-option.php 2016-06-18 10:09:26 UTC (rev 37746)
+++ trunk/tests/phpunit/tests/option/sanitize-option.php 2016-06-19 12:01:11 UTC (rev 37747)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,4 +119,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, sanitize_option( 'blogname', $value ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, sanitize_option( 'blogdescription', $value ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @dataProvider permalink_structure_provider
+ */
+ public function test_sanitize_permalink_structure( $provided, $expected, $valid ) {
+ global $wp_settings_errors;
+
+ $old_wp_settings_errors = (array) $wp_settings_errors;
+
+ $actual = sanitize_option( 'permalink_structure', $provided);
+ $errors = get_settings_errors( 'permalink_structure' );
+
+ // Clear errors.
+ $wp_settings_errors = $old_wp_settings_errors;
+
+ if ( $valid ) {
+ $this->assertEmpty( $errors );
+ } else {
+ $this->assertNotEmpty( $errors );
+ $this->assertEquals( 'invalid_permalink_structure', $errors[0]['code'] );
+ }
+
+ $this->assertEquals( $expected, $actual );
+ }
+
+ public function permalink_structure_provider() {
+ return array(
+ array( '', '', true ),
+ array( '%postname', false, false ),
+ array( '%/%', false, false ),
+ array( '%%%', false, false ),
+ array( '%a%', '%a%', true ),
+ array( '%postname%', '%postname%', true ),
+ array( '/%postname%/', '/%postname%/', true ),
+ array( '/%year%/%monthnum%/%day%/%postname%/', '/%year%/%monthnum%/%day%/%postname%/', true ),
+ array( '/%year/%postname%/', '/%year/%postname%/', true ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>