com.liferay.source.formatter.check.JavaModuleUniqueVerifyProcessCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.source.formatter
Liferay Source Formatter
The newest version!
/**
 * SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
 * SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
 */

package com.liferay.source.formatter.check;

import com.liferay.source.formatter.SourceFormatterExcludes;
import com.liferay.source.formatter.check.util.SourceUtil;
import com.liferay.source.formatter.parser.JavaClass;
import com.liferay.source.formatter.parser.JavaClassParser;
import com.liferay.source.formatter.parser.JavaTerm;
import com.liferay.source.formatter.parser.ParseException;
import com.liferay.source.formatter.util.FileUtil;
import com.liferay.source.formatter.util.SourceFormatterUtil;

import java.io.File;
import java.io.IOException;

import java.util.List;

/**
 * @author Alan Huang
 */
public class JavaModuleUniqueVerifyProcessCheck extends BaseJavaTermCheck {

	@Override
	public boolean isModuleSourceCheck() {
		return true;
	}

	@Override
	protected String doProcess(
			String fileName, String absolutePath, JavaTerm javaTerm,
			String fileContent)
		throws IOException, ParseException {

		JavaClass javaClass = (JavaClass)javaTerm;

		if (javaClass.getParentJavaClass() != null) {
			return javaTerm.getContent();
		}

		List extendedClassNames = javaClass.getExtendedClassNames(true);

		if (!extendedClassNames.contains(
				"com.liferay.portal.verify.VerifyProcess")) {

			return javaTerm.getContent();
		}

		int x = absolutePath.indexOf("/src/");

		if (x == -1) {
			return javaTerm.getContent();
		}

		List javaFileNames = SourceFormatterUtil.scanForFileNames(
			absolutePath.substring(0, x + 5), new String[0],
			new String[] {"**/*.java"}, new SourceFormatterExcludes(), true);

		int extendedVerifyProcessClassCount = 0;

		for (String javaFileName : javaFileNames) {
			File file = new File(javaFileName);

			if (!file.exists()) {
				continue;
			}

			String content = FileUtil.read(file);

			if (SourceUtil.containsUnquoted(content, "@generated") ||
				SourceUtil.containsUnquoted(content, "$ANTLR")) {

				continue;
			}

			javaClass = JavaClassParser.parseJavaClass(javaFileName, content);

			extendedClassNames = javaClass.getExtendedClassNames(true);

			if (extendedClassNames.contains(
					"com.liferay.portal.verify.VerifyProcess")) {

				extendedVerifyProcessClassCount++;
			}

			if (extendedVerifyProcessClassCount > 1) {
				addMessage(
					fileName,
					"A module can not have more than 1 verify process class " +
						"(class extends VerifyProcess)");

				return javaTerm.getContent();
			}
		}

		return javaTerm.getContent();
	}

	@Override
	protected String[] getCheckableJavaTermNames() {
		return new String[] {JAVA_CLASS};
	}

}