Changeset 42343 for trunk/src/wp-includes/compat.php

Timestamp:

11/30/2017 11:09:33 PM (2 years ago)

Author:

pento

Message:

Code is Poetry.
WordPress' code just... wasn't.
This is now dealt with.

Props jrf, pento, netweb, GaryJ, jdgrimes, westonruter, Greg Sherwood from PHPCS, and everyone who's ever contributed to WPCS and PHPCS.
Fixes #41057.

File:

• trunk/src/wp-includes/compat.php (modified) (9 diffs)

trunk/src/wp-includes/compat.php

@@ -8 +8 @@
 
 // If gettext isn't available
-if ( !function_exists('_') ) {
-    function _($string) {
+if ( ! function_exists( '_' ) ) {
+    function _( $string ) {
         return $string;
     }
@@ -126 +126 @@
         $chars = array_merge( $chars, $pieces );
 
-    // If there's anything left over, repeat the loop.
+        // If there's anything left over, repeat the loop.
     } while ( count( $pieces ) > 1 && $str = array_pop( $pieces ) );
 
@@ -210 +210 @@
         $count += count( $pieces );
 
-    // If there's anything left over, repeat the loop.
+        // If there's anything left over, repeat the loop.
     } while ( $str = array_pop( $pieces ) );
 
@@ -217 +217 @@
 }
 
-if ( !function_exists('hash_hmac') ):
+if ( ! function_exists( 'hash_hmac' ) ) :
+    /**
+     * Compat function to mimic hash_hmac().
+     *
+     * @ignore
+     * @since 3.2.0
+     *
+     * @see _hash_hmac()
+     *
+     * @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
+     * @param string $data       Data to be hashed.
+     * @param string $key        Secret key to use for generating the hash.
+     * @param bool   $raw_output Optional. Whether to output raw binary data (true),
+     *                           or lowercase hexits (false). Default false.
+     * @return string|false The hash in output determined by `$raw_output`. False if `$algo`
+     *                      is unknown or invalid.
+     */
+    function hash_hmac( $algo, $data, $key, $raw_output = false ) {
+        return _hash_hmac( $algo, $data, $key, $raw_output );
+    }
+endif;
+
 /**
- * Compat function to mimic hash_hmac().
+ * Internal compat function to mimic hash_hmac().
  *
  * @ignore
  * @since 3.2.0
- *
- * @see _hash_hmac()
  *
  * @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
@@ -234 +253 @@
  *                      is unknown or invalid.
  */
