<!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>[41697] trunk: Customize: Provide validation feedback for invalid Custom Link URLs in nav menu items.</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/41697">41697</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/41697","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-03 03:43:01 +0000 (Tue, 03 Oct 2017)</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'>Customize: Provide validation feedback for invalid Custom Link URLs in nav menu items.
Props RMarks, EGregor, umangvaghela123, andrew.taylor, celloexpressions, westonruter, voldemortensen.
Fixes <a href="https://core.trac.wordpress.org/ticket/32816">#32816</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincsscustomizenavmenuscss">trunk/src/wp-admin/css/customize-nav-menus.css</a></li>
<li><a href="#trunksrcwpadminjscustomizenavmenusjs">trunk/src/wp-admin/js/customize-nav-menus.js</a></li>
<li><a href="#trunksrcwpincludescustomizeclasswpcustomizenavmenuitemsettingphp">trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php</a></li>
<li><a href="#trunktestsphpunittestscustomizenavmenuitemsettingphp">trunk/tests/phpunit/tests/customize/nav-menu-item-setting.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincsscustomizenavmenuscss"></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/css/customize-nav-menus.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/css/customize-nav-menus.css 2017-10-03 02:59:03 UTC (rev 41696)
+++ trunk/src/wp-admin/css/customize-nav-menus.css 2017-10-03 03:43:01 UTC (rev 41697)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -559,6 +559,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> #custom-menu-item-name.invalid,
</span><span class="cx" style="display: block; padding: 0 10px"> #custom-menu-item-url.invalid,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+.edit-menu-item-url.invalid,
</ins><span class="cx" style="display: block; padding: 0 10px"> .menu-name-field.invalid,
</span><span class="cx" style="display: block; padding: 0 10px"> .menu-name-field.invalid:focus,
</span><span class="cx" style="display: block; padding: 0 10px"> #available-menu-items .new-content-item .create-item-input.invalid,
</span></span></pre></div>
<a id="trunksrcwpadminjscustomizenavmenusjs"></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/js/customize-nav-menus.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-nav-menus.js 2017-10-03 02:59:03 UTC (rev 41696)
+++ trunk/src/wp-admin/js/customize-nav-menus.js 2017-10-03 03:43:01 UTC (rev 41697)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -535,23 +535,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> submitLink: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var menuItem,
</span><span class="cx" style="display: block; padding: 0 10px"> itemName = $( '#custom-menu-item-name' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- itemUrl = $( '#custom-menu-item-url' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ itemUrl = $( '#custom-menu-item-url' ),
+ urlRegex,
+ urlValue;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! this.currentMenuControl ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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">+ /*
+ * Copyright (c) 2010-2013 Diego Perini, MIT licensed
+ * https://gist.github.com/dperini/729294
+ * see also https://mathiasbynens.be/demo/url-regex
+ * modified to allow protocol-relative URLs
+ */
+ urlRegex = /^(?:(?:(?:https?|ftp):)?\/\/)(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,})).?)(?::\d{2,5})?(?:[/?#]\S*)?$/i;
+
+ urlValue = itemUrl.val();
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( '' === itemName.val() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> itemName.addClass( 'invalid' );
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } else if ( '' === itemUrl.val() || 'http://' === itemUrl.val() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else if ( '' === urlValue || 'http://' === urlValue || ! ( '/' === urlValue[0] || urlRegex.test( urlValue ) ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> itemUrl.addClass( 'invalid' );
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</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"> menuItem = {
</span><span class="cx" style="display: block; padding: 0 10px"> 'title': itemName.val(),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'url': itemUrl.val(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'url': urlValue,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'type': 'custom',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type_label': api.Menus.data.l10n.custom_label,
</span><span class="cx" style="display: block; padding: 0 10px"> 'object': 'custom'
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1387,7 +1398,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> _setupUpdateUI: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var control = this,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- settingValue = control.setting();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ settingValue = control.setting(),
+ updateNotifications;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> control.elements = {};
</span><span class="cx" style="display: block; padding: 0 10px"> control.elements.url = new api.Element( control.container.find( '.edit-menu-item-url' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1470,6 +1482,13 @@
</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">+
+ // Style the URL field as invalid when there is an invalid_url notification.
+ updateNotifications = function() {
+ control.elements.url.element.toggleClass( 'invalid', control.setting.notifications.has( 'invalid_url' ) );
+ };
+ control.setting.notifications.bind( 'add', updateNotifications );
+ control.setting.notifications.bind( 'removed', updateNotifications );
</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></span></pre></div>
<a id="trunksrcwpincludescustomizeclasswpcustomizenavmenuitemsettingphp"></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/customize/class-wp-customize-nav-menu-item-setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php 2017-10-03 02:59:03 UTC (rev 41696)
+++ trunk/src/wp-includes/customize/class-wp-customize-nav-menu-item-setting.php 2017-10-03 03:43:01 UTC (rev 41697)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -641,8 +641,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $menu_item_value The value to sanitize.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array|false|null Null if an input isn't valid. False if it is marked for deletion.
- * Otherwise the sanitized value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array|false|null|WP_Error Null or WP_Error if an input isn't valid. False if it is marked for deletion.
+ * Otherwise the sanitized value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function sanitize( $menu_item_value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Menu is marked for deletion.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -701,7 +701,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_item_value['attr_title'] = wp_unslash( apply_filters( 'excerpt_save_pre', wp_slash( $menu_item_value['attr_title'] ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_item_value['description'] = wp_unslash( apply_filters( 'content_save_pre', wp_slash( $menu_item_value['description'] ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $menu_item_value['url'] = esc_url_raw( $menu_item_value['url'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( '' !== $menu_item_value['url'] ) {
+ $menu_item_value['url'] = esc_url_raw( $menu_item_value['url'] );
+ if ( '' === $menu_item_value['url'] ) {
+ return new WP_Error( 'invalid_url', __( 'Invalid URL.' ) ); // Fail sanitization if URL is invalid.
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'publish' !== $menu_item_value['status'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $menu_item_value['status'] = 'draft';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizenavmenuitemsettingphp"></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/customize/nav-menu-item-setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/nav-menu-item-setting.php 2017-10-03 02:59:03 UTC (rev 41696)
+++ trunk/tests/phpunit/tests/customize/nav-menu-item-setting.php 2017-10-03 03:43:01 UTC (rev 41697)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -472,6 +472,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( $setting->sanitize( 'not an array' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( $setting->sanitize( 123 ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $valid_urls = array(
+ 'http://example.com/',
+ 'https://foo.example.com/hello.html',
+ 'mailto:nobody@example.com?subject=hi',
+ 'ftp://example.com/',
+ 'ftps://example.com/',
+ 'news://news.server.example/example.group.this',
+ 'irc://irc.freenode.net/wordpress',
+ 'gopher://example.com',
+ 'nntp://news.server.example/example.group.this',
+ 'feed://example.com/',
+ 'telnet://example.com',
+ 'mms://example.com',
+ 'rtsp://example.com/',
+ 'svn://develop.svn.wordpress.org/trunk',
+ 'tel:000-000-000',
+ 'fax:000-000-000',
+ 'xmpp:user@host?message',
+ 'webcal://example.com',
+ 'urn:org.wordpress',
+ );
+ foreach ( $valid_urls as $valid_url ) {
+ $url_setting = $setting->sanitize( array( 'url' => $valid_url ) );
+ $this->assertInternalType( 'array', $url_setting );
+ $this->assertEquals( $valid_url, $url_setting['url'] );
+ }
+
+ $invalid_urls = array(
+ 'javascript:alert(1)',
+ 'unknown://something.out-there',
+ 'smtp://user:pass@mailserver.thing',
+ );
+ foreach ( $invalid_urls as $invalid_url ) {
+ $url_setting = $setting->sanitize( array( 'url' => $invalid_url ) );
+ $this->assertInstanceOf( 'WP_Error', $url_setting );
+ $this->assertEquals( 'invalid_url', $url_setting->get_error_code() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $unsanitized = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'object_id' => 'bad',
</span><span class="cx" style="display: block; padding: 0 10px"> 'object' => '<b>hello</b>',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -479,7 +517,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'position' => -123,
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'custom<b>',
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => '\o/ o\'o Hi<script>unfilteredHtml()</script>',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'url' => 'javascript:alert(1)',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'url' => '', // Note the javascript: protocol is checked above and results in a hard validation error, beyond mere sanitization.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'target' => '" onclick="',
</span><span class="cx" style="display: block; padding: 0 10px"> 'attr_title' => '\o/ o\'o <b>bolded</b><script>unfilteredHtml()</script>',
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => '\o/ o\'o <b>Hello world</b><script>unfilteredHtml()</script>',
</span></span></pre>
</div>
</div>
</body>
</html>