com.liferay.source.formatter.checks.XMLPortletFileCheck 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.checks;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.source.formatter.checks.util.SourceUtil;
import java.util.List;
import org.dom4j.Document;
import org.dom4j.DocumentException;
import org.dom4j.Element;
/**
* @author Hugo Huijser
*/
public class XMLPortletFileCheck extends BaseFileCheck {
@Override
protected String doProcess(
String fileName, String absolutePath, String content)
throws DocumentException {
if (fileName.endsWith("/liferay-portlet.xml") ||
((isPortalSource() || isSubrepository()) &&
fileName.endsWith("/portlet-custom.xml")) ||
(!isPortalSource() && !isSubrepository() &&
fileName.endsWith("/portlet.xml"))) {
_checkPortletXML(fileName, absolutePath, content);
}
return content;
}
private void _checkPortletXML(
String fileName, String absolutePath, String content)
throws DocumentException {
Document document = SourceUtil.readXML(content);
Element rootElement = document.getRootElement();
boolean checkNumericalPortletNameElement = !isExcludedPath(
_NUMERICAL_PORTLET_NAME_ELEMENT_EXCLUDES, absolutePath);
List portletElements = rootElement.elements("portlet");
for (Element portletElement : portletElements) {
if (checkNumericalPortletNameElement) {
Element portletNameElement = portletElement.element(
"portlet-name");
String portletNameText = portletNameElement.getText();
if (!Validator.isNumber(portletNameText)) {
addMessage(
fileName,
"Nonstandard portlet-name element '" + portletNameText +
"'");
}
}
}
}
private static final String _NUMERICAL_PORTLET_NAME_ELEMENT_EXCLUDES =
"numerical.portlet.name.element.excludes";
}