Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.liferay.source.formatter.util.SourceFormatterUtil Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.source.formatter.util;
import com.liferay.petra.string.CharPool;
import com.liferay.petra.string.StringBundler;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.util.ArrayUtil;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.kernel.util.TextFormatter;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.tools.ToolsUtil;
import com.liferay.source.formatter.ExcludeSyntax;
import com.liferay.source.formatter.ExcludeSyntaxPattern;
import com.liferay.source.formatter.SourceFormatterExcludes;
import com.liferay.source.formatter.checks.util.SourceUtil;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.nio.file.FileSystem;
import java.nio.file.FileSystems;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.PathMatcher;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
/**
* @author Igor Spasic
* @author Brian Wing Shun Chan
* @author Hugo Huijser
*/
public class SourceFormatterUtil {
public static final String CHECKSTYLE_DOCUMENTATION_URL_BASE =
"https://checkstyle.sourceforge.io/";
public static final String GIT_LIFERAY_PORTAL_BRANCH =
"git.liferay.portal.branch";
public static final String GIT_LIFERAY_PORTAL_URL =
"https://raw.githubusercontent.com/liferay/liferay-portal/";
public static final String SOURCE_FORMATTER_TEST_PATH =
"/source/formatter/dependencies/";
public static List filterFileNames(
List allFileNames, String[] excludes, String[] includes,
SourceFormatterExcludes sourceFormatterExcludes,
boolean forceIncludeAllFiles) {
List excludeRegexList = new ArrayList<>();
Map> excludeRegexMap = new HashMap<>();
List includeRegexList = new ArrayList<>();
for (String exclude : excludes) {
if (!exclude.contains(StringPool.DOLLAR)) {
excludeRegexList.add(_createRegex(exclude));
}
}
if (!forceIncludeAllFiles) {
Map> excludeSyntaxPatternsMap =
sourceFormatterExcludes.getExcludeSyntaxPatternsMap();
for (Map.Entry> entry :
excludeSyntaxPatternsMap.entrySet()) {
List excludeSyntaxPatterns =
entry.getValue();
List regexList = new ArrayList<>();
for (ExcludeSyntaxPattern excludeSyntaxPattern :
excludeSyntaxPatterns) {
String excludePattern =
excludeSyntaxPattern.getExcludePattern();
ExcludeSyntax excludeSyntax =
excludeSyntaxPattern.getExcludeSyntax();
if (excludeSyntax.equals(ExcludeSyntax.REGEX)) {
regexList.add(excludePattern);
}
else if (!excludePattern.contains(StringPool.DOLLAR)) {
regexList.add(_createRegex(excludePattern));
}
}
excludeRegexMap.put(entry.getKey(), regexList);
}
}
for (String include : includes) {
if (!include.contains(StringPool.DOLLAR)) {
includeRegexList.add(_createRegex(include));
}
}
List fileNames = new ArrayList<>();
outerLoop:
for (String fileName : allFileNames) {
String encodedFileName = SourceUtil.getAbsolutePath(fileName);
for (String includeRegex : includeRegexList) {
if (!encodedFileName.matches(includeRegex)) {
continue;
}
for (String excludeRegex : excludeRegexList) {
if (encodedFileName.matches(excludeRegex)) {
continue outerLoop;
}
}
for (Map.Entry> entry :
excludeRegexMap.entrySet()) {
String propertiesFileLocation = entry.getKey();
if (encodedFileName.startsWith(propertiesFileLocation)) {
for (String excludeRegex : entry.getValue()) {
if (encodedFileName.matches(excludeRegex)) {
continue outerLoop;
}
}
}
}
fileNames.add(fileName);
continue outerLoop;
}
}
return fileNames;
}
public static List filterRecentChangesFileNames(
Set recentChangesFileNames, String[] excludes,
String[] includes, SourceFormatterExcludes sourceFormatterExcludes)
throws IOException {
if (ArrayUtil.isEmpty(includes)) {
return new ArrayList<>();
}
PathMatchers pathMatchers = _getPathMatchers(
excludes, includes, sourceFormatterExcludes);
return _filterRecentChangesFileNames(
recentChangesFileNames, pathMatchers);
}
public static String getDocumentationURLString(Class checkClass) {
String documentationURLString = _getDocumentationURLString(
checkClass.getSimpleName());
if (documentationURLString != null) {
return documentationURLString;
}
Class superclass = checkClass.getSuperclass();
String className = superclass.getSimpleName();
documentationURLString = _getDocumentationURLString(className);
if ((documentationURLString != null) || !className.startsWith("Base")) {
return documentationURLString;
}
return _getDocumentationURLString(className.substring(4));
}
public static File getFile(String baseDirName, String fileName, int level) {
for (int i = 0; i < level; i++) {
File file = new File(baseDirName + fileName);
if (file.exists()) {
return file;
}
fileName = "../" + fileName;
}
return null;
}
public static String getGitContent(String fileName, String branchName) {
URL url = getPortalGitURL(fileName, branchName);
if (url == null) {
return null;
}
try {
return StringUtil.read(url.openStream());
}
catch (IOException ioException) {
if (_log.isDebugEnabled()) {
_log.debug(ioException, ioException);
}
return null;
}
}
public static String getMarkdownFileName(String camelCaseName) {
camelCaseName = StringUtil.replace(camelCaseName, "OSGi", "OSGI");
camelCaseName = camelCaseName.replaceAll("([A-Z])s([A-Z])", "$1S$2");
String markdownFileName = TextFormatter.format(
camelCaseName, TextFormatter.K);
markdownFileName = TextFormatter.format(
markdownFileName, TextFormatter.N);
return markdownFileName + ".markdown";
}
public static File getPortalDir(String baseDirName) {
File portalImplDir = getFile(
baseDirName, "portal-impl", ToolsUtil.PORTAL_MAX_DIR_LEVEL);
if (portalImplDir == null) {
return null;
}
return portalImplDir.getParentFile();
}
public static URL getPortalGitURL(
String fileName, String portalBranchName) {
if (Validator.isNull(portalBranchName)) {
return null;
}
try {
return new URL(
StringBundler.concat(
SourceFormatterUtil.GIT_LIFERAY_PORTAL_URL,
portalBranchName, StringPool.SLASH, fileName));
}
catch (Exception exception) {
if (_log.isDebugEnabled()) {
_log.debug(exception, exception);
}
return null;
}
}
public static String getSimpleName(String name) {
int pos = name.lastIndexOf(CharPool.PERIOD);
if (pos != -1) {
return name.substring(pos + 1);
}
return name;
}
public static List getSuppressionsFiles(
String baseDirName, List allFileNames,
SourceFormatterExcludes sourceFormatterExcludes) {
List suppressionsFiles = new ArrayList<>();
// Find suppressions files in any parent directory
String parentDirName = baseDirName;
for (int j = 0; j < ToolsUtil.PORTAL_MAX_DIR_LEVEL; j++) {
File suppressionsFile = new File(
parentDirName + _SUPPRESSIONS_FILE_NAME);
if (suppressionsFile.exists()) {
suppressionsFiles.add(suppressionsFile);
}
parentDirName += "../";
}
// Find suppressions files in any child directory
List moduleSuppressionsFileNames = filterFileNames(
allFileNames, new String[0],
new String[] {"**/" + _SUPPRESSIONS_FILE_NAME},
sourceFormatterExcludes, true);
for (String moduleSuppressionsFileName : moduleSuppressionsFileNames) {
moduleSuppressionsFileName = StringUtil.replace(
moduleSuppressionsFileName, CharPool.BACK_SLASH,
CharPool.SLASH);
suppressionsFiles.add(new File(moduleSuppressionsFileName));
}
return suppressionsFiles;
}
public static void printError(String fileName, File file) {
printError(fileName, file.toString());
}
public static void printError(String fileName, String message) {
System.out.println(message);
}
public static List scanForFiles(
String baseDirName, String[] excludes, String[] includes,
SourceFormatterExcludes sourceFormatterExcludes,
boolean includeSubrepositories)
throws IOException {
if (ArrayUtil.isEmpty(includes)) {
return new ArrayList<>();
}
PathMatchers pathMatchers = _getPathMatchers(
excludes, includes, sourceFormatterExcludes);
return _scanForFiles(baseDirName, pathMatchers, includeSubrepositories);
}
private static String _createRegex(String s) {
if (!s.startsWith("**/")) {
s = "**/" + s;
}
s = StringUtil.replace(s, CharPool.PERIOD, "\\.");
StringBundler sb = new StringBundler();
for (int i = 0; i < s.length(); i++) {
char c1 = s.charAt(i);
if (c1 != CharPool.STAR) {
sb.append(c1);
continue;
}
if (i == (s.length() - 1)) {
sb.append("[^/]*");
continue;
}
char c2 = s.charAt(i + 1);
if (c2 == CharPool.STAR) {
sb.append(".*");
i++;
continue;
}
sb.append("[^/]*");
}
return sb.toString();
}
private static List _filterRecentChangesFileNames(
Set recentChangesFileNames, PathMatchers pathMatchers)
throws IOException {
List fileNames = new ArrayList<>();
recentChangesFileNamesLoop:
for (String fileName : recentChangesFileNames) {
File file = new File(fileName);
File canonicalFile = file.getCanonicalFile();
Path filePath = canonicalFile.toPath();
for (PathMatcher pathMatcher :
pathMatchers.getExcludeFilePathMatchers()) {
if (pathMatcher.matches(filePath)) {
continue recentChangesFileNamesLoop;
}
}
String currentFilePath = SourceUtil.getAbsolutePath(filePath);
Map> excludeFilePathMatchersMap =
pathMatchers.getExcludeFilePathMatchersMap();
for (Map.Entry> entry :
excludeFilePathMatchersMap.entrySet()) {
String propertiesFileLocation = entry.getKey();
if (currentFilePath.startsWith(propertiesFileLocation)) {
for (PathMatcher pathMatcher : entry.getValue()) {
if (pathMatcher.matches(filePath)) {
continue recentChangesFileNamesLoop;
}
}
}
}
File dir = file.getParentFile();
while (true) {
File canonicalDir = dir.getCanonicalFile();
Path dirPath = canonicalDir.toPath();
for (PathMatcher pathMatcher :
pathMatchers.getExcludeDirPathMatchers()) {
if (pathMatcher.matches(dirPath)) {
continue recentChangesFileNamesLoop;
}
}
String currentDirPath = SourceUtil.getAbsolutePath(dirPath);
Map> excludeDirPathMatchersMap =
pathMatchers.getExcludeDirPathMatchersMap();
for (Map.Entry> entry :
excludeDirPathMatchersMap.entrySet()) {
String propertiesFileLocation = entry.getKey();
if (currentDirPath.startsWith(propertiesFileLocation)) {
for (PathMatcher pathMatcher : entry.getValue()) {
if (pathMatcher.matches(dirPath)) {
continue recentChangesFileNamesLoop;
}
}
}
}
if (Files.exists(dirPath.resolve("source_formatter.ignore"))) {
continue recentChangesFileNamesLoop;
}
dir = dir.getParentFile();
if (dir == null) {
break;
}
}
for (PathMatcher pathMatcher :
pathMatchers.getIncludeFilePathMatchers()) {
if (pathMatcher.matches(filePath)) {
Path curFilePath = Paths.get(fileName);
fileNames.add(curFilePath.toString());
continue recentChangesFileNamesLoop;
}
}
}
return fileNames;
}
private static Path _getCanonicalPath(Path path) {
try {
File file = path.toFile();
File canonicalFile = file.getCanonicalFile();
return canonicalFile.toPath();
}
catch (IOException ioException) {
throw new RuntimeException(ioException);
}
}
private static String _getDocumentationURLString(String checkName) {
String markdownFileName = getMarkdownFileName(checkName);
ClassLoader classLoader = SourceFormatterUtil.class.getClassLoader();
InputStream inputStream = classLoader.getResourceAsStream(
"documentation/checks/" + markdownFileName);
if (inputStream != null) {
return _DOCUMENTATION_URL + markdownFileName;
}
return null;
}
private static PathMatchers _getPathMatchers(
String[] excludes, String[] includes,
SourceFormatterExcludes sourceFormatterExcludes) {
PathMatchers pathMatchers = new PathMatchers(FileSystems.getDefault());
for (String exclude : excludes) {
pathMatchers.addExcludeSyntaxPattern(
new ExcludeSyntaxPattern(ExcludeSyntax.GLOB, exclude));
}
for (ExcludeSyntaxPattern excludeSyntaxPattern :
sourceFormatterExcludes.getDefaultExcludeSyntaxPatterns()) {
pathMatchers.addExcludeSyntaxPattern(excludeSyntaxPattern);
}
Map> excludeSyntaxPatternsMap =
sourceFormatterExcludes.getExcludeSyntaxPatternsMap();
for (Map.Entry> entry :
excludeSyntaxPatternsMap.entrySet()) {
pathMatchers.addExcludeSyntaxPatterns(
entry.getKey(), entry.getValue());
}
for (String include : includes) {
pathMatchers.addInclude(include);
}
return pathMatchers;
}
private static List _scanForFiles(
final String baseDirName, final PathMatchers pathMatchers,
final boolean includeSubrepositories)
throws IOException {
final List fileNames = new ArrayList<>();
Files.walkFileTree(
Paths.get(baseDirName),
new SimpleFileVisitor() {
@Override
public FileVisitResult preVisitDirectory(
Path dirPath, BasicFileAttributes basicFileAttributes) {
if (Files.exists(
dirPath.resolve("source_formatter.ignore"))) {
return FileVisitResult.SKIP_SUBTREE;
}
String currentDirPath = SourceUtil.getAbsolutePath(dirPath);
if (!includeSubrepositories) {
String baseDirPath = SourceUtil.getAbsolutePath(
baseDirName);
if (!baseDirPath.equals(currentDirPath)) {
Path gitRepoPath = dirPath.resolve(".gitrepo");
if (Files.exists(gitRepoPath)) {
try {
String content = FileUtil.read(
gitRepoPath.toFile());
if (content.contains("autopull = true")) {
return FileVisitResult.SKIP_SUBTREE;
}
}
catch (Exception exception) {
if (_log.isDebugEnabled()) {
_log.debug(exception, exception);
}
}
}
}
}
dirPath = _getCanonicalPath(dirPath);
for (PathMatcher pathMatcher :
pathMatchers.getExcludeDirPathMatchers()) {
if (pathMatcher.matches(dirPath)) {
return FileVisitResult.SKIP_SUBTREE;
}
}
Map> excludeDirPathMatchersMap =
pathMatchers.getExcludeDirPathMatchersMap();
for (Map.Entry> entry :
excludeDirPathMatchersMap.entrySet()) {
String propertiesFileLocation = entry.getKey();
if (currentDirPath.startsWith(propertiesFileLocation)) {
for (PathMatcher pathMatcher : entry.getValue()) {
if (pathMatcher.matches(dirPath)) {
return FileVisitResult.SKIP_SUBTREE;
}
}
}
}
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult visitFile(
Path filePath, BasicFileAttributes basicFileAttributes) {
Path canonicalPath = _getCanonicalPath(filePath);
for (PathMatcher pathMatcher :
pathMatchers.getExcludeFilePathMatchers()) {
if (pathMatcher.matches(canonicalPath)) {
return FileVisitResult.CONTINUE;
}
}
String currentFilePath = SourceUtil.getAbsolutePath(
filePath);
Map> excludeFilePathMatchersMap =
pathMatchers.getExcludeFilePathMatchersMap();
for (Map.Entry> entry :
excludeFilePathMatchersMap.entrySet()) {
String propertiesFileLocation = entry.getKey();
if (currentFilePath.startsWith(
propertiesFileLocation)) {
for (PathMatcher pathMatcher : entry.getValue()) {
if (pathMatcher.matches(canonicalPath)) {
return FileVisitResult.CONTINUE;
}
}
}
}
for (PathMatcher pathMatcher :
pathMatchers.getIncludeFilePathMatchers()) {
if (!pathMatcher.matches(canonicalPath)) {
continue;
}
fileNames.add(filePath.toString());
return FileVisitResult.CONTINUE;
}
return FileVisitResult.CONTINUE;
}
});
return fileNames;
}
private static final String _DOCUMENTATION_URL =
"https://github.com/liferay/liferay-portal/blob/master/modules/util" +
"/source-formatter/src/main/resources/documentation/checks/";
private static final String _SUPPRESSIONS_FILE_NAME =
"source-formatter-suppressions.xml";
private static final Log _log = LogFactoryUtil.getLog(
SourceFormatterUtil.class);
private static class PathMatchers {
public PathMatchers(FileSystem fileSystem) {
_fileSystem = fileSystem;
}
public void addExcludeSyntaxPattern(
ExcludeSyntaxPattern excludeSyntaxPattern) {
String excludePattern = excludeSyntaxPattern.getExcludePattern();
ExcludeSyntax excludeSyntax =
excludeSyntaxPattern.getExcludeSyntax();
if (excludeSyntax.equals(ExcludeSyntax.GLOB) &&
!excludePattern.startsWith("**/")) {
excludePattern = "**/" + excludePattern;
}
if (excludeSyntax.equals(ExcludeSyntax.GLOB) &&
excludePattern.endsWith("/**")) {
excludePattern = excludePattern.substring(
0, excludePattern.length() - 3);
_excludeDirPathMatchers.add(
_fileSystem.getPathMatcher(
excludeSyntax.getValue() + ":" + excludePattern));
}
else if (excludeSyntax.equals(ExcludeSyntax.REGEX) &&
excludePattern.endsWith(
Pattern.quote(File.separator) + ".*")) {
excludePattern = StringUtil.replaceLast(
excludePattern, Pattern.quote(File.separator) + ".*",
StringPool.BLANK);
_excludeDirPathMatchers.add(
_fileSystem.getPathMatcher(
excludeSyntax.getValue() + ":" + excludePattern));
}
else {
_excludeFilePathMatchers.add(
_fileSystem.getPathMatcher(
excludeSyntax.getValue() + ":" + excludePattern));
}
}
public void addExcludeSyntaxPatterns(
String propertiesFileLocation,
List excludeSyntaxPatterns) {
List excludeDirPathMatcherList = new ArrayList<>();
List excludeFilePathMatcherList = new ArrayList<>();
for (ExcludeSyntaxPattern excludeSyntaxPattern :
excludeSyntaxPatterns) {
String excludePattern =
excludeSyntaxPattern.getExcludePattern();
ExcludeSyntax excludeSyntax =
excludeSyntaxPattern.getExcludeSyntax();
if (excludeSyntax.equals(ExcludeSyntax.GLOB) &&
!excludePattern.startsWith("**/")) {
excludePattern = "**/" + excludePattern;
}
if (excludeSyntax.equals(ExcludeSyntax.GLOB) &&
excludePattern.endsWith("/**")) {
excludePattern = excludePattern.substring(
0, excludePattern.length() - 3);
excludeDirPathMatcherList.add(
_fileSystem.getPathMatcher(
excludeSyntax.getValue() + ":" + excludePattern));
}
else if (excludeSyntax.equals(ExcludeSyntax.REGEX) &&
excludePattern.endsWith(
Pattern.quote(File.separator) + ".*")) {
excludePattern = StringUtil.replaceLast(
excludePattern, Pattern.quote(File.separator) + ".*",
StringPool.BLANK);
excludeDirPathMatcherList.add(
_fileSystem.getPathMatcher(
excludeSyntax.getValue() + ":" + excludePattern));
}
else {
excludeFilePathMatcherList.add(
_fileSystem.getPathMatcher(
excludeSyntax.getValue() + ":" + excludePattern));
}
}
_excludeDirPathMatchersMap.put(
propertiesFileLocation, excludeDirPathMatcherList);
_excludeFilePathMatchersMap.put(
propertiesFileLocation, excludeFilePathMatcherList);
}
public void addInclude(String include) {
_includeFilePathMatchers.add(
_fileSystem.getPathMatcher("glob:" + include));
}
public List getExcludeDirPathMatchers() {
return _excludeDirPathMatchers;
}
public Map> getExcludeDirPathMatchersMap() {
return _excludeDirPathMatchersMap;
}
public List getExcludeFilePathMatchers() {
return _excludeFilePathMatchers;
}
public Map> getExcludeFilePathMatchersMap() {
return _excludeFilePathMatchersMap;
}
public List getIncludeFilePathMatchers() {
return _includeFilePathMatchers;
}
private List _excludeDirPathMatchers = new ArrayList<>();
private Map> _excludeDirPathMatchersMap =
new HashMap<>();
private List _excludeFilePathMatchers = new ArrayList<>();
private Map> _excludeFilePathMatchersMap =
new HashMap<>();
private final FileSystem _fileSystem;
private List _includeFilePathMatchers = new ArrayList<>();
}
}
