<!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>[57061] trunk/src: Coding Standards: Remove unnecessary ignore annotations in `dbDelta()`.</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="https://core.trac.wordpress.org/changeset/57061">57061</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/57061","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-11-04 00:24:33 +0000 (Sat, 04 Nov 2023)</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'>Coding Standards: Remove unnecessary ignore annotations in `dbDelta()`.
It is perfectly possible to write a commented regex with layout for readability by using the `x` modifier.
As per the manual:
> x (`PCRE_EXTENDED`)
>
> If this modifier is set, whitespace data characters in the pattern are totally ignored except when escaped or inside a character class, and characters between an unescaped # outside a character class and the next newline character, inclusive, are also ignored. This is equivalent to Perl's /x modifier, and makes it possible to include commentary inside complicated patterns.
>
> Note, however, that this applies only to data characters. Whitespace characters may never appear within special character sequences in a pattern, for example within the sequence (?( which introduces a conditional subpattern.
Reference: [https://www.php.net/manual/en/reference.pcre.pattern.modifiers.php PHP Manual: Pattern Modifiers].
This commit rewrites these two regexes to use the `x` modifier and gets rid of the unnecessary `phpcs:disable` comments.
The tests in the `tests/phpunit/tests/db/dbDelta.php` file cover this change.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/42249">[42249]</a>.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/59650">#59650</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesupgradephp">trunk/src/wp-admin/includes/upgrade.php</a></li>
<li><a href="#trunksrcwpincludesksesphp">trunk/src/wp-includes/kses.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesupgradephp"></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/includes/upgrade.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/upgrade.php 2023-11-03 23:27:35 UTC (rev 57060)
+++ trunk/src/wp-admin/includes/upgrade.php 2023-11-04 00:24:33 UTC (rev 57061)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2910,31 +2910,29 @@
</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"> // Extract type, name and columns from the definition.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</del><span class="cx" style="display: block; padding: 0 10px"> preg_match(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '/^'
- . '(?P<index_type>' // 1) Type of the index.
- . 'PRIMARY\s+KEY|(?:UNIQUE|FULLTEXT|SPATIAL)\s+(?:KEY|INDEX)|KEY|INDEX'
- . ')'
- . '\s+' // Followed by at least one white space character.
- . '(?:' // Name of the index. Optional if type is PRIMARY KEY.
- . '`?' // Name can be escaped with a backtick.
- . '(?P<index_name>' // 2) Name of the index.
- . '(?:[0-9a-zA-Z$_-]|[\xC2-\xDF][\x80-\xBF])+'
- . ')'
- . '`?' // Name can be escaped with a backtick.
- . '\s+' // Followed by at least one white space character.
- . ')*'
- . '\(' // Opening bracket for the columns.
- . '(?P<index_columns>'
- . '.+?' // 3) Column names, index prefixes, and orders.
- . ')'
- . '\)' // Closing bracket for the columns.
- . '$/im',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '/^
+ (?P<index_type> # 1) Type of the index.
+ PRIMARY\s+KEY|(?:UNIQUE|FULLTEXT|SPATIAL)\s+(?:KEY|INDEX)|KEY|INDEX
+ )
+ \s+ # Followed by at least one white space character.
+ (?: # Name of the index. Optional if type is PRIMARY KEY.
+ `? # Name can be escaped with a backtick.
+ (?P<index_name> # 2) Name of the index.
+ (?:[0-9a-zA-Z$_-]|[\xC2-\xDF][\x80-\xBF])+
+ )
+ `? # Name can be escaped with a backtick.
+ \s+ # Followed by at least one white space character.
+ )*
+ \( # Opening bracket for the columns.
+ (?P<index_columns>
+ .+? # 3) Column names, index prefixes, and orders.
+ )
+ \) # Closing bracket for the columns.
+ $/imx',
</ins><span class="cx" style="display: block; padding: 0 10px"> $fld,
</span><span class="cx" style="display: block; padding: 0 10px"> $index_matches
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // phpcs:enable
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Uppercase the index type and normalize space characters.
</span><span class="cx" style="display: block; padding: 0 10px"> $index_type = strtoupper( preg_replace( '/\s+/', ' ', trim( $index_matches['index_type'] ) ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2952,29 +2950,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Normalize columns.
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $index_columns as $id => &$index_column ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Extract column name and number of indexed characters (sub_part).
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- don't remove regex indentation
</del><span class="cx" style="display: block; padding: 0 10px"> preg_match(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '/'
- . '`?' // Name can be escaped with a backtick.
- . '(?P<column_name>' // 1) Name of the column.
- . '(?:[0-9a-zA-Z$_-]|[\xC2-\xDF][\x80-\xBF])+'
- . ')'
- . '`?' // Name can be escaped with a backtick.
- . '(?:' // Optional sub part.
- . '\s*' // Optional white space character between name and opening bracket.
- . '\(' // Opening bracket for the sub part.
- . '\s*' // Optional white space character after opening bracket.
- . '(?P<sub_part>'
- . '\d+' // 2) Number of indexed characters.
- . ')'
- . '\s*' // Optional white space character before closing bracket.
- . '\)' // Closing bracket for the sub part.
- . ')?'
- . '/',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '/
+ `? # Name can be escaped with a backtick.
+ (?P<column_name> # 1) Name of the column.
+ (?:[0-9a-zA-Z$_-]|[\xC2-\xDF][\x80-\xBF])+
+ )
+ `? # Name can be escaped with a backtick.
+ (?: # Optional sub part.
+ \s* # Optional white space character between name and opening bracket.
+ \( # Opening bracket for the sub part.
+ \s* # Optional white space character after opening bracket.
+ (?P<sub_part>
+ \d+ # 2) Number of indexed characters.
+ )
+ \s* # Optional white space character before closing bracket.
+ \) # Closing bracket for the sub part.
+ )?
+ /x',
</ins><span class="cx" style="display: block; padding: 0 10px"> $index_column,
</span><span class="cx" style="display: block; padding: 0 10px"> $index_column_matches
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // phpcs:enable
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Escape the column name with backticks.
</span><span class="cx" style="display: block; padding: 0 10px"> $index_column = '`' . $index_column_matches['column_name'] . '`';
</span></span></pre></div>
<a id="trunksrcwpincludesksesphp"></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/kses.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/kses.php 2023-11-03 23:27:35 UTC (rev 57060)
+++ trunk/src/wp-includes/kses.php 2023-11-04 00:24:33 UTC (rev 57061)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1565,8 +1565,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Note: do NOT remove the `x` modifiers as they are essential for the above regex!
</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">- $validation = "%^($regex)+$%x";
- $extraction = "%$regex%x";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $validation = "/^($regex)+$/x";
+ $extraction = "/$regex/x";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 1 === preg_match( $validation, $attr ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match_all( $extraction, $attr, $attrarr );
</span></span></pre>
</div>
</div>
</body>
</html>