com.github.zhanhb.ckfinder.connector.utils.PathUtils.java Source code

Introduction

Here is the source code for com.github.zhanhb.ckfinder.connector.utils.PathUtils.java

Source

/*
 * CKFinder
 * ========
 * http://cksource.com/ckfinder
 * Copyright (C) 2007-2015, CKSource - Frederico Knabben. All rights reserved.
 *
 * The software, this file and its contents are subject to the CKFinder
 * License. Please read the license.txt file before using, installing, copying,
 * modifying or distribute this file or part of its contents. The contents of
 * this file is part of the Source Code of CKFinder.
 */
package com.github.zhanhb.ckfinder.connector.utils;

import com.github.zhanhb.ckfinder.connector.api.Constants;
import java.util.regex.Pattern;
import org.springframework.util.StringUtils;

/**
 * Utility class used to change paths in connector.
 */
@SuppressWarnings("UtilityClassWithoutPrivateConstructor")
public class PathUtils {

    public static String normalize(String string) {
        return string != null ? string.replaceAll("[\\\\/]+", "/") : null;
    }

    /**
     * Escapes double slashes (//) and replaces backslashes characters (\) with
     * slashes (/). <br>
     * <strong>NOTE:</strong> This method preserves UNC paths.
     *
     * @param string string to escapeUrl
     * @return Escaped string, {@code null} or empty string.
     */
    public static String normalizeUrl(String string) {
        if (StringUtils.isEmpty(string)) {
            return string;
        }
        final int prefixIndex = string.indexOf("://");
        String prefix;
        String suffix;
        if (prefixIndex > -1) {
            prefix = string.substring(0, prefixIndex + 2);
            suffix = string.substring(prefixIndex + 2);
        } else {
            prefix = "";
            suffix = string;
        }
        suffix = suffix.replace('\\', '/');

        // preserve // at the beginning for UNC paths
        if (suffix.startsWith("//")) {
            return prefix + "/" + suffix.replaceAll("/+", "/");
        } else {
            return prefix.concat(suffix.replaceAll("/+", "/"));
        }
    }

    /**
     * Adds slash character at the end of String provided as parameter. The slash
     * character will not be added if parameter is empty string or ends with
     * slash.
     *
     * @param string string to add slash character to
     * @return String with slash character at the end, {@code null} or empty
     * string.
     */
    public static String addSlashToEnd(String string) {
        if (string == null || string.endsWith("/")) {
            return string;
        }
        return string.concat("/");
    }

    /**
     * Adds slash character at the start of String provided as parameter. The
     * slash character will not be added if parameter is ULR or starts with slash.
     *
     * @param string string to add slash character to
     * @return String with slash character at the beginning, {@code null} or full
     * URL.
     */
    public static String addSlashToBegin(String string) {
        if (string == null || string.startsWith("/") || Pattern.matches(Constants.URL_REGEX, string)) {
            return string;
        }
        return "/".concat(string);
    }

}