-function hash_hmac($algo, $data, $key, $raw_output = false) {
-    return _hash_hmac($algo, $data, $key, $raw_output);
-}
-endif;
-
-/**
- * Internal compat function to mimic hash_hmac().
- *
- * @ignore
- * @since 3.2.0
- *
- * @param string $algo       Hash algorithm. Accepts 'md5' or 'sha1'.
- * @param string $data       Data to be hashed.
- * @param string $key        Secret key to use for generating the hash.
- * @param bool   $raw_output Optional. Whether to output raw binary data (true),
- *                           or lowercase hexits (false). Default false.
- * @return string|false The hash in output determined by `$raw_output`. False if `$algo`
- *                      is unknown or invalid.
- */
-function _hash_hmac($algo, $data, $key, $raw_output = false) {
-    $packs = array('md5' => 'H32', 'sha1' => 'H40');
-
-    if ( !isset($packs[$algo]) )
+function _hash_hmac( $algo, $data, $key, $raw_output = false ) {
+    $packs = array(
+        'md5'  => 'H32',
+        'sha1' => 'H40',
+    );
+
+    if ( ! isset( $packs[ $algo ] ) ) {
         return false;
-
-    $pack = $packs[$algo];
-
-    if (strlen($key) > 64)
-        $key = pack($pack, $algo($key));
-
-    $key = str_pad($key, 64, chr(0));
-
-    $ipad = (substr($key, 0, 64) ^ str_repeat(chr(0x36), 64));
-    $opad = (substr($key, 0, 64) ^ str_repeat(chr(0x5C), 64));
-
-    $hmac = $algo($opad . pack($pack, $algo($ipad . $data)));
-
-    if ( $raw_output )
+    }
+
+    $pack = $packs[ $algo ];
+
+    if ( strlen( $key ) > 64 ) {
+        $key = pack( $pack, $algo( $key ) );
+    }
+
+    $key = str_pad( $key, 64, chr( 0 ) );
+
+    $ipad = ( substr( $key, 0, 64 ) ^ str_repeat( chr( 0x36 ), 64 ) );
+    $opad = ( substr( $key, 0, 64 ) ^ str_repeat( chr( 0x5C ), 64 ) );
+
+    $hmac = $algo( $opad . pack( $pack, $algo( $ipad . $data ) ) );
+
+    if ( $raw_output ) {
         return pack( $pack, $hmac );
+    }
     return $hmac;
 }
 
-if ( !function_exists('json_encode') ) {
+if ( ! function_exists( 'json_encode' ) ) {
     function json_encode( $string ) {
         global $wp_json;
@@ -289 +295 @@
 }
 
-if ( !function_exists('json_decode') ) {
+if ( ! function_exists( 'json_decode' ) ) {
     /**
      * @global Services_JSON $wp_json
@@ -299 +305 @@
         global $wp_json;
 
-        if ( ! ($wp_json instanceof Services_JSON ) ) {
+        if ( ! ( $wp_json instanceof Services_JSON ) ) {
             require_once( ABSPATH . WPINC . '/class-json.php' );
             $wp_json = new Services_JSON();
@@ -305 +311 @@
 
         $res = $wp_json->decode( $string );
-        if ( $assoc_array )
+        if ( $assoc_array ) {
             $res = _json_decode_object_helper( $res );
+        }
         return $res;
     }
@@ -314 +321 @@
      * @return array
      */
-    function _json_decode_object_helper($data) {
-        if ( is_object($data) )
-            $data = get_object_vars($data);
-        return is_array($data) ? array_map(__FUNCTION__, $data) : $data;
+    function _json_decode_object_helper( $data ) {
+        if ( is_object( $data ) ) {
+            $data = get_object_vars( $data );
+        }
+        return is_array( $data ) ? array_map( __FUNCTION__, $data ) : $data;
     }
 }
 
 if ( ! function_exists( 'hash_equals' ) ) :
-/**
- * Timing attack safe string comparison
- *
- * Compares two strings using the same time whether they're equal or not.
- *
- * This function was added in PHP 5.6.
- *
- * Note: It can leak the length of a string when arguments of differing length are supplied.
- *
- * @since 3.9.2
- *
- * @param string $a Expected string.
- * @param string $b Actual, user supplied, string.
- * @return bool Whether strings are equal.
- */
-function hash_equals( $a, $b ) {
-    $a_length = strlen( $a );
-    if ( $a_length !== strlen( $b ) ) {
-        return false;
-    }
-    $result = 0;
-
-    // Do not attempt to "optimize" this.
-    for ( $i = 0; $i < $a_length; $i++ ) {
-        $result |= ord( $a[ $i ] ) ^ ord( $b[ $i ] );
-    }
-
-    return $result === 0;
-}
+    /**
+     * Timing attack safe string comparison
+     *
+     * Compares two strings using the same time whether they're equal or not.
+     *
+     * This function was added in PHP 5.6.
+     *
+     * Note: It can leak the length of a string when arguments of differing length are supplied.
+     *
+     * @since 3.9.2
+     *
+     * @param string $a Expected string.
+     * @param string $b Actual, user supplied, string.
+     * @return bool Whether strings are equal.
+     */
+    function hash_equals( $a, $b ) {
+        $a_length = strlen( $a );
+        if ( $a_length !== strlen( $b ) ) {
+            return false;
+        }
+        $result = 0;
+
+        // Do not attempt to "optimize" this.
+        for ( $i = 0; $i < $a_length; $i++ ) {
+            $result |= ord( $a[ $i ] ) ^ ord( $b[ $i ] );
+        }
+
+        return $result === 0;
+    }
 endif;