com.sdl.webapp.common.util.UrlEncoder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dxa-common Show documentation
DXA Common project contains framework common classes shared between all other artifacts
There is a newer version: 2.3.7
package com.sdl.webapp.common.util;

import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import com.google.common.escape.Escaper;
import com.google.common.net.UrlEscapers;

import java.util.List;


/**
 * This class provides a way to use encoded paths for querying with GraphQL
 * content service. The reason for that is that all file paths are stored in DB encoded.
 * This is a copy of .NET implementation here: https://stash.sdl.com/projects/TSI/repos/web-application/browse/Sdl.Web.Common/Utils/UrlEncoding.cs#72
 */
public class UrlEncoder {

    private static final List PATH_ESCAPERS = Lists.newArrayList(
            //order of escapers matters!
            UrlEscapers.urlFormParameterEscaper(),
            new Escaper() {
                @Override
                public String escape(String text) {
                    return text.replaceAll("\\*", "%2A");
                }
            },
            new Escaper() {
                @Override
                public String escape(String text) {
                    return text.replaceAll("\\+", "%20");
                }
            },
            new Escaper() {
                @Override
                public String escape(String text) {
                    return text.replaceAll("%7E", "~");
                }
            }
    );

    /**
     * Performs an encoding of the url path.
     * @deprecated use guavaEscaper instead.
     * @param url Unencoded url path
     * @return Encoded url path.
     */
    @Deprecated
    public static String urlPartialPathEncode(String url)
    {
        if (Strings.isNullOrEmpty(url)) {
            return url;
        }
        int length = url.length();
        StringBuilder urlCopy = new StringBuilder(length);

        for (int i = 0; i < length; i++)
        {
            char c = url.charAt(i);
            switch (c)
            {
                case ' ': urlCopy.append("%20"); break;
                case '!': urlCopy.append("%21"); break;
                case '"': urlCopy.append("%22"); break;
                case '#': urlCopy.append("%23"); break;
                case '$': urlCopy.append("%24"); break;
                case '%': urlCopy.append("%25"); break;
                case '&': urlCopy.append("%26"); break;
                case '\'': urlCopy.append("%27"); break;
                case '(': urlCopy.append("%28"); break;
                case ')': urlCopy.append("%29"); break;
                case '*': urlCopy.append("%2A"); break;
                case ',': urlCopy.append("%2C"); break;
                case ':': urlCopy.append("%3A"); break;
                case ';': urlCopy.append("%3B"); break;
                case '<': urlCopy.append("%3C"); break;
                case '=': urlCopy.append("%3D"); break;
                case '>': urlCopy.append("%3E"); break;
                case '?': urlCopy.append("%3F"); break;
                case '@': urlCopy.append("%40"); break;
                case '[': urlCopy.append("%5B"); break;
                case ']': urlCopy.append("%5D"); break;
                case '^': urlCopy.append("%5E"); break;
                case '{': urlCopy.append("%7B"); break;
                case '|': urlCopy.append("%7C"); break;
                case '}': urlCopy.append("%7D"); break;
                case '~': urlCopy.append("%7E"); break;
                default: urlCopy.append(c); break;
            }
        }

        return urlCopy.toString();
    }

    /**
     * The CMS does not allow to use next characters in file names:
     * back-slash, slash, colon, asterix, question mark, double quotes, pipe,
     * less than and more than.
     * @param text file name supported by CM and not encoded.
     * @return encoded file names to support all characters from CM.
     */
    public static String urlPartialPathEncodeFullEntityTable(String text) {
        if (Strings.isNullOrEmpty(text)) {
            return text;
        }
        StringBuilder result = new StringBuilder(text.length() * 2);
        for (String part : text.split("/")) {
            String escapedPart = part;
            for (Escaper escaper : PATH_ESCAPERS) {
                escapedPart = escaper.escape(escapedPart);
            }
            result.append(escapedPart);
            result.append("/");
        }
        int length = result.length();
        if (length > 0) {
            //remove the last /
            result.setLength(length - 1);
        }
        return result.toString();
    }
}