Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* SonarQube XML Plugin
* Copyright (C) 2010-2018 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program 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 3 of the License, or (at your option) any later version.
*
* This program 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.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.plugins.xml.checks;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.xml.XMLConstants;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import org.apache.commons.lang.StringUtils;
import org.apache.xerces.impl.Constants;
import org.sonar.api.utils.log.Logger;
import org.sonar.api.utils.log.Loggers;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.plugins.xml.Utils;
import org.sonar.plugins.xml.parsers.DetectSchemaParser;
import org.sonar.plugins.xml.parsers.DetectSchemaParser.Doctype;
import org.sonar.plugins.xml.schemas.SchemaResolver;
import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.SAXParseException;
/**
* RSPEC-2322.
* Perform schema check using xerces parser.
* @author Matthijs Galesloot
*/
@Rule(key = "XmlSchemaCheck")
public class XmlSchemaCheck extends AbstractXmlCheck {
/**
* filePattern indicates which files should be checked.
*/
@RuleProperty(key = "filePattern", description = "Files to be validated using Ant-style matching patterns.")
private String filePattern;
/**
* schemas may refer to a schema that is provided as a built-in resource, a web resource or a file resource.
*/
@RuleProperty(
key = "schemas",
description = "Whitespace-separated list of schemas to use for validation.",
defaultValue = DEFAULT_SCHEMA,
type = "TEXT")
private String schemas;
/**
* Use Sonar logger instead of SL4FJ logger, in order to be able to unit test the logs.
*/
private static final Logger LOG = Loggers.get(XmlSchemaCheck.class);
private static final Map CACHED_SCHEMAS = new HashMap<>();
public static final String DEFAULT_SCHEMA = "autodetect";
/**
* MessageHandler creates violations for errors and warnings. The handler is assigned to {@link Validator} to catch the errors and
* warnings raised by the validator.
*/
private class MessageHandler implements ErrorHandler {
private void createViolation(SAXParseException e) {
XmlSchemaCheck.this.createViolation(e.getLineNumber(), e.getLocalizedMessage());
if (e.getLocalizedMessage().contains(UnrecoverableParseError.FAILUREMESSAGE)) {
throw new UnrecoverableParseError(e);
}
}
@Override
public void error(SAXParseException e) throws SAXException {
createViolation(e);
}
@Override
public void fatalError(SAXParseException e) throws SAXException {
createViolation(e);
}
@Override
public void warning(SAXParseException e) throws SAXException {
createViolation(e);
}
}
/**
* Exception for a parse error from which the parser cannot recover.
*/
private static class UnrecoverableParseError extends RuntimeException {
static final String FAILUREMESSAGE = "The reference to entity \"null\"";
private static final long serialVersionUID = 1L;
public UnrecoverableParseError(SAXParseException e) {
super(e);
}
}
/**
* Create xsd schema for a list of schema's.
*/
private Schema createSchema(String[] schemaList) {
final String cacheKey = StringUtils.join(schemaList, ",");
// first try to load a cached schema.
Schema schema = CACHED_SCHEMAS.get(cacheKey);
if (schema != null) {
return schema;
}
List schemaSources = new ArrayList<>();
// load each schema in a StreamSource.
for (String schemaReference : schemaList) {
InputStream input = SchemaResolver.getBuiltinSchema(schemaReference);
if (input == null) {
throw new SchemaNotFoundException("Could not load schema \"" + schemaReference + "\"");
}
schemaSources.add(new StreamSource(input));
}
// create a schema for the list of StreamSources.
try {
SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
schemaFactory.setResourceResolver(new SchemaResolver());
schema = schemaFactory.newSchema(schemaSources.toArray(new Source[schemaSources.size()]));
CACHED_SCHEMAS.put(cacheKey, schema);
return schema;
} catch (SAXException e) {
LOG.warn("Could not validate file {}", getWebSourceCode());
LOG.warn("Reason: Unable to create schema for [{}]", cacheKey);
LOG.warn("Cause: {}", e.toString());
return null;
}
}
private void autodetectSchemaAndValidate() {
final Doctype doctype = detectSchema();
if (doctype.getDtd() != null) {
// first try doctype as this is more specific
InputStream input = SchemaResolver.getBuiltinSchema(doctype.getDtd());
if (input == null) {
LOG.error("Could not validate {} for doctype {}", getWebSourceCode(), doctype.getDtd());
} else {
Utils.closeQuietly(input);
validate(new String[]{doctype.getDtd()});
}
} else if (doctype.getNamespace() != null && !StringUtils.isEmpty(doctype.getNamespace())) {
// try namespace
validate(new String[]{doctype.getNamespace()});
} else {
LOG.info("Could not autodetect schema for {}, skip validation.", getWebSourceCode());
}
}
/**
* Checks if a certain message has already been raised. Avoids duplicate messages.
*/
private boolean containsMessage(SAXException e) {
if (e instanceof SAXParseException) {
SAXParseException spe = (SAXParseException) e;
for (XmlIssue i : getWebSourceCode().getXmlIssues()) {
if (i.getLine() == spe.getLineNumber() && i.getMessage().equals(spe.getMessage())) {
return true;
}
}
}
return false;
}
private Doctype detectSchema() {
return new DetectSchemaParser().findDoctype(getWebSourceCode().createInputStream());
}
public String getFilePattern() {
return filePattern;
}
public String getSchemas() {
return schemas;
}
static void setFeature(Validator validator, String feature, boolean value) {
try {
validator.setFeature(feature, value);
} catch (SAXNotRecognizedException | SAXNotSupportedException e) {
throw new IllegalStateException(e);
}
}
public void setFilePattern(String filePattern) {
this.filePattern = filePattern;
}
public void setSchemas(String schemas) {
this.schemas = schemas;
}
private void validate() {
try {
if ("autodetect".equalsIgnoreCase(schemas)) {
autodetectSchemaAndValidate();
} else {
String[] schemaList = StringUtils.split(schemas, " \t\n");
validate(schemaList);
}
} catch (SchemaNotFoundException e) {
LOG.warn("Cannot validate file {}", getWebSourceCode());
LOG.warn("Cause: {}", e.toString());
}
}
private void validate(String[] schemaList) {
Schema schema = createSchema(schemaList);
if (schema != null) {
Validator validator = schema.newValidator();
setFeature(validator, Constants.XERCES_FEATURE_PREFIX + "continue-after-fatal-error", true);
validator.setErrorHandler(new MessageHandler());
validator.setResourceResolver(new SchemaResolver());
// Validate and catch the exceptions. MessageHandler will receive the errors and warnings.
try {
LOG.info("Validating {} with schema {}", getWebSourceCode(), StringUtils.join(schemaList, ","));
validator.validate(new StreamSource(getWebSourceCode().createInputStream()));
} catch (SAXException e) {
if (!containsMessage(e)) {
createViolation(0, e.getMessage());
}
} catch (IOException e) {
LOG.warn("Unable to validate file {}", getWebSourceCode());
LOG.warn("Cause: {}", e.getMessage());
} catch (UnrecoverableParseError e) {
// ignore, message already reported.
}
}
}
@Override
public void validate(XmlSourceCode xmlSourceCode) {
setWebSourceCode(xmlSourceCode);
if (schemas != null && isFileIncluded(filePattern)) {
validate();
}
}
@SuppressWarnings("serial")
private static class SchemaNotFoundException extends RuntimeException {
SchemaNotFoundException(String msg) {
super(msg);
}
}
}
