com.liferay.source.formatter

Class JSPSourceProcessor

java.lang.Object

com.liferay.source.formatter.BaseSourceProcessor

com.liferay.source.formatter.JSPSourceProcessor

All Implemented Interfaces:

SourceProcessor

public class JSPSourceProcessor
extends BaseSourceProcessor

Field Summary

Fields inherited from class com.liferay.source.formatter.BaseSourceProcessor

applyLangMergerPluginPattern, attributeNamePattern, bndContentDirPattern, emptyCollectionPattern, getterUtilGetPattern, javaSourceInsideJSPLinePattern, jsonObjectPutBlockPattern, jsonObjectPutPattern, languageKeyPattern, mergeLangPattern, PLUGINS_MAX_DIR_LEVEL, PORTAL_MAX_DIR_LEVEL, portalSource, principalExceptionPattern, sbAppendPattern, sbAppendWithStartingSpacePattern, sessionKeyPattern, setAttributeBlockPattern, setAttributePattern, singleLengthStringPattern, sourceFormatterArgs, stringUtilReplacePattern, taglibSessionKeyPattern, validatorEqualsPattern

Constructor Summary

Constructors

Constructor and Description
JSPSourceProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	addImportCounts(java.lang.String content)
protected java.util.List<java.lang.String>	addIncludedAndReferencedFileNames(java.util.List<java.lang.String> fileNames, java.util.Set<java.lang.String> checkedFileNames)
protected void	addJSPUnusedImports(java.lang.String fileName, java.util.List<java.lang.String> importLines, java.util.List<java.lang.String> unneededImports, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected java.lang.String	buildFullPathIncludeFileName(java.lang.String fileName, java.lang.String includeFileName)
protected void	checkDefineObjectsVariable(java.lang.String line, java.lang.String fileName, int lineCount, java.lang.String objectType, java.lang.String variableName, java.lang.String value, java.lang.String tag)
protected void	checkDefineObjectsVariables(java.lang.String line, java.lang.String fileName, java.lang.String absolutePath, int lineCount)
protected void	checkValidatorEquals(java.lang.String fileName, java.lang.String content)
protected java.lang.String	compressImportsOrTaglibs(java.lang.String fileName, java.lang.String content, java.lang.String attributePrefix)
protected java.lang.String	doFormat(java.io.File file, java.lang.String fileName, java.lang.String absolutePath, java.lang.String content)
protected java.util.List<java.lang.String>	doGetFileNames()
protected java.lang.String	fixEmptyJavaSourceTag(java.lang.String content)
protected java.lang.String	fixEmptyLineInNestedTags(java.lang.String content, java.util.regex.Pattern pattern, boolean startTag)
protected java.lang.String	fixIncorrectClosingTag(java.lang.String content)
protected java.lang.String	fixMissingEmptyLinesBetweenTags(java.lang.String content)
protected java.lang.String	fixRedirectBackURL(java.lang.String content)
protected java.lang.String	fixXSSVulnerability(java.lang.String fileName, java.lang.String content)
protected java.lang.String	formatDefineObjects(java.lang.String content)
protected java.lang.String	formatJSP(java.lang.String fileName, java.lang.String absolutePath, java.lang.String content, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected java.lang.String	formatJSPImportsOrTaglibs(java.lang.String fileName, java.lang.String content, java.util.regex.Pattern compressedPattern, java.util.regex.Pattern uncompressedPattern, boolean checkUnusedImports, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected java.lang.String	formatLogFileName(java.lang.String absolutePath, java.lang.String content)
protected java.lang.String	formatMultilineTagAttributes(java.lang.String fileName, java.lang.String content)
protected java.lang.String	formatTagAttributeType(java.lang.String line, java.lang.String tagName, java.lang.String attributeAndValue)
protected java.lang.String	formatTaglibVariable(java.lang.String fileName, java.lang.String content)
java.lang.String[]	getIncludes()
protected java.util.List<java.lang.String>	getJSPDuplicateImports(java.lang.String fileName, java.lang.String content, java.util.List<java.lang.String> importLines)
protected java.util.Set<java.lang.String>	getJSPIncludeFileNames(java.lang.String fileName, java.util.Collection<java.lang.String> fileNames)
protected java.util.Set<java.lang.String>	getJSPReferenceFileNames(java.lang.String fileName, java.util.Collection<java.lang.String> fileNames)
protected java.util.Set<java.lang.String>	getPrimitiveTagAttributeDataTypes()
protected int	getTaglibXSSVulnerabilityPos(java.lang.String content, java.lang.String vulnerability)
protected java.lang.String	getUtilTaglibSrcDirName()
protected java.lang.String	getVariableName(java.lang.String line)
protected boolean	hasUnusedJSPTerm(java.lang.String fileName, java.lang.String regex, java.lang.String type, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected boolean	hasUnusedTaglib(java.lang.String fileName, java.lang.String line, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected boolean	hasUnusedVariable(java.lang.String fileName, java.lang.String line, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected boolean	isJSPDuplicateImport(java.lang.String fileName, java.lang.String importLine, boolean checkFile)
protected boolean	isJSPTermRequired(java.lang.String fileName, java.lang.String regex, java.lang.String type, java.util.Set<java.lang.String> checkedForUnusedJSPTerm, java.util.Set<java.lang.String> checkedForIncludesFileNames, java.util.Set<java.lang.String> includeFileNames)
protected boolean	isValidTagAttributeValue(java.lang.String value, java.lang.String dataType)
protected void	moveFrequentlyUsedImportsToCommonInit(int minCount)
protected void	preFormat()
protected java.lang.String	sortHTMLAttributes(java.lang.String line, java.lang.String value, java.lang.String attributeAndValue)

Methods inherited from class com.liferay.source.formatter.BaseSourceProcessor

addExtraEmptyLine, adjustLevel, checkEmptyCollection, checkGetterUtilGet, checkIfClauseParentheses, checkInefficientStringMethods, checkInefficientStringMethods, checkLanguageKeys, checkOrder, checkPrincipalException, checkPropertyUtils, checkResourceUtil, checkStringUtilReplace, checkUTF8, fixCompatClassImports, fixCopyright, fixIncorrectParameterTypeForLanguageUtil, fixSessionKey, format, format, format, formatAttributes, formatEmptyArray, formatIncorrectSyntax, formatIncorrectSyntax, formatJavaTerms, formatStringBundler, formatWhitespace, formatWhitespace, getAbsolutePath, getAnnotationsExclusions, getBNDFileLanguageProperties, getBNDFileLocationAndContentTuple, getCompatClassNamesMap, getContent, getCustomCopyright, getFile, getFileNames, getFileNames, getFileNames, getFileNames, getFirstSourceMismatchException, getImmutableFieldTypes, getLanguageKeys, getLeadingTabCount, getLevel, getLevel, getLevel, getLevel, getLine, getLineCount, getLineLength, getLineStartPos, getMainReleaseVersion, getModifiedFileNames, getModuleLangDirNames, getModuleLangLanguageProperties, getModuleLanguageProperties, getParameterList, getPluginsInsideModulesDirectoryNames, getProperty, getPropertyList, getRunOutsidePortalExcludes, getSourceFormatterMessages, hasMissingParentheses, hasRedundantParentheses, hasRedundantParentheses, isAttributName, isExcludedPath, isExcludedPath, isExcludedPath, isModulesFile, isModulesFile, postFormat, printError, processFormattedFile, processMessage, processMessage, readXML, replacePrimitiveWrapperInstantiation, setSourceFormatterArgs, sortDefinitions, sortPutOrSetCalls, splitParameters, stripQuotes, stripQuotes, stripRedundantParentheses, trimContent, trimLine

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSPSourceProcessor

public JSPSourceProcessor()

Method Detail

getIncludes

public java.lang.String[] getIncludes()

addImportCounts

protected void addImportCounts(java.lang.String content)

addIncludedAndReferencedFileNames

protected java.util.List<java.lang.String> addIncludedAndReferencedFileNames(java.util.List<java.lang.String> fileNames,
                                                                             java.util.Set<java.lang.String> checkedFileNames)

addJSPUnusedImports

protected void addJSPUnusedImports(java.lang.String fileName,
                                   java.util.List<java.lang.String> importLines,
                                   java.util.List<java.lang.String> unneededImports,
                                   java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                   java.util.Set<java.lang.String> includeFileNames)

buildFullPathIncludeFileName

protected java.lang.String buildFullPathIncludeFileName(java.lang.String fileName,
                                                        java.lang.String includeFileName)

checkDefineObjectsVariable

protected void checkDefineObjectsVariable(java.lang.String line,
                                          java.lang.String fileName,
                                          int lineCount,
                                          java.lang.String objectType,
                                          java.lang.String variableName,
                                          java.lang.String value,
                                          java.lang.String tag)

checkDefineObjectsVariables

protected void checkDefineObjectsVariables(java.lang.String line,
                                           java.lang.String fileName,
                                           java.lang.String absolutePath,
                                           int lineCount)

checkValidatorEquals

protected void checkValidatorEquals(java.lang.String fileName,
                                    java.lang.String content)

compressImportsOrTaglibs

protected java.lang.String compressImportsOrTaglibs(java.lang.String fileName,
                                                    java.lang.String content,
                                                    java.lang.String attributePrefix)

doFormat

protected java.lang.String doFormat(java.io.File file,
                                    java.lang.String fileName,
                                    java.lang.String absolutePath,
                                    java.lang.String content)
                             throws java.lang.Exception

Specified by:

doFormat in class BaseSourceProcessor

Throws:

java.lang.Exception

doGetFileNames

protected java.util.List<java.lang.String> doGetFileNames()
                                                   throws java.lang.Exception

Specified by:

doGetFileNames in class BaseSourceProcessor

Throws:

java.lang.Exception

fixEmptyJavaSourceTag

protected java.lang.String fixEmptyJavaSourceTag(java.lang.String content)

fixEmptyLineInNestedTags

protected java.lang.String fixEmptyLineInNestedTags(java.lang.String content,
                                                    java.util.regex.Pattern pattern,
                                                    boolean startTag)

fixIncorrectClosingTag

protected java.lang.String fixIncorrectClosingTag(java.lang.String content)

fixMissingEmptyLinesBetweenTags

protected java.lang.String fixMissingEmptyLinesBetweenTags(java.lang.String content)

fixRedirectBackURL

protected java.lang.String fixRedirectBackURL(java.lang.String content)

fixXSSVulnerability

protected java.lang.String fixXSSVulnerability(java.lang.String fileName,
                                               java.lang.String content)

formatDefineObjects

protected java.lang.String formatDefineObjects(java.lang.String content)

formatJSP

protected java.lang.String formatJSP(java.lang.String fileName,
                                     java.lang.String absolutePath,
                                     java.lang.String content,
                                     java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                     java.util.Set<java.lang.String> includeFileNames)
                              throws java.lang.Exception

Throws:

java.lang.Exception

formatJSPImportsOrTaglibs

protected java.lang.String formatJSPImportsOrTaglibs(java.lang.String fileName,
                                                     java.lang.String content,
                                                     java.util.regex.Pattern compressedPattern,
                                                     java.util.regex.Pattern uncompressedPattern,
                                                     boolean checkUnusedImports,
                                                     java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                                     java.util.Set<java.lang.String> includeFileNames)
                                              throws java.io.IOException

Throws:

java.io.IOException

formatLogFileName

protected java.lang.String formatLogFileName(java.lang.String absolutePath,
                                             java.lang.String content)

formatMultilineTagAttributes

protected java.lang.String formatMultilineTagAttributes(java.lang.String fileName,
                                                        java.lang.String content)
                                                 throws java.lang.Exception

Throws:

java.lang.Exception

formatTagAttributeType

protected java.lang.String formatTagAttributeType(java.lang.String line,
                                                  java.lang.String tagName,
                                                  java.lang.String attributeAndValue)
                                           throws java.lang.Exception

Overrides:

formatTagAttributeType in class BaseSourceProcessor

Throws:

java.lang.Exception

formatTaglibVariable

protected java.lang.String formatTaglibVariable(java.lang.String fileName,
                                                java.lang.String content)

getJSPDuplicateImports

protected java.util.List<java.lang.String> getJSPDuplicateImports(java.lang.String fileName,
                                                                  java.lang.String content,
                                                                  java.util.List<java.lang.String> importLines)

getJSPIncludeFileNames

protected java.util.Set<java.lang.String> getJSPIncludeFileNames(java.lang.String fileName,
                                                                 java.util.Collection<java.lang.String> fileNames)

getJSPReferenceFileNames

protected java.util.Set<java.lang.String> getJSPReferenceFileNames(java.lang.String fileName,
                                                                   java.util.Collection<java.lang.String> fileNames)

getPrimitiveTagAttributeDataTypes

protected java.util.Set<java.lang.String> getPrimitiveTagAttributeDataTypes()

getTaglibXSSVulnerabilityPos

protected int getTaglibXSSVulnerabilityPos(java.lang.String content,
                                           java.lang.String vulnerability)

getUtilTaglibSrcDirName

protected java.lang.String getUtilTaglibSrcDirName()

getVariableName

protected java.lang.String getVariableName(java.lang.String line)

hasUnusedJSPTerm

protected boolean hasUnusedJSPTerm(java.lang.String fileName,
                                   java.lang.String regex,
                                   java.lang.String type,
                                   java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                   java.util.Set<java.lang.String> includeFileNames)

hasUnusedTaglib

protected boolean hasUnusedTaglib(java.lang.String fileName,
                                  java.lang.String line,
                                  java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                  java.util.Set<java.lang.String> includeFileNames)

hasUnusedVariable

protected boolean hasUnusedVariable(java.lang.String fileName,
                                    java.lang.String line,
                                    java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                    java.util.Set<java.lang.String> includeFileNames)

isJSPDuplicateImport

protected boolean isJSPDuplicateImport(java.lang.String fileName,
                                       java.lang.String importLine,
                                       boolean checkFile)

isJSPTermRequired

protected boolean isJSPTermRequired(java.lang.String fileName,
                                    java.lang.String regex,
                                    java.lang.String type,
                                    java.util.Set<java.lang.String> checkedForUnusedJSPTerm,
                                    java.util.Set<java.lang.String> checkedForIncludesFileNames,
                                    java.util.Set<java.lang.String> includeFileNames)

isValidTagAttributeValue

protected boolean isValidTagAttributeValue(java.lang.String value,
                                           java.lang.String dataType)

moveFrequentlyUsedImportsToCommonInit

protected void moveFrequentlyUsedImportsToCommonInit(int minCount)
                                              throws java.io.IOException

Throws:

java.io.IOException

preFormat

protected void preFormat()
                  throws java.lang.Exception

Overrides:

preFormat in class BaseSourceProcessor

Throws:

java.lang.Exception

sortHTMLAttributes

protected java.lang.String sortHTMLAttributes(java.lang.String line,
                                              java.lang.String value,
                                              java.lang.String attributeAndValue)

Overrides:

sortHTMLAttributes in class BaseSourceProcessor