com.liferay.source.formatter.checks.JavaOSGiReferenceCheck 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.checks;
import com.liferay.petra.string.CharPool;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.util.StringBundler;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.tools.ToolsUtil;
import com.liferay.source.formatter.BNDSettings;
import com.liferay.source.formatter.checks.util.JavaSourceUtil;
import com.liferay.source.formatter.parser.JavaClass;
import com.liferay.source.formatter.parser.JavaClassParser;
import com.liferay.source.formatter.parser.JavaConstructor;
import com.liferay.source.formatter.parser.JavaMethod;
import com.liferay.source.formatter.parser.JavaTerm;
import com.liferay.source.formatter.util.FileUtil;
import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author Hugo Huijser
*/
public class JavaOSGiReferenceCheck extends BaseFileCheck {
@Override
public boolean isModulesCheck() {
return true;
}
public void setServiceReferenceUtilClassNames(
String serviceReferenceUtilClassNames) {
Collections.addAll(
_serviceReferenceUtilClassNames,
StringUtil.split(serviceReferenceUtilClassNames));
}
@Override
protected String doProcess(
String fileName, String absolutePath, String content)
throws Exception {
if (!content.contains("@Component")) {
return content;
}
String packageName = JavaSourceUtil.getPackageName(content);
if (!packageName.startsWith("com.liferay")) {
return content;
}
_checkMissingReference(fileName, content);
String className = JavaSourceUtil.getClassName(fileName);
String moduleSuperClassContent = _getModuleSuperClassContent(
content, className, packageName);
content = _formatDuplicateReferenceMethods(
fileName, content, moduleSuperClassContent);
if (!isExcludedPath("service.reference.util.excludes", absolutePath)) {
for (String serviceProxyFactoryUtilClassName :
_getServiceProxyFactoryUtilClassNames()) {
_checkUtilUsage(
fileName, content, serviceProxyFactoryUtilClassName,
moduleSuperClassContent);
}
}
for (String serviceReferenceUtilClassName :
_serviceReferenceUtilClassNames) {
_checkUtilUsage(
fileName, content, serviceReferenceUtilClassName,
moduleSuperClassContent);
}
Matcher matcher = _referenceMethodPattern.matcher(content);
while (matcher.find()) {
String methodName = matcher.group(4);
if (!methodName.startsWith("set")) {
continue;
}
String annotationParameters = matcher.group(1);
String methodContent = matcher.group();
content = _formatMissingUnbindAnnotation(
content, methodName, methodContent, annotationParameters);
String methodBody = matcher.group(6);
String typeName = matcher.group(5);
content = _formatVolatileReferenceVariable(
content, methodBody, typeName);
}
return content;
}
private void _checkMissingReference(String fileName, String content) {
String moduleServicePackageName = null;
Matcher matcher = _serviceUtilImportPattern.matcher(content);
while (matcher.find()) {
String serviceUtilClassName = matcher.group(2);
if (moduleServicePackageName == null) {
moduleServicePackageName = _getModuleServicePackageName(
fileName);
}
if (Validator.isNotNull(moduleServicePackageName)) {
String serviceUtilClassPackageName = matcher.group(1);
if (serviceUtilClassPackageName.startsWith(
moduleServicePackageName)) {
continue;
}
}
addMessage(
fileName,
"Use @Reference instead of calling " + serviceUtilClassName +
" directly",
"osgi_components.markdown");
}
}
private void _checkUtilUsage(
String fileName, String content,
String serviceReferenceUtilClassName,
String moduleSuperClassContent)
throws Exception {
if (!content.contains(serviceReferenceUtilClassName) ||
(Validator.isNotNull(moduleSuperClassContent) &&
moduleSuperClassContent.contains("@Component"))) {
return;
}
int pos = serviceReferenceUtilClassName.lastIndexOf(StringPool.PERIOD);
String shortClassName = serviceReferenceUtilClassName.substring(
pos + 1);
JavaClass javaClass = JavaClassParser.parseJavaClass(fileName, content);
for (JavaTerm javaTerm : javaClass.getChildJavaTerms()) {
if (!javaTerm.isStatic() &&
(javaTerm instanceof JavaConstructor ||
javaTerm instanceof JavaMethod) &&
!javaTerm.hasAnnotation("Reference")) {
String javaTermContent = javaTerm.getContent();
if (javaTermContent.contains(
shortClassName + StringPool.PERIOD)) {
addMessage(
fileName,
"Use portal service reference instead of '" +
serviceReferenceUtilClassName + "' in modules",
"osgi_components.markdown");
return;
}
}
}
}
private String _formatDuplicateReferenceMethods(
String fileName, String content, String moduleSuperClassContent)
throws Exception {
if (Validator.isNull(moduleSuperClassContent) ||
!moduleSuperClassContent.contains("@Component") ||
!moduleSuperClassContent.contains("@Reference")) {
return content;
}
Matcher matcher = _referenceMethodPattern.matcher(
moduleSuperClassContent);
boolean bndInheritRequired = false;
while (matcher.find()) {
String referenceMethod = matcher.group();
int pos = content.indexOf(referenceMethod);
if (pos != -1) {
String referenceMethodContent = matcher.group(6);
Matcher referenceMethodContentMatcher =
_referenceMethodContentPattern.matcher(
referenceMethodContent);
if (referenceMethodContentMatcher.find()) {
String variableName = referenceMethodContentMatcher.group(
1);
if (StringUtil.count(content, variableName) > 1) {
continue;
}
}
int x = content.lastIndexOf("\n\n", pos);
int y = pos + referenceMethod.length();
String entireMethod = content.substring(x + 1, y);
content = StringUtil.replace(
content, entireMethod, StringPool.BLANK);
bndInheritRequired = true;
}
else {
String referenceMethodModifierAndName = matcher.group(2);
Pattern duplicateReferenceMethodPattern = Pattern.compile(
referenceMethodModifierAndName +
"\\(\\s*([ ,<>\\w]+)\\s+\\w+\\) \\{\\s+([\\s\\S]*?)" +
"\\s*?\n\t\\}\n");
Matcher duplicateReferenceMethodMatcher =
duplicateReferenceMethodPattern.matcher(content);
if (!duplicateReferenceMethodMatcher.find()) {
bndInheritRequired = true;
continue;
}
String methodContent = duplicateReferenceMethodMatcher.group(2);
String referenceMethodName = matcher.group(4);
if (methodContent.startsWith("super." + referenceMethodName)) {
int x = content.lastIndexOf(
"\n\n", duplicateReferenceMethodMatcher.start());
int y = duplicateReferenceMethodMatcher.end();
String entireMethod = content.substring(x + 1, y);
content = StringUtil.replace(
content, entireMethod, StringPool.BLANK);
bndInheritRequired = true;
}
}
}
if (bndInheritRequired) {
BNDSettings bndSettings = getBNDSettings(fileName);
String bndSettingsContent = bndSettings.getContent();
if (!bndSettingsContent.contains(
"-dsannotations-options: inherit") &&
_bndFileNames.add(bndSettings.getFileName())) {
addMessage(
fileName,
"Add '-dsannotations-options: inherit' to '" +
bndSettings.getFileName(),
"osgi_components_inheritance.markdown");
}
}
return content;
}
private String _formatMissingUnbindAnnotation(
String content, String methodName, String methodContent,
String annotationParameters) {
if (annotationParameters.contains("unbind =") ||
content.contains("un" + methodName + "(")) {
return content;
}
if (Validator.isNull(annotationParameters)) {
String newMethodContent = StringUtil.replaceFirst(
methodContent, "@Reference", "@Reference(unbind = \"-\")");
return StringUtil.replace(content, methodContent, newMethodContent);
}
if (!annotationParameters.contains(StringPool.NEW_LINE)) {
String newAnnotationParameters = StringUtil.replaceLast(
annotationParameters, CharPool.CLOSE_PARENTHESIS,
", unbind = \"-\")");
String newMethodContent = StringUtil.replaceFirst(
methodContent, annotationParameters, newAnnotationParameters);
return StringUtil.replace(content, methodContent, newMethodContent);
}
if (!annotationParameters.contains("\n\n")) {
String newAnnotationParameters = StringUtil.replaceLast(
annotationParameters, "\n", ",\n\t\tunbind = \"-\"\n");
String newMethodContent = StringUtil.replaceFirst(
methodContent, annotationParameters, newAnnotationParameters);
return StringUtil.replace(content, methodContent, newMethodContent);
}
return content;
}
private String _formatVolatileReferenceVariable(
String content, String methodBody, String typeName) {
Matcher matcher = _referenceMethodContentPattern.matcher(methodBody);
if (!matcher.find()) {
return content;
}
String variableName = matcher.group(1);
StringBundler sb = new StringBundler(5);
sb.append("private volatile ");
sb.append(typeName);
sb.append("\\s+");
sb.append(variableName);
sb.append(StringPool.SEMICOLON);
Pattern privateVarPattern = Pattern.compile(sb.toString());
matcher = privateVarPattern.matcher(content);
if (matcher.find()) {
String match = matcher.group();
String replacement = StringUtil.replace(
match, "private volatile ", "private ");
return StringUtil.replace(content, match, replacement);
}
return content;
}
private String _getModuleClassContent(String fullClassName)
throws Exception {
String classContent = _moduleFileContentsMap.get(fullClassName);
if (classContent != null) {
return classContent;
}
Map moduleFileNamesMap = _getModuleFileNamesMap();
String moduleFileName = moduleFileNamesMap.get(fullClassName);
if (moduleFileName == null) {
_moduleFileContentsMap.put(fullClassName, StringPool.BLANK);
return StringPool.BLANK;
}
File file = new File(moduleFileName);
classContent = FileUtil.read(file);
if (classContent != null) {
_moduleFileContentsMap.put(fullClassName, classContent);
}
return classContent;
}
private synchronized Map _getModuleFileNamesMap()
throws Exception {
if (_moduleFileNamesMap != null) {
return _moduleFileNamesMap;
}
_moduleFileNamesMap = new HashMap<>();
List fileNames = new ArrayList<>();
String moduleRootDirLocation = "modules/";
for (int i = 0; i < 6; i++) {
File file = new File(getBaseDirName() + moduleRootDirLocation);
if (file.exists()) {
fileNames = getFileNames(
getBaseDirName() + moduleRootDirLocation, new String[0],
new String[] {"**/*.java"});
break;
}
moduleRootDirLocation = "../" + moduleRootDirLocation;
}
for (String fileName : fileNames) {
fileName = StringUtil.replace(
fileName, CharPool.BACK_SLASH, CharPool.SLASH);
String className = StringUtil.replace(
fileName, CharPool.SLASH, CharPool.PERIOD);
int pos = className.lastIndexOf(".com.liferay.");
className = className.substring(pos + 1, fileName.length() - 5);
_moduleFileNamesMap.put(className, fileName);
}
return _moduleFileNamesMap;
}
private String _getModuleServicePackageName(String fileName) {
String serviceDirLocation = fileName;
while (true) {
int pos = serviceDirLocation.lastIndexOf(StringPool.SLASH);
if (pos == -1) {
return StringPool.BLANK;
}
serviceDirLocation = serviceDirLocation.substring(0, pos + 1);
File file = new File(serviceDirLocation + "service");
if (file.exists()) {
serviceDirLocation = serviceDirLocation + "service";
break;
}
file = new File(serviceDirLocation + "liferay");
if (file.exists()) {
return StringPool.BLANK;
}
serviceDirLocation = StringUtil.replaceLast(
serviceDirLocation, CharPool.SLASH, StringPool.BLANK);
}
serviceDirLocation = StringUtil.replace(
serviceDirLocation, CharPool.SLASH, CharPool.PERIOD);
int pos = serviceDirLocation.lastIndexOf(".com.");
return serviceDirLocation.substring(pos + 1);
}
private String _getModuleSuperClassContent(
String content, String className, String packageName)
throws Exception {
Pattern pattern = Pattern.compile(
" class " + className + "\\s+extends\\s+([\\w.]+) ");
Matcher matcher = pattern.matcher(content);
if (!matcher.find()) {
return null;
}
String superClassName = matcher.group(1);
if (superClassName.contains(StringPool.PERIOD)) {
if (!superClassName.startsWith("com.liferay")) {
return null;
}
return _getModuleClassContent(superClassName);
}
String superClassPackageName = packageName;
pattern = Pattern.compile("\nimport (.+?)\\." + superClassName + ";");
matcher = pattern.matcher(content);
if (matcher.find()) {
superClassPackageName = matcher.group(1);
}
if (!superClassPackageName.startsWith("com.liferay")) {
return null;
}
String superClassFullClassName =
superClassPackageName + StringPool.PERIOD + superClassName;
return _getModuleClassContent(superClassFullClassName);
}
private synchronized List _getServiceProxyFactoryUtilClassNames()
throws Exception {
if (_serviceProxyFactoryUtilClassNames != null) {
return _serviceProxyFactoryUtilClassNames;
}
if (!isPortalSource()) {
_serviceProxyFactoryUtilClassNames = Collections.emptyList();
return _serviceProxyFactoryUtilClassNames;
}
String portalKernelLocation = "portal-kernel/";
for (int i = 0; i < ToolsUtil.PORTAL_MAX_DIR_LEVEL - 1; i++) {
File file = new File(getBaseDirName() + portalKernelLocation);
if (!file.exists()) {
portalKernelLocation = "../" + portalKernelLocation;
continue;
}
_serviceProxyFactoryUtilClassNames = new ArrayList<>();
List utilFileNames = getFileNames(
getBaseDirName() + portalKernelLocation, new String[0],
new String[] {"**/*Util.java"});
for (String fileName : utilFileNames) {
fileName = StringUtil.replace(
fileName, CharPool.BACK_SLASH, CharPool.SLASH);
String content = FileUtil.read(new File(fileName));
if (content.contains(
"com.liferay.portal.kernel.util.ServiceProxyFactory")) {
_serviceProxyFactoryUtilClassNames.add(
JavaSourceUtil.getPackageName(content) + "." +
JavaSourceUtil.getClassName(fileName));
}
}
return _serviceProxyFactoryUtilClassNames;
}
_serviceProxyFactoryUtilClassNames = Collections.emptyList();
return _serviceProxyFactoryUtilClassNames;
}
private final Set _bndFileNames = new CopyOnWriteArraySet<>();
private final Map _moduleFileContentsMap =
new ConcurrentHashMap<>();
private Map _moduleFileNamesMap;
private final Pattern _referenceMethodContentPattern = Pattern.compile(
"^(\\w+) =\\s+\\w+;$");
private final Pattern _referenceMethodPattern = Pattern.compile(
"\n\t@Reference([\\s\\S]*?)\\s+((protected|public) void (\\w+?))\\(" +
"\\s*([ ,<>\\w]+)\\s+\\w+\\) \\{\\s+([\\s\\S]*?)\\s*?\n\t\\}\n");
private List _serviceProxyFactoryUtilClassNames;
private final List _serviceReferenceUtilClassNames =
new ArrayList<>();
private final Pattern _serviceUtilImportPattern = Pattern.compile(
"\nimport ([A-Za-z1-9\\.]*)\\.([A-Za-z1-9]*ServiceUtil);");
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy