Changeset 40781 for trunk/src/wp-admin/includes/class-wp-community-events.php

Timestamp:

05/18/2017 05:33:14 PM (7 years ago)

Author:

obenland

Message:

Dashboard: Combine methods to retreive IP

They're only used in one place, no reason to be so verbose about it.

See #40702.

File:

• trunk/src/wp-admin/includes/class-wp-community-events.php (modified) (5 diffs)

trunk/src/wp-admin/includes/class-wp-community-events.php

@@ -157 +157 @@
         $args    = array(
             'number' => 5, // Get more than three in case some get trimmed out.
-            'ip'     => $this->maybe_anonymize_ip_address( $this->get_unsafe_client_ip() ),
+            'ip'     => $this->get_client_ip(),
         );
 
@@ -183 +183 @@
 
     /**
-     * Determines the user's actual IP address, if possible.
+     * Determines the user's actual IP address and attempts to partially
+     * anonymize an IP address by converting it to a network ID.
+     *
+     * Geolocating the network ID usually returns a similar location as the
+     * actual IP, but provides some privacy for the user.
      *
      * $_SERVER['REMOTE_ADDR'] cannot be used in all cases, such as when the user
@@ -191 +195 @@
      *
      * Modified from http://stackoverflow.com/a/2031935/450127, MIT license.
+     * Modified from https://github.com/geertw/php-ip-anonymizer, MIT license.
      *
      * SECURITY WARNING: This function is _NOT_ intended to be used in
@@ -200 +205 @@
      * @since 4.8.0
      *
-     * @return false|string false on failure, the string address on success.
-     */
-    protected function get_unsafe_client_ip() {
+     * @return false|string The anonymized address on success; the given address
+     *                      or false on failure.
+     */
+    protected function get_client_ip() {
         $client_ip = false;
 
@@ -230 +236 @@
         }
 
+        // These functions are not available on Windows until PHP 5.3.
+        if ( function_exists( 'inet_pton' ) && function_exists( 'inet_ntop' ) ) {
+            if ( 4 === strlen( inet_pton( $client_ip ) ) ) {
+                $netmask = '255.255.255.0'; // ipv4.
+            } else {
+                $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000'; // ipv6.
+            }
+
+            $client_ip = inet_ntop( inet_pton( $client_ip ) & inet_pton( $netmask ) );
+        }
+
         return $client_ip;
-    }
-
-    /**
-     * Attempts to partially anonymize an IP address by converting it to a network ID.
-     *
-     * Geolocating the network ID usually returns a similar location as the
-     * actual IP, but provides some privacy for the user.
-     *
-     * Modified from https://github.com/geertw/php-ip-anonymizer, MIT license.
-     *
-     * @access protected
-     * @since 4.8.0
-     *
-     * @param  string $address The IP address that should be anonymized.
-     * @return bool|string The anonymized address on success; the given address
-     *                     or false on failure.
-     */
-    protected function maybe_anonymize_ip_address( $address ) {
-        // These functions are not available on Windows until PHP 5.3.
-        if ( ! function_exists( 'inet_pton' ) || ! function_exists( 'inet_ntop' ) ) {
-            return $address;
-        }
-
-        if ( 4 === strlen( inet_pton( $address ) ) ) {
-            $netmask = '255.255.255.0'; // ipv4.
-        } else {
-            $netmask = 'ffff:ffff:ffff:ffff:0000:0000:0000:0000'; // ipv6.
-        }
-
-        return inet_ntop( inet_pton( $address ) & inet_pton( $netmask ) );
     }