Support to include a simplified XPath location in report items when the location is returned as a line position

costas80 · costas80 · commit f66841d06b7f · 2025-06-17T15:10:46.000+02:00
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/ApplicationConfig.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/ApplicationConfig.java
@@ -35,6 +35,7 @@ public class ApplicationConfig extends eu.europa.ec.itb.validation.commons.confi
     private String defaultLocationAsPathDescription;
     private String defaultLocaleDescription;
     private String defaultAddInputToReportDescription;
+    private String defaultShowLocationPathsDescription;
 
     /**
      * @return True if caching is disabled for artifact pre-processing.
@@ -288,6 +289,20 @@ public void setDefaultAddInputToReportDescription(String defaultAddInputToReport
         this.defaultAddInputToReportDescription = defaultAddInputToReportDescription;
     }
 
+    /**
+     * @return The web service description for the show location paths input.
+     */
+    public String getDefaultShowLocationPathsDescription() {
+        return defaultShowLocationPathsDescription;
+    }
+
+    /**
+     * @param defaultShowLocationPathsDescription The web service description for the show location paths input.
+     */
+    public void setDefaultShowLocationPathsDescription(String defaultShowLocationPathsDescription) {
+        this.defaultShowLocationPathsDescription = defaultShowLocationPathsDescription;
+    }
+
     /**
      * @return The default labels to use for the description of SOAP web service inputs.
      */
