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.JSPSourceProcessor 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;
import com.liferay.petra.string.CharPool;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.tools.GitUtil;
import com.liferay.source.formatter.checks.util.JSPSourceUtil;
import com.liferay.source.formatter.checks.util.SourceUtil;
import com.liferay.source.formatter.checkstyle.util.CheckstyleLogger;
import com.liferay.source.formatter.checkstyle.util.CheckstyleUtil;
import com.liferay.source.formatter.checkstyle.util.JSPCheckstyleUtil;
import com.liferay.source.formatter.util.SourceFormatterUtil;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
/**
* @author Hugo Huijser
*/
public class JSPSourceProcessor extends BaseSourceProcessor {
@Override
protected List doGetFileNames() throws Exception {
String[] excludes = {"**/null.jsp", "**/tools/**"};
List fileNames = getFileNames(excludes, getIncludes());
SourceFormatterArgs sourceFormatterArgs = getSourceFormatterArgs();
if (fileNames.isEmpty() ||
(!sourceFormatterArgs.isFormatCurrentBranch() &&
!sourceFormatterArgs.isFormatLatestAuthor() &&
!sourceFormatterArgs.isFormatLocalChanges())) {
return fileNames;
}
List allJSPFileNames = getFileNames(
excludes, getIncludes(), true);
Map contentsMap = JSPSourceUtil.getContentsMap(
allJSPFileNames);
Map deletedContentsMap = _getDeletedContentsMap(
excludes);
if (deletedContentsMap.isEmpty()) {
return JSPSourceUtil.addIncludedAndReferencedFileNames(
fileNames, new HashSet(), contentsMap, ".*");
}
contentsMap.putAll(deletedContentsMap);
fileNames.addAll(deletedContentsMap.keySet());
fileNames = JSPSourceUtil.addIncludedAndReferencedFileNames(
fileNames, new HashSet(), contentsMap, ".*");
fileNames.removeAll(deletedContentsMap.keySet());
return fileNames;
}
@Override
protected String[] doGetIncludes() {
return _INCLUDES;
}
@Override
protected File format(
File file, String fileName, String absolutePath, String content)
throws Exception {
// When executing 'format-source-current-branch',
// 'format-source-latest-author', or 'format-source-local-changes', we
// add included and referenced file names in order to detect unused
// imports or variable names. As a result, file names that are excluded
// via source-formatter.properties#source.formatter.excludes are also
// added to the list. Here we make sure we do not format files that
// should be excluded.
SourceFormatterArgs sourceFormatterArgs = getSourceFormatterArgs();
if (sourceFormatterArgs.isFormatCurrentBranch() ||
sourceFormatterArgs.isFormatLatestAuthor() ||
sourceFormatterArgs.isFormatLocalChanges()) {
List fileNames = SourceFormatterUtil.filterFileNames(
Arrays.asList(fileName), new String[0], new String[] {"*.*"},
getSourceFormatterExcludes(), false);
if (fileNames.isEmpty()) {
return file;
}
}
file = super.format(file, fileName, absolutePath, content);
_processCheckstyle(absolutePath, content);
return file;
}
@Override
protected void postFormat() throws CheckstyleException, IOException {
_processCheckstyle();
for (SourceFormatterMessage sourceFormatterMessage :
_sourceFormatterMessages) {
String fileName = sourceFormatterMessage.getFileName();
processMessage(fileName, sourceFormatterMessage);
printError(fileName, sourceFormatterMessage.toString());
}
}
@Override
protected void preFormat() throws CheckstyleException {
SourceFormatterArgs sourceFormatterArgs = getSourceFormatterArgs();
_checkstyleLogger = new CheckstyleLogger(
sourceFormatterArgs.getBaseDirName());
_checkstyleConfiguration = CheckstyleUtil.getConfiguration(
"checkstyle-jsp.xml", getPropertiesMap(), sourceFormatterArgs);
}
private Map _getDeletedContentsMap(String[] excludes)
throws Exception {
List fileNames = Collections.emptyList();
SourceFormatterArgs sourceFormatterArgs = getSourceFormatterArgs();
if (sourceFormatterArgs.isFormatCurrentBranch()) {
fileNames = GitUtil.getCurrentBranchFileNames(
sourceFormatterArgs.getBaseDirName(),
sourceFormatterArgs.getGitWorkingBranchName(), true);
}
else if (sourceFormatterArgs.isFormatLatestAuthor()) {
fileNames = GitUtil.getLatestAuthorFileNames(
sourceFormatterArgs.getBaseDirName(), true);
}
else if (sourceFormatterArgs.isFormatLocalChanges()) {
fileNames = GitUtil.getLocalChangesFileNames(
sourceFormatterArgs.getBaseDirName(), true);
}
if (fileNames.isEmpty()) {
return Collections.emptyMap();
}
List deletedFileNames = new ArrayList<>();
for (String fileName : fileNames) {
File file = new File(SourceUtil.getAbsolutePath(fileName));
if (!Files.exists(file.toPath())) {
deletedFileNames.add(fileName);
}
}
if (deletedFileNames.isEmpty()) {
return Collections.emptyMap();
}
Map contentsMap = new HashMap<>();
List filteredFileNames = SourceFormatterUtil.filterFileNames(
deletedFileNames, excludes, getIncludes(),
getSourceFormatterExcludes(), true);
for (String filteredFileName : filteredFileNames) {
String content = GitUtil.getCurrentBranchFileContent(
sourceFormatterArgs.getGitWorkingBranchName(),
filteredFileName);
String fileName = StringUtil.replace(
sourceFormatterArgs.getBaseDirName() + filteredFileName,
CharPool.BACK_SLASH, CharPool.SLASH);
contentsMap.put(fileName, content);
}
return contentsMap;
}
private void _processCheckstyle() throws CheckstyleException, IOException {
if (_ungeneratedFileContents.isEmpty()) {
return;
}
_sourceFormatterMessages.addAll(
processCheckstyle(
_checkstyleConfiguration, _checkstyleLogger,
_ungeneratedFileContents));
_ungeneratedFileContents.clear();
}
private synchronized void _processCheckstyle(
String absolutePath, String content)
throws CheckstyleException, IOException {
String javaContent = JSPCheckstyleUtil.getJavaContent(
absolutePath, content);
if (javaContent != null) {
_ungeneratedFileContents.add(
new String[] {absolutePath, javaContent});
if (_ungeneratedFileContents.size() == CheckstyleUtil.BATCH_SIZE) {
_processCheckstyle();
}
}
}
private static final String[] _INCLUDES = {
"**/*.jsp", "**/*.jspf", "**/*.tag", "**/*.tpl", "**/*.vm"
};
private Configuration _checkstyleConfiguration;
private CheckstyleLogger _checkstyleLogger;
private final Set _sourceFormatterMessages =
new TreeSet<>();
private final List _ungeneratedFileContents = new ArrayList<>();
}
