is_ignore_case() ) { $url = Red_Url_Path::to_lower( $url ); } $this->query = $this->get_url_query( $url ); } /** * Does this object match the URL? * * @param String $url URL to match. * @param Red_Source_Flags $flags Source flags. * @return boolean */ public function is_match( $url, Red_Source_Flags $flags ) { if ( $flags->is_ignore_case() ) { $url = Red_Url_Path::to_lower( $url ); } // If we can't parse the query params then match the params exactly if ( $this->match_exact !== false ) { return $this->get_query_after( $url ) === $this->match_exact; } $target = $this->get_url_query( $url ); // All params in the source have to exist in the request, but in any order $matched = $this->get_query_same( $this->query, $target ); if ( count( $matched ) !== count( $this->query ) ) { // Source params arent matched exactly return false; }; // Get list of whatever is left over $query_diff = $this->get_query_diff( $this->query, $target ); $query_diff = array_merge( $query_diff, $this->get_query_diff( $target, $this->query ) ); if ( $flags->is_query_ignore() || $flags->is_query_pass() ) { return true; // This ignores all other query params } // In an exact match there shouldn't be any more params return count( $query_diff ) === 0; } /** * Pass query params from one URL to another URL, ignoring any params that already exist on the target. * * @param string $target_url The target URL to add params to. * @param string $requested_url The source URL to pass params from. * @param Red_Source_Flags $flags Any URL flags. * @return string URL, modified or not. */ public static function add_to_target( $target_url, $requested_url, Red_Source_Flags $flags ) { if ( $flags->is_query_pass() && $target_url ) { $source_query = new Red_Url_Query( $target_url, $flags ); $request_query = new Red_Url_Query( $requested_url, $flags ); // Now add any remaining params $query_diff = $source_query->get_query_diff( $source_query->query, $request_query->query ); $request_diff = $request_query->get_query_diff( $request_query->query, $source_query->query ); foreach ( $request_diff as $key => $value ) { $query_diff[ $key ] = $value; } // Remove any params from $source that are present in $request - we dont allow // predefined params to be overridden foreach ( array_keys( $query_diff ) as $key ) { if ( isset( $source_query->query[ $key ] ) ) { unset( $query_diff[ $key ] ); } } return self::build_url( $target_url, $query_diff ); } return $target_url; } /** * Build a URL from a base and query parameters * * @param String $url Base URL. * @param Array $query Query parameters. * @return String */ public static function build_url( $url, $query ) { $query = http_build_query( $query ); $query = preg_replace( '@%5B\d*%5D@', '[]', $query ); // Make these look like [] if ( $query ) { // Get any fragment $target_fragment = wp_parse_url( $url, PHP_URL_FRAGMENT ); // If we have a fragment we need to ensure it comes after the query parameters, not before if ( $target_fragment ) { // Remove fragment $url = str_replace( '#' . $target_fragment, '', $url ); // Add to the end of the query $query .= '#' . $target_fragment; } return $url . ( strpos( $url, '?' ) === false ? '?' : '&' ) . $query; } return $url; } /** * Get a URL with the given base and query parameters from this Url_Query * * @param String $url Base URL. * @return String */ public function get_url_with_query( $url ) { return self::build_url( $url, $this->query ); } /** * Get the query parameters * * @return Array */ public function get() { return $this->query; } /** * Does the URL and the query params contain no parameters? * * @param String $url URL. * @param Array $params Query params. * @return boolean */ private function is_exact_match( $url, $params ) { // No parsed query params but we have query params on the URL - some parsing error with wp_parse_str if ( count( $params ) === 0 && $this->has_query_params( $url ) ) { return true; } return false; } /** * Get query parameters from a URL * * @param String $url URL. * @return array */ private function get_url_query( $url ) { $params = []; $query = $this->get_query_after( $url ); wp_parse_str( $query ? $query : '', $params ); if ( $this->is_exact_match( $url, $params ) ) { $this->match_exact = $query; } return $params; } /** * Does the URL contain query parameters? * * @param String $url URL. * @return boolean */ public function has_query_params( $url ) { $qpos = strpos( $url, '?' ); if ( $qpos === false ) { return false; } return true; } /** * Get parameters after the ? * * @param String $url URL. * @return String */ public function get_query_after( $url ) { $qpos = strpos( $url, '?' ); $qrpos = strpos( $url, '\\?' ); // No ? anywhere - no query if ( $qpos === false ) { return ''; } // Found an escaped ? and it comes before the non-escaped ? if ( $qrpos !== false && $qrpos < $qpos ) { return substr( $url, $qrpos + 2 ); } // Standard query param return substr( $url, $qpos + 1 ); } /** * Get query parameters that are the same in both query arrays * * @param array $source_query Source query params. * @param array $target_query Target query params. * @param integer $depth Current recursion depth. * @return array */ public function get_query_same( array $source_query, array $target_query, $depth = 0 ) { if ( $depth > self::RECURSION_LIMIT ) { return []; } $same = []; foreach ( $source_query as $key => $value ) { if ( isset( $target_query[ $key ] ) ) { $add = false; if ( is_array( $value ) && is_array( $target_query[ $key ] ) ) { $add = $this->get_query_same( $source_query[ $key ], $target_query[ $key ], $depth + 1 ); if ( count( $add ) !== count( $source_query[ $key ] ) ) { $add = false; } } elseif ( is_string( $value ) && is_string( $target_query[ $key ] ) ) { $add = $value === $target_query[ $key ] ? $value : false; } if ( ! empty( $add ) || is_numeric( $add ) || $add === '' ) { $same[ $key ] = $add; } } } return $same; } /** * Get the difference in query parameters * * @param array $source_query Source query params. * @param array $target_query Target query params. * @param integer $depth Current recursion depth. * @return array */ public function get_query_diff( array $source_query, array $target_query, $depth = 0 ) { if ( $depth > self::RECURSION_LIMIT ) { return []; } $diff = []; foreach ( $source_query as $key => $value ) { if ( isset( $target_query[ $key ] ) && is_array( $value ) && is_array( $target_query[ $key ] ) ) { $add = $this->get_query_diff( $source_query[ $key ], $target_query[ $key ], $depth + 1 ); if ( ! empty( $add ) ) { $diff[ $key ] = $add; } } elseif ( ! isset( $target_query[ $key ] ) || ! is_string( $value ) || ! is_string( $target_query[ $key ] ) || $target_query[ $key ] !== $source_query[ $key ] ) { $diff[ $key ] = $value; } } return $diff; } }