io.gravitee.common.util.URIUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-common Show documentation
There is a newer version: 4.6.0
/*
 * Copyright © 2015 The Gravitee team (http://gravitee.io)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gravitee.common.util;

import java.util.regex.Pattern;

/**
 * @author Nicolas GERAUD (nicolas.geraud at graviteesource.com)
 * @author GraviteeSource Team
 */
public class URIUtils {

    private static final Pattern URL_PATTERN = Pattern.compile("^\\w{2,}://.*$");
    private static final char FRAGMENT_SEPARATOR_CHAR = '#';
    private static final char QUERYPARAM_SEPARATOR_CHAR1 = '&';
    private static final char QUERYPARAM_SEPARATOR_CHAR2 = ';';
    private static final char QUERYPARAM_VALUE_SEPARATOR_CHAR = '=';
    private static final char QUERY_SEPARATOR_CHAR = '?';

    /**
     * An url is considered absolute if it starts with protocol://.
     * Protocol must at least contain 2 chars, ex:
     * 
     *     https://api.gravitee.io/echo: is absolute
     *     http://api.gravitee.io/echo: is absolute
     *     wss://api.gravitee.io/echo: is absolute
     *     kafka://kafka.gravitee.io: is absolute
     *     a://kafka.gravitee.io: is not considered as absolute cause the protocol isn't valid ( < 2 chars)
     *     /echo: is not absolute
     *     ?foo=bar: is not absolute
     *     empty: is not absolute
     * 
     *
     * @param uri the uri to test.
     * @return true if the uri is considered absolute, false otherwise.
     */
    public static boolean isAbsolute(final String uri) {
        return uri != null && URL_PATTERN.matcher(uri).matches();
    }

    /**
     * Splits an HTTP query string into key-multivalues parameters pairs.
     * @param uri to splits to extract query parameters
     * @return a {@link MultiValueMap} of query parameters
     */
    public static MultiValueMap parameters(String uri) {
        return parameters(uri, false);
    }

    /**
     * Splits an HTTP query string into key-multivalues parameters pairs.
     * Can be used considering semicolon char ";" as a separator or as a normal char (useful for url-encoded-form-data or OData queries).
     * @param uri to splits to extract query parameters
     * @param semicolonIsNormalChar, when true, uses netty's QueryStringDecoder to consider semicolon character as a normal one
     * @return a {@link MultiValueMap} of query parameters
     */
    public static MultiValueMap parameters(String uri, boolean semicolonIsNormalChar) {
        MultiValueMap queryParameters;
        int questionMarkIndex = uri.indexOf(QUERY_SEPARATOR_CHAR);
        if (questionMarkIndex < 0 || uri.length() == (questionMarkIndex + 1)) {
            queryParameters = new LinkedMultiValueMap<>(0);
        } else {
            queryParameters = new LinkedMultiValueMap<>();
            int end = uri.length();
            int i;
            int paramNameStart = questionMarkIndex + 1;
            int paramValueStart = -1;
            loop:for (i = questionMarkIndex + 1; i < end; i++) {
                switch (uri.charAt(i)) {
                    case QUERYPARAM_VALUE_SEPARATOR_CHAR:
                        if (paramNameStart == i) {
                            paramNameStart = i + 1;
                        } else if (paramValueStart < paramNameStart) {
                            paramValueStart = i + 1;
                        }
                        break;
                    case QUERYPARAM_SEPARATOR_CHAR2:
                        if (semicolonIsNormalChar) {
                            continue;
                        }
                    case QUERYPARAM_SEPARATOR_CHAR1:
                        addParameter(queryParameters, uri, paramNameStart, paramValueStart, i);
                        paramNameStart = i + 1;
                        break;
                    case FRAGMENT_SEPARATOR_CHAR:
                        break loop;
                    default:
                    // continue
                }
            }
            if (paramNameStart < i) {
                addParameter(queryParameters, uri, paramNameStart, paramValueStart, i);
            }
        }
        return queryParameters;
    }

    private static void addParameter(
        MultiValueMap queryParameters,
        String uri,
        int paramNameStart,
        int paramValueStart,
        int end
    ) {
        if (paramValueStart == -1 || paramValueStart < paramNameStart) {
            queryParameters.add(uri.substring(paramNameStart, end), null);
        } else {
            String k = uri.substring(paramNameStart, paramValueStart - 1);
            String v = uri.substring(paramValueStart, end);
            queryParameters.add(k, v);
        }
    }
}