com.caoccao.javet.sanitizer.checkers.BaseJavetSanitizerChecker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swc4j Show documentation
swc4j (SWC for Java) is an ultra-fast JavaScript and TypeScript compilation and bundling tool on JVM.
The newest version!
/*
 * Copyright (c) 2023-2024. caoccao.com Sam Cao
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.caoccao.javet.sanitizer.checkers;

import com.caoccao.javet.sanitizer.exceptions.JavetSanitizerException;
import com.caoccao.javet.sanitizer.options.JavetSanitizerOptions;
import com.caoccao.javet.sanitizer.visitors.IJavetSanitizerVisitor;
import com.caoccao.javet.swc4j.Swc4j;
import com.caoccao.javet.swc4j.ast.enums.Swc4jAstType;
import com.caoccao.javet.swc4j.ast.interfaces.ISwc4jAst;
import com.caoccao.javet.swc4j.ast.interfaces.ISwc4jAstProgram;
import com.caoccao.javet.swc4j.exceptions.Swc4jCoreException;
import com.caoccao.javet.swc4j.options.Swc4jParseOptions;
import com.caoccao.javet.swc4j.outputs.Swc4jParseOutput;
import com.caoccao.javet.swc4j.utils.AssertionUtils;
import com.caoccao.javet.swc4j.utils.StringUtils;

/**
 * The type Base javet sanitizer checker.
 *
 * @since 0.7.0
 */
@SuppressWarnings("unchecked")
public abstract class BaseJavetSanitizerChecker implements IJavetSanitizerChecker {
    /**
     * The constant swc4j.
     *
     * @since 0.7.0
     */
    protected static final Swc4j swc4j = new Swc4j();
    /**
     * The Code string.
     *
     * @since 0.7.0
     */
    protected String codeString;
    /**
     * The Option.
     *
     * @since 0.7.0
     */
    protected JavetSanitizerOptions options;
    /**
     * The Root parser.
     *
     * @since 0.7.0
     */
    protected ISwc4jAstProgram program;

    /**
     * Instantiates a new Base javet sanitizer checker.
     *
     * @since 0.7.0
     */
    public BaseJavetSanitizerChecker() {
        this(JavetSanitizerOptions.Default);
    }

    /**
     * Instantiates a new Base javet sanitizer checker.
     *
     * @param options the option
     * @since 0.7.0
     */
    public BaseJavetSanitizerChecker(JavetSanitizerOptions options) {
        codeString = null;
        program = null;
        setOptions(options);
    }

    @Override
    public void check(String codeString) throws JavetSanitizerException {
        reset();
        this.codeString = codeString;
        validateBlank();
        Swc4jParseOptions parseOptions = new Swc4jParseOptions()
                .setMediaType(options.getMediaType())
                .setParseMode(options.getParseMode())
                .setSpecifier(options.getSpecifier())
                .setCaptureAst(true);
        try {
            Swc4jParseOutput output = swc4j.parse(codeString, parseOptions);
            program = output.getProgram();
            IJavetSanitizerVisitor visitor = options.getVisitor();
            if (visitor != null) {
                try {
                    program.visit(visitor);
                } catch (Throwable t) {
                    if (visitor.getException() != null) {
                        throw visitor.getException().setCodeString(codeString);
                    } else {
                        throw JavetSanitizerException.unknownError(t.getMessage(), t);
                    }
                }
            }
        } catch (Swc4jCoreException e) {
            throw JavetSanitizerException.parsingError(e);
        }
    }

    /**
     * Gets code string.
     *
     * @return the code string
     * @since 0.7.0
     */
    public String getCodeString() {
        return codeString;
    }

    /**
     * Gets name.
     *
     * @return the name
     * @since 0.7.0
     */
    public abstract String getName();

    @Override
    public JavetSanitizerOptions getOptions() {
        return options;
    }

    @Override
    @SuppressWarnings("unchecked")
    public  ISwc4jAstProgram getProgram() {
        return (ISwc4jAstProgram) program;
    }

    /**
     * Reset.
     *
     * @since 0.7.0
     */
    protected void reset() {
        codeString = null;
        program = null;
    }

    @Override
    public void setOptions(JavetSanitizerOptions options) {
        this.options = AssertionUtils.notNull(options, "Options");
    }

    /**
     * Validate blank.
     *
     * @throws JavetSanitizerException the javet sanitizer exception
     * @since 0.7.0
     */
    protected void validateBlank() throws JavetSanitizerException {
        if (StringUtils.isBlank(codeString)) {
            throw JavetSanitizerException.emptyCodeString().setCodeString(codeString);
        }
    }

    /**
     * Validate body not empty.
     *
     * @throws JavetSanitizerException the javet sanitizer exception
     * @since 0.7.0
     */
    protected void validateBodyNotEmpty() throws JavetSanitizerException {
        if (program.getBody().isEmpty()) {
            throw JavetSanitizerException.nodeCountTooSmall(1, program.getBody().size())
                    .setCodeString(codeString).setNode(program);
        }
    }

    /**
     * Validate body size.
     *
     * @param maxSize the max size
     * @throws JavetSanitizerException the javet sanitizer exception
     * @since 0.7.0
     */
    protected void validateBodySize(int maxSize) throws JavetSanitizerException {
        if (program.getBody().size() > maxSize) {
            throw JavetSanitizerException.nodeCountTooLarge(maxSize, program.getBody().size())
                    .setCodeString(codeString).setNode(program);
        }
    }

    /**
     * Validate node.
     *
     * @param           the type parameter
     * @param node         the node
     * @param expectedType the expected type
     * @return the node
     * @throws JavetSanitizerException the javet sanitizer exception
     * @since 0.7.0
     */
    protected  T validateNode(ISwc4jAst node, Swc4jAstType expectedType) throws JavetSanitizerException {
        if (node.getType() != expectedType) {
            throw JavetSanitizerException.invalidNode(
                            getName(),
                            Swc4jAstType.getName(expectedType.getAstClass()),
                            Swc4jAstType.getName(node.getType().getAstClass()))
                    .setCodeString(codeString).setNode(node);
        }
        return (T) node.as(expectedType.getAstClass());
    }

    /**
     * Validate node.
     *
     * @param            the type parameter
     * @param node          the node
     * @param expectedClass the expected class
     * @return the node
     * @throws JavetSanitizerException the javet sanitizer exception
     * @since 0.7.0
     */
    protected  T validateNode(ISwc4jAst node, Class expectedClass) throws JavetSanitizerException {
        if (!expectedClass.isAssignableFrom(node.getClass())) {
            throw JavetSanitizerException.invalidNode(
                            getName(),
                            Swc4jAstType.getName(expectedClass),
                            Swc4jAstType.getName(node.getType().getAstClass()))
                    .setCodeString(codeString).setNode(node);
        }
        return (T) node.as(expectedClass);
    }

    /**
     * Validate shebang.
     *
     * @param expectedClass the expected class
     * @throws JavetSanitizerException the javet sanitizer exception
     * @since 0.7.0
     */
    protected void validateShebang(Class expectedClass) throws JavetSanitizerException {
        if (!options.isShebangEnabled() && program.getShebang().isPresent()) {
            throw JavetSanitizerException.invalidNode(
                            getName(),
                            Swc4jAstType.getName(expectedClass),
                            "Shebang " + program.getShebang().get())
                    .setCodeString(codeString).setNode(program);
        }
    }
}