@@ -314,6 +329,7 @@ public void init() {
         defaultLabels.put(ValidationConstants.INPUT_LOCATION_AS_PATH, defaultLocationAsPathDescription);
         defaultLabels.put(ValidationConstants.INPUT_LOCALE, defaultLocaleDescription);
         defaultLabels.put(ValidationConstants.INPUT_ADD_INPUT_TO_REPORT, defaultAddInputToReportDescription);
+        defaultLabels.put(ValidationConstants.INPUT_SHOW_LOCATION_PATHS, defaultShowLocationPathsDescription);
     }
 
 }
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/DomainConfig.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/DomainConfig.java
@@ -32,6 +32,7 @@ public class DomainConfig extends WebDomainConfig {
     private String mailInboundFolder;
     private boolean includeTestDefinition;
     private boolean includeAssertionID;
+    private boolean includeLocationPath = false;
     private List<ContextFileConfig> contextFileConfigDefaultConfig;
     private Map<String, List<ContextFileConfig>> contextFileMap;
     private ContextFileCombinationTemplateConfig contextFileCombinationDefaultTemplate;
@@ -191,6 +192,20 @@ public ValidationArtifactInfo getSchematronInfo(String validationType) {
         return getArtifactInfo().get(validationType).get(ARTIFACT_TYPE_SCHEMATRON);
     }
 
+    /**
+     * @return True if path locations should be included in validation report items.
+     */
+    public boolean isIncludeLocationPath() {
+        return includeLocationPath;
+    }
+
+    /**
+     * @param includeLocationPath True if path locations should be included in validation report items.
+     */
+    public void setIncludeLocationPath(boolean includeLocationPath) {
+        this.includeLocationPath = includeLocationPath;
+    }
+
     /**
      * @return True if tests should be included in validation report items.
      */
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/DomainConfigCache.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/DomainConfigCache.java
@@ -84,6 +84,7 @@ protected void addDomainConfiguration(DomainConfig domainConfig, Configuration c
         domainConfig.setMailInboundFolder(config.getString("validator.mailInboundFolder", "INBOX"));
         domainConfig.setIncludeTestDefinition(config.getBoolean("validator.includeTestDefinition", true));
         domainConfig.setIncludeAssertionID(config.getBoolean("validator.includeAssertionID", true));
+        domainConfig.setIncludeLocationPath(config.getBoolean("validator.includeLocationPath", false));
         // Context files - START
         domainConfig.setContextFileDefaultConfig(ParseUtils.parseValueList("validator.defaultContextFile", config, getContextFileMapper(domainConfig, true)));
         domainConfig.setContextFiles(parseTypeSpecificContextFiles("validator.contextFile", domainConfig.getType(), config, domainConfig));
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/ValidationSpecs.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/ValidationSpecs.java
@@ -60,6 +60,7 @@ public class ValidationSpecs {
     private List<ContextFileData> contextFiles;
     private boolean locationAsPath = false;
     private boolean addInputToReport = true;
+    private Boolean showLocationPaths;
     private Path tempFolder;
     private List<SchematronFileInfo> schematronFilesToUse;
     private ApplicationContext applicationContext;
@@ -593,6 +594,16 @@ public boolean isLocationAsPath() {
         return locationAsPath;
     }
 
+    /**
+     * @return True if a simplified XPath expression should be added to report item locations.
+     */
+    public boolean isShowLocationPaths() {
+        if (showLocationPaths == null) {
+            showLocationPaths = domainConfig.isIncludeLocationPath();
+        }
+        return showLocationPaths;
+    }
+
     /**
      * @return True if the provided input should be added as context to the produced TAR report.
      */
@@ -703,6 +714,17 @@ public Builder addInputToReport(boolean addInputToReport) {
             return this;
         }
 
+        /**
+         * Whether locations will include a simplified XPath expression.
+         *
+         * @param showLocationPaths The flag's value.
+         * @return The builder.
+         */
+        public Builder showLocationPaths(boolean showLocationPaths) {
+            instance.showLocationPaths = showLocationPaths;
+            return this;
+        }
+
         /**
          * Set the temporary folder used for this validation run.
          *
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/validation/SchematronReportHandler.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/validation/SchematronReportHandler.java
@@ -39,6 +39,7 @@ public class SchematronReportHandler {
     private final SchematronOutputType svrlReport;
     private final boolean locationAsPath;
     private final LocalisationHelper localiser;
+    private final boolean includeLocationPath;
     private NamespaceContext namespaceContext;
     private XPathFactory xpathFactory;
     private Boolean hasDefaultNamespace;
@@ -58,9 +59,11 @@ public class SchematronReportHandler {
      * @param includeAssertionID True if the assertion IDs per report item should be included.
      * @param locationAsPath True if report item locations should be XPath expressions. If not the line numbers will be
      *                       calculated and recorded instead.
+     * @param includeLocationPath True to append the location XPath expression when the location is reported as the line number.
+     *                            In case locationAsPath is true this flag is ignored.
      * @param localiser Helper class for translations.
      */
-    public SchematronReportHandler(Document node, SchematronOutputType svrl, boolean convertXPathExpressions, boolean includeTest, boolean includeAssertionID, boolean locationAsPath, LocalisationHelper localiser) {
+    public SchematronReportHandler(Document node, SchematronOutputType svrl, boolean convertXPathExpressions, boolean includeTest, boolean includeAssertionID, boolean locationAsPath, boolean includeLocationPath, LocalisationHelper localiser) {
         this.node = node;
         this.svrlReport = svrl;
         report = new TAR();
@@ -71,6 +74,7 @@ public SchematronReportHandler(Document node, SchematronOutputType svrl, boolean
         this.convertXPathExpressions = convertXPathExpressions;
         this.includeTest = includeTest;
         this.includeAssertionID = includeAssertionID;
+        this.includeLocationPath = includeLocationPath;
         this.locationAsPath = locationAsPath;
         this.localiser = localiser;
     }
@@ -153,9 +157,14 @@ private <T extends AbstractSVRLMessage> List<JAXBElement<TestAssertionReportType
             reportItem.setDescription(getMessageText(message));
             if (message.getLocation() != null && !message.getLocation().isBlank()) {
                 if (locationAsPath) {
-                    reportItem.setLocation(message.getLocation());
+                    reportItem.setLocation(toPathForPresentation(message.getLocation()));
                 } else {
-                    reportItem.setLocation(ValidationConstants.INPUT_XML+":" + this.getLineNumberFromXPath(message.getLocation()) + ":0");
+                    LocationInfo locationInfo = getLocationInfo(message.getLocation());
+                    if (includeLocationPath) {
+                        reportItem.setLocation("%s:%s:0|%s".formatted(ValidationConstants.INPUT_XML, locationInfo.lineNumber(), locationInfo.path()));
+                    } else {
+                        reportItem.setLocation("%s:%s:0".formatted(ValidationConstants.INPUT_XML, locationInfo.lineNumber()));
+                    }
                 }
             }
             if (message.getTest() != null && includeTest) {
@@ -261,11 +270,12 @@ private XPathFactory getXPathFactory() {
      * @param xpathExpression The expression.
      * @return The line number.
      */
-    private String getLineNumberFromXPath(String xpathExpression) {
+    private LocationInfo getLocationInfo(String xpathExpression) {
         String xpathExpressionConverted = convertToXPathExpression(xpathExpression);
         XPath xPath = getXPathFactory().newXPath();
         xPath.setNamespaceContext(getNamespaceContext());
         Node locatedNode;
+        String lineNumber;
         try {
             locatedNode = (Node)xPath.evaluate(xpathExpressionConverted, this.node, XPathConstants.NODE);
             if (locatedNode == null) {
@@ -275,13 +285,30 @@ private String getLineNumberFromXPath(String xpathExpression) {
                 }
             }
             if (locatedNode == null) {
-                return "0";
+                lineNumber = "0";
             } else {
-                return (String)locatedNode.getUserData("lineNumber");
+                lineNumber = (String)locatedNode.getUserData("lineNumber");
             }
         } catch (Exception e) {
             logger.error("Unable to locate line for expression [{}] [{}]: {}", xpathExpression, xpathExpressionConverted, e.getMessage());
-            return "0";
+            lineNumber = "0";
+        }
+        return new LocationInfo(toPathForPresentation(xpathExpression), lineNumber);
+    }
+
+    /**
+     * Concert the provided XPath expression to one to be used for reporting.
+     *
+     * @param xpathExpression The XPath expression to process.
+     * @return The location path to use.
+     */
+    private String toPathForPresentation(String xpathExpression) {
+        if (xpathExpression != null) {
+            return xpathExpression
+                    .replaceAll("\\*:", "")
+                    .replaceAll("\\[\\s*namespace-uri\\(\\)\\s*=\\s*(?:'[^\\[\\]]+'|\"[^\\[\\]]+\")\\s*]", "");
+        } else {
+            return null;
         }
     }
 
@@ -369,4 +396,12 @@ private boolean documentHasDefaultNamespace(Document node) {
         return hasDefaultNamespace;
     }
 
+    /**
+     * Record to group together the XPath path and line number to represent a location.
+     *
+     * @param path The XPath expression.
+     * @param lineNumber The line number.
+     */
+    private record LocationInfo(String path, String lineNumber) {}
+
 }
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/validation/ValidationConstants.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/validation/ValidationConstants.java
@@ -30,6 +30,8 @@ public class ValidationConstants {
     public static final String INPUT_LOCATION_AS_PATH = "locationAsPath";
     /** Whether the validated content should be added to the TAR report. */
     public static final String INPUT_ADD_INPUT_TO_REPORT = "addInputToReport";
+    /** Whether a simplified XPath expression should be added to report item locations. */
+    public static final String INPUT_SHOW_LOCATION_PATHS = "showLocationPaths";
     /** The locale string to consider. */
     public static final String INPUT_LOCALE = "locale";
 
diff --git a/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/validation/XMLValidator.java b/xmlvalidator-common/src/main/java/eu/europa/ec/itb/xml/validation/XMLValidator.java
@@ -481,7 +481,7 @@ private TAR validateSchematron(File schematronFile, boolean supportPureValidatio
         } catch (Exception e) {
             throw new IllegalStateException("Schematron file ["+schematronFile.getName()+"] is invalid", e);
         }
-        SchematronReportHandler handler = new SchematronReportHandler(specs.inputAsDocumentForSchematronValidation(), svrlOutput, convertXPathExpressions, specs.getDomainConfig().isIncludeTestDefinition(), specs.getDomainConfig().isIncludeAssertionID(), specs.isLocationAsPath(), specs.getLocalisationHelper());
+        SchematronReportHandler handler = new SchematronReportHandler(specs.inputAsDocumentForSchematronValidation(), svrlOutput, convertXPathExpressions, specs.getDomainConfig().isIncludeTestDefinition(), specs.getDomainConfig().isIncludeAssertionID(), specs.isLocationAsPath(), specs.isShowLocationPaths(), specs.getLocalisationHelper());
         return handler.createReport();
     }
 
diff --git a/xmlvalidator-common/src/main/resources/application.properties b/xmlvalidator-common/src/main/resources/application.properties
@@ -55,6 +55,7 @@ validator.defaultContextFilesDescription=A list of maps that defines context fil
 validator.defaultLocationAsPathDescription=Whether error locations should be XPath expressions or resolve their line and column locations in the provided input.
 validator.defaultLocaleDescription=Locale (language code) to use for reporting of results. If the provided locale is not supported by the validator the default locale will be used instead (e.g. "fr", "fr_FR").
 validator.defaultAddInputToReportDescription=Whether the returned XML validation report should also include the validated input as context information.
+validator.defaultShowLocationPathsDescription=Whether report items should also include a simplified XPath expression as part of their location.
 # Properties for the OpenAPI/Swagger documentation.
 springdoc.packagesToScan = eu.europa.ec.itb.xml.rest
 springdoc.pathsToMatch = /**
diff --git a/xmlvalidator-ws/src/main/java/eu/europa/ec/itb/xml/rest/RestValidationController.java b/xmlvalidator-ws/src/main/java/eu/europa/ec/itb/xml/rest/RestValidationController.java
@@ -182,6 +182,7 @@ private TAR executeValidationProcess(Input in, DomainConfig domainConfig) {
             var validationType = inputHelper.validateValidationType(domainConfig, in.getValidationType());
             var locationAsPath = Objects.requireNonNullElse(in.getLocationAsPath(), true);
             var addInputToReport = Objects.requireNonNullElse(in.getAddInputToReport(), false);
+            var showLocationPaths = Objects.requireNonNullElse(in.getShowLocationPaths(), domainConfig.isIncludeLocationPath());
             var contentEmbeddingMethod = inputHelper.getEmbeddingMethod(in.getEmbeddingMethod());
             var externalSchemas = getExternalSchemas(domainConfig, in.getExternalSchemas(), validationType, DomainConfig.ARTIFACT_TYPE_SCHEMA, parentFolder);
             var externalSchematrons = getExternalSchemas(domainConfig, in.getExternalSchematrons(), validationType, DomainConfig.ARTIFACT_TYPE_SCHEMATRON, parentFolder);
@@ -194,6 +195,7 @@ private TAR executeValidationProcess(Input in, DomainConfig domainConfig) {
                     .withExternalSchematrons(externalSchematrons)
                     .locationAsPath(locationAsPath)
                     .addInputToReport(addInputToReport)
+                    .showLocationPaths(showLocationPaths)
                     .withContextFiles(contextFiles)
                     .withTempFolder(parentFolder.toPath())
                     .build();
diff --git a/xmlvalidator-ws/src/main/java/eu/europa/ec/itb/xml/rest/model/Input.java b/xmlvalidator-ws/src/main/java/eu/europa/ec/itb/xml/rest/model/Input.java
@@ -30,6 +30,8 @@ public class Input {
     private Boolean locationAsPath;
     @Schema(description = "Whether to include the validated input in the resulting report's context section.", defaultValue = "false")
     private Boolean addInputToReport;
+    @Schema(description = "Whether report items should also include a simplified XPath expression as part of their location.", defaultValue = "false")
+    private Boolean showLocationPaths;
     @Schema(description = "Whether to wrap the input (see addInputToReport) in a CDATA block if producing an XML report. False results in adding the input via XML escaping.", defaultValue = "false")
     private Boolean wrapReportDataInCDATA;
     @Schema(description = "Locale (language code) to use for reporting of results. If the provided locale is not supported by the validator the default locale will be used instead (e.g. 'fr', 'fr_FR').")
@@ -138,6 +140,20 @@ public void setAddInputToReport(Boolean addInputToReport) {
         this.addInputToReport = addInputToReport;
     }
 
+    /**
+     * @return Whether report items should also include a simplified XPath expression as part of their location.
+     */
+    public Boolean getShowLocationPaths() {
+        return showLocationPaths;
+    }
+
+    /**
+     * @param showLocationPaths Whether report items should also include a simplified XPath expression as part of their location.
+     */
+    public void setShowLocationPaths(Boolean showLocationPaths) {
+        this.showLocationPaths = showLocationPaths;
+    }
+
     /**
      * @return Whether to wrap the input (see addInputToReport) in a CDATA block if producing an XML report. False results in adding the input via XML escaping.
      */
diff --git a/xmlvalidator-ws/src/main/java/eu/europa/ec/itb/xml/ws/ValidationServiceImpl.java b/xmlvalidator-ws/src/main/java/eu/europa/ec/itb/xml/ws/ValidationServiceImpl.java
@@ -78,6 +78,7 @@ public GetModuleDefinitionResponse getModuleDefinition(@WebParam(name = "GetModu
         response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_EMBEDDING_METHOD, "string", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_EMBEDDING_METHOD)));
         response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_LOCATION_AS_PATH, "boolean", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_LOCATION_AS_PATH)));
         response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_ADD_INPUT_TO_REPORT, "boolean", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_ADD_INPUT_TO_REPORT)));
