<!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>[43082] branches/4.9: Privacy: add helper function for anonymizing data in a standardized way.</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/43082">43082</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/43082","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>2018-05-02 00:48:23 +0000 (Wed, 02 May 2018)</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'>Privacy: add helper function for anonymizing data in a standardized way.
Props jesperher, allendav, iandunn, birgire, azaozz, joemcgill.
Merges <a href="https://core.trac.wordpress.org/changeset/42971">[42971]</a> and <a href="https://core.trac.wordpress.org/changeset/43081">[43081]</a> to the 4.9 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/43545">#43545</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches49srcwpadminincludesclasswpcommunityeventsphp">branches/4.9/src/wp-admin/includes/class-wp-community-events.php</a></li>
<li><a href="#branches49srcwpincludesfunctionsphp">branches/4.9/src/wp-includes/functions.php</a></li>
<li><a href="#branches49testsphpunittestsadminincludesCommunityEventsphp">branches/4.9/tests/phpunit/tests/admin/includesCommunityEvents.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#branches49testsphpunittestsfunctionsanonymizationphp">branches/4.9/tests/phpunit/tests/functions/anonymization.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches49">branches/4.9/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.9
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.9 2018-05-02 00:40:50 UTC (rev 43081)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.9 2018-05-02 00:48:23 UTC (rev 43082)
</ins><a id="branches49"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.9</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42256-42261,42350,42358,42362,42364-42368,42374,42388,42390,42401,42417,42421,42423-42425,42430,42433,42437,42441,42443,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42648,42652-42653,42665,42687,42711,42713,42719,42722,42739-42740,42744,42758,42791-42792,42801,42817-42818,42830,42837,42839,42841,42844,42851-42852,42860,42864,42881,42888-42889,42892-42894,42930,42964,42967,42972,42977,42986-42987,42989,42994
,42998,43001,43004,43007,43025,43027,43030,43032,43034,43036,43039,43056,43058,43062-43063,43065
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,42132,42134,42136,42138,42140,42144,42146,42148,42150,42152-42153,42155,42157,42159,42161,42163,42169,42171,42173,42175,42177,42181,42183,42185,42187,42189,42191,42193,42199,42203,42210,42214,42220,42222,42226,42242,42244,42247,42251,42256-42261,42350,42358,42362,42364-42368,42374,42388,42390,42401,42417,42421,42423-42425,42430,42433,42437,42441,42443,42446-42447,42449,42451,42453,42457,42459,42462,42491,42521,42529,42531,42533,42536,42538,42541,42543,42545,42549,42566,42568,42570,42572,42574,42576,42579,42581-42582,42584-42585,42587-42588,42590,42592,42594-42595,42598-42599,42602,42604,42606,42611-42613,42615,42617,42624-42625,42639,42648,42652-42653,42665,42687,42711,42713,42719,42722,42739-42740,42744,42758,42791-42792,42801,42817-42818,42830,42837,42839,42841,42844,42851-42852,42860,42864,42881,42888-42889,42892-42894,42930,42964,42967,42971-42972,42977,42986-42987,42989
,42994,42998,43001,43004,43007,43025,43027,43030,43032,43034,43036,43039,43056,43058,43062-43063,43065,43081
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches49srcwpadminincludesclasswpcommunityeventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-admin/includes/class-wp-community-events.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-admin/includes/class-wp-community-events.php 2018-05-02 00:40:50 UTC (rev 43081)
+++ branches/4.9/src/wp-admin/includes/class-wp-community-events.php 2018-05-02 00:48:23 UTC (rev 43082)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,7 +234,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_unsafe_client_ip() {
</span><span class="cx" style="display: block; padding: 0 10px"> $client_ip = $netmask = false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $ip_prefix = '';
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // In order of preference, with the best ones for this purpose first.
</span><span class="cx" style="display: block; padding: 0 10px"> $address_headers = array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,43 +264,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // Detect what kind of IP address this is.
- $is_ipv6 = substr_count( $client_ip, ':' ) > 1;
- $is_ipv4 = ( 3 === substr_count( $client_ip, '.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $anon_ip = wp_privacy_anonymize_ip( $client_ip, true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $is_ipv6 && $is_ipv4 ) {
- // IPv6 compatibility mode, temporarily strip the IPv6 part, and treat it like IPv4.
- $ip_prefix = '::ffff:';
- $client_ip = preg_replace( '/^\[?[0-9a-f:]*:/i', '', $client_ip );
- $client_ip = str_replace( ']', '', $client_ip );
- $is_ipv6 = false;
- }
-
- if ( $is_ipv6 ) {
- // IPv6 addresses will always be enclosed in [] if there's a port.
- $ip_start = 1;
- $ip_end = (int) strpos( $client_ip, ']' ) - 1;
- $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
-
- // Strip the port (and [] from IPv6 addresses), if they exist.
- if ( $ip_end > 0 ) {
- $client_ip = substr( $client_ip, $ip_start, $ip_end );
- }
-
- // Partially anonymize the IP by reducing it to the corresponding network ID.
- if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) {
- $client_ip = inet_ntop( inet_pton( $client_ip ) & inet_pton( $netmask ) );
- }
- } elseif ( $is_ipv4 ) {
- // Strip any port and partially anonymize the IP.
- $last_octet_position = strrpos( $client_ip, '.' );
- $client_ip = substr( $client_ip, 0, $last_octet_position ) . '.0';
- } else {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( '0.0.0.0' === $anon_ip || '::' === $anon_ip ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- // Restore the IPv6 prefix to compatibility mode addresses.
- return $ip_prefix . $client_ip;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $anon_ip;
</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="branches49srcwpincludesfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/src/wp-includes/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/src/wp-includes/functions.php 2018-05-02 00:40:50 UTC (rev 43081)
+++ branches/4.9/src/wp-includes/functions.php 2018-05-02 00:48:23 UTC (rev 43082)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5816,3 +5816,121 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $site_name
</span><span class="cx" style="display: block; padding: 0 10px"> ), $email_change_email['message'], $email_change_email['headers'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Return an anonymized IPv4 or IPv6 address.
+ *
+ * @since 4.9.6 Abstracted from `WP_Community_Events::get_unsafe_client_ip()`.
+ *
+ * @param string $ip_addr The IPv4 or IPv6 address to be anonymized.
+ * @param bool $ipv6_fallback Optional. Whether to return the original IPv6 address if the needed functions
+ * to anonymize it are not present. Default false, return `::` (unspecified address).
+ * @return string The anonymized IP address.
+ */
+function wp_privacy_anonymize_ip( $ip_addr, $ipv6_fallback = false ) {
+ // Detect what kind of IP address this is.
+ $ip_prefix = '';
+ $is_ipv6 = substr_count( $ip_addr, ':' ) > 1;
+ $is_ipv4 = ( 3 === substr_count( $ip_addr, '.' ) );
+
+ if ( $is_ipv6 && $is_ipv4 ) {
+ // IPv6 compatibility mode, temporarily strip the IPv6 part, and treat it like IPv4.
+ $ip_prefix = '::ffff:';
+ $ip_addr = preg_replace( '/^\[?[0-9a-f:]*:/i', '', $ip_addr );
+ $ip_addr = str_replace( ']', '', $ip_addr );
+ $is_ipv6 = false;
+ }
+
+ if ( $is_ipv6 ) {
+ // IPv6 addresses will always be enclosed in [] if there's a port.
+ $left_bracket = strpos( $ip_addr, '[' );
+ $right_bracket = strpos( $ip_addr, ']' );
+ $percent = strpos( $ip_addr, '%' );
+ $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000';
+
+ // Strip the port (and [] from IPv6 addresses), if they exist.
+ if ( false !== $left_bracket && false !== $right_bracket ) {
+ $ip_addr = substr( $ip_addr, $left_bracket + 1, $right_bracket - $left_bracket - 1 );
+ } elseif ( false !== $left_bracket || false !== $right_bracket ) {
+ // The IP has one bracket, but not both, so it's malformed.
+ return '::';
+ }
+
+ // Strip the reachability scope.
+ if ( false !== $percent ) {
+ $ip_addr = substr( $ip_addr, 0, $percent );
+ }
+
+ // No invalid characters should be left.
+ if ( preg_match( '/[^0-9a-f:]/i', $ip_addr ) ) {
+ return '::';
+ }
+
+ // Partially anonymize the IP by reducing it to the corresponding network ID.
+ if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) {
+ $ip_addr = inet_ntop( inet_pton( $ip_addr ) & inet_pton( $netmask ) );
+ if ( false === $ip_addr) {
+ return '::';
+ }
+ } elseif ( ! $ipv6_fallback ) {
+ return '::';
+ }
+ } elseif ( $is_ipv4 ) {
+ // Strip any port and partially anonymize the IP.
+ $last_octet_position = strrpos( $ip_addr, '.' );
+ $ip_addr = substr( $ip_addr, 0, $last_octet_position ) . '.0';
+ } else {
+ return '0.0.0.0';
+ }
+
+ // Restore the IPv6 prefix to compatibility mode addresses.
+ return $ip_prefix . $ip_addr;
+}
+
+/**
+ * Return uniform "anonymous" data by type.
+ *
+ * @since 4.9.6
+ *
+ * @param string $type The type of data to be anonymized.
+ * @param string $data Optional The data to be anonymized.
+ * @return string The anonymous data for the requested type.
+ */
+function wp_privacy_anonymize_data( $type, $data = '' ) {
+
+ switch ( $type ) {
+ case 'email':
+ $anonymous = 'deleted@site.invalid';
+ break;
+ case 'url':
+ $anonymous = 'https://site.invalid';
+ break;
+ case 'ip':
+ $anonymous = wp_privacy_anonymize_ip( $data );
+ break;
+ case 'date':
+ $anonymous = '0000-00-00 00:00:00';
+ break;
+ case 'text':
+ /* translators: deleted text */
+ $anonymous = __( '[deleted]' );
+ break;
+ case 'longtext':
+ /* translators: deleted long text */
+ $anonymous = __( 'This content was deleted by the author.' );
+ break;
+ default:
+ $anonymous = '';
+ }
+
+ /**
+ * Filters the anonymous data for each type.
+ *
+ * @since 4.9.6
+ *
+ * @param string $anonymous Anonymized data.
+ * @param string $type Type of the data.
+ * @param string $data Original data.
+ */
+ return apply_filters( 'wp_privacy_anonymize_data', $anonymous, $type, $data );
+}
</ins></span></pre></div>
<a id="branches49testsphpunittestsadminincludesCommunityEventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.9/tests/phpunit/tests/admin/includesCommunityEvents.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/tests/phpunit/tests/admin/includesCommunityEvents.php 2018-05-02 00:40:50 UTC (rev 43081)
+++ branches/4.9/tests/phpunit/tests/admin/includesCommunityEvents.php 2018-05-02 00:48:23 UTC (rev 43082)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -259,109 +259,48 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Test that get_unsafe_client_ip() properly anonymizes all possible address formats
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @dataProvider data_get_unsafe_client_ip_anonymization
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @dataProvider data_get_unsafe_client_ip
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 41083
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_get_unsafe_client_ip_anonymization( $raw_ip, $expected_result ) {
- $_SERVER['REMOTE_ADDR'] = $raw_ip;
- $actual_result = WP_Community_Events::get_unsafe_client_ip();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_get_unsafe_client_ip( $raw_ip, $expected_result ) {
+ $_SERVER['REMOTE_ADDR'] = 'this should not be used';
+ $_SERVER['HTTP_CLIENT_IP'] = $raw_ip;
+ $actual_result = WP_Community_Events::get_unsafe_client_ip();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected_result, $actual_result );
</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">- public function data_get_unsafe_client_ip_anonymization() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Provide test cases for `test_get_unsafe_client_ip()`.
+ *
+ * @return array
+ */
+ public function data_get_unsafe_client_ip() {
</ins><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Invalid IP.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Handle '::' returned from `wp_privacy_anonymize_ip()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '', // Raw IP address
- false, // Expected result
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'or=\"[1000:0000:0000:0000:0000:0000:0000:0001',
+ false,
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Handle '0.0.0.0' returned from `wp_privacy_anonymize_ip()`.
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'unknown',
</span><span class="cx" style="display: block; padding: 0 10px"> false,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // IPv4, no port
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Valid IPv4.
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '10.20.30.45',
- '10.20.30.0',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '198.143.164.252',
+ '198.143.164.0',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // IPv4, port
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Valid IPv6.
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '10.20.30.45:20000',
- '10.20.30.0',
- ),
- // IPv6, no port
- array(
</del><span class="cx" style="display: block; padding: 0 10px"> '2a03:2880:2110:df07:face:b00c::1',
</span><span class="cx" style="display: block; padding: 0 10px"> '2a03:2880:2110:df07::',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // IPv6, port
- array(
- '[2a03:2880:2110:df07:face:b00c::1]:20000',
- '2a03:2880:2110:df07::',
- ),
- // IPv6, no port, reducible representation
- array(
- '0000:0000:0000:0000:0000:0000:0000:0001',
- '::',
- ),
- // IPv6, no port, partially reducible representation
- array(
- '1000:0000:0000:0000:0000:0000:0000:0001',
- '1000::',
- ),
- // IPv6, port, reducible representation
- array(
- '[0000:0000:0000:0000:0000:0000:0000:0001]:1234',
- '::',
- ),
- // IPv6, port, partially reducible representation
- array(
- '[1000:0000:0000:0000:0000:0000:0000:0001]:5678',
- '1000::',
- ),
- // IPv6, no port, reduced representation
- array(
- '::',
- '::',
- ),
- // IPv6, no port, reduced representation
- array(
- '::1',
- '::',
- ),
- // IPv6, port, reduced representation
- array(
- '[::]:20000',
- '::',
- ),
- // IPv6, address brackets without port delimiter and number, reduced representation
- array(
- '[::1]',
- '::',
- ),
- // IPv6, no port, compatibility mode
- array(
- '::ffff:10.15.20.25',
- '::ffff:10.15.20.0',
- ),
- // IPv6, port, compatibility mode
- array(
- '[::ffff:10.15.20.25]:30000',
- '::ffff:10.15.20.0',
- ),
- // IPv6, no port, compatibility mode shorthand
- array(
- '::127.0.0.1',
- '::ffff:127.0.0.0',
- ),
- // IPv6, port, compatibility mode shorthand
- array(
- '[::127.0.0.1]:30000',
- '::ffff:127.0.0.0',
- ),
</del><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="branches49testsphpunittestsfunctionsanonymizationphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: branches/4.9/tests/phpunit/tests/functions/anonymization.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.9/tests/phpunit/tests/functions/anonymization.php (rev 0)
+++ branches/4.9/tests/phpunit/tests/functions/anonymization.php 2018-05-02 00:48:23 UTC (rev 43082)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,247 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test anonymization functions.
+ *
+ * @package WordPress
+ *
+ * @since 5.0.0
+ */
+
+/**
+ * Class Tests_Functions_Anonymization.
+ *
+ * @group functions.php
+ * @group privacy
+ *
+ * @since 5.0.0
+ */
+class Tests_Functions_Anonymization extends WP_UnitTestCase {
+ /**
+ * Test that wp_privacy_anonymize_ip() properly anonymizes all possible IP address formats.
+ *
+ * @dataProvider data_wp_privacy_anonymize_ip
+ *
+ * @ticket 41083
+ * @ticket 43545
+ *
+ * @param string $raw_ip Raw IP address.
+ * @param string $expected_result Expected result.
+ */
+ public function test_wp_privacy_anonymize_ip( $raw_ip, $expected_result ) {
+ if ( ! function_exists( 'inet_ntop' ) || ! function_exists( 'inet_pton' ) ) {
+ $this->markTestSkipped( 'This test requires both the inet_ntop() and inet_pton() functions.' );
+ }
+
+ $actual_result = wp_privacy_anonymize_data( 'ip', $raw_ip );
+
+ /* Todo test ipv6_fallback mode if keeping it.*/
+
+ $this->assertEquals( $expected_result, $actual_result );
+ }
+
+ /**
+ * Provide test cases for `test_wp_privacy_anonymize_ip()`.
+ *
+ * @since 5.0.0 Moved from `Test_WP_Community_Events::data_get_unsafe_client_ip_anonymization()`.
+ *
+ * @return array {
+ * @type array {
+ * @string string $raw_ip Raw IP address.
+ * @string string $expected_result Expected result.
+ * }
+ * }
+ */
+ public function data_wp_privacy_anonymize_ip() {
+ return array(
+ // Invalid IP.
+ array(
+ null,
+ '0.0.0.0',
+ ),
+ array(
+ '',
+ '0.0.0.0',
+ ),
+ array(
+ '0.0.0.0.0',
+ '0.0.0.0',
+ ),
+ array(
+ '0000:0000:0000:0000:0000:0000:0127:2258',
+ '::',
+ ),
+ // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'unknown',
+ '0.0.0.0',
+ ),
+ // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'or=\"[1000:0000:0000:0000:0000:0000:0000:0001',
+ '::',
+ ),
+ // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'or=\"1000:0000:0000:0000:0000:0000:0000:0001',
+ '::',
+ ),
+ // Invalid IP. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ '1000:0000:0000:0000:0000:0000:0000:0001or=\"',
+ '::',
+ ),
+ // Malformed string with valid IP substring. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'or=\"[1000:0000:0000:0000:0000:0000:0000:0001]:400',
+ '1000::',
+ ),
+ // Malformed string with valid IP substring. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'or=\"[1000:0000:0000:0000:0000:0000:0000:0001]',
+ '1000::',
+ ),
+ // Malformed string with valid IP substring. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ 'or=\"[1000:0000:0000:0000:0000:0000:0000:0001]400',
+ '1000::',
+ ),
+ // Malformed string with valid IP substring. Sometimes proxies add things like this, or other arbitrary strings.
+ array(
+ '[1000:0000:0000:0000:0000:0000:0000:0001]:235\"or=',
+ '1000::',
+ ),
+ // IPv4, no port.
+ array(
+ '10.20.30.45',
+ '10.20.30.0',
+ ),
+ // IPv4, port.
+ array(
+ '10.20.30.45:20000',
+ '10.20.30.0',
+ ),
+ // IPv4, netmask.
+ array(
+ '10.20.30.45/24',
+ '10.20.30.0',
+ ),
+ // IPv6, no port.
+ array(
+ '2a03:2880:2110:df07:face:b00c::1',
+ '2a03:2880:2110:df07::',
+ ),
+ // IPv6, port.
+ array(
+ '[2a03:2880:2110:df07:face:b00c::1]:20000',
+ '2a03:2880:2110:df07::',
+ ),
+ // IPv6, no port, reducible representation.
+ array(
+ '0000:0000:0000:0000:0000:0000:0000:0001',
+ '::',
+ ),
+ // IPv6, no port, partially reducible representation.
+ array(
+ '1000:0000:0000:0000:0000:0000:0000:0001',
+ '1000::',
+ ),
+ // IPv6, port, reducible representation.
+ array(
+ '[0000:0000:0000:0000:0000:0000:0000:0001]:1234',
+ '::',
+ ),
+ // IPv6, port, partially reducible representation.
+ array(
+ '[1000:0000:0000:0000:0000:0000:0000:0001]:5678',
+ '1000::',
+ ),
+ // IPv6, no port, reduced representation.
+ array(
+ '::',
+ '::',
+ ),
+ // IPv6, no port, reduced representation.
+ array(
+ '::1',
+ '::',
+ ),
+ // IPv6, port, reduced representation.
+ array(
+ '[::]:20000',
+ '::',
+ ),
+ // IPv6, address brackets without port delimiter and number, reduced representation.
+ array(
+ '[::1]',
+ '::',
+ ),
+ // IPv6, no port, compatibility mode.
+ array(
+ '::ffff:10.15.20.25',
+ '::ffff:10.15.20.0',
+ ),
+ // IPv6, port, compatibility mode.
+ array(
+ '[::FFFF:10.15.20.25]:30000',
+ '::ffff:10.15.20.0',
+ ),
+ // IPv6, no port, compatibility mode shorthand.
+ array(
+ '::127.0.0.1',
+ '::ffff:127.0.0.0',
+ ),
+ // IPv6, port, compatibility mode shorthand.
+ array(
+ '[::127.0.0.1]:30000',
+ '::ffff:127.0.0.0',
+ ),
+ // IPv6 with reachability scope.
+ array(
+ 'fe80::b059:65f4:e877:c40%16',
+ 'fe80::',
+ ),
+ // IPv6 with reachability scope.
+ array(
+ 'FE80::B059:65F4:E877:C40%eth0',
+ 'fe80::',
+ ),
+ );
+ }
+
+ /**
+ * Test email anonymization of `wp_privacy_anonymize_data()`.
+ */
+ public function test_anonymize_email() {
+ $this->assertEquals( 'deleted@site.invalid', wp_privacy_anonymize_data( 'email', 'bar@example.com' ) );
+ }
+
+ /**
+ * Test url anonymization of `wp_privacy_anonymize_data()`.
+ */
+ public function test_anonymize_url() {
+ $this->assertEquals( 'https://site.invalid', wp_privacy_anonymize_data( 'url', 'https://example.com/author/username' ) );
+ }
+
+ /**
+ * Test date anonymization of `wp_privacy_anonymize_data()`.
+ */
+ public function test_anonymize_date() {
+ $this->assertEquals( '0000-00-00 00:00:00', wp_privacy_anonymize_data( 'date', '2003-12-25 12:34:56' ) );
+ }
+
+ /**
+ * Test text anonymization of `wp_privacy_anonymize_data()`.
+ */
+ public function test_anonymize_text() {
+ $text = __( 'Four score and seven years ago' );
+ $this->assertEquals( '[deleted]', wp_privacy_anonymize_data( 'text', $text ) );
+ }
+
+ /**
+ * Test long text anonymization of `wp_privacy_anonymize_data()`.
+ */
+ public function test_anonymize_long_text() {
+ $text = __( 'Four score and seven years ago' );
+ $this->assertEquals( 'This content was deleted by the author.', wp_privacy_anonymize_data( 'longtext', $text ) );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>