com.jalios.jcms.tools

Class JsChecker

java.lang.Object

com.jalios.jcms.tools.AbstractChecker

com.jalios.jcms.tools.JsChecker

public class JsChecker
extends AbstractChecker

Check JS for bad coding practices.

Eg. console.log, alert(...), debugger, trailing comma, ...

Since:

jcms-7.1.3, jcms-8.0.0

Version:

$Revision: 77558 $

Author:

Sylvain Devaux

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENT_REGEX
static java.lang.String	REVISION

Fields inherited from class com.jalios.jcms.tools.AbstractChecker

CHANNEL

Constructor Summary

Constructors

Constructor and Description
JsChecker()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkAlert(CheckResult result, java.io.File jsFile, java.lang.String relativeFilePath, java.lang.String fileContent, java.util.List<java.lang.String> fileLinesList, java.lang.String fileMd5Signature)
static CheckResult	checkAll(java.io.File webappDir)
static void	checkConsole(CheckResult result, java.io.File jsFile, java.lang.String relativeFilePath, java.lang.String fileContent, java.util.List<java.lang.String> fileLinesList, java.lang.String fileMd5Signature)
static void	checkDebugger(CheckResult result, java.io.File jsFile, java.lang.String relativeFilePath, java.lang.String fileContent, java.util.List<java.lang.String> fileLinesList, java.lang.String fileMd5Signature)
static void	checkHrefAttribute(CheckResult result, java.io.File jsFile, java.lang.String relativeFilePath, java.lang.String fileContent, java.util.List<java.lang.String> fileLinesList, java.lang.String fileMd5Signature)
static void	checkPattern(java.lang.String checkName, org.apache.oro.text.regex.Pattern invalidUsePattern, java.util.regex.Pattern[] authorizedUsePatterns, CheckResult result, java.lang.String relativeFilePath, java.util.List<java.lang.String> fileLinesList) Check if the specified invalid pattern is part of any lines in the javascript File being analyez
static void	checkTrailingComma(CheckResult result, java.io.File jsFile, java.lang.String relativeFilePath, java.lang.String fileContent, java.util.List<java.lang.String> fileLinesList, java.lang.String fileMd5Signature)
protected static java.util.List<java.io.File>	getFileList(java.io.File webappDir)
static void	main(java.lang.String[] args)

Methods inherited from class com.jalios.jcms.tools.AbstractChecker

loadLanguageProperties, loadProperties, saveError

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

COMMENT_REGEX

public static final java.lang.String COMMENT_REGEX

See Also:

Constant Field Values

Constructor Detail

JsChecker

public JsChecker()

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException

getFileList

protected static java.util.List<java.io.File> getFileList(java.io.File webappDir)

checkAll

public static CheckResult checkAll(java.io.File webappDir)
                            throws java.io.IOException

Throws:

java.io.IOException

checkConsole

public static void checkConsole(CheckResult result,
                java.io.File jsFile,
                java.lang.String relativeFilePath,
                java.lang.String fileContent,
                java.util.List<java.lang.String> fileLinesList,
                java.lang.String fileMd5Signature)
                         throws java.io.IOException

Throws:

java.io.IOException

checkAlert

public static void checkAlert(CheckResult result,
              java.io.File jsFile,
              java.lang.String relativeFilePath,
              java.lang.String fileContent,
              java.util.List<java.lang.String> fileLinesList,
              java.lang.String fileMd5Signature)
                       throws java.io.IOException

Throws:

java.io.IOException

checkDebugger

public static void checkDebugger(CheckResult result,
                 java.io.File jsFile,
                 java.lang.String relativeFilePath,
                 java.lang.String fileContent,
                 java.util.List<java.lang.String> fileLinesList,
                 java.lang.String fileMd5Signature)
                          throws java.io.IOException

Throws:

java.io.IOException

checkHrefAttribute

public static void checkHrefAttribute(CheckResult result,
                      java.io.File jsFile,
                      java.lang.String relativeFilePath,
                      java.lang.String fileContent,
                      java.util.List<java.lang.String> fileLinesList,
                      java.lang.String fileMd5Signature)
                               throws java.io.IOException

Throws:

java.io.IOException

checkTrailingComma

public static void checkTrailingComma(CheckResult result,
                      java.io.File jsFile,
                      java.lang.String relativeFilePath,
                      java.lang.String fileContent,
                      java.util.List<java.lang.String> fileLinesList,
                      java.lang.String fileMd5Signature)
                               throws java.io.IOException

Throws:

java.io.IOException

checkPattern

public static void checkPattern(java.lang.String checkName,
                org.apache.oro.text.regex.Pattern invalidUsePattern,
                java.util.regex.Pattern[] authorizedUsePatterns,
                CheckResult result,
                java.lang.String relativeFilePath,
                java.util.List<java.lang.String> fileLinesList)

Check if the specified invalid pattern is part of any lines in the javascript File being analyez

Parameters:

checkName - the name of the check being formed (used in log message)

invalidUsePattern - a perl Pattern which MUST NOT be part of any line (excepted in comment)

authorizedUsePatterns - optionnal perl pattern which are authorized even though invalid pattern has matched

result - the CheckResult instance filled with the analysis result

relativeFilePath - the path (relative to the main directory being verified), of the JavaScript file being checked

fileLinesList - the lines of the files