+        response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_SHOW_LOCATION_PATHS, "boolean", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_SHOW_LOCATION_PATHS)));
         if (inputHelper.supportsExternalArtifacts(domainConfig.getArtifactInfo(), DomainConfig.ARTIFACT_TYPE_SCHEMA)) {
             response.getModule().getInputs().getParam().add(Utils.createParameter(ValidationConstants.INPUT_EXTERNAL_SCHEMA, "list[map]", UsageEnumeration.O, ConfigurationType.SIMPLE, domainConfig.getWebServiceDescription().get(ValidationConstants.INPUT_EXTERNAL_SCHEMA)));
         }
@@ -101,6 +102,7 @@ public ValidationResponse validate(@WebParam(name = "ValidateRequest", targetNam
             ValueEmbeddingEnumeration contentEmbeddingMethod = inputHelper.validateContentEmbeddingMethod(validateRequest, ValidationConstants.INPUT_EMBEDDING_METHOD);
             boolean locationAsPath = getInputAsBoolean(validateRequest, ValidationConstants.INPUT_LOCATION_AS_PATH, false);
             boolean addInputToReport = getInputAsBoolean(validateRequest, ValidationConstants.INPUT_ADD_INPUT_TO_REPORT, true);
+            boolean showLocationPaths = getInputAsBoolean(validateRequest, ValidationConstants.INPUT_SHOW_LOCATION_PATHS, domainConfig.isIncludeLocationPath());
             File contentToValidate = inputHelper.validateContentToValidate(validateRequest, ValidationConstants.INPUT_XML, contentEmbeddingMethod, null, tempFolderPath, domainConfig.getHttpVersion()).getFile();
             String validationType = inputHelper.validateValidationType(domainConfig, validateRequest, ValidationConstants.INPUT_TYPE);
             List<FileInfo> externalSchemas = inputHelper.validateExternalArtifacts(domainConfig, validateRequest, ValidationConstants.INPUT_EXTERNAL_SCHEMA, ValidationConstants.INPUT_EXTERNAL_ARTIFACT_CONTENT, ValidationConstants.INPUT_EMBEDDING_METHOD, validationType, DomainConfig.ARTIFACT_TYPE_SCHEMA, tempFolderPath);
@@ -113,6 +115,7 @@ public ValidationResponse validate(@WebParam(name = "ValidateRequest", targetNam
                     .withExternalSchematrons(externalSchematron)
                     .locationAsPath(locationAsPath)
                     .addInputToReport(addInputToReport)
+                    .showLocationPaths(showLocationPaths)
                     .withContextFiles(contextFiles)
                     .withTempFolder(tempFolderPath.toPath())
                     .build();

Original file line number	Diff line number	Diff line change
`@@ -481,7 +481,7 @@ private TAR validateSchematron(File schematronFile, boolean supportPureValidatio`
`481`	`481`	`} catch (Exception e) {`
`482`	`482`	`throw new IllegalStateException("Schematron file ["+schematronFile.getName()+"] is invalid", e);`
`483`	`483`	`}`
`484`		`- SchematronReportHandler handler = new SchematronReportHandler(specs.inputAsDocumentForSchematronValidation(), svrlOutput, convertXPathExpressions, specs.getDomainConfig().isIncludeTestDefinition(), specs.getDomainConfig().isIncludeAssertionID(), specs.isLocationAsPath(), specs.getLocalisationHelper());`
	`484`	`+ SchematronReportHandler handler = new SchematronReportHandler(specs.inputAsDocumentForSchematronValidation(), svrlOutput, convertXPathExpressions, specs.getDomainConfig().isIncludeTestDefinition(), specs.getDomainConfig().isIncludeAssertionID(), specs.isLocationAsPath(), specs.isShowLocationPaths(), specs.getLocalisationHelper());`
`485`	`485`	`return handler.createReport();`
`486`	`486`	`}`
`487`	`487`