{headline}
+{description}
+ {children} +
+
+ {({ className, style, tokens, getLineProps, getTokenProps }) => (
+
+ {(enableCopy || download) && (
+
+ );
+}
+
+export default Codeblock;
diff --git a/server/ui/src/components/Codeblock/index.ts b/server/ui/src/components/Codeblock/index.ts
new file mode 100644
index 0000000..ba756c3
--- /dev/null
+++ b/server/ui/src/components/Codeblock/index.ts
@@ -0,0 +1,3 @@
+import Codeblock from "./Codeblock";
+
+export default Codeblock;
diff --git a/server/ui/src/components/Dropzone/Dropzone.module.css b/server/ui/src/components/Dropzone/Dropzone.module.css
new file mode 100644
index 0000000..c47bb98
--- /dev/null
+++ b/server/ui/src/components/Dropzone/Dropzone.module.css
@@ -0,0 +1,94 @@
+:where(.dropzone) {
+ --dropzone-color-text: var(--text-faded);
+ --dropzone-icon-active: var(--text-accent-2);
+ --dropzone-color-background: var(--surface-2);
+ --dropzone-color-background-active: var(--surface-accent-0);
+ --dropzone-color-border: var(--color-border);
+ --dropzone-color-border-active: var(--color-border-accent);
+ --dropzone-opacity-hover-preview: 0;
+ --dropzone-shadow-opacity: 0;
+ --dropzone-border-size: 0.2rem;
+}
+
+:where([data-theme="dark"] .dropzone) {
+ --dropzone-color-text: var(--text-0);
+ --dropzone-icon-active: var(--text-accent-0);
+ --dropzone-color-background: transparent;
+ --dropzone-color-background-active: var(--surface-accent-5);
+}
+
+.dropzone {
+ position: relative;
+ cursor: pointer;
+ width: 100%;
+ height: 15em;
+ color: var(--dropzone-color-text);
+ background: var(--dropzone-color-background);
+ border: var(--dropzone-border-size) dashed var(--dropzone-color-border);
+ border-radius: var(--border-radius-medium);
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ box-shadow: var(--ifm-global-shadow-lw);
+}
+
+.dropzone::before {
+ content: "";
+ position: absolute;
+ pointer-events: none;
+ top: 0;
+ right: 0;
+ bottom: 0;
+ left: 0;
+ box-shadow: var(--ifm-global-shadow-md);
+ z-index: -1;
+ opacity: var(--dropzone-shadow-opacity);
+ transition: opacity 200ms ease;
+}
+
+.active {
+ --dropzone-opacity-hover-preview: 0.8;
+ --dropzone-shadow-opacity: 1;
+}
+
+.hasFiles {
+ --dropzone-color-background: var(--dropzone-color-background-active);
+ --dropzone-color-border: var(--dropzone-color-border-active);
+ --dropzone-shadow-opacity: 0.25;
+}
+
+.fileHoverPreview {
+ --dropzone-color-background: var(--dropzone-color-background-active);
+ --dropzone-color-border: var(--dropzone-color-border-active);
+
+ position: absolute;
+ top: calc(-1 * var(--dropzone-border-size));
+ right: calc(-1 * var(--dropzone-border-size));
+ bottom: calc(-1 * var(--dropzone-border-size));
+ left: calc(-1 * var(--dropzone-border-size));
+ display: flex;
+ justify-content: center;
+ align-items: center;
+ color: var(--dropzone-color-text);
+ background: var(--dropzone-color-background);
+ border: var(--dropzone-border-size) dashed var(--dropzone-color-border);
+ border-radius: var(--border-radius-medium);
+ opacity: var(--dropzone-opacity-hover-preview);
+ transition: opacity 150ms ease-in-out;
+}
+
+.icon {
+ font-size: 3rem;
+ width: 1em;
+ height: 1em;
+}
+
+.fileHoverIcon {
+ font-size: 5rem;
+ color: var(--dropzone-icon-active);
+}
+
+.uploadIcon {
+ color: var(--dropzone-color-text);
+ margin-right: 0.5rem;
+}
diff --git a/server/ui/src/components/Dropzone/Dropzone.tsx b/server/ui/src/components/Dropzone/Dropzone.tsx
new file mode 100644
index 0000000..66a639d
--- /dev/null
+++ b/server/ui/src/components/Dropzone/Dropzone.tsx
@@ -0,0 +1,80 @@
+/* eslint-disable react/jsx-props-no-spreading */
+import React, { JSX } from "react";
+import clsx from "clsx";
+import type { DropEvent } from "react-dropzone";
+import { useDropzone } from "react-dropzone";
+import type { DropzoneProps, RejectionType } from "./types";
+import styles from "./Dropzone.module.css";
+
+const Dropzone = ({
+ accept,
+ children,
+ className,
+ activeClassName,
+ multiple = false,
+ name,
+ onDrop,
+ hasSelectedFiles,
+ ...props
+}: DropzoneProps): JSX.Element => {
+ const handleDrop = (
+ accepted: File[],
+ fileRejections: RejectionType[],
+ event: DropEvent,
+ ) => {
+ const rejected = fileRejections.map((rejection) => rejection.file);
+ onDrop(accepted, rejected, event);
+ };
+ const {
+ getRootProps,
+ getInputProps,
+ isDragActive,
+ isDragAccept,
+ isDragReject,
+ } = useDropzone({ accept, multiple, onDrop: handleDrop, ...props });
+ return (
+
+ {tokens.map((line, i) => (
+ // eslint-disable-next-line react/jsx-key
+
+ {line.map((token, key) => (
+ // eslint-disable-next-line react/jsx-key
+
+ ))}
+
+ ))}
+
+ )}
+
+ {enableCopy && (
+
+ )}
+ {download && (
+
+ )}
+
+ )}
+
+
+ );
+};
+
+export default Dropzone;
diff --git a/server/ui/src/components/Dropzone/index.ts b/server/ui/src/components/Dropzone/index.ts
new file mode 100644
index 0000000..ec82590
--- /dev/null
+++ b/server/ui/src/components/Dropzone/index.ts
@@ -0,0 +1,5 @@
+import Dropzone from "./Dropzone";
+
+export { default as useDropzone } from "./useDropzone";
+
+export default Dropzone;
diff --git a/server/ui/src/components/Dropzone/types.ts b/server/ui/src/components/Dropzone/types.ts
new file mode 100644
index 0000000..e1229cb
--- /dev/null
+++ b/server/ui/src/components/Dropzone/types.ts
@@ -0,0 +1,24 @@
+import type { ReactNode, RefAttributes } from "react";
+import type {
+ DropEvent,
+ DropzoneProps as ReactDropzoneProps,
+ DropzoneRef,
+} from "react-dropzone";
+import type { ExtendProps } from "../util/types";
+
+export interface RejectionType {
+ file: File;
+}
+
+export type DropzoneProps = ExtendProps<
+ ReactDropzoneProps & RefAttributes
+
+
+
+ {children}
+
+
+ {title}
+ {children}
+
+ );
+}
+
+export default ErrorDisplay;
diff --git a/server/ui/src/components/ErrorDisplay/index.ts b/server/ui/src/components/ErrorDisplay/index.ts
new file mode 100644
index 0000000..0532c0c
--- /dev/null
+++ b/server/ui/src/components/ErrorDisplay/index.ts
@@ -0,0 +1,3 @@
+import ErrorDisplay from "./ErrorDisplay";
+
+export default ErrorDisplay;
diff --git a/server/ui/src/components/PageLayout/PageLayout.module.css b/server/ui/src/components/PageLayout/PageLayout.module.css
new file mode 100644
index 0000000..2e21fd7
--- /dev/null
+++ b/server/ui/src/components/PageLayout/PageLayout.module.css
@@ -0,0 +1,3 @@
+.headline {
+ font-size: 3rem;
+}
diff --git a/server/ui/src/components/PageLayout/PageLayout.tsx b/server/ui/src/components/PageLayout/PageLayout.tsx
new file mode 100644
index 0000000..0f64e01
--- /dev/null
+++ b/server/ui/src/components/PageLayout/PageLayout.tsx
@@ -0,0 +1,30 @@
+import type { JSX, ReactNode } from "react";
+import React from "react";
+import Layout from "@theme/Layout";
+import styles from "./PageLayout.module.css";
+
+function PageLayout({
+ children,
+ layoutDescription,
+ description,
+ title,
+ headline,
+}: {
+ children: ReactNode;
+ layoutDescription: string;
+ description: string;
+ headline: string;
+ title?: string;
+}): JSX.Element {
+ return (
+
+
+ {data || error?.message || ""}
+
+
+ )}
+
+ );
+}
+
+export default Upload;
diff --git a/server/ui/src/components/Upload/index.ts b/server/ui/src/components/Upload/index.ts
new file mode 100644
index 0000000..6955a66
--- /dev/null
+++ b/server/ui/src/components/Upload/index.ts
@@ -0,0 +1,3 @@
+import Upload from "./Upload";
+
+export default Upload;
diff --git a/server/ui/src/components/XmlView/XmlView.tsx b/server/ui/src/components/XmlView/XmlView.tsx
new file mode 100644
index 0000000..7c29fa8
--- /dev/null
+++ b/server/ui/src/components/XmlView/XmlView.tsx
@@ -0,0 +1,35 @@
+import React, { useEffect } from "react";
+import Codeblock from "../Codeblock";
+import ErrorDisplay from "../ErrorDisplay";
+import useRequest, { RequestStatus } from "../util/useRequest";
+
+function XmlView({
+ endpoint,
+ fileName,
+}: {
+ endpoint: string;
+ fileName: string;
+}): JSX.Element {
+ const { request, data, error, status } = useRequest();
+
+ useEffect(() => {
+ request(endpoint, { headers: { "Content-Type": "application/xml" } });
+ }, [endpoint, request]);
+
+ return (
+ <>
+ {status === RequestStatus.Failure && error && (
+ - * Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other {@link Source - * Soures}. You need to supply the hashcode for identification then. + * Reads a test document from a {@link Source}. Note: computing the hashcode is only supported for + * {@link StreamSource}. You can not directly use other {@link Source Soures}. You need to supply the hashcode for + * identification then. * * @param source source * @return an {@link Input} */ - public static Input read(final StreamSource source) { - return read(source, DEFAULT_ALGORITH); + public static Input read(final Source source) { + if (source instanceof StreamSource) { + return read(source, source.getSystemId(), DEFAULT_ALGORITH); + } + final String name = UUID.randomUUID().toString(); + return read(source, name, PSEUDO_NAME_ALGORITHM, name.getBytes()); } /** * Reads a test document from a {@link Source} using a specified digest algorithm. * - * Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other {@link Source - * Soures}. You need to supply the hashcode for identification then. + * Note: computing the hashcode is only supported for {@link StreamSource}. You can not directly use other + * {@link Source Soures}. You need to supply the hashcode for identification then. * * @param source source - * @param digestAlgorithm the digest algorithm + * @param name the digest algorithm * @return an {@link Input} */ - public static Input read(final StreamSource source, final String digestAlgorithm) { - return read(source, digestAlgorithm, null); + public static Input read(final Source source, final String name) { + checkNotEmpty(name); + return read(source, name, PSEUDO_NAME_ALGORITHM, name.getBytes()); + } + + public static Input read(final Source source, final String name, final String digestAlgorithm) { + return read(source, name, digestAlgorithm, null); } /** @@ -198,7 +213,12 @@ public class InputFactory { */ public static Input read(final Source source, final String digestAlgorithm, final byte[] hashcode) { checkNull(source); - return new SourceInput(source, source.getSystemId(), digestAlgorithm, hashcode); + return read(source, source.getSystemId(), digestAlgorithm, hashcode); + } + + public static Input read(final Source source, final String name, final String digestAlgorithm, final byte[] hashcode) { + checkNull(source); + return new SourceInput(source, name, digestAlgorithm, hashcode); } /** @@ -278,7 +298,20 @@ public class InputFactory { */ public static Input read(final InputStream inputStream, final String name, final String digestAlgorithm) { checkNull(inputStream); - return read(new StreamSource(inputStream, name), digestAlgorithm); + return read(new StreamSource(inputStream, name), name, digestAlgorithm); + } + + /** + * Reads a saxon {@link XdmNode} with a given name. Hashcode identification is based on the name of the supplied + * input. Now real hashcode is computed. + * + * @param node the node to read + * @param name the name of the {@link Input} + * @return an {@link Input} to validate + */ + public static Input read(final XdmNode node, final String name) { + checkNull(node); + return new XdmNodeInput(node, name, PSEUDO_NAME_ALGORITHM, name.getBytes()); } } diff --git a/src/main/java/de/kosit/validationtool/api/ResolvingConfigurationStrategy.java b/src/main/java/de/kosit/validationtool/api/ResolvingConfigurationStrategy.java index 86cad76..37be24f 100644 --- a/src/main/java/de/kosit/validationtool/api/ResolvingConfigurationStrategy.java +++ b/src/main/java/de/kosit/validationtool/api/ResolvingConfigurationStrategy.java @@ -1,3 +1,19 @@ +/* + * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT) + * + * 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 de.kosit.validationtool.api; import java.net.URI; @@ -7,7 +23,7 @@ import javax.xml.validation.Schema; import javax.xml.validation.SchemaFactory; import javax.xml.validation.Validator; -import net.sf.saxon.s9api.Processor; +import net.sf.saxon.lib.UnparsedTextURIResolver; /** * Centralized construction and configuration of XML related infrastructure components. This interface allows to use @@ -28,39 +44,37 @@ public interface ResolvingConfigurationStrategy { /** * Creates a preconfigured {@link SchemaFactory} for loading {@link javax.xml.validation.Schema} objects. The * implementation is responsible for xml security. Take care - * + * * @return preconfigured {@link SchemaFactory} */ SchemaFactory createSchemaFactory(); - /** - * Returns a preconfigured {@link Processor Saxon Processor} for various tasks within the Validator. The validator - * leverages the saxon s9api for internal processing e.g. xml reading and writing. So this is the main object to secure - * for reading, transforming and writing xml files. - * - * Note: you need exactly one instance for all validator related processing. - * - * @return a preconfigured {@link Processor} - */ - Processor getProcessor(); - /** * Creates a specific implementation for resolving referenced objects in XML files. The URIResolver is used for * dereferencing an absolute URI (after resolution) to return a {@link javax.xml.transform.Source}. It can be * used for resolving relative URIs against a base URI or restrict access to certain URIs. *
- * This URIResolver is used to dereference the URIs appearing in xsl:import, xsl:include, and
- * xsl:import-schema declarations.
+ * This URIResolver is used to dereference the URIs appearing in xsl:import, xsl:include,
+ * and xsl:import-schema declarations.
*
unparsed-text()
+ * function.
+ *
+ * @param scenarioRepository an optional repository, your implementation might not need this
+ * @return a preconfigured {@link net.sf.saxon.lib.UnparsedTextURIResolver} or null for using saxons default
+ */
+ UnparsedTextURIResolver createUnparsedTextURIResolver(URI scenarioRepository);
+
+ /**
+ * Creates a preconfigured {@link Validator } instance for a given schema for xml file validation. The
+ * implementation takes care about security and reference resolving strategies.
*
* @param schema the scheme to create a {@link Validator} for
* @return a preconfigured {@link Validator}
diff --git a/src/main/java/de/kosit/validationtool/api/Result.java b/src/main/java/de/kosit/validationtool/api/Result.java
index a32adb2..f3ed697 100644
--- a/src/main/java/de/kosit/validationtool/api/Result.java
+++ b/src/main/java/de/kosit/validationtool/api/Result.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.api;
import java.util.List;
@@ -6,18 +22,19 @@ import org.oclc.purl.dsdl.svrl.FailedAssert;
import org.oclc.purl.dsdl.svrl.SchematronOutput;
import org.w3c.dom.Document;
+import de.kosit.validationtool.impl.model.CustomFailedAssert;
import net.sf.saxon.s9api.XdmNode;
/**
- * API Rückgabe Objekt des Ergebnisses des Validierungsprozesses.
+ * API result object holding various information of the validation process results.
*
* @author Andreas Penski
*/
public interface Result {
/**
- * Zeigt an, ob die Verarbeitung durch den Validator erfolgreich durchlaufen wurde. Diese Funktion macht ausdrücklich
- * keine Aussage über die zur Akzeptanz.
+ * Zeigt an, ob die Verarbeitung durch den Validator erfolgreich durchlaufen wurde. Diese Funktion macht
+ * ausdrücklich keine Aussage über die zur Akzeptanz.
*
* @return true, wenn die Verarbeitung komplett und erfolgreich durchlaufen wurde
* @see #getAcceptRecommendation()
@@ -53,23 +70,31 @@ public interface Result {
/**
* Schnellzugriff auf die Empfehlung zur Weiterverarbeitung des Dokuments.
*
- * @return true wenn {@link AcceptRecommendation#ACCEPTABLE}
+ * @return true wenn {@link AcceptRecommendation#ACCEPTABLE}
*/
boolean isAcceptable();
/**
* Gibt eine Liste mit gefundenen Schema-Validation-Fehler zurück. Diese Liste ist leer, wenn keine Fehler gefunden
* wurden.
+ *
+ * @return List of schema validation errors.
*/
Listnull but maybe empty.
+ */
+ Listtrue if XML Schema compliant
*/
boolean isSchemaValid();
/**
* Liefert ein true, wenn der Prüfling eine well-formed XML-Datei ist.
*
- * @return true wenn well-formed
+ * @return true if wellformed
*/
boolean isWellformed();
/**
- * Returns true, if schematron has been checked and the result does not contain any {@link FailedAssert FailedAsserts}.
+ * Returns true, if schematron has been checked and the result does not contain any {@link FailedAssert
+ * FailedAsserts}.
*
- * @return true, if valid
+ * @return true, if valid
*/
boolean isSchematronValid();
}
diff --git a/src/main/java/de/kosit/validationtool/api/XmlError.java b/src/main/java/de/kosit/validationtool/api/XmlError.java
index 962b61e..5432b0b 100644
--- a/src/main/java/de/kosit/validationtool/api/XmlError.java
+++ b/src/main/java/de/kosit/validationtool/api/XmlError.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.api;
/**
diff --git a/src/main/java/de/kosit/validationtool/cmd/CheckAssertionAction.java b/src/main/java/de/kosit/validationtool/cmd/CheckAssertionAction.java
index 79d4d24..655c080 100644
--- a/src/main/java/de/kosit/validationtool/cmd/CheckAssertionAction.java
+++ b/src/main/java/de/kosit/validationtool/cmd/CheckAssertionAction.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.cmd;
@@ -26,16 +23,14 @@ import java.util.Map;
import org.apache.commons.lang3.StringUtils;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-
import de.kosit.validationtool.cmd.assertions.AssertionType;
import de.kosit.validationtool.cmd.assertions.Assertions;
import de.kosit.validationtool.impl.model.Result;
import de.kosit.validationtool.impl.tasks.CheckAction;
-
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.XPathCompiler;
@@ -59,12 +54,12 @@ class CheckAssertionAction implements CheckAction {
private Map codes = new HashSet<>();
+
+ public Code[] mergeCodes(final Collection newCodes) {
+ return mergeCodes(newCodes.toArray(new Code[newCodes.size()]));
+ }
+
+ public Code[] mergeCodes(final Code... newCodes) {
+ final Code[] allCodes = ArrayUtils.addAll(ArrayUtils.addAll(this.codes.toArray(new Code[0]), newCodes), this.textColor,
+ this.background);
+
+ final Optional color = Arrays.stream(allCodes).filter(Objects::nonNull).filter(Code::isColor).findFirst();
+ final Optional bg = Arrays.stream(allCodes).filter(Objects::nonNull).filter(Code::isBackground).findFirst();
+ final List attributes = Arrays.stream(allCodes).filter(Objects::nonNull).filter(Code::isBackground).filter(Code::isColor)
+ .collect(Collectors.toList());
+ attributes.add(color.orElse(this.textColor));
+ attributes.add(bg.orElse(this.background));
+ return attributes.stream().filter(Objects::nonNull).toArray(Code[]::new);
+ }
+
+ /**
+ * Sets explicit text color.
+ *
+ * @param textColor the color.
+ *
+ * @return this {@link Format}
+ */
+ public Format color(final Code textColor) {
+ this.textColor = textColor;
+ return this;
+ }
+
+ /**
+ * Sets explicit background color.
+ *
+ * @param color the color.
+ *
+ * @return this {@link Format}
+ */
+ public Format background(final Code color) {
+ this.background = color;
+ return this;
+ }
+
+ /**
+ * Fügt weitere Formatierungscodes hinzu.
+ *
+ * @param codes die Codes
+ *
+ * @return this {@link Format}
+ */
+ public Format addCodes(final Code... codes) {
+ this.codes.addAll(Arrays.asList(codes));
+ return this;
+ }
+}
diff --git a/src/main/java/de/kosit/validationtool/cmd/report/Grid.java b/src/main/java/de/kosit/validationtool/cmd/report/Grid.java
new file mode 100644
index 0000000..944acb6
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/cmd/report/Grid.java
@@ -0,0 +1,327 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.cmd.report;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.stream.Collectors;
+import java.util.stream.IntStream;
+import java.util.stream.Stream;
+
+import org.apache.commons.lang3.StringUtils;
+import org.fusesource.jansi.AnsiRenderer.Code;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+/**
+ * An text based grid for cli based programs.
+ *
+ * @author Andreas Penski
+ */
+public class Grid {
+
+ /**
+ * A definition / configuration for a column with a result table.
+ */
+ @Getter
+ public static class ColumnDefinition {
+
+ private static final int MAX_LENGTH = 80;
+
+ private final String name;
+
+ private int length = 0;
+
+ private final int maxLength;
+
+ private final int minLength;
+
+ private final int maxLines;
+
+ private Justify justify = Justify.LEFT;
+
+ /**
+ * Constructor.
+ *
+ * @param name the name of the column
+ */
+ public ColumnDefinition(final String name) {
+ this(name, -1, -1, 1);
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param name the name of the column
+ * @param maxLength the max length of the column
+ */
+ public ColumnDefinition(final String name, final int maxLength) {
+ this(name, maxLength, -1, 1);
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param name the name of the column
+ * @param maxLength the max length of the column
+ * @param minLength the minimum length of the column
+ */
+ public ColumnDefinition(final String name, final int maxLength, final int minLength) {
+ this(name, maxLength, minLength, 1);
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param name the name of the column
+ * @param maxLength the max length of the column
+ * @param minLength the minimum length of the column
+ * @param maxLines the max lines per cell
+ */
+ public ColumnDefinition(final String name, final int maxLength, final int minLength, final int maxLines) {
+ this.name = name;
+ this.maxLength = maxLength;
+ this.minLength = minLength;
+ this.maxLines = maxLines;
+ }
+
+ /**
+ * Returns the actual max length of the column
+ *
+ * @return max length
+ */
+ public int getLength() {
+ if (this.minLength > 0 && this.minLength > this.length) {
+ return this.minLength;
+ }
+ if (this.maxLength > 0 && this.length > this.maxLength) {
+ return this.maxLength;
+ }
+ return this.length;
+ }
+
+ /**
+ * Sets a calculated length for the column.
+ *
+ * @param length the length
+ */
+ public void setLength(final int length) {
+ if (length > this.length) {
+ this.length = length;
+ }
+ if (length > MAX_LENGTH) {
+ this.length = MAX_LENGTH;
+ }
+ }
+
+ public ColumnDefinition justify(final Justify justify) {
+ this.justify = justify;
+ return this;
+ }
+ }
+
+ @RequiredArgsConstructor
+ @Getter
+ private static class Cell {
+
+ private final Format format = DEFAULT_FORMAT;
+
+ private final List text;
+
+ public Cell(final Text txt) {
+ this.text = new ArrayList<>();
+ this.text.add(txt);
+ }
+
+ protected Line getFormattedLine(final int lineNumber, final ColumnDefinition def) {
+ final Line line = new Line();
+ int startSubstring = lineNumber * def.getLength();
+ int currentVisibleLength = 0;
+ for (final Text t : this.text) {
+ final String part = t.getVisibleText(startSubstring, def.getLength());
+ currentVisibleLength += part.length();
+ if (StringUtils.isNotBlank(part)) {
+ line.add(part, t.getFormat());
+ if (currentVisibleLength >= def.getLength()) {
+ break;
+ }
+ startSubstring = 0;
+ } else {
+ startSubstring = startSubstring - t.getLength();
+ }
+ }
+ return line;
+ }
+
+ protected List getFormattedLines(final ColumnDefinition def) {
+ int count = 0;
+ Line line;
+ final List lines = new ArrayList<>();
+ while ((line = getFormattedLine(count++, def)).isNotEmpty()) {
+ lines.add(line);
+ }
+ return lines;
+ }
+
+ public String render(final int row, final ColumnDefinition def) {
+ final List test = getFormattedLines(def);
+ final Line line = test.size() > row ? test.get(row) : null;
+ if (line != null) {
+ return def.getJustify().apply(line.render(false, row == def.getMaxLines() - 1 && test.size() > def.getMaxLines()),
+ def.getLength() + (line.getLength() - line.getVisibleLength()));
+ }
+ return def.getJustify().apply("", def.getLength());
+
+ }
+
+ }
+
+ private static final Format DEFAULT_FORMAT = new Format();
+
+ /**
+ * A grid / table for printing results.
+ */
+
+ private final List definitions = new ArrayList<>();
+
+ private final List values = new ArrayList<>();
+
+ /**
+ * Constructor.
+ *
+ * @param def {@link ColumnDefinition}s
+ */
+ public Grid(final ColumnDefinition... def) {
+ Stream.of(def).forEach(this::addColumn);
+ }
+
+ private String generateGridStart() {
+ return IntStream.range(0, getLineLength() + this.definitions.size()).mapToObj(i -> "-").collect(Collectors.joining("")) + "\n";
+ }
+
+ private String generateGridEnd() {
+ return IntStream.range(0, getLineLength() + this.definitions.size()).mapToObj(i -> "-").collect(Collectors.joining("")) + "\n";
+ }
+
+ private String generateHeader() {
+ return "|" + this.definitions.stream().map(d -> StringUtils.rightPad(d.getName(), d.getLength())).collect(Collectors.joining("|"))
+ + "|\n";
+ }
+
+ /**
+ * Adds new a column definition.
+ *
+ * @param def definitions
+ * @return this grid
+ */
+ public Grid addColumn(final ColumnDefinition def) {
+ this.definitions.add(def);
+ return this;
+ }
+
+ private void calculateLength() {
+ IntStream.range(0, this.definitions.size()).forEach(i -> {
+ final ColumnDefinition def = this.definitions.get(i);
+ final List column = getColumn(i);
+ final int maxLength = column.stream().mapToInt(cell -> cell.getText().stream().mapToInt(Text::getLength).sum()).max().orElse(0);
+ def.setLength(Math.max(maxLength, def.getName().length()));
+
+ });
+ }
+
+ public List getColumn(final int index) {
+
+ return IntStream.range(0, this.values.size()).filter(n -> n % this.definitions.size() == index).mapToObj(this.values::get)
+ .collect(Collectors.toList());
+ }
+
+ public Grid addCell(final Cell cell) {
+ this.values.add(cell);
+ return this;
+ }
+
+ public Grid addCell(final Text... text) {
+ return addCell(new Cell(Arrays.asList(text)));
+ }
+
+ public Grid addCell(final Object cell, final Code... codes) {
+ final Format f = new Format();
+ f.addCodes(codes);
+ final Text t = new Text(cell, f);
+ return addCell(new Cell(t));
+ }
+
+ public Grid addCell(final Object cell) {
+ return addCell(cell, DEFAULT_FORMAT.getTextColor());
+ }
+
+ private Collection> prepareLines() {
+ final AtomicInteger counter = new AtomicInteger();
+ final int chunkSize = this.definitions.size();
+ return this.values.stream().collect(Collectors.groupingBy(it -> counter.getAndIncrement() / chunkSize)).values();
+ }
+
+ public String render() {
+ final StringBuilder b = new StringBuilder();
+ calculateLength();
+ b.append(generateGridStart());
+ b.append(generateHeader());
+ prepareLines().forEach(line -> b.append(printLine(line)));
+
+ b.append(generateGridEnd());
+ return b.toString();
+ }
+
+ private String printLine(final List line) {
+ final StringBuilder b = new StringBuilder();
+ int virtualLine = 0;
+ while (true) {
+ final StringBuilder current = new StringBuilder();
+ final int bound = this.definitions.size();
+ for (int i = 0; i < bound; i++) {
+ final ColumnDefinition def = this.definitions.get(i);
+ current.append("|");
+ current.append(line.get(i).render(virtualLine, def));
+ }
+ current.append("|");
+ if (isEmpty(current) || virtualLine >= getMaxVirtualLine()) {
+ break;
+ }
+ b.append(current.toString());
+ virtualLine++;
+ b.append("\n");
+ }
+ return b.toString();
+
+ }
+
+ private static boolean isEmpty(final StringBuilder current) {
+ return current.toString().replace("|", "").trim().length() == 0;
+ }
+
+ private int getMaxVirtualLine() {
+ return this.definitions.stream().mapToInt(ColumnDefinition::getMaxLines).max().orElseThrow(IllegalAccessError::new);
+ }
+
+ private int getLineLength() {
+ return this.definitions.stream().map(ColumnDefinition::getLength).reduce(0, Integer::sum);
+ }
+}
diff --git a/src/main/java/de/kosit/validationtool/cmd/report/Justify.java b/src/main/java/de/kosit/validationtool/cmd/report/Justify.java
new file mode 100644
index 0000000..b90b3c7
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/cmd/report/Justify.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.cmd.report;
+
+import org.apache.commons.lang3.StringUtils;
+
+/**
+ * Justification modes for the text in grid columns.
+ *
+ * @author Andreas Penski
+ */
+public enum Justify {
+
+ LEFT {
+
+ @Override
+ public String apply(final String string, final int length) {
+ return StringUtils.rightPad(string, length);
+ }
+ },
+ CENTER {
+
+ @Override
+ public String apply(final String string, final int length) {
+ return StringUtils.center(string, length);
+ }
+ },
+ RIGHT {
+
+ @Override
+ public String apply(final String string, final int length) {
+ return StringUtils.leftPad(string, length);
+ }
+ };
+
+ public abstract String apply(String string, int length);
+}
diff --git a/src/main/java/de/kosit/validationtool/cmd/report/Line.java b/src/main/java/de/kosit/validationtool/cmd/report/Line.java
new file mode 100644
index 0000000..c8233a0
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/cmd/report/Line.java
@@ -0,0 +1,122 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.cmd.report;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.apache.commons.lang3.StringUtils;
+import org.fusesource.jansi.AnsiRenderer.Code;
+
+import lombok.NoArgsConstructor;
+
+/**
+ * Helper for printing a colored lines (with newline at the end) to the console.
+ */
+@NoArgsConstructor
+public class Line {
+
+ private final List texts = new ArrayList<>();
+
+ private Format baseFormat = new Format();
+
+ /**
+ * Constructor.
+ *
+ * @param format the configured base format
+ */
+ public Line(final Format format) {
+ this.baseFormat = format;
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param codes Ansi escape codes for formatting
+ */
+ public Line(final Code... codes) {
+ this(new Format().addCodes(codes));
+ }
+
+ /**
+ * Add some text to the line.
+ *
+ * @param text the text
+ * @return this line
+ */
+ public Line add(final Text text) {
+ this.texts.add(text);
+ return this;
+ }
+
+ public Line add(final Object t) {
+ return add(new Text(t));
+ }
+
+ public Line add(final Object text, final Code... codes) {
+ return add(new Text(text, codes));
+ }
+
+ public Line add(final Object text, final Format format) {
+ return add(new Text(text, format));
+ }
+
+ public String render() {
+ return render(true, false);
+ }
+
+ public String render(final boolean newLine, final boolean dotted) {
+ final List joins = new ArrayList<>();
+ final List reversed = new ArrayList<>(this.texts);
+ int replace = 0;
+ Collections.reverse(reversed);
+ if (dotted && getVisibleLength() > replace) {
+ replace = 3;
+ }
+ for (final Text t : reversed) {
+ if (replace > 0) {
+ final String render = t.render(t.getVisibleText(0, t.getVisibleLength() - replace), this.baseFormat);
+ if (StringUtils.isNotEmpty(render)) {
+ joins.add(render);
+ }
+ replace = replace - t.getVisibleLength();
+ } else {
+ joins.add(t.render(this.baseFormat));
+ }
+
+ }
+ Collections.reverse(joins);
+ return String.join(" ", joins) + (dotted ? "..." : "") + (newLine ? "\n" : "");
+ }
+
+ public int getLength() {
+ return this.texts.stream().mapToInt(Text::getLength).sum();
+ }
+
+ public static String render(final String text, final Code... codes) {
+ return new Line().add(text, codes).render();
+ }
+
+ public boolean isNotEmpty() {
+ return !this.texts.isEmpty();
+ }
+
+ public int getVisibleLength() {
+ return this.texts.stream().mapToInt(Text::getVisibleLength).sum();
+ }
+}
diff --git a/src/main/java/de/kosit/validationtool/cmd/report/Text.java b/src/main/java/de/kosit/validationtool/cmd/report/Text.java
new file mode 100644
index 0000000..1db9433
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/cmd/report/Text.java
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.cmd.report;
+
+import java.util.Arrays;
+
+import org.fusesource.jansi.AnsiRenderer;
+import org.fusesource.jansi.AnsiRenderer.Code;
+
+import lombok.Getter;
+
+/**
+ * Ansi formatted text for outputting to the console.
+ *
+ * @author Andreas Penski
+ */
+@Getter
+public class Text {
+
+ private final String value;
+
+ private Format format;
+
+ public Text(final Object value) {
+ this.value = value != null ? value.toString() : "";
+ this.format = new Format();
+ }
+
+ public Text(final Object value, final Format format) {
+ this(value);
+ this.format = format;
+ }
+
+ public Text(final Object value, final Code... codes) {
+ this(value, new Format().addCodes(codes));
+ }
+
+ public String getVisibleText(final int startIndex, final int length) {
+ if (startIndex < 0) {
+ return "Wrong cell text index";
+ }
+ if (startIndex > this.value.length()) {
+ return "";
+ }
+ final String substring = this.value.substring(startIndex);
+ return substring.length() > length ? substring.substring(0, length) : substring;
+ }
+
+ public String render(final String text, final Format baseformat) {
+ return AnsiRenderer.render(text,
+ Arrays.stream(this.format.mergeCodes(baseformat.getCodes())).map(Code::name).toArray(String[]::new));
+ }
+
+ public int getLength() {
+ return render(this.format).length();
+ }
+
+ public String render(final Format baseFormat) {
+ return render(getValue(), baseFormat);
+ }
+
+ public int getVisibleLength() {
+ return this.value.length();
+ }
+}
diff --git a/src/main/java/de/kosit/validationtool/config/Builder.java b/src/main/java/de/kosit/validationtool/config/Builder.java
index 6182e30..5b7d4f0 100644
--- a/src/main/java/de/kosit/validationtool/config/Builder.java
+++ b/src/main/java/de/kosit/validationtool/config/Builder.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import de.kosit.validationtool.impl.ContentRepository;
diff --git a/src/main/java/de/kosit/validationtool/config/ConfigurationBuilder.java b/src/main/java/de/kosit/validationtool/config/ConfigurationBuilder.java
index ce199b3..e8d4c67 100644
--- a/src/main/java/de/kosit/validationtool/config/ConfigurationBuilder.java
+++ b/src/main/java/de/kosit/validationtool/config/ConfigurationBuilder.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import static de.kosit.validationtool.impl.DateFactory.createTimestamp;
@@ -5,6 +21,7 @@ import static de.kosit.validationtool.impl.DateFactory.createTimestamp;
import java.net.URI;
import java.nio.file.Path;
import java.time.LocalDate;
+import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
@@ -51,8 +68,6 @@ public class ConfigurationBuilder {
private ResolvingMode resolvingMode = ResolvingMode.STRICT_RELATIVE;
- private Processor processor;
-
private String author = "API";
private String date = LocalDate.now().toString();
@@ -107,7 +122,7 @@ public class ConfigurationBuilder {
* @return this
*/
public ConfigurationBuilder date(final Date date) {
- return date(date != null ? LocalDate.ofEpochDay(date.getTime()) : null);
+ return date(date != null ? date.toInstant().atZone(ZoneId.systemDefault()).toLocalDate() : null);
}
/**
@@ -252,12 +267,9 @@ public class ConfigurationBuilder {
* @return a valid configuration
* @throws IllegalStateException when the configuration is not valid/complete
*/
- public Configuration build() {
+ public Configuration build(final Processor processor) {
final ResolvingConfigurationStrategy resolving = getResolvingConfigurationStrategy();
- if (this.processor == null) {
- this.processor = resolving.getProcessor();
- }
- final ContentRepository contentRepository = new ContentRepository(resolving, this.repository);
+ final ContentRepository contentRepository = new ContentRepository(processor, resolving, this.repository);
final List list = initializeScenarios(contentRepository);
final Scenario fallbackScenario = initializeFallback(contentRepository);
diff --git a/src/main/java/de/kosit/validationtool/config/ConfigurationLoader.java b/src/main/java/de/kosit/validationtool/config/ConfigurationLoader.java
index 0457459..0f279d8 100644
--- a/src/main/java/de/kosit/validationtool/config/ConfigurationLoader.java
+++ b/src/main/java/de/kosit/validationtool/config/ConfigurationLoader.java
@@ -1,6 +1,20 @@
-package de.kosit.validationtool.config;
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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.
+ */
-import static org.apache.commons.lang3.StringUtils.startsWith;
+package de.kosit.validationtool.config;
import java.net.MalformedURLException;
import java.net.URI;
@@ -11,10 +25,7 @@ import java.util.stream.Collectors;
import javax.xml.validation.Schema;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.Strings;
import de.kosit.validationtool.api.Check;
import de.kosit.validationtool.api.Configuration;
@@ -25,6 +36,7 @@ import de.kosit.validationtool.impl.ContentRepository;
import de.kosit.validationtool.impl.ConversionService;
import de.kosit.validationtool.impl.ResolvingMode;
import de.kosit.validationtool.impl.Scenario;
+import de.kosit.validationtool.impl.SchemaProvider;
import de.kosit.validationtool.impl.model.Result;
import de.kosit.validationtool.impl.tasks.DocumentParseAction;
import de.kosit.validationtool.impl.xml.RelativeUriResolver;
@@ -32,14 +44,17 @@ import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
import de.kosit.validationtool.model.scenarios.ResourceType;
import de.kosit.validationtool.model.scenarios.ScenarioType;
import de.kosit.validationtool.model.scenarios.Scenarios;
-
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.QName;
import net.sf.saxon.s9api.XdmNode;
import net.sf.saxon.s9api.XdmNodeKind;
/**
- * Configuration class that loads neccessary {@link Check} configuration from an existing scenario.xml specification.
+ * Configuration class that loads necessary {@link Check} configuration from an existing scenario.xml specification.
* This is the recommended option when an official configuration exists as is the case with 'xrechnung'.
*
* @author Andreas Penski
@@ -52,6 +67,8 @@ public class ConfigurationLoader {
private static final String SUPPORTED_MAJOR_VERSION_SCHEMA = "http://www.xoev.de/de/validator/framework/1/scenarios";
+ protected final Map parameters = new HashMap<>();
+
/**
* URL, die auf die scenerio.xml Datei zeigt.
*/
@@ -67,16 +84,6 @@ public class ConfigurationLoader {
protected ResolvingConfigurationStrategy resolvingConfigurationStrategy;
- protected final Map parameters = new HashMap<>();
-
- URI getScenarioRepository() {
- if (this.scenarioRepository == null) {
- log.info("Creating default scenario repository (alongside scenario definition)");
- return RelativeUriResolver.resolve(URI.create("."), this.scenarioDefinition);
- }
- return this.scenarioRepository;
- }
-
private static void checkVersion(final URI scenarioDefinition, final Processor processor) {
try {
final Result result = new DocumentParseAction(processor)
@@ -104,8 +111,8 @@ public class ConfigurationLoader {
private static boolean isSupportedDocument(final XdmNode doc) {
final XdmNode root = findRoot(doc);
final String frameworkVersion = root.getAttributeValue(new QName("frameworkVersion"));
- return startsWith(frameworkVersion, SUPPORTED_MAJOR_VERSION)
- && root.getNodeName().getNamespaceURI().equals(SUPPORTED_MAJOR_VERSION_SCHEMA);
+ return Strings.CS.startsWith(frameworkVersion, SUPPORTED_MAJOR_VERSION)
+ && root.getNodeName().getNamespace().equals(SUPPORTED_MAJOR_VERSION_SCHEMA);
}
private static Scenario createFallback(final Scenarios scenarios, final ContentRepository repository) {
@@ -115,12 +122,43 @@ public class ConfigurationLoader {
}
- public Configuration build() {
- final ResolvingConfigurationStrategy resolving = getResolvingConfigurationStrategy();
- final Processor processor = resolving.getProcessor();
- final ContentRepository contentRepository = new ContentRepository(resolving, getScenarioRepository());
+ private static List initializeScenarios(final Scenarios def, final ContentRepository contentRepository) {
+ return def.getScenario().stream().map(s -> initialize(s, contentRepository)).collect(Collectors.toList());
+ }
- final Scenarios def = loadScenarios(contentRepository.getScenarioSchema(), processor);
+ private static Scenario initialize(final ScenarioType def, final ContentRepository repository) {
+ final Scenario s = new Scenario(def);
+ s.setMatchExecutable(repository.createMatchExecutable(def));
+ s.setSchema(repository.createSchema(def));
+ s.setSchematronValidations(repository.createSchematronTransformations(def));
+ if (def.getCreateReport() != null) {
+ s.setReportTransformation(repository.createReportTransformation(def));
+ } else {
+ log.warn("No report configured. Will provide an internal format as report!");
+ s.setReportTransformation(repository.createIdentityTransformation());
+ }
+ s.setFactory(repository.getResolvingConfigurationStrategy());
+ s.setUriResolver(repository.getResolver());
+ s.setUnparsedTextURIResolver(repository.getUnparsedTextURIResolver());
+ if (def.getAcceptMatch() != null) {
+ s.setAcceptExecutable(repository.createAccepptExecutable(def));
+ }
+ return s;
+ }
+
+ URI getScenarioRepository() {
+ if (this.scenarioRepository == null) {
+ log.info("Creating default scenario repository (alongside scenario definition)");
+ return RelativeUriResolver.resolve(URI.create("."), this.scenarioDefinition);
+ }
+ return this.scenarioRepository;
+ }
+
+ public Configuration build(final Processor processor) {
+ final ResolvingConfigurationStrategy resolving = getResolvingConfigurationStrategy();
+ final ContentRepository contentRepository = new ContentRepository(processor, resolving, getScenarioRepository());
+
+ final Scenarios def = loadScenarios(SchemaProvider.getScenarioSchema(), processor);
final List scenarios = initializeScenarios(def, contentRepository);
final Scenario fallbackScenario = createFallback(def, contentRepository);
final DefaultConfiguration configuration = new DefaultConfiguration(scenarios, fallbackScenario);
@@ -134,10 +172,6 @@ public class ConfigurationLoader {
return (configuration);
}
- private static List initializeScenarios(final Scenarios def, final ContentRepository contentRepository) {
- return def.getScenario().stream().map(s -> initialize(s, contentRepository)).collect(Collectors.toList());
- }
-
private ResolvingConfigurationStrategy getResolvingConfigurationStrategy() {
if (this.resolvingConfigurationStrategy != null) {
log.info("Custom resolving strategy supplied. Please take care of xml security!");
@@ -148,10 +182,10 @@ public class ConfigurationLoader {
}
private Scenarios loadScenarios(final Schema scenarioSchema, final Processor processor) {
- final ConversionService conversionService = new ConversionService();
checkVersion(this.scenarioDefinition, processor);
log.info("Loading scenarios from {}", this.scenarioDefinition);
final CollectingErrorEventHandler handler = new CollectingErrorEventHandler();
+ final ConversionService conversionService = new ConversionService();
final Scenarios scenarios = conversionService.readXml(this.scenarioDefinition, Scenarios.class, scenarioSchema, handler);
if (!handler.hasErrors()) {
log.info("Loading scenario content from {}", this.getScenarioRepository());
@@ -163,35 +197,28 @@ public class ConfigurationLoader {
}
- private static Scenario initialize(final ScenarioType def, final ContentRepository repository) {
- final Scenario s = new Scenario(def);
- s.setMatchExecutable(repository.createMatchExecutable(def));
- s.setSchema(repository.createSchema(def));
- s.setSchematronValidations(repository.createSchematronTransformations(def));
- s.setReportTransformation(repository.createReportTransformation(def));
- if (def.getAcceptMatch() != null) {
- s.setAcceptExecutable(repository.createAccepptExecutable(def));
- }
- return s;
- }
-
/**
* Sets actual {@link ResolvingMode}, when the validator needs to resolve stuff on startup.
+ *
* @param mode the resolving mode
* @return this
*/
public ConfigurationLoader setResolvingMode(final ResolvingMode mode) {
+ if (this.resolvingConfigurationStrategy != null) {
+ log.warn("Ignoring resolving mode configuration since a custom strategy is already defined");
+ }
this.resolvingMode = mode;
return this;
}
- public ConfigurationLoader setResolvingStrategy(final ResolvingConfigurationStrategy strategy){
+ public ConfigurationLoader setResolvingStrategy(final ResolvingConfigurationStrategy strategy) {
this.resolvingConfigurationStrategy = strategy;
return this;
}
/**
* Add a parameter to the configuration.
+ *
* @param name the name of the parameter
* @param value the parameter value object
* @return this
diff --git a/src/main/java/de/kosit/validationtool/config/DefaultConfiguration.java b/src/main/java/de/kosit/validationtool/config/DefaultConfiguration.java
index 830f86b..9771867 100644
--- a/src/main/java/de/kosit/validationtool/config/DefaultConfiguration.java
+++ b/src/main/java/de/kosit/validationtool/config/DefaultConfiguration.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import java.util.List;
diff --git a/src/main/java/de/kosit/validationtool/config/FallbackBuilder.java b/src/main/java/de/kosit/validationtool/config/FallbackBuilder.java
index d81b096..c58dda0 100644
--- a/src/main/java/de/kosit/validationtool/config/FallbackBuilder.java
+++ b/src/main/java/de/kosit/validationtool/config/FallbackBuilder.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import java.net.URI;
@@ -30,6 +46,9 @@ public class FallbackBuilder implements Builder {
object.setCreateReport(build.getObject().getLeft());
final Scenario s = new Scenario(object);
s.setFallback(true);
+ s.setFactory(repository.getResolvingConfigurationStrategy());
+ s.setUriResolver(repository.getResolver());
+ s.setUnparsedTextURIResolver(repository.getUnparsedTextURIResolver());
s.setReportTransformation(build.getObject().getRight());
result = new Result<>(s);
} else {
@@ -48,8 +67,8 @@ public class FallbackBuilder implements Builder {
}
/**
- * Specifices a source for this report. This is either used to compile the report transformation or as documentation for
- * a precompiled tranformation.
+ * Specifices a source for this report. This is either used to compile the report transformation or as documentation
+ * for a precompiled tranformation.
*
* @param source the source
* @return this
@@ -60,8 +79,8 @@ public class FallbackBuilder implements Builder {
}
/**
- * Specifices a source for this report. This is either used to compile the report transformation or as documentation for
- * a precompiled tranformation.
+ * Specifices a source for this report. This is either used to compile the report transformation or as documentation
+ * for a precompiled tranformation.
*
* @param source the source
* @return this
@@ -72,8 +91,8 @@ public class FallbackBuilder implements Builder {
}
/**
- * Specifices a source for this report. This is either used to compile the report transformation or as documentation for
- * a precompiled tranformation.
+ * Specifices a source for this report. This is either used to compile the report transformation or as documentation
+ * for a precompiled tranformation.
*
* @param source the source
* @return this
diff --git a/src/main/java/de/kosit/validationtool/config/Keys.java b/src/main/java/de/kosit/validationtool/config/Keys.java
index bd37c5c..f814260 100644
--- a/src/main/java/de/kosit/validationtool/config/Keys.java
+++ b/src/main/java/de/kosit/validationtool/config/Keys.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
/**
@@ -11,9 +27,10 @@ public final class Keys {
* The actual scenarios file location as used with {@link ConfigurationLoader}.
*/
public static final String SCENARIOS_FILE = "scenarios_file";
+
/**
- * The actual scenarios configuration represented as serializable tree. This either loaded from file or build manually
- * via {@link ConfigurationBuilder}
+ * The actual scenarios configuration represented as serializable tree. This either loaded from file or build
+ * manually via {@link ConfigurationBuilder}
*/
public static final String SCENARIO_DEFINITION = "scenario_definition";
diff --git a/src/main/java/de/kosit/validationtool/config/ReportBuilder.java b/src/main/java/de/kosit/validationtool/config/ReportBuilder.java
index b512877..2d601cf 100644
--- a/src/main/java/de/kosit/validationtool/config/ReportBuilder.java
+++ b/src/main/java/de/kosit/validationtool/config/ReportBuilder.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import static org.apache.commons.lang3.ObjectUtils.isNotEmpty;
@@ -70,8 +86,8 @@ public class ReportBuilder implements Builder {
buildReport(repository, errors, scenario);
buildAccept(repository, errors, scenario);
buildNamespaces(scenario);
+ scenario.setFactory(repository.getResolvingConfigurationStrategy());
+ scenario.setUriResolver(repository.getResolver());
+ scenario.setUnparsedTextURIResolver(repository.getUnparsedTextURIResolver());
return new Result<>(scenario, errors);
}
@@ -157,8 +176,8 @@ public class ScenarioBuilder implements Builder {
/**
* Add description for this scenario. This is part of the
- * {@link de.kosit.validationtool.model.reportInput.CreateReportInput} configuration and can be used while creating the
- * report
+ * {@link de.kosit.validationtool.model.reportInput.CreateReportInput} configuration and can be used while creating
+ * the report
*
* @param description the description
* @return this
diff --git a/src/main/java/de/kosit/validationtool/config/SchemaBuilder.java b/src/main/java/de/kosit/validationtool/config/SchemaBuilder.java
index 3c7aa1d..b6d4151 100644
--- a/src/main/java/de/kosit/validationtool/config/SchemaBuilder.java
+++ b/src/main/java/de/kosit/validationtool/config/SchemaBuilder.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import static org.apache.commons.lang3.ObjectUtils.isNotEmpty;
diff --git a/src/main/java/de/kosit/validationtool/config/SchematronBuilder.java b/src/main/java/de/kosit/validationtool/config/SchematronBuilder.java
index 73c187b..bafcdca 100644
--- a/src/main/java/de/kosit/validationtool/config/SchematronBuilder.java
+++ b/src/main/java/de/kosit/validationtool/config/SchematronBuilder.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.config;
import static org.apache.commons.lang3.ObjectUtils.isNotEmpty;
@@ -70,8 +86,8 @@ public class SchematronBuilder implements Builder {
- private static final String[] IGNORED_PREFIXES = new String[] { "xsd", "saxon", "xsl", "xs" };
+ private static final String[] IGNORED_PREFIXES = new String[] { "xsd", "saxon", "xsl", "xs", "xml" };
private final String name;
@@ -44,6 +60,10 @@ class XPathBuilder implements Builder {
@Setter(AccessLevel.PACKAGE)
private Map namespaces;
+ private static Result createError(final String msg) {
+ return new Result<>(null, Collections.singletonList(msg));
+ }
+
Map getNamespaces() {
if (this.namespaces == null) {
this.namespaces = new HashMap<>();
@@ -53,7 +73,7 @@ class XPathBuilder implements Builder {
/**
* Returns the xpath expression.
- *
+ *
* @return xpath expression
*/
public String getXPath() {
@@ -94,7 +114,7 @@ class XPathBuilder implements Builder {
final Iterable iterable = () -> iterator;
StreamSupport.stream(iterable.spliterator(), false).filter(e -> !ArrayUtils.contains(IGNORED_PREFIXES, e))
.filter(StringUtils::isNotBlank).forEach(e -> ns.put(e, this.executable.getUnderlyingExpression().getInternalExpression()
- .getRetainedStaticContext().getURIForPrefix(e, false)));
+ .getRetainedStaticContext().getURIForPrefix(e, false).toString()));
getNamespaces().putAll(ns);
}
@@ -102,8 +122,4 @@ class XPathBuilder implements Builder {
private String extractExpression() {
return this.executable.getUnderlyingExpression().getInternalExpression().toString();
}
-
- private static Result createError(final String msg) {
- return new Result<>(null, Collections.singletonList(msg));
- }
}
diff --git a/src/main/java/de/kosit/validationtool/daemon/BaseHandler.java b/src/main/java/de/kosit/validationtool/daemon/BaseHandler.java
index 9aaae1c..e84dd28 100644
--- a/src/main/java/de/kosit/validationtool/daemon/BaseHandler.java
+++ b/src/main/java/de/kosit/validationtool/daemon/BaseHandler.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
import java.io.IOException;
@@ -15,32 +31,36 @@ abstract class BaseHandler implements HttpHandler {
protected static final String APPLICATION_XML = "application/xml";
- protected static final int OK = 200;
-
protected static void write(final HttpExchange exchange, final byte[] content, final String contentType) throws IOException {
- write(exchange, contentType, os -> os.write(content));
+ write(exchange, content, contentType, HttpStatus.SC_OK);
}
- protected static void write(final HttpExchange exchange, final String contentType, Write write) throws IOException {
+ protected static void write(final HttpExchange exchange, final byte[] content, final String contentType, final int statusCode)
+ throws IOException {
+ write(exchange, contentType, os -> os.write(content), statusCode);
+ }
+
+ protected static void write(final HttpExchange exchange, final String contentType, final Write write, final int statusCode)
+ throws IOException {
exchange.getResponseHeaders().add("Content-Type", contentType);
- exchange.sendResponseHeaders(OK, 0);
- final OutputStream os = exchange.getResponseBody();
- write.write(os);
- os.close();
+ exchange.sendResponseHeaders(statusCode, 0);
+ try ( final OutputStream os = exchange.getResponseBody() ) {
+ write.write(os);
+ }
}
protected static void error(final HttpExchange exchange, final int statusCode, final String message) throws IOException {
final byte[] bytes = message.getBytes();
exchange.getResponseHeaders().add("Content-Type", "text/plain");
exchange.sendResponseHeaders(statusCode, bytes.length);
- final OutputStream os = exchange.getResponseBody();
- os.write(bytes);
- os.close();
+ try ( final OutputStream os = exchange.getResponseBody() ) {
+ os.write(bytes);
+ }
}
@FunctionalInterface
protected interface Write {
- public void write(OutputStream out) throws IOException;
+ void write(OutputStream out) throws IOException;
}
}
diff --git a/src/main/java/de/kosit/validationtool/daemon/CheckHandler.java b/src/main/java/de/kosit/validationtool/daemon/CheckHandler.java
index 1476d8c..5b44872 100644
--- a/src/main/java/de/kosit/validationtool/daemon/CheckHandler.java
+++ b/src/main/java/de/kosit/validationtool/daemon/CheckHandler.java
@@ -1,10 +1,29 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
+import java.io.BufferedInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
-import java.io.InputStream;
+import java.net.URI;
import java.util.concurrent.atomic.AtomicLong;
+import org.apache.commons.lang3.StringUtils;
+
import com.sun.net.httpserver.HttpExchange;
import lombok.RequiredArgsConstructor;
@@ -14,6 +33,7 @@ import de.kosit.validationtool.api.Check;
import de.kosit.validationtool.api.InputFactory;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.impl.input.SourceInput;
+import de.kosit.validationtool.impl.input.StreamHelper;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.SaxonApiException;
@@ -36,33 +56,68 @@ class CheckHandler extends BaseHandler {
/**
* Methode, die eine gegebene Anforderung verarbeitet und eine entsprechende Antwort generiert
*
- * @param httpExchange kapselt eine empfangene HTTP-Anforderung und eine Antwort, die in einem Exchange generiert werden
- * soll.
+ * @param httpExchange kapselt eine empfangene HTTP-Anforderung und eine Antwort, die in einem Exchange generiert
+ * werden soll.
*/
@Override
public void handle(final HttpExchange httpExchange) throws IOException {
try {
log.debug("Incoming request");
final String requestMethod = httpExchange.getRequestMethod();
+ // check neccessary, since gui can be disabled
if (requestMethod.equals("POST")) {
- final InputStream inputStream = httpExchange.getRequestBody();
- if (inputStream.available() > 0) {
- final SourceInput serverInput = (SourceInput) InputFactory.read(inputStream,
- "supplied_instance_" + counter.incrementAndGet());
+ final BufferedInputStream buffered = StreamHelper.wrapPeekable(httpExchange.getRequestBody());
+ if (!isMultipartFormData(httpExchange) && isContentAvailable(httpExchange, buffered)) {
+ final SourceInput serverInput = (SourceInput) InputFactory.read(buffered,
+ resolveInputName(httpExchange.getRequestURI()));
final Result result = this.implemenation.checkInput(serverInput);
- write(httpExchange, serialize(result), APPLICATION_XML);
+ write(httpExchange, serialize(result), APPLICATION_XML, resolveStatus(result));
} else {
- error(httpExchange, 400, "No content supplied");
+ error(httpExchange, HttpStatus.SC_BAD_REQUEST, "No content supplied");
}
} else {
- error(httpExchange, 405, "Method not supported");
+ error(httpExchange, HttpStatus.SC_METHOD_NOT_ALLOWED, "Method not supported");
}
} catch (final Exception e) {
- error(httpExchange, 500, "Internal error: " + e.getMessage());
+ log.error("Error checking entity", e);
+ error(httpExchange, HttpStatus.SC_INTERNAL_SERVER_ERROR, "Internal error: " + e.getMessage());
}
}
+ private static boolean isContentAvailable(final com.sun.net.httpserver.HttpExchange httpExchange, final BufferedInputStream buffered)
+ throws IOException {
+ final String length = httpExchange.getRequestHeaders().getFirst("Content-length");
+ if (StringUtils.isNumeric(length)) {
+ return Integer.parseInt(length) > 0;
+ }
+ return streamContainsContent(buffered);
+ }
+
+ private static boolean isMultipartFormData(final HttpExchange httpExchange) {
+ return httpExchange.getRequestHeaders().getFirst("Content-type").startsWith("multipart");
+ }
+
+ private static boolean streamContainsContent(final BufferedInputStream requestBody) throws IOException {
+ return requestBody.available() > 0;
+
+ }
+
+ private static String resolveInputName(final URI requestURI) {
+ final String path = requestURI.getPath();
+ if (path.equalsIgnoreCase("/")) {
+ return "supplied_instance_" + counter.incrementAndGet();
+ }
+ return path.substring((path.lastIndexOf('/') + 1));
+ }
+
+ private static int resolveStatus(final Result result) {
+ if (result.isProcessingSuccessful()) {
+ return result.isAcceptable() ? HttpStatus.SC_OK : HttpStatus.SC_NOT_ACCEPTABLE;
+ }
+ return HttpStatus.SC_UNPROCESSABLE_ENTITY;
+ }
+
private byte[] serialize(final Result result) {
try ( final ByteArrayOutputStream out = new ByteArrayOutputStream() ) {
final Serializer serializer = this.processor.newSerializer(out);
diff --git a/src/main/java/de/kosit/validationtool/daemon/ConfigHandler.java b/src/main/java/de/kosit/validationtool/daemon/ConfigHandler.java
index 696c70e..1e131a4 100644
--- a/src/main/java/de/kosit/validationtool/daemon/ConfigHandler.java
+++ b/src/main/java/de/kosit/validationtool/daemon/ConfigHandler.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
import java.io.IOException;
@@ -5,6 +21,7 @@ import java.io.InputStreamReader;
import java.io.Reader;
import java.io.StringWriter;
import java.net.URI;
+import java.util.List;
import java.util.Optional;
import org.apache.commons.io.IOUtils;
@@ -26,9 +43,9 @@ import de.kosit.validationtool.model.scenarios.Scenarios;
*/
@Slf4j
@RequiredArgsConstructor
- class ConfigHandler extends BaseHandler {
+class ConfigHandler extends BaseHandler {
- private final Configuration configuration;
+ private final List configuration;
private final ConversionService conversionService;
@@ -48,7 +65,8 @@ import de.kosit.validationtool.model.scenarios.Scenarios;
}
private Optional getSource() {
- final URI fileUri = (URI) this.configuration.getAdditionalParameters().get(Keys.SCENARIOS_FILE);
+
+ final URI fileUri = (URI) this.configuration.get(0).getAdditionalParameters().get(Keys.SCENARIOS_FILE);
return fileUri != null ? loadFile(fileUri) : loadFromConfig();
}
@@ -64,7 +82,7 @@ import de.kosit.validationtool.model.scenarios.Scenarios;
private Optional loadFromConfig() {
final Optional result;
- final Scenarios scenarios = (Scenarios) this.configuration.getAdditionalParameters().get(Keys.SCENARIO_DEFINITION);
+ final Scenarios scenarios = (Scenarios) this.configuration.get(0).getAdditionalParameters().get(Keys.SCENARIO_DEFINITION);
if (scenarios != null) {
final String s = this.conversionService.writeXml(scenarios);
result = Optional.of(s);
diff --git a/src/main/java/de/kosit/validationtool/daemon/Daemon.java b/src/main/java/de/kosit/validationtool/daemon/Daemon.java
index fa0dcbe..4ad7fbd 100644
--- a/src/main/java/de/kosit/validationtool/daemon/Daemon.java
+++ b/src/main/java/de/kosit/validationtool/daemon/Daemon.java
@@ -1,5 +1,22 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
+import static de.kosit.validationtool.impl.Printer.writeOut;
import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
import java.io.IOException;
@@ -10,7 +27,6 @@ import java.util.concurrent.Executors;
import com.sun.net.httpserver.HttpHandler;
import com.sun.net.httpserver.HttpServer;
-import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
@@ -20,6 +36,8 @@ import de.kosit.validationtool.impl.ConversionService;
import de.kosit.validationtool.impl.DefaultCheck;
import de.kosit.validationtool.model.daemon.HealthType;
+import net.sf.saxon.s9api.Processor;
+
/**
* HTTP-Daemon für die Bereitstellung der Prüf-Funktionalität via http.
*
@@ -44,13 +62,14 @@ public class Daemon {
/**
* Create a new daemon.
+ *
* @param hostname the interface to bind to
* @param port the port to expose
* @param threadCount the number of working threads
*/
- public Daemon(String hostname, int port, int threadCount) {
+ public Daemon(final String hostname, final int port, final int threadCount) {
this.bindAddress = hostname;
- this.port = port;
+ this.port = port;
this.threadCount = threadCount;
}
@@ -59,31 +78,32 @@ public class Daemon {
*
* @param config the configuration to use
*/
- public void startServer(final Configuration config) {
+ public void startServer(final Processor processor, final Configuration... config) {
HttpServer server = null;
try {
final ConversionService healthConverter = new ConversionService();
healthConverter.initialize(HealthType.class.getPackage());
final ConversionService converter = new ConversionService();
+ final DefaultCheck check = new DefaultCheck(processor, config);
server = HttpServer.create(getSocket(), 0);
- server.createContext("/", createRootHandler(config));
- server.createContext("/server/health", new HealthHandler(config, healthConverter));
- server.createContext("/server/config", new ConfigHandler(config, converter));
+ server.createContext("/", createRootHandler(check, processor));
+ server.createContext("/server/health", new HealthHandler(check.getConfiguration(), healthConverter));
+ server.createContext("/server/config", new ConfigHandler(check.getConfiguration(), converter));
server.setExecutor(createExecutor());
server.start();
log.info("Server {} started", server.getAddress());
+ writeOut("Daemon started. Visit http://{0}", this.bindAddress + ":" + this.port);
} catch (final IOException e) {
log.error("Error starting HttpServer for Valdidator: {}", e.getMessage(), e);
}
}
- private HttpHandler createRootHandler(Configuration config) {
- HttpHandler rootHandler;
- final DefaultCheck check = new DefaultCheck(config);
- final CheckHandler checkHandler = new CheckHandler(check, config.getContentRepository().getProcessor());
- if (guiEnabled) {
- GuiHandler gui = new GuiHandler();
+ private HttpHandler createRootHandler(final DefaultCheck check, final Processor processor) {
+ final HttpHandler rootHandler;
+ final CheckHandler checkHandler = new CheckHandler(check, processor);
+ if (this.guiEnabled) {
+ final GuiHandler gui = new GuiHandler();
rootHandler = new RoutingHandler(checkHandler, gui);
} else {
rootHandler = checkHandler;
@@ -98,4 +118,5 @@ public class Daemon {
private InetSocketAddress getSocket() {
return new InetSocketAddress(defaultIfBlank(this.bindAddress, DEFAULT_HOST), this.port > 0 ? this.port : DEFAULT_PORT);
}
+
}
diff --git a/src/main/java/de/kosit/validationtool/daemon/GuiHandler.java b/src/main/java/de/kosit/validationtool/daemon/GuiHandler.java
index 972daf8..ce56bac 100644
--- a/src/main/java/de/kosit/validationtool/daemon/GuiHandler.java
+++ b/src/main/java/de/kosit/validationtool/daemon/GuiHandler.java
@@ -1,18 +1,36 @@
-package de.kosit.validationtool.daemon;
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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.
+ */
-import com.sun.net.httpserver.HttpExchange;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import org.apache.commons.io.IOUtils;
+package de.kosit.validationtool.daemon;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.Arrays;
+import org.apache.commons.io.IOUtils;
+
+import com.sun.net.httpserver.HttpExchange;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
public class GuiHandler extends BaseHandler {
- private static final URL INDEX_HTML = GuiHandler.class.getClassLoader().getResource("gui/index.html");
+ private static final URL INDEX_HTML = GuiHandler.class.getClassLoader().getResource("ui/index.html");
public GuiHandler() {
if (INDEX_HTML == null) {
@@ -21,32 +39,32 @@ public class GuiHandler extends BaseHandler {
}
@Override
- public void handle(HttpExchange exchange) throws IOException {
+ public void handle(final HttpExchange exchange) throws IOException {
assert INDEX_HTML != null;
final String path = exchange.getRequestURI().toASCIIString();
if (path.equals("/")) {
write(exchange, IOUtils.toString(INDEX_HTML, Charset.defaultCharset()).getBytes(), "text/html");
- } else{
- final URL resource = GuiHandler.class.getClassLoader().getResource("gui" + path);
+ } else {
+ final URL resource = GuiHandler.class.getClassLoader().getResource("ui" + path);
if (resource != null) {
- write(exchange,IOUtils.toString(resource, Charset.defaultCharset()).getBytes(), Mediatype.resolveBySuffix(resource.getPath()).getMimeType());;
- }else {
- error(exchange,404,"not found");
+ write(exchange, IOUtils.toString(resource, Charset.defaultCharset()).getBytes(),
+ Mediatype.resolveBySuffix(resource.getPath()).getMimeType());
+ } else {
+ error(exchange, 404, "not found");
}
}
}
-
@RequiredArgsConstructor
@Getter
protected enum Mediatype {
- JS("application/javascript"),
- MD("text/markdown"),
- CSS("text/css");
+
+ JS("application/javascript"), MD("text/markdown"), CSS("text/css"), SVG("image/svg+xml"), HTML("text/html"), PNG("image/png");
+
private final String mimeType;
- static Mediatype resolveBySuffix(String path){
- return Arrays.stream(values()).filter(e->path.toUpperCase().endsWith("."+e.name())).findFirst().orElse(Mediatype.MD);
+ static Mediatype resolveBySuffix(final String path) {
+ return Arrays.stream(values()).filter(e -> path.toUpperCase().endsWith("." + e.name())).findFirst().orElse(Mediatype.MD);
}
}
}
diff --git a/src/main/java/de/kosit/validationtool/daemon/HealthHandler.java b/src/main/java/de/kosit/validationtool/daemon/HealthHandler.java
index de7e40f..84a244a 100644
--- a/src/main/java/de/kosit/validationtool/daemon/HealthHandler.java
+++ b/src/main/java/de/kosit/validationtool/daemon/HealthHandler.java
@@ -1,16 +1,33 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
import java.io.IOException;
+import java.util.List;
import com.sun.net.httpserver.HttpExchange;
-import de.kosit.validationtool.impl.EngineInformation;
-import de.kosit.validationtool.model.daemon.ApplicationType;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.impl.ConversionService;
+import de.kosit.validationtool.impl.EngineInformation;
+import de.kosit.validationtool.model.daemon.ApplicationType;
import de.kosit.validationtool.model.daemon.HealthType;
import de.kosit.validationtool.model.daemon.MemoryType;
@@ -23,7 +40,7 @@ import de.kosit.validationtool.model.daemon.MemoryType;
@RequiredArgsConstructor
class HealthHandler extends BaseHandler {
- private final Configuration scenarios;
+ private final List scenarios;
private final ConversionService conversionService;
@@ -39,7 +56,7 @@ class HealthHandler extends BaseHandler {
final HealthType h = new HealthType();
h.setMemory(createMemory());
h.setApplication(createApplication());
- h.setStatus(scenarios.getScenarios().size() > 0 ? "UP" : "DOWN");
+ h.setStatus(this.scenarios.stream().mapToLong(c -> c.getScenarios().size()).sum() > 0 ? "UP" : "DOWN");
return h;
}
@@ -53,7 +70,7 @@ class HealthHandler extends BaseHandler {
}
private static ApplicationType createApplication() {
- ApplicationType a = new ApplicationType();
+ final ApplicationType a = new ApplicationType();
a.setBuild(EngineInformation.getBuild());
a.setName(EngineInformation.getName());
a.setVersion(EngineInformation.getVersion());
diff --git a/src/main/java/de/kosit/validationtool/daemon/HttpStatus.java b/src/main/java/de/kosit/validationtool/daemon/HttpStatus.java
new file mode 100644
index 0000000..a4bf079
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/daemon/HttpStatus.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
+
+/**
+ * Status codes for the HTTP daemon.
+ *
+ * @author Andreas Penski
+ */
+public interface HttpStatus {
+
+ // --- 2xx Success ---
+
+ /** {@code 200 OK} (HTTP/1.0 - RFC 1945) */
+ int SC_OK = 200;
+
+ // --- 4xx Client Error ---
+
+ /** {@code 400 Bad Request} (HTTP/1.1 - RFC 2616) */
+ int SC_BAD_REQUEST = 400;
+
+ /** {@code 405 Method Not Allowed} (HTTP/1.1 - RFC 2616) */
+ int SC_METHOD_NOT_ALLOWED = 405;
+
+ /** {@code 406 Not Acceptable} (HTTP/1.1 - RFC 2616) */
+ int SC_NOT_ACCEPTABLE = 406;
+
+ /** {@code 422 Unprocessable Entity} (WebDAV - RFC 2518) */
+ public static final int SC_UNPROCESSABLE_ENTITY = 422;
+
+ /** {@code 500 Server Error} (HTTP/1.0 - RFC 1945) */
+ int SC_INTERNAL_SERVER_ERROR = 500;
+
+}
\ No newline at end of file
diff --git a/src/main/java/de/kosit/validationtool/daemon/RoutingHandler.java b/src/main/java/de/kosit/validationtool/daemon/RoutingHandler.java
index d15a39c..1e6a81d 100644
--- a/src/main/java/de/kosit/validationtool/daemon/RoutingHandler.java
+++ b/src/main/java/de/kosit/validationtool/daemon/RoutingHandler.java
@@ -1,11 +1,27 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.daemon;
-import com.sun.net.httpserver.HttpExchange;
-import com.sun.net.httpserver.HttpHandler;
-import lombok.RequiredArgsConstructor;
-
import java.io.IOException;
+import com.sun.net.httpserver.HttpExchange;
+
+import lombok.RequiredArgsConstructor;
+
/**
* A simple handler which routes between the {@link CheckHandler} and the {@link GuiHandler} depending on the request.
*/
@@ -17,12 +33,12 @@ class RoutingHandler extends BaseHandler {
private final GuiHandler guiHandler;
@Override
- public void handle(HttpExchange exchange) throws IOException {
+ public void handle(final HttpExchange exchange) throws IOException {
final String requestMethod = exchange.getRequestMethod();
if (requestMethod.equals("POST")) {
- checkHandler.handle(exchange);
+ this.checkHandler.handle(exchange);
} else if (requestMethod.equals("GET")) {
- guiHandler.handle(exchange);
+ this.guiHandler.handle(exchange);
} else {
error(exchange, 405, String.format("Method % not supported", requestMethod));
}
diff --git a/src/main/java/de/kosit/validationtool/impl/CollectingErrorEventHandler.java b/src/main/java/de/kosit/validationtool/impl/CollectingErrorEventHandler.java
index b1daca8..042dd95 100644
--- a/src/main/java/de/kosit/validationtool/impl/CollectingErrorEventHandler.java
+++ b/src/main/java/de/kosit/validationtool/impl/CollectingErrorEventHandler.java
@@ -1,30 +1,25 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl;
import java.util.ArrayList;
-import java.util.Collection;
+import java.util.List;
import java.util.StringJoiner;
-import javax.xml.bind.ValidationEvent;
-import javax.xml.bind.ValidationEventHandler;
import javax.xml.transform.ErrorListener;
import javax.xml.transform.SourceLocator;
import javax.xml.transform.TransformerException;
@@ -33,12 +28,13 @@ import org.xml.sax.ErrorHandler;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
-import lombok.Getter;
-
import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
import de.kosit.validationtool.model.reportInput.XMLSyntaxErrorSeverity;
-
-import net.sf.saxon.s9api.MessageListener;
+import jakarta.xml.bind.ValidationEvent;
+import jakarta.xml.bind.ValidationEventHandler;
+import lombok.Getter;
+import net.sf.saxon.s9api.MessageListener2;
+import net.sf.saxon.s9api.QName;
import net.sf.saxon.s9api.XdmNode;
/**
@@ -47,14 +43,14 @@ import net.sf.saxon.s9api.XdmNode;
* @author Andreas Penski
*/
@Getter
-public class CollectingErrorEventHandler implements ValidationEventHandler, ErrorHandler, MessageListener, ErrorListener {
+public class CollectingErrorEventHandler implements ValidationEventHandler, ErrorHandler, MessageListener2, ErrorListener {
private static final int DEFAULT_ABORT_COUNT = 50;
- private final Collection errors = new ArrayList<>();
-
private final int stopProcessCount = DEFAULT_ABORT_COUNT;
+ private final List errors = new ArrayList<>();
+
private static XMLSyntaxError createError(final XMLSyntaxErrorSeverity severity, final String message) {
final XMLSyntaxError e = new XMLSyntaxError();
e.setSeverityCode(severity);
@@ -97,7 +93,7 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
e.setColumnNumber(event.getLocator().getColumnNumber());
e.setRowNumber(event.getLocator().getLineNumber());
this.errors.add(e);
- return this.stopProcessCount != this.errors.size();
+ return stopProcessCount != this.errors.size();
}
/**
@@ -134,7 +130,7 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
}
@Override
- public void message(final XdmNode content, final boolean terminate, final SourceLocator locator) {
+ public void message(final XdmNode content, final QName errorCode, final boolean terminate, final SourceLocator locator) {
final XMLSyntaxError e = new XMLSyntaxError();
if (locator != null) {
e.setColumnNumber(locator.getColumnNumber());
@@ -161,9 +157,8 @@ public class CollectingErrorEventHandler implements ValidationEventHandler, Erro
public String getErrorDescription() {
final StringJoiner joiner = new StringJoiner("\n");
- this.errors.forEach(e -> joiner
- .add(e.getSeverityCode().value() + " " + e.getMessage() + " At row " + e.getRowNumber() + " at pos "
- + e.getColumnNumber()));
+ this.errors.forEach(e -> joiner.add(
+ e.getSeverityCode().value() + " " + e.getMessage() + " At row " + e.getRowNumber() + " at pos " + e.getColumnNumber()));
return joiner.toString();
}
}
\ No newline at end of file
diff --git a/src/main/java/de/kosit/validationtool/impl/ContentRepository.java b/src/main/java/de/kosit/validationtool/impl/ContentRepository.java
index 84757d4..e530040 100644
--- a/src/main/java/de/kosit/validationtool/impl/ContentRepository.java
+++ b/src/main/java/de/kosit/validationtool/impl/ContentRepository.java
@@ -1,25 +1,23 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl;
import java.io.IOException;
+import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
@@ -37,21 +35,20 @@ import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import org.apache.commons.lang3.StringUtils;
-import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.SAXException;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-
import de.kosit.validationtool.api.ResolvingConfigurationStrategy;
import de.kosit.validationtool.impl.Scenario.Transformation;
import de.kosit.validationtool.impl.xml.RelativeUriResolver;
+import de.kosit.validationtool.impl.xml.StringTrimAdapter;
import de.kosit.validationtool.model.scenarios.NamespaceType;
import de.kosit.validationtool.model.scenarios.ResourceType;
import de.kosit.validationtool.model.scenarios.ScenarioType;
import de.kosit.validationtool.model.scenarios.ValidateWithSchematron;
-
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import net.sf.saxon.lib.UnparsedTextURIResolver;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.XPathCompiler;
@@ -68,8 +65,6 @@ import net.sf.saxon.s9api.XsltExecutable;
@Slf4j
public class ContentRepository {
- private Schema reportInputSchema;
-
@Getter
private final Processor processor;
@@ -77,6 +72,8 @@ public class ContentRepository {
private final URIResolver resolver;
+ private final UnparsedTextURIResolver unparsedTextURIResolver;
+
private final SchemaFactory schemaFactory;
@Getter
@@ -89,15 +86,16 @@ public class ContentRepository {
* @param strategy the security and resolving strategy
* @param repository the repository.
*/
- public ContentRepository(final ResolvingConfigurationStrategy strategy, final URI repository) {
+ public ContentRepository(final Processor processor, final ResolvingConfigurationStrategy strategy, final URI repository) {
this.repository = repository;
this.resolvingConfigurationStrategy = strategy;
- this.processor = this.resolvingConfigurationStrategy.getProcessor();
+ this.processor = processor;
this.resolver = this.resolvingConfigurationStrategy.createResolver(repository);
+ this.unparsedTextURIResolver = this.resolvingConfigurationStrategy.createUnparsedTextURIResolver(repository);
this.schemaFactory = this.resolvingConfigurationStrategy.createSchemaFactory();
}
- @SuppressWarnings("java:S2095")
+ @SuppressWarnings("squid:S2095")
private static Source resolve(final URL resource) {
try {
return new StreamSource(resource.openStream(), resource.toURI().getRawPath());
@@ -106,20 +104,15 @@ public class ContentRepository {
}
}
- private Schema createSchema(final Source[] schemaSources, final LSResourceResolver resourceResolver) {
+ private Schema createSchema(final Source[] schemaSources) {
try {
- final SchemaFactory sf = this.schemaFactory;
- sf.setResourceResolver(resourceResolver);
- return sf.newSchema(schemaSources);
+ this.schemaFactory.setResourceResolver(null);
+ return this.schemaFactory.newSchema(schemaSources);
} catch (final SAXException e) {
throw new IllegalArgumentException("Can not load schema from sources " + schemaSources[0].getSystemId(), e);
}
}
- private Schema createSchema(final Source[] schemaSources) {
- return createSchema(schemaSources, null);
- }
-
/**
* Lädt ein XSL von der angegebenen URI
*
@@ -156,40 +149,13 @@ public class ContentRepository {
* @return das erzeugte Schema
*/
public Schema createSchema(final URL url) {
- return createSchema(url, null);
+ return createSchema(new Source[] { resolve(url) });
}
public Schema createSchema(final URI uri) {
return createSchema(new Source[] { resolveInRepository(uri) });
}
- public Schema createSchema(final URL url, final LSResourceResolver resourceResolver) {
- log.info("Load schema from source {}", url.getPath());
- return createSchema(new Source[] { resolve(url) }, resourceResolver);
- }
-
- /**
- * Liefert das definiert Schema für die Szenario-Konfiguration
- *
- * @return Scenario-Schema
- */
- public Schema getScenarioSchema() {
- return createSchema(ContentRepository.class.getResource("/xsd/scenarios.xsd"));
- }
-
- /**
- * Liefert das definierte Schema für die Validierung des [@link CreateReportInput}
- *
- * @return ReportInput-Schema
- */
- public Schema getReportInputSchema() {
- if (this.reportInputSchema == null) {
- final Source source = resolve(ContentRepository.class.getResource("/xsd/createReportInput.xsd"));
- this.reportInputSchema = createSchema(new Source[] { source }, new ClassPathResourceResolver("/xsd"));
- }
- return this.reportInputSchema;
- }
-
/**
* Erzeugt ein Schema auf Basis der übegebenen URIs
*
@@ -251,14 +217,18 @@ public class ContentRepository {
}
/**
- * Erzeugt einen resolver für dieses Repository, der nur relativ auflösen kann
+ * Returns the {@link URIResolver} to use for resolving xml artifacts.
*
- * @return ein neuer Resolver
+ * @return the resolver
*/
public URIResolver getResolver() {
return this.resolver;
}
+ public UnparsedTextURIResolver getUnparsedTextURIResolver() {
+ return this.unparsedTextURIResolver;
+ }
+
/**
* Gibt eine Transformation zurück.
*
@@ -276,13 +246,13 @@ public class ContentRepository {
public XPathExecutable createMatchExecutable(final ScenarioType s) {
final Map namespaces = s.getNamespace().stream()
- .collect(Collectors.toMap(NamespaceType::getPrefix, NamespaceType::getValue));
+ .collect(Collectors.toMap(NamespaceType::getPrefix, ns -> StringTrimAdapter.trim(ns.getValue())));
return createXPath(s.getMatch(), namespaces);
}
public XPathExecutable createAccepptExecutable(final ScenarioType s) {
final Map namespaces = s.getNamespace().stream()
- .collect(Collectors.toMap(NamespaceType::getPrefix, NamespaceType::getValue));
+ .collect(Collectors.toMap(NamespaceType::getPrefix, ns -> StringTrimAdapter.trim(ns.getValue())));
return createXPath(s.getAcceptMatch(), namespaces);
}
@@ -294,4 +264,18 @@ public class ContentRepository {
public Transformation createSchematronTransformation(final ValidateWithSchematron validateWithSchematron) {
return createTransformation(validateWithSchematron.getResource());
}
+
+ public Transformation createIdentityTransformation() {
+ final URL url = ContentRepository.class.getClassLoader().getResource("transform/identity.xsl");
+ try ( final InputStream input = url.openStream() ) {
+ final XsltCompiler xsltCompiler = getProcessor().newXsltCompiler();
+ final XsltExecutable executable = xsltCompiler.compile(new StreamSource(input));
+ final ResourceType resource = new ResourceType();
+ resource.setName("identity");
+ resource.setLocation(url.toString());
+ return new Transformation(executable, resource);
+ } catch (final IOException | SaxonApiException e) {
+ throw new IllegalStateException("Error creating identity transformation", e);
+ }
+ }
}
diff --git a/src/main/java/de/kosit/validationtool/impl/ConversionService.java b/src/main/java/de/kosit/validationtool/impl/ConversionService.java
index 0fc6cd0..bd0ba6c 100644
--- a/src/main/java/de/kosit/validationtool/impl/ConversionService.java
+++ b/src/main/java/de/kosit/validationtool/impl/ConversionService.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl;
@@ -27,14 +24,6 @@ import java.util.Arrays;
import java.util.Collection;
import java.util.StringJoiner;
-import javax.xml.bind.JAXBContext;
-import javax.xml.bind.JAXBElement;
-import javax.xml.bind.JAXBException;
-import javax.xml.bind.JAXBIntrospector;
-import javax.xml.bind.Marshaller;
-import javax.xml.bind.Unmarshaller;
-import javax.xml.bind.ValidationEventHandler;
-import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLOutputFactory;
@@ -47,6 +36,14 @@ import javax.xml.validation.Schema;
import org.apache.commons.lang3.StringUtils;
+import jakarta.xml.bind.JAXBContext;
+import jakarta.xml.bind.JAXBElement;
+import jakarta.xml.bind.JAXBException;
+import jakarta.xml.bind.JAXBIntrospector;
+import jakarta.xml.bind.Marshaller;
+import jakarta.xml.bind.Unmarshaller;
+import jakarta.xml.bind.ValidationEventHandler;
+import jakarta.xml.bind.annotation.XmlRegistry;
import lombok.extern.slf4j.Slf4j;
/**
@@ -81,6 +78,7 @@ public class ConversionService {
}
private static final int MAX_LOG_CONTENT = 50;
+
// context setup
private JAXBContext jaxbContext;
@@ -131,7 +129,7 @@ public class ConversionService {
public void initialize(final Collection context) {
final String[] packages = context != null ? context.stream().map(Package::getName).toArray(String[]::new) : new String[0];
final StringJoiner joiner = new StringJoiner(":");
- Arrays.stream(packages).forEach(p -> joiner.add(p));
+ Arrays.stream(packages).forEach(joiner::add);
initialize(joiner.toString());
}
@@ -142,14 +140,14 @@ public class ConversionService {
*/
private void initialize(final String contextPath) {
try {
- this.jaxbContext = JAXBContext.newInstance(contextPath);
+ this.jaxbContext = JAXBContext.newInstance(contextPath, ConversionService.class.getClassLoader());
} catch (final JAXBException e) {
throw new IllegalStateException(String.format("Can not create JAXB context for given context: %s", contextPath), e);
}
}
/**
- * Unmarshalls a specifc xml model into a defined java object.
+ * Unmarshalls a specific XML model into a defined Java object.
*
* @param xml the xml
* @param type the expected type created
@@ -221,6 +219,7 @@ public class ConversionService {
final XMLOutputFactory xof = XMLOutputFactory.newFactory();
final XMLStreamWriter xmlStreamWriter = xof.createXMLStreamWriter(w);
if (null == introspector.getElementName(model)) {
+ @SuppressWarnings({ "rawtypes", "unchecked" })
final JAXBElement jaxbElement = new JAXBElement(createQName(model), model.getClass(), model);
marshaller.marshal(jaxbElement, xmlStreamWriter);
} else {
@@ -233,9 +232,6 @@ public class ConversionService {
}
}
-
-
-
public T readDocument(final Source source, final Class type) {
try {
final Unmarshaller u = getJaxbContext().createUnmarshaller();
diff --git a/src/main/java/de/kosit/validationtool/impl/DateFactory.java b/src/main/java/de/kosit/validationtool/impl/DateFactory.java
index 0c9fe9a..2e9bb9a 100644
--- a/src/main/java/de/kosit/validationtool/impl/DateFactory.java
+++ b/src/main/java/de/kosit/validationtool/impl/DateFactory.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
import java.util.Date;
@@ -19,9 +35,9 @@ public class DateFactory {
@SneakyThrows
public static XMLGregorianCalendar createTimestamp() {
- final GregorianCalendar cal = new GregorianCalendar();
- cal.setTime(new Date());
- return DatatypeFactory.newInstance().newXMLGregorianCalendar(cal);
+ final GregorianCalendar cal = new GregorianCalendar();
+ cal.setTime(new Date());
+ return DatatypeFactory.newInstance().newXMLGregorianCalendar(cal);
}
}
diff --git a/src/main/java/de/kosit/validationtool/impl/DefaultCheck.java b/src/main/java/de/kosit/validationtool/impl/DefaultCheck.java
index f87fb00..26ab801 100644
--- a/src/main/java/de/kosit/validationtool/impl/DefaultCheck.java
+++ b/src/main/java/de/kosit/validationtool/impl/DefaultCheck.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl;
@@ -22,18 +19,22 @@ package de.kosit.validationtool.impl;
import static de.kosit.validationtool.impl.DateFactory.createTimestamp;
import java.util.ArrayList;
-import java.util.Collection;
+import java.util.Arrays;
+import java.util.Collections;
import java.util.List;
+import java.util.Map;
+import java.util.Optional;
import java.util.stream.Collectors;
-import lombok.Getter;
-import lombok.extern.slf4j.Slf4j;
+import org.oclc.purl.dsdl.svrl.FailedAssert;
+import org.oclc.purl.dsdl.svrl.SchematronOutput;
import de.kosit.validationtool.api.Check;
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.api.Input;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.api.XmlError;
+import de.kosit.validationtool.impl.model.CustomFailedAssert;
import de.kosit.validationtool.impl.tasks.CheckAction;
import de.kosit.validationtool.impl.tasks.CheckAction.Bag;
import de.kosit.validationtool.impl.tasks.ComputeAcceptanceAction;
@@ -44,15 +45,19 @@ import de.kosit.validationtool.impl.tasks.ScenarioSelectionAction;
import de.kosit.validationtool.impl.tasks.SchemaValidationAction;
import de.kosit.validationtool.impl.tasks.SchematronValidationAction;
import de.kosit.validationtool.impl.tasks.ValidateReportInputAction;
+import de.kosit.validationtool.impl.xml.ProcessorProvider;
import de.kosit.validationtool.model.reportInput.CreateReportInput;
import de.kosit.validationtool.model.reportInput.EngineType;
import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
-
+import de.kosit.validationtool.model.scenarios.ErrorLevelType;
+import de.kosit.validationtool.model.scenarios.ScenarioType;
+import lombok.Getter;
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.s9api.Processor;
/**
- * Die Referenz-Implementierung für den Prüfprozess. Nach initialer Konfiguration ist diese Klasse threadsafe und kann
- * in Server-Umgebungen eingesetzt werden
+ * The reference implementation for the validation process. After initialisation, instances are threadsafe and should be
+ * reused since initializing saxon runtime objects is an rather heavyweight process.
*
* @author Andreas Penski
*/
@@ -62,44 +67,53 @@ public class DefaultCheck implements Check {
@Getter
private final ConversionService conversionService;
- private final Configuration configuration;
+ @Getter
+ private final List configuration;
@Getter
private final List checkSteps;
+ @Getter
+ private final Processor processor;
+
+ public DefaultCheck(final Configuration... configuration) {
+ this(ProcessorProvider.getProcessor(), configuration);
+ }
+
/**
- * Erzeugt eine neue Instanz mit der angegebenen Konfiguration.
+ * Creates a new instance for the {@link Configuration}.
*
- * @param configuration die Konfiguration
+ * @param configuration the Configuration
*/
- public DefaultCheck(final Configuration configuration) {
- this.configuration = configuration;
- final ContentRepository content = configuration.getContentRepository();
- final Processor processor = content.getProcessor();
+ public DefaultCheck(final Processor processor, final Configuration... configuration) {
+ this.configuration = Arrays.asList(configuration);
+ this.processor = processor;
this.conversionService = new ConversionService();
this.checkSteps = new ArrayList<>();
this.checkSteps.add(new DocumentParseAction(processor));
this.checkSteps.add(new CreateDocumentIdentificationAction());
this.checkSteps.add(new ScenarioSelectionAction(new ScenarioRepository(configuration)));
- this.checkSteps.add(new SchemaValidationAction(content.getResolvingConfigurationStrategy(), processor));
- this.checkSteps.add(new SchematronValidationAction(content.getResolver(), this.conversionService));
- this.checkSteps.add(new ValidateReportInputAction(this.conversionService, content.getReportInputSchema()));
- this.checkSteps.add(new CreateReportAction(processor, this.conversionService, content.getResolver()));
+ this.checkSteps.add(new SchemaValidationAction(processor));
+ this.checkSteps.add(new SchematronValidationAction(this.conversionService));
+ this.checkSteps.add(new ValidateReportInputAction(this.conversionService, SchemaProvider.getReportInputSchema()));
+ this.checkSteps.add(new CreateReportAction(processor, this.conversionService));
this.checkSteps.add(new ComputeAcceptanceAction());
}
protected static CreateReportInput createReport() {
final CreateReportInput type = new CreateReportInput();
final EngineType e = new EngineType();
- e.setName(EngineInformation.getName());
+ e.setName(EngineInformation.getName() + " " + EngineInformation.getVersion());
type.setEngine(e);
type.setTimestamp(createTimestamp());
type.setFrameworkVersion(EngineInformation.getFrameworkVersion());
return type;
}
-
+ protected boolean isSuccessful(final Map results) {
+ return results.entrySet().stream().allMatch(e -> e.getValue().isAcceptable());
+ }
@Override
public Result checkInput(final Input input) {
@@ -123,20 +137,40 @@ public class DefaultCheck implements Check {
}
private Result createResult(final Bag t) {
- final DefaultResult result = new DefaultResult(t.getReport(), t.getAcceptStatus(),
- new HtmlExtractor(this.configuration.getContentRepository().getProcessor()));
+ final DefaultResult result = new DefaultResult(t.getReport(), t.getAcceptStatus(), new HtmlExtractor(this.processor));
result.setWellformed(t.getParserResult().isValid());
result.setReportInput(t.getReportInput());
if (t.getSchemaValidationResult() != null) {
result.setSchemaViolations(convertErrors(t.getSchemaValidationResult().getErrors()));
}
result.setProcessingSuccessful(!t.isStopped() && t.isFinished());
- result.setSchematronResult(t.getReportInput().getValidationResultsSchematron().stream()
+ result.setSchematronResult(t.getReportInput().getValidationResultsSchematron().stream().filter(e -> e.getResults() != null)
.map(e -> e.getResults().getSchematronOutput()).collect(Collectors.toList()));
+
+ result.setCustomFailedAsserts(buildCustomFailedAssertsList(t, result.getSchematronResult()));
+
return result;
}
- private static List convertErrors(final Collection errors) {
+ private List buildCustomFailedAssertsList(final Bag t, final List schematronResult) {
+ // Get Map of Assertion ID to custom error levels for the current scenario
+ final Map customLevels = Optional.ofNullable(t.getScenarioSelectionResult())
+ .map(de.kosit.validationtool.impl.model.Result::getObject).map(Scenario::getConfiguration)
+ .map(ScenarioType::getCreateReport)
+ .map(r -> r.getCustomLevel().stream()
+ .flatMap(customLevel -> customLevel.getValue().stream().map(id -> Map.entry(id, customLevel.getLevel())))
+ .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)))
+ .orElse(Collections.emptyMap());
+
+ // Now check all failed assertions of all schematron validations if they contain a failed assertion with one of
+ // the changed IDs
+ return schematronResult.stream().flatMap(x -> x.getActivePatternAndFiredRuleAndFailedAssert().stream())
+ .filter(FailedAssert.class::isInstance).map(FailedAssert.class::cast).filter(fa -> customLevels.containsKey(fa.getId()))
+ .map(fa -> new CustomFailedAssert(fa, customLevels.get(fa.getId()))).collect(Collectors.toList());
+ }
+
+ @SuppressWarnings("unchecked")
+ private static List convertErrors(final List errors) {
// noinspection unchecked
return (List) (List) errors;
}
diff --git a/src/main/java/de/kosit/validationtool/impl/DefaultResult.java b/src/main/java/de/kosit/validationtool/impl/DefaultResult.java
index e8be8ac..162e3f9 100644
--- a/src/main/java/de/kosit/validationtool/impl/DefaultResult.java
+++ b/src/main/java/de/kosit/validationtool/impl/DefaultResult.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
import java.util.Collections;
@@ -9,15 +25,14 @@ import org.oclc.purl.dsdl.svrl.SchematronOutput;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.Setter;
-
import de.kosit.validationtool.api.AcceptRecommendation;
import de.kosit.validationtool.api.Result;
import de.kosit.validationtool.api.XmlError;
+import de.kosit.validationtool.impl.model.CustomFailedAssert;
import de.kosit.validationtool.model.reportInput.CreateReportInput;
-
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.Setter;
import net.sf.saxon.dom.NodeOverNodeInfo;
import net.sf.saxon.s9api.XdmNode;
@@ -51,6 +66,11 @@ public class DefaultResult implements Result {
@Setter(AccessLevel.PACKAGE)
private List schematronResult;
+ /**
+ * List of custom failed asserts per Schematron level. Only failed assertions with a custom level are contained.
+ */
+ private List customFailedAsserts;
+
@Getter
@Setter
private boolean processingSuccessful;
@@ -133,13 +153,28 @@ public class DefaultResult implements Result {
}
private List filterSchematronResult(final Class type) {
- return getSchematronResult() != null
- ? getSchematronResult().stream().filter(type::isInstance).map(type::cast).collect(Collectors.toList())
+ return this.schematronResult != null
+ ? this.schematronResult.stream().flatMap(e -> e.getActivePatternAndFiredRuleAndFailedAssert().stream())
+ .filter(type::isInstance).map(type::cast).collect(Collectors.toList())
: Collections.emptyList();
}
+ private boolean isSchematronEvaluated() {
+ return this.schematronResult != null
+ && this.schematronResult.stream().noneMatch(e -> e.getActivePatternAndFiredRuleAndFailedAssert().isEmpty());
+ }
+
@Override
public boolean isSchematronValid() {
- return getSchematronResult() != null && getFailedAsserts().isEmpty();
+ return isSchematronEvaluated() && getFailedAsserts().isEmpty();
+ }
+
+ @Override
+ public List getCustomFailedAsserts() {
+ return this.customFailedAsserts;
+ }
+
+ public void setCustomFailedAsserts(List customFailedAsserts) {
+ this.customFailedAsserts = customFailedAsserts;
}
}
diff --git a/src/main/java/de/kosit/validationtool/impl/EngineInformation.java b/src/main/java/de/kosit/validationtool/impl/EngineInformation.java
index d781f94..c5a7bd3 100644
--- a/src/main/java/de/kosit/validationtool/impl/EngineInformation.java
+++ b/src/main/java/de/kosit/validationtool/impl/EngineInformation.java
@@ -1,6 +1,20 @@
-package de.kosit.validationtool.impl;
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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.
+ */
-import lombok.SneakyThrows;
+package de.kosit.validationtool.impl;
import java.io.IOException;
import java.io.InputStream;
diff --git a/src/main/java/de/kosit/validationtool/impl/HtmlExtractor.java b/src/main/java/de/kosit/validationtool/impl/HtmlExtractor.java
index bde98a1..0c2677a 100644
--- a/src/main/java/de/kosit/validationtool/impl/HtmlExtractor.java
+++ b/src/main/java/de/kosit/validationtool/impl/HtmlExtractor.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
import java.io.StringWriter;
diff --git a/src/main/java/de/kosit/validationtool/impl/Printer.java b/src/main/java/de/kosit/validationtool/impl/Printer.java
new file mode 100644
index 0000000..cdfbbb4
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/impl/Printer.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
+
+import java.text.MessageFormat;
+import java.util.Locale;
+
+/**
+ * Wrapper for {@link System Systems} printing capability.
+ *
+ * @author Andreas Penski
+ */
+@SuppressWarnings("squid:S106")
+public class Printer {
+
+ private Printer() {
+ // hide
+ }
+
+ /**
+ * Writes to standard output channel.
+ *
+ * @param message the message with placeholders
+ * @param params the params.
+ */
+ public static void writeOut(final String message, final Object... params) {
+ try {
+ System.out.println(new MessageFormat(message, Locale.ENGLISH).format(params));
+ } catch (final RuntimeException ex) {
+ System.err.println("[Format error!] <" + message + "> with params <" + params + ">");
+ }
+ }
+
+ /**
+ * Writes to standard error channel.
+ *
+ * @param message the message with placeholders
+ * @param params the params.
+ */
+ public static void writeErr(final String message, final Object... params) {
+ try {
+ System.err.println(new MessageFormat(message, Locale.ENGLISH).format(params));
+ } catch (final RuntimeException ex) {
+ System.err.println("[Format error!] <" + message + "> with params <" + params + ">");
+ }
+ }
+
+ /**
+ * Writes to standard error channel and prints a stacktrace.
+ *
+ * @param ex the exception
+ * @param message the message with placeholders
+ * @param params the params
+ */
+ @SuppressWarnings("squid:S1148")
+ public static void writeErr(final Exception ex, final String message, final Object... params) {
+ writeErr(message, params);
+ if (ex != null) {
+ ex.printStackTrace();
+ }
+ }
+
+}
diff --git a/src/main/java/de/kosit/validationtool/impl/ResolvingMode.java b/src/main/java/de/kosit/validationtool/impl/ResolvingMode.java
index 1ca8517..5b9e59c 100644
--- a/src/main/java/de/kosit/validationtool/impl/ResolvingMode.java
+++ b/src/main/java/de/kosit/validationtool/impl/ResolvingMode.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
import lombok.Getter;
@@ -17,7 +33,7 @@ import de.kosit.validationtool.impl.xml.StrictRelativeResolvingStrategy;
public enum ResolvingMode {
/**
- * Resolving using only the configured content repository. No furthing resolving allowed. This
+ * Resolving using only the configured content repository.
*/
STRICT_RELATIVE(new StrictRelativeResolvingStrategy()) {
diff --git a/src/main/java/de/kosit/validationtool/impl/Scenario.java b/src/main/java/de/kosit/validationtool/impl/Scenario.java
index 0e0ef5c..d92768a 100644
--- a/src/main/java/de/kosit/validationtool/impl/Scenario.java
+++ b/src/main/java/de/kosit/validationtool/impl/Scenario.java
@@ -1,19 +1,36 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
-import java.util.Collections;
+import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
+import javax.xml.transform.URIResolver;
import javax.xml.validation.Schema;
+import de.kosit.validationtool.api.ResolvingConfigurationStrategy;
+import de.kosit.validationtool.model.scenarios.ResourceType;
+import de.kosit.validationtool.model.scenarios.ScenarioType;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
-
-import de.kosit.validationtool.model.scenarios.ResourceType;
-import de.kosit.validationtool.model.scenarios.ScenarioType;
-
+import net.sf.saxon.lib.UnparsedTextURIResolver;
import net.sf.saxon.s9api.XPathExecutable;
import net.sf.saxon.s9api.XPathSelector;
import net.sf.saxon.s9api.XsltExecutable;
@@ -49,13 +66,23 @@ public class Scenario {
private XPathExecutable acceptExecutable;
+ private ResolvingConfigurationStrategy factory;
+
+ private URIResolver uriResolver;
+
+ private UnparsedTextURIResolver unparsedTextURIResolver;
+
@Setter
private List schematronValidations;
private Transformation reportTransformation;
public List getSchematronValidations() {
- return this.schematronValidations == null ? Collections.emptyList() : this.schematronValidations;
+ // Must return a mutable list
+ if (this.schematronValidations == null) {
+ this.schematronValidations = new ArrayList<>();
+ }
+ return this.schematronValidations;
}
public String getName() {
@@ -70,9 +97,9 @@ public class Scenario {
}
/**
- * Liefert einen neuen XPath-Selector zur Evaluierung der {@link de.kosit.validationtool.api.AcceptRecommendation}.
+ * Returns a new XPath selector for evaluating the {@link de.kosit.validationtool.api.AcceptRecommendation}.
*
- * @return neuer Selector
+ * @return new selector
*/
public Optional getAcceptSelector() {
final XPathSelector selector = this.acceptExecutable != null ? this.acceptExecutable.load() : null;
diff --git a/src/main/java/de/kosit/validationtool/impl/ScenarioRepository.java b/src/main/java/de/kosit/validationtool/impl/ScenarioRepository.java
index a8ddc26..267bc23 100644
--- a/src/main/java/de/kosit/validationtool/impl/ScenarioRepository.java
+++ b/src/main/java/de/kosit/validationtool/impl/ScenarioRepository.java
@@ -1,33 +1,28 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl;
-import java.util.Collections;
+import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
-import lombok.extern.slf4j.Slf4j;
-
import de.kosit.validationtool.api.Configuration;
import de.kosit.validationtool.impl.model.Result;
-
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.XPathSelector;
import net.sf.saxon.s9api.XdmNode;
@@ -41,48 +36,53 @@ import net.sf.saxon.s9api.XdmNode;
public class ScenarioRepository {
- private final Configuration configuration;
+ public static final String DEFAULT = "default";
- public ScenarioRepository(final Configuration configuration) {
- this.configuration = configuration;
- log.info("Loaded scenarios for {} by {} from {}. The following scenarios are available:\n\n{}", configuration.getName(),
- configuration.getAuthor(), configuration.getDate(), summarizeScenarios());
+ public static final String DEFAULT_ID = DEFAULT + "_1";
+
+ private final List configuration;
+
+ public ScenarioRepository(final Configuration... configuration) {
+ if (configuration.length == 0) {
+ throw new IllegalArgumentException("Must provide at least one configuration");
+ }
+ this.configuration = Arrays.asList(configuration);
+ this.configuration.forEach(v -> log.info("Loaded scenarios for {} by {} from {}.", v.getName(), v.getAuthor(), v.getDate()));
+ log.info("The following scenarios are available:\n{}", summarizeScenarios());
}
public Scenario getFallbackScenario() {
- return this.configuration.getFallbackScenario();
+ if (this.configuration.size() > 1) {
+ log.warn("Multiple configurations found. Using fallback scenario from first configuration");
+ }
+ return this.configuration.get(0).getFallbackScenario();
}
public List getScenarios() {
- return this.configuration.getScenarios();
+ return this.configuration.stream().flatMap(c -> c.getScenarios().stream()).collect(Collectors.toList());
}
private String summarizeScenarios() {
final StringBuilder b = new StringBuilder();
- getScenarios().forEach(s -> {
- b.append(s.getName());
- b.append("\n");
- });
+ getScenarios().forEach(s -> b.append(s.getName()).append('\n'));
return b.toString();
}
/**
- * Ermittelt für das gegebene Dokument das passende Szenario.
+ * Determine the matching Scenario for the provided input document
*
- * @param document das Eingabedokument
+ * @param document input document
* @return ein Ergebnis-Objekt zur weiteren Verarbeitung
*/
public Result selectScenario(final XdmNode document) {
final Result result;
- final List collect = getScenarios().stream().filter(s -> match(document, s))
- .collect(Collectors.toList());
+ final List collect = getScenarios().stream().filter(s -> match(document, s)).collect(Collectors.toList());
if (collect.size() == 1) {
result = new Result<>(collect.get(0));
} else if (collect.isEmpty()) {
- result = new Result<>(getFallbackScenario(),
- Collections.singleton("None of the loaded scenarios matches the specified document"));
+ result = new Result<>(getFallbackScenario(), Arrays.asList("None of the loaded scenarios matches the specified document"));
} else {
- result = new Result<>(getFallbackScenario(), Collections.singleton("More than on scenario matches the specified document"));
+ result = new Result<>(getFallbackScenario(), Arrays.asList("More than one scenario matches the specified document"));
}
return result;
diff --git a/src/main/java/de/kosit/validationtool/impl/SchemaProvider.java b/src/main/java/de/kosit/validationtool/impl/SchemaProvider.java
new file mode 100644
index 0000000..4798bff
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/impl/SchemaProvider.java
@@ -0,0 +1,87 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.net.URL;
+
+import javax.xml.transform.Source;
+import javax.xml.transform.stream.StreamSource;
+import javax.xml.validation.Schema;
+import javax.xml.validation.SchemaFactory;
+
+import org.w3c.dom.ls.LSResourceResolver;
+import org.xml.sax.SAXException;
+
+import de.kosit.validationtool.impl.xml.ClassPathResourceResolver;
+
+/**
+ * @author Andreas Penski
+ */
+public class SchemaProvider {
+
+ private static Schema reportInputSchema;
+
+ /**
+ * Liefert das definierte Schema für die Validierung des [@link CreateReportInput}
+ *
+ * @return ReportInput-Schema
+ */
+ public static Schema getReportInputSchema() {
+ if (reportInputSchema == null) {
+ final SchemaFactory sf = ResolvingMode.STRICT_RELATIVE.getStrategy().createSchemaFactory();
+ final Source source = resolve(SchemaProvider.class.getResource("/xsd/createReportInput.xsd"));
+ reportInputSchema = createSchema(sf, new Source[] { source }, new ClassPathResourceResolver("/xsd"));
+ }
+ return reportInputSchema;
+ }
+
+ private static Schema createSchema(final SchemaFactory sf, final Source[] schemaSources, final LSResourceResolver resourceResolver) {
+ try {
+ sf.setResourceResolver(resourceResolver);
+ return sf.newSchema(schemaSources);
+ } catch (final SAXException e) {
+ throw new IllegalArgumentException("Can not load schema from sources " + schemaSources[0].getSystemId(), e);
+ }
+ }
+
+ private static Schema createSchema(final SchemaFactory sf, final Source... schemaSources) {
+ return createSchema(sf, schemaSources, null);
+ }
+
+ @SuppressWarnings("java:S2095") // xml stack requires not closing the resource here
+ private static Source resolve(final URL resource) {
+ try {
+ final String rawPath = resource.toURI().getRawPath();
+ return new StreamSource(resource.openStream(), rawPath);
+ } catch (final IOException | URISyntaxException e) {
+ throw new IllegalStateException("Can not load schema for resource " + resource.getPath(), e);
+ }
+ }
+
+ /**
+ * Liefert das definiert Schema für die Szenario-Konfiguration
+ *
+ * @return Scenario-Schema
+ */
+ public static Schema getScenarioSchema() {
+ final SchemaFactory sf = ResolvingMode.STRICT_RELATIVE.getStrategy().createSchemaFactory();
+ return createSchema(sf, resolve(SchemaProvider.class.getResource("/xsd/scenarios.xsd")));
+ }
+
+}
diff --git a/src/main/java/de/kosit/validationtool/impl/input/AbstractInput.java b/src/main/java/de/kosit/validationtool/impl/input/AbstractInput.java
index c5c30aa..17c2bdf 100644
--- a/src/main/java/de/kosit/validationtool/impl/input/AbstractInput.java
+++ b/src/main/java/de/kosit/validationtool/impl/input/AbstractInput.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
import static de.kosit.validationtool.impl.input.StreamHelper.drain;
diff --git a/src/main/java/de/kosit/validationtool/impl/input/ByteArrayInput.java b/src/main/java/de/kosit/validationtool/impl/input/ByteArrayInput.java
index 5dfa630..e741cec 100644
--- a/src/main/java/de/kosit/validationtool/impl/input/ByteArrayInput.java
+++ b/src/main/java/de/kosit/validationtool/impl/input/ByteArrayInput.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
import java.io.ByteArrayInputStream;
diff --git a/src/main/java/de/kosit/validationtool/impl/input/LazyReadInput.java b/src/main/java/de/kosit/validationtool/impl/input/LazyReadInput.java
index 31918aa..6ab098f 100644
--- a/src/main/java/de/kosit/validationtool/impl/input/LazyReadInput.java
+++ b/src/main/java/de/kosit/validationtool/impl/input/LazyReadInput.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
import java.io.InputStream;
diff --git a/src/main/java/de/kosit/validationtool/impl/input/ResourceInput.java b/src/main/java/de/kosit/validationtool/impl/input/ResourceInput.java
index 107677b..234d7a9 100644
--- a/src/main/java/de/kosit/validationtool/impl/input/ResourceInput.java
+++ b/src/main/java/de/kosit/validationtool/impl/input/ResourceInput.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
import java.io.File;
diff --git a/src/main/java/de/kosit/validationtool/impl/input/SourceInput.java b/src/main/java/de/kosit/validationtool/impl/input/SourceInput.java
index cb9f929..60c926e 100644
--- a/src/main/java/de/kosit/validationtool/impl/input/SourceInput.java
+++ b/src/main/java/de/kosit/validationtool/impl/input/SourceInput.java
@@ -1,31 +1,53 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
+import static org.apache.commons.lang3.StringUtils.defaultIfBlank;
+
import java.io.IOException;
+import java.io.UncheckedIOException;
import java.nio.charset.Charset;
import javax.xml.transform.Source;
+import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.stream.StreamSource;
import org.apache.commons.io.input.ReaderInputStream;
+import jakarta.xml.bind.util.JAXBSource;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
+import net.sf.saxon.om.TreeInfo;
/**
- * A validator {@link de.kosit.validationtool.api.Input} based on a {@link Source}.
+ * A validator {@link de.kosit.validationtool.api.Input} based on a {@link Source}.
*
* Note: The various implementations of {@link Source} varies wether the can be read twice or no. This implementation
* tries to handle this with respect document identification (hashcode).
*
- * This class is know to work with:
+ * This class is known to work with:
*
* - {@link StreamSource} - both {@link java.io.InputStream} based and {@link java.io.Reader} based
* - {@link javax.xml.transform.dom.DOMSource}
- * - {@link javax.xml.bind.util.JAXBSource}
+ * - {@link jakarta.xml.bind.util.JAXBSource}
+ * - {@link TreeInfo}
*
*
* Other {@link Source Sources} may work as well, please try and let us know.
- *
*
* @author Andreas Penski
*/
@@ -51,31 +73,36 @@ public class SourceInput extends AbstractInput {
validate();
}
+ @Override
+ public String getName() {
+ return defaultIfBlank(this.name, this.source.getClass().getSimpleName());
+ }
+
private void validate() {
- if (!isHashcodeComputed() && !isSupported()) {
+ if (!isHashcodeComputed() && !isHashcodeComputationSupported()) {
throw new IllegalStateException("Unsupported source. Only StreamSource supported yet");
}
if (!isHashcodeComputed() && ((StreamSource) this.source).getInputStream() == null) {
log.warn("No hashcode supplied, will wrap the reader using system default charset");
}
+ if (!(isTreeInfo() || isDomSource() || isStreamSource() || isJaxbSource())) {
+ log.warn("No known to be working Source implementation provided.");
+ }
}
@Override
public Source getSource() throws IOException {
- if (!isHashcodeComputed() && !isSupported()) {
- throw new IllegalStateException("Unsupported source. Only InputStream-based StreamSource supported yet");
- }
if (isConsumed()) {
throw new IllegalStateException("A SourceInput can only read once");
}
return isHashcodeComputed() ? this.source : wrappedSource();
}
- private boolean isSupported() {
+ private boolean isHashcodeComputationSupported() {
return isStreamSource();
}
- private boolean isConsumed() throws IOException {
+ private boolean isConsumed() {
if (isStreamSource()) {
final StreamSource ss = (StreamSource) this.source;
@@ -94,6 +121,18 @@ public class SourceInput extends AbstractInput {
return this.source instanceof StreamSource;
}
+ private boolean isDomSource() {
+ return this.source instanceof DOMSource;
+ }
+
+ public boolean isTreeInfo() {
+ return this.source instanceof TreeInfo;
+ }
+
+ private boolean isJaxbSource() {
+ return this.source instanceof JAXBSource;
+ }
+
private Source wrappedSource() {
Source result = this.source;
if (isStreamSource()) {
@@ -101,19 +140,21 @@ public class SourceInput extends AbstractInput {
if (ss.getInputStream() != null) {
result = new StreamSource(wrap(ss.getInputStream()), this.source.getSystemId());
} else if (ss.getReader() != null) {
- result = new StreamSource(wrap(new ReaderInputStream(ss.getReader(), Charset.defaultCharset())), this.source.getSystemId());
+ try {
+ result = new StreamSource(
+ wrap(ReaderInputStream.builder().setReader(ss.getReader()).setCharset(Charset.defaultCharset()).get()),
+ this.source.getSystemId());
+ } catch (final IOException ex) {
+ throw new UncheckedIOException(ex);
+ }
}
}
return result;
}
- private boolean isWrappingRequired() {
- return !isHashcodeComputed();
- }
-
@Override
public boolean supportsMultipleReads() {
- return false;
+ return isDomSource() || isTreeInfo();
}
}
diff --git a/src/main/java/de/kosit/validationtool/impl/input/StreamHelper.java b/src/main/java/de/kosit/validationtool/impl/input/StreamHelper.java
index bd8de8a..cefd0e3 100644
--- a/src/main/java/de/kosit/validationtool/impl/input/StreamHelper.java
+++ b/src/main/java/de/kosit/validationtool/impl/input/StreamHelper.java
@@ -1,15 +1,33 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
+import java.io.BufferedInputStream;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
+import java.io.UncheckedIOException;
import java.security.DigestInputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import javax.xml.transform.stream.StreamSource;
-import org.apache.commons.io.input.CountingInputStream;
+import org.apache.commons.io.input.BoundedInputStream;
import de.kosit.validationtool.api.Input;
@@ -22,8 +40,9 @@ public class StreamHelper {
/**
* Helper class, which generates the hashcode while reading the stream e.g. for parsing the document. This allows
- * generating the hashcode without an aditional reading step.
+ * generating the hashcode without an additional reading step.
*/
+ @SuppressWarnings("squid:S4929") // efficient read is done by internally used stream
private static class DigestingInputStream extends FilterInputStream {
private final MessageDigest digest;
@@ -44,19 +63,49 @@ public class StreamHelper {
}
+ private static class PeekableInputStream extends BufferedInputStream {
+
+ public PeekableInputStream(final InputStream in) {
+ super(in);
+ }
+
+ @Override
+ public synchronized int available() throws IOException {
+ int count = super.available();
+ if (count == 0) {
+ count = peek();
+ }
+ return count;
+ }
+
+ @SuppressWarnings("ResultOfMethodCallIgnored")
+ private int peek() throws IOException {
+ try {
+ mark(2);
+ read();
+ read();
+ reset();
+ } catch (final IOException e) {
+ return 0;
+ }
+ return super.available();
+ }
+ }
+
+ @SuppressWarnings("squid:S4929") // efficient read is done by internally used stream
private static class CountInputStream extends FilterInputStream {
private final LazyReadInput reference;
- public CountInputStream(final LazyReadInput input, final InputStream stream) {
- super(new org.apache.commons.io.input.CountingInputStream(stream));
+ public CountInputStream(final LazyReadInput input, final InputStream stream) throws IOException {
+ super(BoundedInputStream.builder().setInputStream(stream).get());
this.reference = input;
}
@Override
public void close() throws IOException {
super.close();
- this.reference.setLength(((CountingInputStream) this.in).getByteCount());
+ this.reference.setLength(((BoundedInputStream) this.in).getCount());
}
}
@@ -82,25 +131,34 @@ public class StreamHelper {
/**
* Wraps the {@link InputStream} with a counting length implementation.
*
- * @param input the {@link LazyReadInput input}
+ * @param input the lazy read input
* @param stream the stream
* @return a wrapped stream
*/
public static InputStream wrapCount(final LazyReadInput input, final InputStream stream) {
- return new CountInputStream(input, stream);
+ try {
+ return new CountInputStream(input, stream);
+ } catch (final IOException ex) {
+ throw new UncheckedIOException(ex);
+ }
}
/**
* Wraps the {@link InputStream} with an implementation the generates a hash sum over the stream data.
*
- * @param input the {@link LazyReadInput input}
+ * @param input the lazy read input
* @param stream the stream
+ * @param digestAlgorithm the message digest algorithm to use
* @return a wrapped stream
*/
public static InputStream wrapDigesting(final LazyReadInput input, final InputStream stream, final String digestAlgorithm) {
return new DigestingInputStream(input, stream, createDigest(digestAlgorithm));
}
+ public static BufferedInputStream wrapPeekable(final InputStream stream) {
+ return new PeekableInputStream(stream);
+ }
+
/**
* Drains the {@link Input} without further processing. This is useful to computing hashcode etc.
*
@@ -123,10 +181,14 @@ public class StreamHelper {
* @param input the input
* @throws IOException on I/O errors
*/
+ @SuppressWarnings({ "squid:S1854", "unused" })
public static void drain(final InputStream input) throws IOException {
final byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
+ // noinspection unused
int n;
+
+ // noinspection StatementWithEmptyBody,UnusedAssignment
while (EOF != (n = input.read(buffer))) {
// nothing
}
diff --git a/src/main/java/de/kosit/validationtool/impl/input/XdmNodeInput.java b/src/main/java/de/kosit/validationtool/impl/input/XdmNodeInput.java
new file mode 100644
index 0000000..e3b9471
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/impl/input/XdmNodeInput.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.input;
+
+import javax.xml.transform.Source;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+import de.kosit.validationtool.api.Input;
+
+import net.sf.saxon.s9api.XdmNode;
+
+/**
+ * An {@link Input} implementation holding saxon's {@link XdmNode} object.
+ *
+ * @author Andreas Penski
+ */
+@RequiredArgsConstructor
+@Getter
+public class XdmNodeInput implements Input {
+
+ private final XdmNode node;
+
+ private final String name;
+
+ private final String digestAlgorithm;
+
+ private final byte[] hashCode;
+
+ @Override
+ public Source getSource() {
+ // usually not neccessary to be called.
+ return this.node.getUnderlyingNode();
+ }
+}
diff --git a/src/main/java/de/kosit/validationtool/impl/model/BaseOutput.java b/src/main/java/de/kosit/validationtool/impl/model/BaseOutput.java
index b6a670b..8e3c07c 100644
--- a/src/main/java/de/kosit/validationtool/impl/model/BaseOutput.java
+++ b/src/main/java/de/kosit/validationtool/impl/model/BaseOutput.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.model;
import java.io.Serializable;
@@ -43,7 +59,7 @@ public abstract class BaseOutput {
* @return true wenn mindestens ein {@link FailedAssert} vorhanden ist
*/
public boolean hasFailedAsserts() {
- return getFailedAsserts().size() > 0;
+ return !getFailedAsserts().isEmpty();
}
/**
@@ -69,4 +85,8 @@ public abstract class BaseOutput {
return getFailedAsserts().stream().filter(e -> e.getId().equals(name)).findAny();
}
+ public List getMessages() {
+ return getFailedAsserts().stream().map(FailedAssert::getText).flatMap(e -> e.getContent().stream()).map(Object::toString)
+ .collect(Collectors.toList());
+ }
}
diff --git a/src/main/java/de/kosit/validationtool/impl/model/BaseXMLSyntaxError.java b/src/main/java/de/kosit/validationtool/impl/model/BaseXMLSyntaxError.java
index ed4e188..e854092 100644
--- a/src/main/java/de/kosit/validationtool/impl/model/BaseXMLSyntaxError.java
+++ b/src/main/java/de/kosit/validationtool/impl/model/BaseXMLSyntaxError.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.model;
@@ -53,30 +50,6 @@ public abstract class BaseXMLSyntaxError implements XmlError {
return String.format("%s At row %s at pos %s", getMessage(), getRowNumber(), getColumnNumber());
}
- /**
- * Getter aus dem schema
- *
- * @return Spalte des Fehlers
- */
- @Override
- public abstract Integer getColumnNumber();
-
- /**
- * Getter aus dem schema
- *
- * @return Zeile des Fehlers
- */
- @Override
- public abstract Integer getRowNumber();
-
- /**
- * Getter aus dem schema
- *
- * @return Fehlermeldung
- */
- @Override
- public abstract String getMessage();
-
/**
* Getter aus dem schema
*
diff --git a/src/main/java/de/kosit/validationtool/impl/model/CustomFailedAssert.java b/src/main/java/de/kosit/validationtool/impl/model/CustomFailedAssert.java
new file mode 100644
index 0000000..e2163cb
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/impl/model/CustomFailedAssert.java
@@ -0,0 +1,41 @@
+package de.kosit.validationtool.impl.model;
+
+import java.util.Objects;
+
+import org.oclc.purl.dsdl.svrl.FailedAssert;
+
+import de.kosit.validationtool.model.scenarios.ErrorLevelType;
+
+/**
+ * This class contains a single Schematron failed assertion that has a custom error level.
+ *
+ * @since 1.6.0
+ */
+public class CustomFailedAssert {
+
+ private final FailedAssert originalFailedAssert;
+
+ private final ErrorLevelType customLevelFlag;
+
+ /**
+ * Constructor
+ *
+ * @param failedAssert The failed assert from Schematron. May not be null.
+ * @param customLevelFlag The custom error level. May not be null.
+ */
+ public CustomFailedAssert(final FailedAssert failedAssert, final ErrorLevelType customLevelFlag) {
+ Objects.requireNonNull(failedAssert);
+ Objects.requireNonNull(customLevelFlag);
+ this.originalFailedAssert = failedAssert;
+ this.customLevelFlag = customLevelFlag;
+ }
+
+ public FailedAssert getFailedAssert() {
+ return this.originalFailedAssert;
+ }
+
+ public ErrorLevelType getCustomLevelFlag() {
+ return this.customLevelFlag;
+ }
+
+}
diff --git a/src/main/java/de/kosit/validationtool/impl/model/Result.java b/src/main/java/de/kosit/validationtool/impl/model/Result.java
index 432d85e..893f586 100644
--- a/src/main/java/de/kosit/validationtool/impl/model/Result.java
+++ b/src/main/java/de/kosit/validationtool/impl/model/Result.java
@@ -1,27 +1,24 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.model;
import java.util.ArrayList;
-import java.util.Collection;
import java.util.Collections;
+import java.util.List;
import lombok.AllArgsConstructor;
import lombok.Getter;
@@ -40,14 +37,14 @@ public class Result {
private T object;
- private Collection errors = new ArrayList<>();
+ private List errors = new ArrayList<>();
/**
* Erzeugt ein neues Ergebnis mit Fehler
*
* @param errors die Fehler
*/
- public Result(Collection errors) {
+ public Result(final List errors) {
this(null, errors);
}
@@ -56,7 +53,7 @@ public class Result {
*
* @param o
*/
- public Result(T o) {
+ public Result(final T o) {
this(o, Collections.emptyList());
}
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/CheckAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/CheckAction.java
index 23d6476..22f03ca 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/CheckAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/CheckAction.java
@@ -1,32 +1,25 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
import java.util.Collection;
import java.util.Collections;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.Setter;
+import org.apache.commons.io.FilenameUtils;
import de.kosit.validationtool.api.AcceptRecommendation;
import de.kosit.validationtool.api.Input;
@@ -35,7 +28,9 @@ import de.kosit.validationtool.impl.model.Result;
import de.kosit.validationtool.model.reportInput.CreateReportInput;
import de.kosit.validationtool.model.reportInput.ProcessingError;
import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
-
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.Setter;
import net.sf.saxon.s9api.XdmNode;
/**
@@ -58,9 +53,9 @@ public interface CheckAction {
private Result scenarioSelectionResult;
@Setter(AccessLevel.NONE)
- private CreateReportInput reportInput;
+ private final CreateReportInput reportInput;
- /** Das finale Ergebnis */
+ /** The final result */
private XdmNode report;
private boolean finished;
@@ -69,7 +64,7 @@ public interface CheckAction {
private AcceptRecommendation acceptStatus = AcceptRecommendation.UNDEFINED;
- /** Das zu prüfende Dokument */
+ /** The document to validate */
private Input input;
private Result parserResult;
@@ -88,7 +83,9 @@ public interface CheckAction {
}
/**
- * Signalisiert einen vorzeitigen Stop der Vearbeitung.
+ * Indicates an early stop in processing.
+ *
+ * @param error Error text
*/
public void stopProcessing(final String error) {
stopProcessing(Collections.singleton(error));
@@ -113,11 +110,7 @@ public interface CheckAction {
*/
public String getName() {
final String fileName = getInput().getName().replaceAll(".*/|.*\\\\", "");
- final Matcher matcher = Pattern.compile("(.*)\\..+").matcher(fileName);
- if (matcher.matches()) {
- return matcher.group(1);
- }
- return fileName;
+ return FilenameUtils.getBaseName(fileName);
}
}
@@ -129,12 +122,12 @@ public interface CheckAction {
void check(Bag results);
/**
- * Ermittlung, ob ein Schritt u.U. ausgelassen werden kann. Die Funktion wird vor der eigentlichen Prüfaktion aufgerufen
- * und kann somit eine Ausführung des Prüfschrittes verhindern. Entwickler können diese Funktion überschreiben, um den
- * Prüfschritt bedingt auszuführen.
+ * Ermittlung, ob ein Schritt u.U. ausgelassen werden kann. Die Funktion wird vor der eigentlichen Prüfaktion
+ * aufgerufen und kann somit eine Ausführung des Prüfschrittes verhindern. Entwickler können diese Funktion
+ * überschreiben, um den Prüfschritt bedingt auszuführen.
*
* @param results die bisher gesammelten Information
- * @return true wenn der Schritt ausgelassen werden soll
+ * @return true wenn der Schritt ausgelassen werden soll
*/
default boolean isSkipped(final Bag results) {
return false;
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/ComputeAcceptanceAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/ComputeAcceptanceAction.java
index 04ccee2..e0ae2ac 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/ComputeAcceptanceAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/ComputeAcceptanceAction.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.tasks;
import java.util.Optional;
@@ -24,6 +40,10 @@ public class ComputeAcceptanceAction implements CheckAction {
@Override
public void check(final Bag results) {
+ if (results.isStopped() && results.getParserResult().isValid()) {
+ // xml wurde aus irgendwelchen Gründen nicht korrekt verarbeitet, dann lassen wir es als undefined
+ return;
+ }
if (preCondtionsMatch(results)) {
final Optional acceptMatch = results.getScenarioSelectionResult().getObject().getAcceptSelector();
if (results.getSchemaValidationResult().isValid() && acceptMatch.isPresent()) {
@@ -44,11 +64,11 @@ public class ComputeAcceptanceAction implements CheckAction {
}
}
- private boolean isSchematronValid(final Bag results) {
+ private static boolean isSchematronValid(final Bag results) {
return !hasSchematronErrors(results);
}
- private boolean hasSchematronErrors(final Bag results) {
+ private static boolean hasSchematronErrors(final Bag results) {
return results.getReportInput().getValidationResultsSchematron().stream().map(e -> e.getResults().getSchematronOutput())
.flatMap(e -> e.getActivePatternAndFiredRuleAndFailedAssert().stream()).anyMatch(FailedAssert.class::isInstance);
}
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/CreateDocumentIdentificationAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/CreateDocumentIdentificationAction.java
index 3608b5c..b65c1ed 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/CreateDocumentIdentificationAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/CreateDocumentIdentificationAction.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.tasks;
import de.kosit.validationtool.model.reportInput.DocumentIdentificationType;
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/CreateReportAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/CreateReportAction.java
index 014bae7..4a5d265 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/CreateReportAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/CreateReportAction.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
@@ -23,12 +20,10 @@ import java.io.IOException;
import java.util.Collection;
import java.util.stream.Collectors;
-import javax.xml.bind.JAXBException;
-import javax.xml.bind.Marshaller;
-import javax.xml.bind.util.JAXBSource;
-import javax.xml.transform.URIResolver;
+import jakarta.xml.bind.JAXBException;
+import jakarta.xml.bind.Marshaller;
+import jakarta.xml.bind.util.JAXBSource;
-import lombok.extern.slf4j.Slf4j;
import org.xml.sax.ContentHandler;
import org.xml.sax.DTDHandler;
import org.xml.sax.EntityResolver;
@@ -38,9 +33,9 @@ import org.xml.sax.SAXException;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.XMLReader;
-import org.xml.sax.helpers.AttributesImpl;
import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
import de.kosit.validationtool.impl.CollectingErrorEventHandler;
import de.kosit.validationtool.impl.ConversionService;
@@ -48,7 +43,6 @@ import de.kosit.validationtool.impl.EngineInformation;
import de.kosit.validationtool.impl.Scenario;
import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
-import net.sf.saxon.s9api.BuildingContentHandler;
import net.sf.saxon.s9api.DocumentBuilder;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.QName;
@@ -57,6 +51,8 @@ import net.sf.saxon.s9api.XdmDestination;
import net.sf.saxon.s9api.XdmNode;
import net.sf.saxon.s9api.XsltExecutable;
import net.sf.saxon.s9api.XsltTransformer;
+import net.sf.saxon.sapling.SaplingDocument;
+import net.sf.saxon.sapling.Saplings;
/**
* Erzeugt den Report auf Basis der gesammelten Informationen über den Prüfling. Sollte kein Szenario identifiziert
@@ -68,9 +64,68 @@ import net.sf.saxon.s9api.XsltTransformer;
@Slf4j
public class CreateReportAction implements CheckAction {
+ private static final String ERROR_MESSAGE_ELEMENT = "error-message";
+
+ private final Processor processor;
+
+ private final ConversionService conversionService;
+
+ private static XsltExecutable loadFromScenario(final Scenario object) {
+ return object.getReportTransformation().getExecutable();
+ }
+
+ private static XsltExecutable getTransformation(final Bag results) {
+ return loadFromScenario(results.getScenarioSelectionResult().getObject());
+ }
+
+ @Override
+ public void check(final Bag results) {
+ final DocumentBuilder documentBuilder = this.processor.newDocumentBuilder();
+ try {
+
+ final XdmNode parsedDocument = results.getParserResult().isValid() ? results.getParserResult().getObject()
+ : createErrorInformation(results.getParserResult().getErrors());
+
+ final Marshaller marshaller = this.conversionService.getJaxbContext().createMarshaller();
+ final JAXBSource source = new JAXBSource(marshaller, results.getReportInput());
+ // wrap to circumvent inconsistency between sax and saxon
+ source.setXMLReader(new ReaderWrapper(source.getXMLReader()));
+
+ final XdmNode root = documentBuilder.build(source);
+ final XsltTransformer transformer = getTransformation(results).load();
+ transformer.setInitialContextNode(root);
+ final CollectingErrorEventHandler e = new CollectingErrorEventHandler();
+ transformer.setMessageListener(e);
+ final Scenario scenario = results.getScenarioSelectionResult().getObject();
+ transformer.setURIResolver(scenario.getUriResolver());
+
+ if (scenario.getUnparsedTextURIResolver() != null) {
+ transformer.getUnderlyingController().setUnparsedTextURIResolver(scenario.getUnparsedTextURIResolver());
+ }
+ if (parsedDocument != null) {
+ transformer.setParameter(new QName("input-document"), parsedDocument);
+ }
+ final XdmDestination destination = new XdmDestination();
+ transformer.setDestination(destination);
+ transformer.transform();
+ results.setReport(destination.getXdmNode());
+
+ } catch (final SaxonApiException | JAXBException e) {
+ log.error("Error creating final report", e);
+ results.stopProcessing("Can not create final report: " + e.getMessage());
+ }
+ }
+
+ private XdmNode createErrorInformation(final Collection errors) throws SaxonApiException {
+ final String message = errors.stream().map(XMLSyntaxError::getMessage).collect(Collectors.joining());
+ final SaplingDocument doc = Saplings.doc(EngineInformation.getFrameworkNamespace());
+ return doc.withChild(Saplings.elem(ERROR_MESSAGE_ELEMENT).withText(message)).toXdmNode(this.processor);
+ }
+
/**
- * Wrapper to fix some inconsistencies between sax and saxon. Saxon tries to set some properties which has no effect on
- * {@link JAXBSource}'s XMLReader, but it throws exceptions on unknown properties. This just drops this exceptions.
+ * Wrapper to fix some inconsistencies between sax and saxon. Saxon tries to set some properties which has no effect
+ * on {@link JAXBSource}'s XMLReader, but it throws exceptions on unknown properties. This just drops this
+ * exceptions.
*/
private static class ReaderWrapper implements XMLReader {
@@ -116,19 +171,14 @@ public class CreateReportAction implements CheckAction {
this.delegate.setProperty(name, value);
}
- @Override
- public void setEntityResolver(final EntityResolver resolver) {
- this.delegate.setEntityResolver(resolver);
- }
-
@Override
public EntityResolver getEntityResolver() {
return this.delegate.getEntityResolver();
}
@Override
- public void setDTDHandler(final DTDHandler handler) {
- this.delegate.setDTDHandler(handler);
+ public void setEntityResolver(final EntityResolver resolver) {
+ this.delegate.setEntityResolver(resolver);
}
@Override
@@ -137,8 +187,8 @@ public class CreateReportAction implements CheckAction {
}
@Override
- public void setContentHandler(final ContentHandler handler) {
- this.delegate.setContentHandler(handler);
+ public void setDTDHandler(final DTDHandler handler) {
+ this.delegate.setDTDHandler(handler);
}
@Override
@@ -147,8 +197,8 @@ public class CreateReportAction implements CheckAction {
}
@Override
- public void setErrorHandler(final ErrorHandler handler) {
- this.delegate.setErrorHandler(handler);
+ public void setContentHandler(final ContentHandler handler) {
+ this.delegate.setContentHandler(handler);
}
@Override
@@ -156,6 +206,11 @@ public class CreateReportAction implements CheckAction {
return this.delegate.getErrorHandler();
}
+ @Override
+ public void setErrorHandler(final ErrorHandler handler) {
+ this.delegate.setErrorHandler(handler);
+ }
+
@Override
public void parse(final InputSource input) throws IOException, SAXException {
this.delegate.parse(input);
@@ -167,65 +222,4 @@ public class CreateReportAction implements CheckAction {
}
}
- private static final String ERROR_MESSAGE_ELEMENT = "error-message";
-
- private final Processor processor;
-
- private final ConversionService conversionService;
-
- private final URIResolver resolver;
-
- private static XsltExecutable loadFromScenario(final Scenario object) {
- return object.getReportTransformation().getExecutable();
- }
-
- @Override
- public void check(final Bag results) {
- final DocumentBuilder documentBuilder = this.processor.newDocumentBuilder();
- try {
-
- final XdmNode parsedDocument = results.getParserResult().isValid() ? results.getParserResult().getObject()
- : createErrorInformation(results.getParserResult().getErrors());
-
- final Marshaller marshaller = this.conversionService.getJaxbContext().createMarshaller();
- final JAXBSource source = new JAXBSource(marshaller, results.getReportInput());
- // wrap to circumvent inconsistency between sax and saxon
- source.setXMLReader(new ReaderWrapper(source.getXMLReader()));
-
- final XdmNode root = documentBuilder.build(source);
- final XsltTransformer transformer = getTransformation(results).load();
- transformer.setInitialContextNode(root);
- final CollectingErrorEventHandler e = new CollectingErrorEventHandler();
- transformer.setMessageListener(e);
- transformer.setURIResolver(this.resolver);
- // transformer.getUnderlyingController().setUnparsedTextURIResolver(resolver);
- if (parsedDocument != null) {
- transformer.setParameter(new QName("input-document"), parsedDocument);
- }
- final XdmDestination destination = new XdmDestination();
- transformer.setDestination(destination);
- transformer.transform();
- results.setReport(destination.getXdmNode());
-
- } catch (final SaxonApiException | SAXException | JAXBException e) {
- log.error("Error creating final report", e);
- results.stopProcessing("Can not create final report: " + e.getMessage());
- }
- }
-
- private XdmNode createErrorInformation(final Collection errors) throws SaxonApiException, SAXException {
- final BuildingContentHandler contentHandler = this.processor.newDocumentBuilder().newBuildingContentHandler();
- contentHandler.startDocument();
- contentHandler.startElement(EngineInformation.getFrameworkNamespace(), ERROR_MESSAGE_ELEMENT, ERROR_MESSAGE_ELEMENT,
- new AttributesImpl());
- final String message = errors.stream().map(XMLSyntaxError::getMessage).collect(Collectors.joining());
- contentHandler.characters(message.toCharArray(), 0, message.length());
- contentHandler.endElement(EngineInformation.getFrameworkNamespace(), ERROR_MESSAGE_ELEMENT, ERROR_MESSAGE_ELEMENT);
- return contentHandler.getDocumentNode();
- }
-
- private static XsltExecutable getTransformation(final Bag results) {
- return loadFromScenario(results.getScenarioSelectionResult().getObject());
- }
-
}
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/DocumentParseAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/DocumentParseAction.java
index c5559a7..57de17f 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/DocumentParseAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/DocumentParseAction.java
@@ -1,37 +1,34 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
import java.io.IOException;
+import java.util.Arrays;
import java.util.Collections;
import java.util.stream.Collectors;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-
import de.kosit.validationtool.api.Input;
+import de.kosit.validationtool.impl.input.XdmNodeInput;
import de.kosit.validationtool.impl.model.Result;
import de.kosit.validationtool.model.reportInput.ValidationResultsWellformedness;
import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
import de.kosit.validationtool.model.reportInput.XMLSyntaxErrorSeverity;
-
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.s9api.DocumentBuilder;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.SaxonApiException;
@@ -47,6 +44,7 @@ import net.sf.saxon.s9api.XdmNode;
public class DocumentParseAction implements CheckAction {
private final Processor processor;
+
/**
* Parsed und überprüft ein übergebenes Dokument darauf ob es well-formed ist. Dies stellt den ersten
* Verarbeitungsschritt des Prüf-Tools dar. Diese Funktion verzichtet explizit auf die Validierung gegenüber einem
@@ -60,22 +58,32 @@ public class DocumentParseAction implements CheckAction {
throw new IllegalArgumentException("Input may not be null");
}
Result result;
+
try {
- final DocumentBuilder builder = this.processor.newDocumentBuilder();
- builder.setLineNumbering(true);
- final XdmNode doc = builder.build(content.getSource());
- result = new Result<>(doc, Collections.emptyList());
+ if (content instanceof XdmNodeInput && hasCompatibleConfiguration((XdmNodeInput) content)) {
+ // parsing not neccessary
+ result = new Result<>(((XdmNodeInput) content).getNode());
+ } else {
+ final DocumentBuilder builder = this.processor.newDocumentBuilder();
+ builder.setLineNumbering(true);
+ final XdmNode doc = builder.build(content.getSource());
+ result = new Result<>(doc, Collections.emptyList());
+ }
} catch (final SaxonApiException | IOException e) {
log.debug("Exception while parsing {}", content.getName(), e);
final XMLSyntaxError error = new XMLSyntaxError();
error.setSeverityCode(XMLSyntaxErrorSeverity.SEVERITY_FATAL_ERROR);
error.setMessage(String.format("IOException while reading resource %s: %s", content.getName(), e.getMessage()));
- result = new Result<>(Collections.singleton(error));
+ result = new Result<>(Arrays.asList(error));
}
return result;
}
+ private boolean hasCompatibleConfiguration(final XdmNodeInput content) {
+ return content.getNode().getProcessor().getUnderlyingConfiguration().isCompatible(this.processor.getUnderlyingConfiguration());
+ }
+
@Override
public void check(final Bag results) {
final Result parserResult = parseDocument(results.getInput());
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/ScenarioSelectionAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/ScenarioSelectionAction.java
index 90b5c46..01559a4 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/ScenarioSelectionAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/ScenarioSelectionAction.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
@@ -54,9 +51,9 @@ public class ScenarioSelectionAction implements CheckAction {
results.setScenarioSelectionResult(scenarioTypeResult);
if (!scenarioTypeResult.getObject().isFallback()) {
report.setScenario(scenarioTypeResult.getObject().getConfiguration());
- log.info("Schenario {} identified for {}", scenarioTypeResult.getObject().getName(), results.getInput().getName());
+ log.info("Scenario {} identified for {}", scenarioTypeResult.getObject().getName(), results.getInput().getName());
} else {
- log.error("No valid schenario configuration found for {}", results.getInput().getName());
+ log.info("No valid scenario configuration found for {}", results.getInput().getName());
}
}
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/SchemaValidationAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/SchemaValidationAction.java
index a2396c8..2a0b175 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/SchemaValidationAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/SchemaValidationAction.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
@@ -34,14 +31,7 @@ import javax.xml.validation.Validator;
import org.apache.commons.io.FileUtils;
import org.xml.sax.SAXException;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-import lombok.Setter;
-import lombok.extern.slf4j.Slf4j;
-
import de.kosit.validationtool.api.Input;
-import de.kosit.validationtool.api.ResolvingConfigurationStrategy;
import de.kosit.validationtool.impl.CollectingErrorEventHandler;
import de.kosit.validationtool.impl.Scenario;
import de.kosit.validationtool.impl.input.AbstractInput;
@@ -49,7 +39,11 @@ import de.kosit.validationtool.impl.model.Result;
import de.kosit.validationtool.model.reportInput.CreateReportInput;
import de.kosit.validationtool.model.reportInput.ValidationResultsXmlSchema;
import de.kosit.validationtool.model.reportInput.XMLSyntaxError;
-
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.Setter;
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.Serializer;
@@ -103,7 +97,6 @@ public class SchemaValidationAction implements CheckAction {
private static class FileSerializedDocument implements SerializedDocument {
-
private final Path file;
private final Processor processor;
@@ -138,8 +131,6 @@ public class SchemaValidationAction implements CheckAction {
private static final String LIMIT_PARAMETER = "schema.validation.inmem.limit";
- private final ResolvingConfigurationStrategy factory;
-
private final Processor processor;
@Setter(AccessLevel.PACKAGE)
@@ -151,7 +142,7 @@ public class SchemaValidationAction implements CheckAction {
final CollectingErrorEventHandler errorHandler = new CollectingErrorEventHandler();
try ( final SourceProvider validateInput = resolveSource(results) ) {
- final Validator validator = this.factory.createValidator(scenario.getSchema());
+ final Validator validator = scenario.getFactory().createValidator(scenario.getSchema());
validator.setErrorHandler(errorHandler);
validator.validate(validateInput.getSource());
return new Result<>(!errorHandler.hasErrors(), errorHandler.getErrors());
@@ -191,9 +182,11 @@ public class SchemaValidationAction implements CheckAction {
}
+ @SuppressWarnings("squid:S2095") // intentionally return open stream/autoclosable here
private SerializedDocument serialize(final Input input, final XdmNode object) throws IOException, SaxonApiException {
final SerializedDocument doc;
if (input instanceof AbstractInput && ((AbstractInput) input).getLength() < getInMemoryLimit()) {
+
doc = new ByteArraySerializedDocument(this.processor);
} else {
doc = new FileSerializedDocument(this.processor);
@@ -221,7 +214,7 @@ public class SchemaValidationAction implements CheckAction {
}
}
- private interface SerializedDocument extends AutoCloseable, SourceProvider {
+ private interface SerializedDocument extends SourceProvider {
void serialize(XdmNode node) throws SaxonApiException, IOException;
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/SchematronValidationAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/SchematronValidationAction.java
index 8f52cfe..90ad899 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/SchematronValidationAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/SchematronValidationAction.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
@@ -22,20 +19,19 @@ package de.kosit.validationtool.impl.tasks;
import java.util.List;
import java.util.stream.Collectors;
-import javax.xml.transform.URIResolver;
import javax.xml.transform.dom.DOMSource;
import org.oclc.purl.dsdl.svrl.SchematronOutput;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-
import de.kosit.validationtool.impl.CollectingErrorEventHandler;
import de.kosit.validationtool.impl.ConversionService;
import de.kosit.validationtool.impl.Scenario;
+import de.kosit.validationtool.impl.Scenario.Transformation;
import de.kosit.validationtool.model.reportInput.CreateReportInput;
import de.kosit.validationtool.model.reportInput.ValidationResultsSchematron;
-
+import de.kosit.validationtool.model.reportInput.ValidationResultsSchematron.Results;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
import net.sf.saxon.dom.NodeOverNodeInfo;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.XdmDestination;
@@ -51,21 +47,20 @@ import net.sf.saxon.s9api.XsltTransformer;
@Slf4j
public class SchematronValidationAction implements CheckAction {
- private final URIResolver resolver;
-
private final ConversionService conversionService;
private List validate(final Bag results, final XdmNode document, final Scenario scenario) {
- return scenario.getSchematronValidations().stream().map(v -> validate(results, document, v)).collect(Collectors.toList());
+ return scenario.getSchematronValidations().stream().map(v -> validate(scenario, results, document, v)).collect(Collectors.toList());
}
- private ValidationResultsSchematron validate(final Bag results, final XdmNode document, final Scenario.Transformation validation) {
+ private ValidationResultsSchematron validate(final Scenario scenario, final Bag results, final XdmNode document,
+ final Transformation validation) {
final ValidationResultsSchematron s = new ValidationResultsSchematron();
s.setResource(validation.getResourceType());
try {
final XsltTransformer transformer = validation.getExecutable().load();
// resolving nur relative zum Repository
- transformer.setURIResolver(this.resolver);
+ transformer.setURIResolver(scenario.getUriResolver());
final CollectingErrorEventHandler e = new CollectingErrorEventHandler();
transformer.setMessageListener(e);
@@ -74,6 +69,11 @@ public class SchematronValidationAction implements CheckAction {
transformer.setInitialContextNode(document);
transformer.transform();
+ // If we reach this line, it means no Exception was thrown :-)
+ if (e.hasErrors()) {
+ log.error("XSLT errors found: " + e.getErrorDescription());
+ }
+
final ValidationResultsSchematron.Results r = new ValidationResultsSchematron.Results();
r.setSchematronOutput(this.conversionService.readDocument(
new DOMSource(NodeOverNodeInfo.wrap(result.getXdmNode().getUnderlyingNode()).getOwnerDocument()),
@@ -81,13 +81,21 @@ public class SchematronValidationAction implements CheckAction {
s.setResults(r);
} catch (final SaxonApiException e) {
- final String msg = String.format("Error processing schematron validation %s", validation.getResourceType().getName());
+ final String msg = String.format("Error processing schematron validation %s. Error is %s",
+ validation.getResourceType().getName(), e.getMessage());
log.error(msg, e);
results.addProcessingError(msg);
+ s.setResults(createErrorResult());
}
return s;
}
+ private static Results createErrorResult() {
+ final Results r = new Results();
+ r.setSchematronOutput(new SchematronOutput());
+ return r;
+ }
+
@Override
public void check(final Bag results) {
final CreateReportInput report = results.getReportInput();
diff --git a/src/main/java/de/kosit/validationtool/impl/tasks/ValidateReportInputAction.java b/src/main/java/de/kosit/validationtool/impl/tasks/ValidateReportInputAction.java
index 44de172..75a8c3d 100644
--- a/src/main/java/de/kosit/validationtool/impl/tasks/ValidateReportInputAction.java
+++ b/src/main/java/de/kosit/validationtool/impl/tasks/ValidateReportInputAction.java
@@ -1,20 +1,17 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.tasks;
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/BaseResolvingStrategy.java b/src/main/java/de/kosit/validationtool/impl/xml/BaseResolvingStrategy.java
index 3b548fb..bb5ec15 100644
--- a/src/main/java/de/kosit/validationtool/impl/xml/BaseResolvingStrategy.java
+++ b/src/main/java/de/kosit/validationtool/impl/xml/BaseResolvingStrategy.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.xml;
import static java.lang.String.format;
@@ -12,34 +28,14 @@ import lombok.extern.slf4j.Slf4j;
import de.kosit.validationtool.api.ResolvingConfigurationStrategy;
-import net.sf.saxon.s9api.Processor;
-
/**
* @author Andreas Penski
*/
@Slf4j
public abstract class BaseResolvingStrategy implements ResolvingConfigurationStrategy {
- protected static final String DISSALLOW_DOCTYPE_DECL_FEATURE = "http://apache.org/xml/features/disallow-doctype-decl";
-
- protected static final String LOAD_EXTERNAL_DTD_FEATURE = "http://apache.org/xml/features/nonvalidating/load-external-dtd";
-
- protected static final String FEATURE_SECURE_PROCESSING = "http://javax.xml.XMLConstants/feature/secure-processing";
-
private static final String ORACLE_XERCES_CLASS = "com.sun.org.apache.xerces.internal.impl.Constants";
- private Processor processor;
-
- @Override
- public Processor getProcessor() {
- if (this.processor == null) {
- this.processor = createProcessor();
- }
- return this.processor;
- }
-
- protected abstract Processor createProcessor();
-
public static void forceOpenJdkXmlImplementation() {
if (!isOpenJdkXmlImplementationAvailable()) {
throw new IllegalStateException("No OpenJDK version of XERCES found");
diff --git a/src/main/java/de/kosit/validationtool/impl/ClassPathResourceResolver.java b/src/main/java/de/kosit/validationtool/impl/xml/ClassPathResourceResolver.java
similarity index 73%
rename from src/main/java/de/kosit/validationtool/impl/ClassPathResourceResolver.java
rename to src/main/java/de/kosit/validationtool/impl/xml/ClassPathResourceResolver.java
index 46ff31f..d961b2f 100644
--- a/src/main/java/de/kosit/validationtool/impl/ClassPathResourceResolver.java
+++ b/src/main/java/de/kosit/validationtool/impl/xml/ClassPathResourceResolver.java
@@ -1,23 +1,20 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl;
+package de.kosit.validationtool.impl.xml;
import java.io.IOException;
import java.io.InputStream;
@@ -25,7 +22,7 @@ import java.io.Reader;
import java.net.URI;
import java.net.URL;
-import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.Strings;
import org.w3c.dom.ls.LSInput;
import org.w3c.dom.ls.LSResourceResolver;
@@ -34,15 +31,13 @@ import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
-import de.kosit.validationtool.impl.xml.RelativeUriResolver;
-
/**
* {@link LSResourceResolver} der objekte relativ zu einem Basis-Pfad aus dem Classpath der Anwendung laden kann.
*
* @author Andreas Penski
*/
@Slf4j
-class ClassPathResourceResolver implements LSResourceResolver {
+public class ClassPathResourceResolver implements LSResourceResolver {
/**
* Simple {@link LSInput}-Implementierung, die einen Stream liefern kann
@@ -95,7 +90,7 @@ class ClassPathResourceResolver implements LSResourceResolver {
* @param basePath der Basispfad
*/
public ClassPathResourceResolver(final String basePath) {
- if (!StringUtils.startsWith(basePath, "/")) {
+ if (!Strings.CS.startsWith(basePath, "/")) {
throw new IllegalArgumentException("Base path must start with a slash");
}
this.base = URI.create(basePath + (basePath.endsWith("/") == basePath.length() > 1 ? "" : "/"));
@@ -114,8 +109,9 @@ class ClassPathResourceResolver implements LSResourceResolver {
try {
final URL resource = resolved.isAbsolute() ? resolved.toURL()
: ClassPathResourceResolver.class.getResource(resolved.toASCIIString());
- final InputStream in = resource.openStream();
final LSInputImpl input = new LSInputImpl(publicId, systemId, resolved.toASCIIString());
+ // intentionally not closed, since xml stack wants it open upon return
+ final InputStream in = resource.openStream();
input.setByteStream(in);
return input;
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/ProcessorProvider.java b/src/main/java/de/kosit/validationtool/impl/xml/ProcessorProvider.java
new file mode 100644
index 0000000..3d91ff7
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/impl/xml/ProcessorProvider.java
@@ -0,0 +1,117 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.xml;
+
+import java.io.Reader;
+import java.net.URI;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+
+import javax.xml.XMLConstants;
+import javax.xml.transform.Result;
+import javax.xml.transform.TransformerException;
+
+import lombok.SneakyThrows;
+
+import net.sf.saxon.Configuration;
+import net.sf.saxon.expr.XPathContext;
+import net.sf.saxon.lib.CollectionFinder;
+import net.sf.saxon.lib.Feature;
+import net.sf.saxon.lib.FeatureKeys;
+import net.sf.saxon.lib.OutputURIResolver;
+import net.sf.saxon.lib.ResourceCollection;
+import net.sf.saxon.lib.UnparsedTextURIResolver;
+import net.sf.saxon.s9api.Processor;
+import net.sf.saxon.trans.XPathException;
+
+/**
+ * @author Andreas Penski
+ */
+public class ProcessorProvider {
+
+ private static class SecureUriResolver implements CollectionFinder, OutputURIResolver, UnparsedTextURIResolver {
+
+ public static final String MESSAGE = "Configuration error. Resolving ist not allowed";
+
+ @Override
+ public OutputURIResolver newInstance() {
+ return this;
+ }
+
+ @Override
+ public Result resolve(final String href, final String base) throws TransformerException {
+ throw new IllegalStateException(MESSAGE);
+ }
+
+ @Override
+ public void close(final Result result) throws TransformerException {
+ throw new IllegalStateException(MESSAGE);
+ }
+
+ @Override
+ public Reader resolve(final URI absoluteURI, final String encoding, final Configuration config) throws XPathException {
+ throw new IllegalStateException(MESSAGE);
+ }
+
+ @Override
+ public ResourceCollection findCollection(final XPathContext context, final String collectionURI) throws XPathException {
+ throw new IllegalStateException(MESSAGE);
+ }
+ }
+
+ protected static final String DISSALLOW_DOCTYPE_DECL_FEATURE = "http://apache.org/xml/features/disallow-doctype-decl";
+
+ protected static final String LOAD_EXTERNAL_DTD_FEATURE = "http://apache.org/xml/features/nonvalidating/load-external-dtd";
+
+ protected static final String FEATURE_SECURE_PROCESSING = "http://javax.xml.XMLConstants/feature/secure-processing";
+
+ private static Processor processor;
+
+ @SneakyThrows
+ private static String encode(final String input) {
+ return URLEncoder.encode(input, StandardCharsets.UTF_8.name());
+ }
+
+ public static Processor getProcessor() {
+ if (processor == null) {
+ processor = createProcessor();
+ }
+ return processor;
+ }
+
+ private static Processor createProcessor() {
+ final Processor processor = new Processor(false);
+ // verhindere global im Prinzip alle resolving strategien
+ final SecureUriResolver resolver = new SecureUriResolver();
+ processor.getUnderlyingConfiguration().setCollectionFinder(resolver);
+ processor.getUnderlyingConfiguration().setOutputURIResolver(resolver);// NOSONAR
+ processor.getUnderlyingConfiguration().setUnparsedTextURIResolver(resolver);
+
+ // grundsätzlich Feature-konfiguration:
+ processor.setConfigurationProperty(Feature.DTD_VALIDATION, false);
+ processor.setConfigurationProperty(Feature.ENTITY_RESOLVER_CLASS, "");
+ processor.setConfigurationProperty(Feature.XINCLUDE, false);
+ processor.setConfigurationProperty(Feature.ALLOW_EXTERNAL_FUNCTIONS, false);
+
+ // Konfiguration des zu verwendenden Parsers, wenn Saxon selbst einen erzeugen muss, bspw. beim XSL parsen
+ processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(FEATURE_SECURE_PROCESSING), true); // NOSONAR
+ processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(DISSALLOW_DOCTYPE_DECL_FEATURE), true);// NOSONAR
+ processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(LOAD_EXTERNAL_DTD_FEATURE), false);// NOSONAR
+ processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(XMLConstants.ACCESS_EXTERNAL_DTD), false);// NOSONAR
+ return processor;
+ }
+}
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/RelativeUriResolver.java b/src/main/java/de/kosit/validationtool/impl/xml/RelativeUriResolver.java
index 5b5d731..132ed7e 100644
--- a/src/main/java/de/kosit/validationtool/impl/xml/RelativeUriResolver.java
+++ b/src/main/java/de/kosit/validationtool/impl/xml/RelativeUriResolver.java
@@ -1,26 +1,22 @@
/*
- * Licensed to the Koordinierungsstelle für IT-Standards (KoSIT) under
- * one or more contributor license agreements. See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership. KoSIT licenses this file
- * to you 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
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
*
- * http://www.apache.org/licenses/LICENSE-2.0
+ * 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
*
- * 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.
+ * 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 de.kosit.validationtool.impl.xml;
import java.io.IOException;
-import java.io.InputStreamReader;
import java.io.Reader;
import java.net.URI;
@@ -30,8 +26,9 @@ import javax.xml.transform.URIResolver;
import javax.xml.transform.stream.StreamSource;
import lombok.RequiredArgsConstructor;
-
import net.sf.saxon.Configuration;
+import net.sf.saxon.lib.StandardUnparsedTextResolver;
+import net.sf.saxon.lib.UnparsedTextURIResolver;
import net.sf.saxon.trans.XPathException;
/**
@@ -41,7 +38,7 @@ import net.sf.saxon.trans.XPathException;
* @author Andreas Penski
*/
@RequiredArgsConstructor()
-public class RelativeUriResolver implements URIResolver {
+public class RelativeUriResolver implements URIResolver, UnparsedTextURIResolver {
/** the base uri */
private final URI baseUri;
@@ -56,10 +53,9 @@ public class RelativeUriResolver implements URIResolver {
throw new TransformerException(String.format("Can not resolve required %s", href), e);
}
- } else {
- throw new TransformerException(String
- .format("The resolved transformation artifact %s is not within the configured repository %s", resolved, this.baseUri));
}
+ throw new TransformerException(String.format("The resolved transformation artifact %s is not within the configured repository %s",
+ resolved, this.baseUri));
}
/**
@@ -93,6 +89,14 @@ public class RelativeUriResolver implements URIResolver {
return r.startsWith(base);
}
-
+ // from UnparsedTextURIResolver
+ @Override
+ public Reader resolve(final URI absoluteURI, final String encoding, final Configuration config) throws XPathException {
+ if (isUnderBaseUri(absoluteURI, this.baseUri)) {
+ return new StandardUnparsedTextResolver().resolve(absoluteURI, encoding, config);
+ }
+ throw new XPathException(String.format("The resolved transformation artifact %s is not within the configured repository %s",
+ absoluteURI, this.baseUri));
+ }
}
\ No newline at end of file
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/RemoteResolvingStrategy.java b/src/main/java/de/kosit/validationtool/impl/xml/RemoteResolvingStrategy.java
index ebebeb5..c361926 100644
--- a/src/main/java/de/kosit/validationtool/impl/xml/RemoteResolvingStrategy.java
+++ b/src/main/java/de/kosit/validationtool/impl/xml/RemoteResolvingStrategy.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.xml;
import javax.xml.validation.SchemaFactory;
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/StrictLocalResolvingStrategy.java b/src/main/java/de/kosit/validationtool/impl/xml/StrictLocalResolvingStrategy.java
index 68c27a8..3a2f04a 100644
--- a/src/main/java/de/kosit/validationtool/impl/xml/StrictLocalResolvingStrategy.java
+++ b/src/main/java/de/kosit/validationtool/impl/xml/StrictLocalResolvingStrategy.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.xml;
import java.net.URI;
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/StrictRelativeResolvingStrategy.java b/src/main/java/de/kosit/validationtool/impl/xml/StrictRelativeResolvingStrategy.java
index 26361e3..fadc42e 100644
--- a/src/main/java/de/kosit/validationtool/impl/xml/StrictRelativeResolvingStrategy.java
+++ b/src/main/java/de/kosit/validationtool/impl/xml/StrictRelativeResolvingStrategy.java
@@ -1,31 +1,32 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.xml;
-import java.io.Reader;
import java.net.URI;
-import java.net.URLEncoder;
-import java.nio.charset.StandardCharsets;
import javax.xml.XMLConstants;
-import javax.xml.transform.Result;
-import javax.xml.transform.TransformerException;
import javax.xml.transform.URIResolver;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;
import lombok.RequiredArgsConstructor;
-import lombok.SneakyThrows;
-import net.sf.saxon.Configuration;
-import net.sf.saxon.expr.XPathContext;
-import net.sf.saxon.lib.CollectionFinder;
-import net.sf.saxon.lib.Feature;
-import net.sf.saxon.lib.FeatureKeys;
-import net.sf.saxon.lib.OutputURIResolver;
-import net.sf.saxon.lib.ResourceCollection;
import net.sf.saxon.lib.UnparsedTextURIResolver;
-import net.sf.saxon.s9api.Processor;
-import net.sf.saxon.trans.XPathException;
/**
* @author Andreas Penski
@@ -33,43 +34,10 @@ import net.sf.saxon.trans.XPathException;
@RequiredArgsConstructor
public class StrictRelativeResolvingStrategy extends BaseResolvingStrategy {
- private static class SecureUriResolver implements CollectionFinder, OutputURIResolver, UnparsedTextURIResolver {
-
- public static final String MESSAGE = "Configuration error. Resolving ist not allowed";
-
- @Override
- public OutputURIResolver newInstance() {
- return this;
- }
-
- @Override
- public Result resolve(final String href, final String base) throws TransformerException {
- throw new IllegalStateException(MESSAGE);
- }
-
- @Override
- public void close(final Result result) throws TransformerException {
- throw new IllegalStateException(MESSAGE);
- }
-
- @Override
- public Reader resolve(final URI absoluteURI, final String encoding, final Configuration config) throws XPathException {
- throw new IllegalStateException(MESSAGE);
- }
-
- @Override
- public ResourceCollection findCollection(final XPathContext context, final String collectionURI) throws XPathException {
- throw new IllegalStateException(MESSAGE);
- }
- }
-
- /**
- * e.g. don't allow any scheme
- */
- private static final String EMPTY_SCHEME = "";
-
@Override
public SchemaFactory createSchemaFactory() {
+ forceOpenJdkXmlImplementation();
+ @SuppressWarnings("java:S2755") //
final SchemaFactory sf = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
disableExternalEntities(sf);
allowExternalSchema(sf, "file");
@@ -77,36 +45,13 @@ public class StrictRelativeResolvingStrategy extends BaseResolvingStrategy {
}
@Override
- protected Processor createProcessor() {
- final Processor processor = new Processor(false);
- // verhindere global im Prinzip alle resolving strategien
- final SecureUriResolver resolver = new SecureUriResolver();
- processor.getUnderlyingConfiguration().setCollectionFinder(resolver);
- processor.getUnderlyingConfiguration().setOutputURIResolver(resolver);
- processor.getUnderlyingConfiguration().setUnparsedTextURIResolver(resolver);
-
- // grundsätzlich Feature-konfiguration:
- processor.setConfigurationProperty(Feature.DTD_VALIDATION, false);
- processor.setConfigurationProperty(Feature.ENTITY_RESOLVER_CLASS, "");
- processor.setConfigurationProperty(Feature.XINCLUDE, false);
- processor.setConfigurationProperty(Feature.ALLOW_EXTERNAL_FUNCTIONS, false);
-
- // Konfiguration des zu verwendenden Parsers, wenn Saxon selbst einen erzeugen muss, bspw. beim XSL parsen
- processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(FEATURE_SECURE_PROCESSING), true);
- processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(DISSALLOW_DOCTYPE_DECL_FEATURE), true);
- processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(LOAD_EXTERNAL_DTD_FEATURE), false);
- processor.setConfigurationProperty(FeatureKeys.XML_PARSER_FEATURE + encode(XMLConstants.ACCESS_EXTERNAL_DTD), false);
- return processor;
- }
-
- @SneakyThrows
- private static String encode(final String input) {
- return URLEncoder.encode(input, StandardCharsets.UTF_8.name());
+ public URIResolver createResolver(final URI repositoryURI) {
+ return new RelativeUriResolver(repositoryURI);
}
@Override
- public URIResolver createResolver(final URI repositoryURI) {
- return new RelativeUriResolver(repositoryURI);
+ public UnparsedTextURIResolver createUnparsedTextURIResolver(final URI scenarioRepository) {
+ return new RelativeUriResolver(scenarioRepository);
}
@Override
diff --git a/src/main/java/de/kosit/validationtool/impl/xml/StringTrimAdapter.java b/src/main/java/de/kosit/validationtool/impl/xml/StringTrimAdapter.java
new file mode 100644
index 0000000..ca839dd
--- /dev/null
+++ b/src/main/java/de/kosit/validationtool/impl/xml/StringTrimAdapter.java
@@ -0,0 +1,39 @@
+/*
+ * Copyright 2017-2022 Koordinierungsstelle für IT-Standards (KoSIT)
+ *
+ * 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 de.kosit.validationtool.impl.xml;
+
+import jakarta.xml.bind.annotation.adapters.XmlAdapter;
+
+public class StringTrimAdapter extends XmlAdapter {
+
+ @Override
+ public String unmarshal(final String v) {
+ return trim(v);
+ }
+
+ @Override
+ public String marshal(final String v) {
+ return trim(v);
+ }
+
+ public static String trim(final String v) {
+ if (v == null) {
+ return null;
+ }
+ return v.trim();
+ }
+}
\ No newline at end of file
diff --git a/src/main/model/binding/global.xjb b/src/main/model/binding/global.xjb
index be1e39c..ae2d603 100644
--- a/src/main/model/binding/global.xjb
+++ b/src/main/model/binding/global.xjb
@@ -1,35 +1,36 @@
+ xmlns:xs="http://www.w3.org/2001/XMLSchema"
+ xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
+ xmlns:jaxb="https://jakarta.ee/xml/ns/jaxb"
+ xmlns:inheritance="urn:jaxb.jvnet.org:plugin:inheritance"
+ jaxb:extensionBindingPrefixes="inheritance"
+ version="3.0">
+
-
de.kosit.validationtool.impl.model.BaseXMLSyntaxError
+
+
-
+
de.kosit.validationtool.impl.model.BaseOutput
+
-
-
\ No newline at end of file
+
diff --git a/src/main/model/xsd/assertions.xsd b/src/main/model/xsd/assertions.xsd
index 4a5bdcc..9c9d91e 100644
--- a/src/main/model/xsd/assertions.xsd
+++ b/src/main/model/xsd/assertions.xsd
@@ -1,21 +1,18 @@
@@ -28,7 +25,7 @@
In diesem Dokument werden zum Test einer Prüftoolkonfiguration Zusicherungen zu einzelnen
Prüfberichten beschrieben. Ein
- solches Dokument kann der Kommandozeilenversion des Prüftools über --implemenation-assertions übergeben werden.
+ solches Dokument kann der Kommandozeilenversion des Prüftools über --check-assertions übergeben werden.
diff --git a/src/main/model/xsd/createReportInput.xsd b/src/main/model/xsd/createReportInput.xsd
index f0377f9..607dc2c 100644
--- a/src/main/model/xsd/createReportInput.xsd
+++ b/src/main/model/xsd/createReportInput.xsd
@@ -1,21 +1,18 @@
diff --git a/src/main/model/xsd/daemon.xsd b/src/main/model/xsd/daemon.xsd
index c5f9b8c..7a1a1e6 100644
--- a/src/main/model/xsd/daemon.xsd
+++ b/src/main/model/xsd/daemon.xsd
@@ -1,4 +1,20 @@
+
+
diff --git a/src/main/model/xsd/scenarios.xsd b/src/main/model/xsd/scenarios.xsd
index 2f41a1f..9521ceb 100644
--- a/src/main/model/xsd/scenarios.xsd
+++ b/src/main/model/xsd/scenarios.xsd
@@ -1,24 +1,4 @@
-
-
-
@@ -75,19 +55,29 @@
+
+
+
+
+
+
+
+ Optional: An XPATH expression to be applied to a generated validation report as defined in the createReport element
+
+
+
@@ -125,7 +115,7 @@
@@ -137,3 +127,18 @@
+
diff --git a/src/main/model/xsd/svrl-kosit.xsd b/src/main/model/xsd/svrl-kosit.xsd
index 2fd478a..615fa20 100644
--- a/src/main/model/xsd/svrl-kosit.xsd
+++ b/src/main/model/xsd/svrl-kosit.xsd
@@ -1,15 +1,23 @@
+
+
-
-
-
@@ -26,7 +34,7 @@
diff --git a/src/main/model/xsd/xml.xsd b/src/main/model/xsd/xml.xsd
index d3847fc..e54df14 100644
--- a/src/main/model/xsd/xml.xsd
+++ b/src/main/model/xsd/xml.xsd
@@ -1,4 +1,20 @@
+
+
";
-
-var requestOptions = {
- method: 'POST',
- headers: myHeaders,
- body: file,
- redirect: 'follow'
-};
-
-fetch("http://localhost:8080", requestOptions)
- .then(response => response.text())
- .then(result => console.log(result))
- .catch(error => console.log('error', error));
-```
\ No newline at end of file
diff --git a/src/main/resources/gui/docs/configurations.md b/src/main/resources/gui/docs/configurations.md
deleted file mode 100644
index 3e8678d..0000000
--- a/src/main/resources/gui/docs/configurations.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Configurations
-
-The validator needs a scenario configuration for working properly.
-
-Currently, there are two public third party validation configurations available.
-
-* Validation Configuration for [XRechnung](http://www.xoev.de/de/xrechnung):
- * Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xrechnung)
- * [Releases](https://github.com/itplr-kosit/validator-configuration-xrechnung/releases) can also be downloaded
-* Validation Configuration for [XGewerbeanzeige](https://xgewerbeanzeige.de/)
- * Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige)
- * [Releases](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige/releases) can also be downloaded
-
-For creating custom configurations see [configaration documentation](https://github.com/itplr-kosit/validator/blob/master/docs/configurations.md)
-for details
\ No newline at end of file
diff --git a/src/main/resources/gui/index.html b/src/main/resources/gui/index.html
deleted file mode 100644
index 1eb48c4..0000000
--- a/src/main/resources/gui/index.html
+++ /dev/null
@@ -1,65 +0,0 @@
-
-
-
-
- Validator
-
-
-
-
-
-
-
-
-
-Loading validator...
-
-
-
-
-
-
\ No newline at end of file
diff --git a/src/main/resources/gui/lib/License b/src/main/resources/gui/lib/License
deleted file mode 100644
index 4a5b531..0000000
--- a/src/main/resources/gui/lib/License
+++ /dev/null
@@ -1,23 +0,0 @@
-Sources in this diretory are based on https://github.com/docsifyjs/docsify/
-
-MIT License
-
-Copyright (c) 2016 - present cinwell.li
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
\ No newline at end of file
diff --git a/src/main/resources/gui/lib/docsify.min.js b/src/main/resources/gui/lib/docsify.min.js
deleted file mode 100644
index 79db41b..0000000
--- a/src/main/resources/gui/lib/docsify.min.js
+++ /dev/null
@@ -1 +0,0 @@
-!function(){function o(n){var r=Object.create(null);return function(e){var t=c(e)?e:JSON.stringify(e);return r[t]||(r[t]=n(e))}}var i=o(function(e){return e.replace(/([A-Z])/g,function(e){return"-"+e.toLowerCase()})}),l=Object.prototype.hasOwnProperty,d=Object.assign||function(e){for(var t=arguments,n=1;n=a.length)i(r);else if("function"==typeof e)if(2===e.length)e(r,function(e){r=e,s(t+1)});else{var n=e(r);r=void 0===n?r:n,s(t+1)}else s(t+1)};s(0)}var O=p.title;function P(){var e=m("section.cover");if(e){var t=e.getBoundingClientRect().height;window.pageYOffset>=t||e.classList.contains("hidden")?A(v,"add","sticky"):A(v,"remove","sticky")}}function z(e,t,r,n){var i=[];null!=(t=m(t))&&(i=y(t,"a"));var a,s=decodeURI(e.toURL(e.getCurrentPath()));return i.sort(function(e,t){return t.href.length-e.href.length}).forEach(function(e){var t=e.getAttribute("href"),n=r?e.parentNode:e;0!==s.indexOf(t)||a?A(n,"remove","active"):(a=e,A(n,"add","active"))}),n&&(p.title=a?a.title||a.innerText+" - "+O:O),a}var j=decodeURIComponent,N=encodeURIComponent;function M(e){var n={};return(e=e.trim().replace(/^(\?|#|&)/,""))&&e.split("&").forEach(function(e){var t=e.replace(/\+/g," ").split("=");n[t[0]]=t[1]&&j(t[1])}),n}function q(e,t){void 0===t&&(t=[]);var n=[];for(var r in e)-1this.end&&e>=this.next}[this.direction]}},{key:"_defaultEase",value:function(e,t,n,r){return(e/=r/2)<1?n/2*e*e+t:-n/2*(--e*(e-2)-1)+t}}]),X);function X(){var e=0o){t=t||u;break}t=u}if(t){var h=Q[re(decodeURIComponent(e),t.getAttribute("data-id"))];if(h&&h!==a&&(a&&a.classList.remove("active"),h.classList.add("active"),a=h,!J&&v.classList.contains("sticky"))){var p=n.clientHeight,d=a.offsetTop+a.clientHeight+40,g=d-0=i.scrollTop&&d<=i.scrollTop+p?i.scrollTop:g?0:d-p;n.scrollTop=f}}}}function re(e,t){return e+"?id="+t}function ie(e,t){if(t){var n=s().topMargin,r=b("#"+t);r&&function(e,t){void 0===t&&(t=0),K&&K.stop(),ee=!1,K=new V({start:window.pageYOffset,end:e.getBoundingClientRect().top+window.pageYOffset-t,duration:500}).on("tick",function(e){return window.scrollTo(0,e)}).on("done",function(){ee=!0,K=null}).begin()}(r,n);var i=Q[re(e,t)],a=b(m(".sidebar"),"li.active");a&&a.classList.remove("active"),i&&i.classList.add("active")}}var ae=p.scrollingElement||p.documentElement;function se(e,t){if(void 0===t&&(t=''),!e||!e.length)return"";var n="";return e.forEach(function(e){n+=''+e.title+" ",e.children&&(n+=se(e.children,t))}),t.replace("{inner}",n)}function oe(e,t){return''+t.slice(5).trim()+" "}function le(e,r){var i=[],a={};return e.forEach(function(e){var t=e.level||1,n=t-1;r?@[\]^`{|}~]/g;function he(e){return e.toLowerCase()}function pe(e){if("string"!=typeof e)return"";var t=e.trim().replace(/[A-Z]+/g,he).replace(/<[^>\d]+>/g,"").replace(ue,"").replace(/\s/g,"-").replace(/-+/g,"-").replace(/^(\d)/,"_$1"),n=ce[t];return n=l.call(ce,t)?n+1:0,(ce[t]=n)&&(t=t+"-"+n),t}function de(e,t){return' '}function ge(e){void 0===e&&(e="");var r={};return{str:e=e&&e.replace(/^'/,"").replace(/'$/,"").replace(/(?:^|\s):([\w-]+:?)=?([\w-]+)?/g,function(e,t,n){return-1===t.indexOf(":")?(r[t]=n&&n.replace(/"/g,"")||!0,""):e}).trim(),config:r}}pe.clear=function(){ce={}};var fe="undefined"!=typeof globalThis?globalThis:"undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof self?self:{};function me(e,t){return e(t={exports:{}},t.exports),t.exports}var ve,be=me(function(e){var c=function(c){var u=/\blang(?:uage)?-([\w-]+)\b/i,t=0,T={manual:c.Prism&&c.Prism.manual,disableWorkerMessageHandler:c.Prism&&c.Prism.disableWorkerMessageHandler,util:{encode:function(e){return e instanceof R?new R(e.type,T.util.encode(e.content),e.alias):Array.isArray(e)?e.map(T.util.encode):e.replace(/&/g,"&").replace(/e.length)return;if(!(y instanceof R)){if(d&&v!=t.length-1){if(u.lastIndex=b,!(A=u.exec(e)))break;for(var k=A.index+(p&&A[1]?A[1].length:0),w=A.index+A[0].length,x=v,_=b,S=t.length;x"+n.content+""},!c.document)return c.addEventListener&&(T.disableWorkerMessageHandler||c.addEventListener("message",function(e){var t=JSON.parse(e.data),n=t.language,r=t.code,i=t.immediateClose;c.postMessage(T.highlight(r,T.languages[n],n)),i&&c.close()},!1)),T;var e=T.util.currentScript();if(e&&(T.filename=e.src,e.hasAttribute("data-manual")&&(T.manual=!0)),!T.manual){function n(){T.manual||T.highlightAll()}var r=document.readyState;"loading"===r||"interactive"===r&&e&&e.defer?document.addEventListener("DOMContentLoaded",n):window.requestAnimationFrame?window.requestAnimationFrame(n):window.setTimeout(n,16)}return T}("undefined"!=typeof window?window:"undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?self:{});e.exports&&(e.exports=c),void 0!==fe&&(fe.Prism=c),c.languages.markup={comment://,prolog:/<\?[\s\S]+?\?>/,doctype:{pattern:/"'[\]]|"[^"]*"|'[^']*')+(?:\[(?:(?!)*\]\s*)?>/i,greedy:!0},cdata://i,tag:{pattern:/<\/?(?!\d)[^\s>\/=$<%]+(?:\s(?:\s*[^\s>\/=]+(?:\s*=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+(?=[\s>]))|(?=[\s/>])))+)?\s*\/?>/i,greedy:!0,inside:{tag:{pattern:/^<\/?[^\s>\/]+/i,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"attr-value":{pattern:/=\s*(?:"[^"]*"|'[^']*'|[^\s'">=]+)/i,inside:{punctuation:[/^=/,{pattern:/^(\s*)["']|["']$/,lookbehind:!0}]}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:/&#?[\da-z]{1,8};/i},c.languages.markup.tag.inside["attr-value"].inside.entity=c.languages.markup.entity,c.hooks.add("wrap",function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))}),Object.defineProperty(c.languages.markup.tag,"addInlined",{value:function(e,t){var n={};n["language-"+t]={pattern:/(^$)/i,lookbehind:!0,inside:c.languages[t]},n.cdata=/^$/i;var r={"included-cdata":{pattern://i,inside:n}};r["language-"+t]={pattern:/[\s\S]+/,inside:c.languages[t]};var i={};i[e]={pattern:RegExp(/(<__[\s\S]*?>)(?:\s*|[\s\S])*?(?=<\/__>)/.source.replace(/__/g,e),"i"),lookbehind:!0,greedy:!0,inside:r},c.languages.insertBefore("markup","cdata",i)}}),c.languages.xml=c.languages.extend("markup",{}),c.languages.html=c.languages.markup,c.languages.mathml=c.languages.markup,c.languages.svg=c.languages.markup,function(e){var t=/("|')(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/;e.languages.css={comment:/\/\*[\s\S]*?\*\//,atrule:{pattern:/@[\w-]+[\s\S]*?(?:;|(?=\s*\{))/,inside:{rule:/@[\w-]+/}},url:{pattern:RegExp("url\\((?:"+t.source+"|[^\n\r()]*)\\)","i"),inside:{function:/^url/i,punctuation:/^\(|\)$/}},selector:RegExp("[^{}\\s](?:[^{};\"']|"+t.source+")*?(?=\\s*\\{)"),string:{pattern:t,greedy:!0},property:/[-_a-z\xA0-\uFFFF][-\w\xA0-\uFFFF]*(?=\s*:)/i,important:/!important\b/i,function:/[-a-z0-9]+(?=\()/i,punctuation:/[(){};:,]/},e.languages.css.atrule.inside.rest=e.languages.css;var n=e.languages.markup;n&&(n.tag.addInlined("style","css"),e.languages.insertBefore("inside","attr-value",{"style-attr":{pattern:/\s*style=("|')(?:\\[\s\S]|(?!\1)[^\\])*\1/i,inside:{"attr-name":{pattern:/^\s*style/i,inside:n.tag.inside},punctuation:/^\s*=\s*['"]|['"]\s*$/,"attr-value":{pattern:/.+/i,inside:e.languages.css}},alias:"language-css"}},n.tag))}(c),c.languages.clike={comment:[{pattern:/(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,lookbehind:!0},{pattern:/(^|[^\\:])\/\/.*/,lookbehind:!0,greedy:!0}],string:{pattern:/(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,greedy:!0},"class-name":{pattern:/(\b(?:class|interface|extends|implements|trait|instanceof|new)\s+|\bcatch\s+\()[\w.\\]+/i,lookbehind:!0,inside:{punctuation:/[.\\]/}},keyword:/\b(?:if|else|while|do|for|return|in|instanceof|function|new|try|throw|catch|finally|null|break|continue)\b/,boolean:/\b(?:true|false)\b/,function:/\w+(?=\()/,number:/\b0x[\da-f]+\b|(?:\b\d+\.?\d*|\B\.\d+)(?:e[+-]?\d+)?/i,operator:/[<>]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]/,punctuation:/[{}[\];(),.:]/},c.languages.javascript=c.languages.extend("clike",{"class-name":[c.languages.clike["class-name"],{pattern:/(^|[^$\w\xA0-\uFFFF])[_$A-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\.(?:prototype|constructor))/,lookbehind:!0}],keyword:[{pattern:/((?:^|})\s*)(?:catch|finally)\b/,lookbehind:!0},{pattern:/(^|[^.]|\.\.\.\s*)\b(?:as|async(?=\s*(?:function\b|\(|[$\w\xA0-\uFFFF]|$))|await|break|case|class|const|continue|debugger|default|delete|do|else|enum|export|extends|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)\b/,lookbehind:!0}],number:/\b(?:(?:0[xX](?:[\dA-Fa-f](?:_[\dA-Fa-f])?)+|0[bB](?:[01](?:_[01])?)+|0[oO](?:[0-7](?:_[0-7])?)+)n?|(?:\d(?:_\d)?)+n|NaN|Infinity)\b|(?:\b(?:\d(?:_\d)?)+\.?(?:\d(?:_\d)?)*|\B\.(?:\d(?:_\d)?)+)(?:[Ee][+-]?(?:\d(?:_\d)?)+)?/,function:/#?[_$a-zA-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\s*(?:\.\s*(?:apply|bind|call)\s*)?\()/,operator:/--|\+\+|\*\*=?|=>|&&|\|\||[!=]==|<<=?|>>>?=?|[-+*/%&|^!=<>]=?|\.{3}|\?[.?]?|[~:]/}),c.languages.javascript["class-name"][0].pattern=/(\b(?:class|interface|extends|implements|instanceof|new)\s+)[\w.\\]+/,c.languages.insertBefore("javascript","keyword",{regex:{pattern:/((?:^|[^$\w\xA0-\uFFFF."'\])\s])\s*)\/(?:\[(?:[^\]\\\r\n]|\\.)*]|\\.|[^/\\\[\r\n])+\/[gimyus]{0,6}(?=(?:\s|\/\*[\s\S]*?\*\/)*(?:$|[\r\n,.;:})\]]|\/\/))/,lookbehind:!0,greedy:!0},"function-variable":{pattern:/#?[_$a-zA-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\s*[=:]\s*(?:async\s*)?(?:\bfunction\b|(?:\((?:[^()]|\([^()]*\))*\)|[_$a-zA-Z\xA0-\uFFFF][$\w\xA0-\uFFFF]*)\s*=>))/,alias:"function"},parameter:[{pattern:/(function(?:\s+[_$A-Za-z\xA0-\uFFFF][$\w\xA0-\uFFFF]*)?\s*\(\s*)(?!\s)(?:[^()]|\([^()]*\))+?(?=\s*\))/,lookbehind:!0,inside:c.languages.javascript},{pattern:/[_$a-z\xA0-\uFFFF][$\w\xA0-\uFFFF]*(?=\s*=>)/i,inside:c.languages.javascript},{pattern:/(\(\s*)(?!\s)(?:[^()]|\([^()]*\))+?(?=\s*\)\s*=>)/,lookbehind:!0,inside:c.languages.javascript},{pattern:/((?:\b|\s|^)(?!(?:as|async|await|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|export|extends|finally|for|from|function|get|if|implements|import|in|instanceof|interface|let|new|null|of|package|private|protected|public|return|set|static|super|switch|this|throw|try|typeof|undefined|var|void|while|with|yield)(?![$\w\xA0-\uFFFF]))(?:[_$A-Za-z\xA0-\uFFFF][$\w\xA0-\uFFFF]*\s*)\(\s*)(?!\s)(?:[^()]|\([^()]*\))+?(?=\s*\)\s*\{)/,lookbehind:!0,inside:c.languages.javascript}],constant:/\b[A-Z](?:[A-Z_]|\dx?)*\b/}),c.languages.insertBefore("javascript","string",{"template-string":{pattern:/`(?:\\[\s\S]|\${(?:[^{}]|{(?:[^{}]|{[^}]*})*})+}|(?!\${)[^\\`])*`/,greedy:!0,inside:{"template-punctuation":{pattern:/^`|`$/,alias:"string"},interpolation:{pattern:/((?:^|[^\\])(?:\\{2})*)\${(?:[^{}]|{(?:[^{}]|{[^}]*})*})+}/,lookbehind:!0,inside:{"interpolation-punctuation":{pattern:/^\${|}$/,alias:"punctuation"},rest:c.languages.javascript}},string:/[\s\S]+/}}}),c.languages.markup&&c.languages.markup.tag.addInlined("script","javascript"),c.languages.js=c.languages.javascript,"undefined"!=typeof self&&self.Prism&&self.document&&document.querySelector&&(self.Prism.fileHighlight=function(e){e=e||document;var l={js:"javascript",py:"python",rb:"ruby",ps1:"powershell",psm1:"powershell",sh:"bash",bat:"batch",h:"c",tex:"latex"};Array.prototype.slice.call(e.querySelectorAll("pre[data-src]")).forEach(function(e){if(!e.hasAttribute("data-src-loaded")){for(var t,n=e.getAttribute("data-src"),r=e,i=/\blang(?:uage)?-([\w-]+)\b/i;r&&!i.test(r.className);)r=r.parentNode;if(r&&(t=(e.className.match(i)||[,""])[1]),!t){var a=(n.match(/\.(\w+)$/)||[,""])[1];t=l[a]||a}var s=document.createElement("code");s.className="language-"+t,e.textContent="",s.textContent="Loading…",e.appendChild(s);var o=new XMLHttpRequest;o.open("GET",n,!0),o.onreadystatechange=function(){4==o.readyState&&(o.status<400&&o.responseText?(s.textContent=o.responseText,c.highlightElement(s),e.setAttribute("data-src-loaded","")):400<=o.status?s.textContent="✖ Error "+o.status+" while fetching file: "+o.statusText:s.textContent="✖ Error: File does not exist or is empty")},o.send(null)}})},document.addEventListener("DOMContentLoaded",function(){self.Prism.fileHighlight()}))});function ye(e,t){return"___"+e.toUpperCase()+t+"___"}ve=Prism,Object.defineProperties(ve.languages["markup-templating"]={},{buildPlaceholders:{value:function(r,i,e,a){if(r.language===i){var s=r.tokenStack=[];r.code=r.code.replace(e,function(e){if("function"==typeof a&&!a(e))return e;for(var t,n=s.length;-1!==r.code.indexOf(t=ye(i,n));)++n;return s[n]=e,t}),r.grammar=ve.languages.markup}}},tokenizePlaceholders:{value:function(d,g){if(d.language===g&&d.tokenStack){d.grammar=ve.languages[g];var f=0,m=Object.keys(d.tokenStack);!function e(t){for(var n=0;n=m.length);n++){var r=t[n];if("string"==typeof r||r.content&&"string"==typeof r.content){var i=m[f],a=d.tokenStack[i],s="string"==typeof r?r:r.content,o=ye(g,i),l=s.indexOf(o);if(-1 ?(paragraph|[^\n]*)(?:\n|$))+/,list:/^( {0,3})(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/,html:"^ {0,3}(?:<(script|pre|style)[\\s>][\\s\\S]*?(?:[^\\n]*\\n+|$)|comment[^\\n]*(\\n+|$)|<\\?[\\s\\S]*?\\?>\\n*|\\n*|\\n*|)[\\s\\S]*?(?:\\n{2,}|$)|<(?!script|pre|style)([a-z][\\w-]*)(?:attribute)*? */?>(?=[ \\t]*(?:\\n|$))[\\s\\S]*?(?:\\n{2,}|$)|(?=[ \\t]*(?:\\n|$))[\\s\\S]*?(?:\\n{2,}|$))",def:/^ {0,3}\[(label)\]: *\n? *]+)>?(?:(?: +\n? *| *\n *)(title))? *(?:\n+|$)/,nptable:h,table:h,lheading:/^([^\n]+)\n {0,3}(=+|-+) *(?:\n+|$)/,_paragraph:/^([^\n]+(?:\n(?!hr|heading|lheading|blockquote|fences|list|html)[^\n]+)*)/,text:/^[^\n]+/};function l(e){this.tokens=[],this.tokens.links=Object.create(null),this.options=e||m.defaults,this.rules=y.normal,this.options.pedantic?this.rules=y.pedantic:this.options.gfm&&(this.rules=y.gfm)}y._label=/(?!\s*\])(?:\\[\[\]]|[^\[\]])+/,y._title=/(?:"(?:\\"?|[^"\\])*"|'[^'\n]*(?:\n[^'\n]+)*\n?'|\([^()]*\))/,y.def=e(y.def).replace("label",y._label).replace("title",y._title).getRegex(),y.bullet=/(?:[*+-]|\d{1,9}\.)/,y.item=/^( *)(bull) ?[^\n]*(?:\n(?!\1bull ?)[^\n]*)*/,y.item=e(y.item,"gm").replace(/bull/g,y.bullet).getRegex(),y.list=e(y.list).replace(/bull/g,y.bullet).replace("hr","\\n+(?=\\1?(?:(?:- *){3,}|(?:_ *){3,}|(?:\\* *){3,})(?:\\n+|$))").replace("def","\\n+(?="+y.def.source+")").getRegex(),y._tag="address|article|aside|base|basefont|blockquote|body|caption|center|col|colgroup|dd|details|dialog|dir|div|dl|dt|fieldset|figcaption|figure|footer|form|frame|frameset|h[1-6]|head|header|hr|html|iframe|legend|li|link|main|menu|menuitem|meta|nav|noframes|ol|optgroup|option|p|param|section|source|summary|table|tbody|td|tfoot|th|thead|title|tr|track|ul",y._comment=//,y.html=e(y.html,"i").replace("comment",y._comment).replace("tag",y._tag).replace("attribute",/ +[a-zA-Z:_][\w.:-]*(?: *= *"[^"\n]*"| *= *'[^'\n]*'| *= *[^\s"'=<>`]+)?/).getRegex(),y.paragraph=e(y._paragraph).replace("hr",y.hr).replace("heading"," {0,3}#{1,6} +").replace("|lheading","").replace("blockquote"," {0,3}>").replace("fences"," {0,3}(?:`{3,}|~{3,})[^`\\n]*\\n").replace("list"," {0,3}(?:[*+-]|1[.)]) ").replace("html",")|<(?:script|pre|style|!--)").replace("tag",y._tag).getRegex(),y.blockquote=e(y.blockquote).replace("paragraph",y.paragraph).getRegex(),y.normal=d({},y),y.gfm=d({},y.normal,{nptable:/^ *([^|\n ].*\|.*)\n *([-:]+ *\|[-| :]*)(?:\n((?:.*[^>\n ].*(?:\n|$))*)\n*|$)/,table:/^ *\|(.+)\n *\|?( *[-:]+[-| :]*)(?:\n((?: *[^>\n ].*(?:\n|$))*)\n*|$)/}),y.pedantic=d({},y.normal,{html:e("^ *(?:comment *(?:\\n|\\s*$)|<(tag)[\\s\\S]+? *(?:\\n{2,}|\\s*$)| ?/gm,""),this.token(i,t),this.tokens.push({type:"blockquote_end"});else if(i=this.rules.list.exec(e)){for(e=e.substring(i[0].length),l={type:"list_start",ordered:f=1<(a=i[2]).length,start:f?+a:"",loose:!1},this.tokens.push(l),n=!(c=[]),g=(i=i[0].match(this.rules.item)).length,p=0;p?@\[\]\\^_`{|}~])/,autolink:/^<(scheme:[^\s\x00-\x1f<>]*|email)>/,url:h,tag:"^comment|^|^<[a-zA-Z][\\w-]*(?:attribute)*?\\s*/?>|^<\\?[\\s\\S]*?\\?>|^|^",link:/^!?\[(label)\]\(\s*(href)(?:\s+(title))?\s*\)/,reflink:/^!?\[(label)\]\[(?!\s*\])((?:\\[\[\]]?|[^\[\]\\])+)\]/,nolink:/^!?\[(?!\s*\])((?:\[[^\[\]]*\]|\\[\[\]]|[^\[\]])*)\](?:\[\])?/,strong:/^__([^\s_])__(?!_)|^\*\*([^\s*])\*\*(?!\*)|^__([^\s][\s\S]*?[^\s])__(?!_)|^\*\*([^\s][\s\S]*?[^\s])\*\*(?!\*)/,em:/^_([^\s_])_(?!_)|^\*([^\s*<\[])\*(?!\*)|^_([^\s<][\s\S]*?[^\s_])_(?!_|[^\spunctuation])|^_([^\s_<][\s\S]*?[^\s])_(?!_|[^\spunctuation])|^\*([^\s<"][\s\S]*?[^\s\*])\*(?!\*|[^\spunctuation])|^\*([^\s*"<\[][\s\S]*?[^\s])\*(?!\*)/,code:/^(`+)([^`]|[^`][\s\S]*?[^`])\1(?!`)/,br:/^( {2,}|\\)\n(?!\s*$)/,del:h,text:/^(`+|[^`])(?:[\s\S]*?(?:(?=[\\?@\\[^_{|}~",n.em=e(n.em).replace(/punctuation/g,n._punctuation).getRegex(),n._escapes=/\\([!"#$%&'()*+,\-./:;<=>?@\[\]\\^_`{|}~])/g,n._scheme=/[a-zA-Z][a-zA-Z0-9+.-]{1,31}/,n._email=/[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+(@)[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+(?![-_])/,n.autolink=e(n.autolink).replace("scheme",n._scheme).replace("email",n._email).getRegex(),n._attribute=/\s+[a-zA-Z:_][\w.:-]*(?:\s*=\s*"[^"]*"|\s*=\s*'[^']*'|\s*=\s*[^\s"'=<>`]+)?/,n.tag=e(n.tag).replace("comment",y._comment).replace("attribute",n._attribute).getRegex(),n._label=/(?:\[[^\[\]]*\]|\\.|`[^`]*`|[^\[\]\\`])*?/,n._href=/<(?:\\[<>]?|[^\s<>\\])*>|[^\s\x00-\x1f]*/,n._title=/"(?:\\"?|[^"\\])*"|'(?:\\'?|[^'\\])*'|\((?:\\\)?|[^)\\])*\)/,n.link=e(n.link).replace("label",n._label).replace("href",n._href).replace("title",n._title).getRegex(),n.reflink=e(n.reflink).replace("label",n._label).getRegex(),n.normal=d({},n),n.pedantic=d({},n.normal,{strong:/^__(?=\S)([\s\S]*?\S)__(?!_)|^\*\*(?=\S)([\s\S]*?\S)\*\*(?!\*)/,em:/^_(?=\S)([\s\S]*?\S)_(?!_)|^\*(?=\S)([\s\S]*?\S)\*(?!\*)/,link:e(/^!?\[(label)\]\((.*?)\)/).replace("label",n._label).getRegex(),reflink:e(/^!?\[(label)\]\s*\[([^\]]*)\]/).replace("label",n._label).getRegex()}),n.gfm=d({},n.normal,{escape:e(n.escape).replace("])","~|])").getRegex(),_extended_email:/[A-Za-z0-9._+-]+(@)[a-zA-Z0-9-_]+(?:\.[a-zA-Z0-9-_]*[a-zA-Z0-9])+(?![-_])/,url:/^((?:ftp|https?):\/\/|www\.)(?:[a-zA-Z0-9\-]+\.?)+[^\s<]*|^email/,_backpedal:/(?:[^?!.,:;*_~()&]+|\([^)]*\)|&(?![a-zA-Z0-9]+;$)|[?!.,:;*_~)]+(?!$))+/,del:/^~+(?=\S)([\s\S]*?\S)~+/,text:/^(`+|[^`])(?:[\s\S]*?(?:(?=[\\/i.test(a[0])&&(this.inLink=!1),!this.inRawBlock&&/^<(pre|code|kbd|script)(\s|>)/i.test(a[0])?this.inRawBlock=!0:this.inRawBlock&&/^<\/(pre|code|kbd|script)(\s|>)/i.test(a[0])&&(this.inRawBlock=!1),e=e.substring(a[0].length),o+=this.options.sanitize?this.options.sanitizer?this.options.sanitizer(a[0]):k(a[0]):a[0];else if(a=this.rules.link.exec(e)){var l=g(a[2],"()");if(-1$/,"$1"),o+=this.outputLink(a,{href:u.escapes(r),title:u.escapes(i)}),this.inLink=!1}else if((a=this.rules.reflink.exec(e))||(a=this.rules.nolink.exec(e))){if(e=e.substring(a[0].length),t=(a[2]||a[1]).replace(/\s+/g," "),!(t=this.links[t.toLowerCase()])||!t.href){o+=a[0].charAt(0),e=a[0].substring(1)+e;continue}this.inLink=!0,o+=this.outputLink(a,t),this.inLink=!1}else if(a=this.rules.strong.exec(e))e=e.substring(a[0].length),o+=this.renderer.strong(this.output(a[4]||a[3]||a[2]||a[1]));else if(a=this.rules.em.exec(e))e=e.substring(a[0].length),o+=this.renderer.em(this.output(a[6]||a[5]||a[4]||a[3]||a[2]||a[1]));else if(a=this.rules.code.exec(e))e=e.substring(a[0].length),o+=this.renderer.codespan(k(a[2].trim(),!0));else if(a=this.rules.br.exec(e))e=e.substring(a[0].length),o+=this.renderer.br();else if(a=this.rules.del.exec(e))e=e.substring(a[0].length),o+=this.renderer.del(this.output(a[1]));else if(a=this.rules.autolink.exec(e))e=e.substring(a[0].length),r="@"===a[2]?"mailto:"+(n=k(this.mangle(a[1]))):n=k(a[1]),o+=this.renderer.link(r,null,n);else if(this.inLink||!(a=this.rules.url.exec(e))){if(a=this.rules.text.exec(e))e=e.substring(a[0].length),this.inRawBlock?o+=this.renderer.text(this.options.sanitize?this.options.sanitizer?this.options.sanitizer(a[0]):k(a[0]):a[0]):o+=this.renderer.text(k(this.smartypants(a[0])));else if(e)throw new Error("Infinite loop on byte: "+e.charCodeAt(0))}else{if("@"===a[2])r="mailto:"+(n=k(a[0]));else{for(;s=a[0],a[0]=this.rules._backpedal.exec(a[0])[0],s!==a[0];);n=k(a[0]),r="www."===a[1]?"http://"+n:n}e=e.substring(a[0].length),o+=this.renderer.link(r,null,n)}return o},u.escapes=function(e){return e?e.replace(u.rules._escapes,"$1"):e},u.prototype.outputLink=function(e,t){var n=t.href,r=t.title?k(t.title):null;return"!"!==e[0].charAt(0)?this.renderer.link(n,r,this.output(e[1])):this.renderer.image(n,r,k(e[1]))},u.prototype.smartypants=function(e){return this.options.smartypants?e.replace(/---/g,"—").replace(/--/g,"–").replace(/(^|[-\u2014/(\[{"\s])'/g,"$1‘").replace(/'/g,"’").replace(/(^|[-\u2014/(\[{\u2018\s])"/g,"$1“").replace(/"/g,"”").replace(/\.{3}/g,"…"):e},u.prototype.mangle=function(e){if(!this.options.mangle)return e;for(var t,n="",r=e.length,i=0;i'+(n?e:k(e,!0))+"\n":""+(n?e:k(e,!0))+"
"},r.prototype.blockquote=function(e){return"\n"+e+" \n"},r.prototype.html=function(e){return e},r.prototype.heading=function(e,t,n,r){return this.options.headerIds?"'+e+"\n":""+e+" \n"},r.prototype.hr=function(){return this.options.xhtml?"
\n":"
\n"},r.prototype.list=function(e,t,n){var r=t?"ol":"ul";return"<"+r+(t&&1!==n?' start="'+n+'"':"")+">\n"+e+"\n"},r.prototype.listitem=function(e){return""+e+" \n"},r.prototype.checkbox=function(e){return" "},r.prototype.paragraph=function(e){return""+e+" \n"},r.prototype.table=function(e,t){return"\n\n"+e+"\n"+(t=t&&""+t+"")+" \n"},r.prototype.tablerow=function(e){return"\n"+e+" \n"},r.prototype.tablecell=function(e,t){var n=t.header?"th":"td";return(t.align?"<"+n+' align="'+t.align+'">':"<"+n+">")+e+"\n"},r.prototype.strong=function(e){return""+e+""},r.prototype.em=function(e){return""+e+""},r.prototype.codespan=function(e){return""+e+""},r.prototype.br=function(){return this.options.xhtml?"
":"
"},r.prototype.del=function(e){return""+e+""},r.prototype.link=function(e,t,n){if(null===(e=a(this.options.sanitize,this.options.baseUrl,e)))return n;var r='"},r.prototype.image=function(e,t,n){if(null===(e=a(this.options.sanitize,this.options.baseUrl,e)))return n;var r=' ":">"},r.prototype.text=function(e){return e},i.prototype.strong=i.prototype.em=i.prototype.codespan=i.prototype.del=i.prototype.text=function(e){return e},i.prototype.link=i.prototype.image=function(e,t,n){return""+n},i.prototype.br=function(){return""},c.parse=function(e,t){return new c(t).parse(e)},c.prototype.parse=function(e){this.inline=new u(e.links,this.options),this.inlineText=new u(e.links,d({},this.options,{renderer:new i})),this.tokens=e.reverse();for(var t="";this.next();)t+=this.tok();return t},c.prototype.next=function(){return this.token=this.tokens.pop(),this.token},c.prototype.peek=function(){return this.tokens[this.tokens.length-1]||0},c.prototype.parseText=function(){for(var e=this.token.text;"text"===this.peek().type;)e+="\n"+this.next().text;return this.inline.output(e)},c.prototype.tok=function(){switch(this.token.type){case"space":return"";case"hr":return this.renderer.hr();case"heading":return this.renderer.heading(this.inline.output(this.token.text),this.token.depth,p(this.inlineText.output(this.token.text)),this.slugger);case"code":return this.renderer.code(this.token.text,this.token.lang,this.token.escaped);case"table":var e,t,n,r,i="",a="";for(n="",e=0;e?@[\]^`{|}~]/g,"").replace(/\s/g,"-");if(this.seen.hasOwnProperty(t))for(var n=t;this.seen[n]++,t=n+"-"+this.seen[n],this.seen.hasOwnProperty(t););return this.seen[t]=0,t},k.escapeTest=/[&<>"']/,k.escapeReplace=/[&<>"']/g,k.replacements={"&":"&","<":"<",">":">",'"':""","'":"'"},k.escapeTestNoEncode=/[<>"']|&(?!#?\w+;)/,k.escapeReplaceNoEncode=/[<>"']|&(?!#?\w+;)/g;var s={},o=/^$|^[a-z][a-z0-9+.-]*:|^[?#]/i;function h(){}function d(e){for(var t,n,r=arguments,i=1;it)n.splice(t);else for(;n.lengthAn error occurred:"+k(e.message+"",!0)+" ";throw e}}h.exec=h,m.options=m.setOptions=function(e){return d(m.defaults,e),m},m.getDefaults=function(){return{baseUrl:null,breaks:!1,gfm:!0,headerIds:!0,headerPrefix:"",highlight:null,langPrefix:"language-",mangle:!0,pedantic:!1,renderer:new r,sanitize:!1,sanitizer:null,silent:!1,smartLists:!1,smartypants:!1,xhtml:!1}},m.defaults=m.getDefaults(),m.Parser=c,m.parser=c.parse,m.Renderer=r,m.TextRenderer=i,m.Lexer=l,m.lexer=l.lex,m.InlineLexer=u,m.inlineLexer=u.output,m.Slugger=t,m.parse=m,v.exports=m}()}),we={},xe={markdown:function(e){return{url:e}},mermaid:function(e){return{url:e}},iframe:function(e,t){return{html:'"}},video:function(e,t){return{html:'"}},audio:function(e,t){return{html:'"}},code:function(e,t){var n=e.match(/\.(\w+)$/);return"md"===(n=t||n&&n[1])&&(n="markdown"),{url:e,lang:n}}},_e=function(i,e){var a=this;this.config=i,this.router=e,this.cacheTree={},this.toc=[],this.cacheTOC={},this.linkTarget=i.externalLinkTarget||"_blank",this.linkRel="_blank"===this.linkTarget?i.externalLinkRel||"noopener":"",this.contentBase=e.getBasePath();var s,t=this._initRenderer();this.heading=t.heading;var n=i.markdown||{};s=r(n)?n(ke,t):(ke.setOptions(d(n,{renderer:d(t,n.renderer)})),ke),this._marked=s,this.compile=function(n){var r=!0,e=o(function(e){r=!1;var t="";return n?(t=c(n)?s(n):s.parser(n),t=i.noEmoji?t:function(e){return e.replace(/<(pre|template|code)[^>]*?>[\s\S]+?<\/(pre|template|code)>/g,function(e){return e.replace(/:/g,"__colon__")}).replace(/:(\w+?):/gi,window.emojify||de).replace(/__colon__/g,":")}(t),pe.clear(),t):n})(n),t=a.router.parse().file;return r?a.toc=a.cacheTOC[t]:a.cacheTOC[t]=[].concat(a.toc),e}};_e.prototype.compileEmbed=function(e,t){var n,r=ge(t),i=r.str,a=r.config;if(t=i,a.include){var s;if(H(e)||(e=D(this.contentBase,I(this.router.getCurrentPath()),e)),a.type&&(s=xe[a.type]))(n=s.call(this,e,t)).type=a.type;else{var o="code";/\.(md|markdown)/.test(e)?o="markdown":/\.mmd/.test(e)?o="mermaid":/\.html?/.test(e)?o="iframe":/\.(mp4|ogg)/.test(e)?o="video":/\.mp3/.test(e)&&(o="audio"),(n=xe[o].call(this,e,t)).type=o}return n.fragment=a.fragment,n}},_e.prototype._matchNotCompileLink=function(e){for(var t=this.config.noCompileLinks||[],n=0;n'+r+""},r.code=function(e){return e.renderer.code=function(e,t){void 0===t&&(t="");var n=be.languages[t]||be.languages.markup;return''+be.highlight(e.replace(/@DOCSIFY_QM@/g,"`"),n)+"
"}}({renderer:e}),r.link=function(e){var t=e.renderer,o=e.router,l=e.linkTarget,c=e.compilerClass;return t.link=function(e,t,n){void 0===t&&(t="");var r=[],i=ge(t),a=i.str,s=i.config;return t=a,H(e)||c._matchNotCompileLink(e)||s.ignore?(!H(e)&&e.startsWith("./")&&(e=document.URL.replace(/\/(?!.*\/).*/,"/").replace("#/./","")+e),r.push(0===e.indexOf("mailto:")?"":'target="'+l+'"')):(e===c.config.homepage&&(e="README"),e=o.toURL(e,null,o.getCurrentPath())),s.target&&r.push('target="'+s.target+'"'),s.disabled&&(r.push("disabled"),e="javascript:void(0)"),s.class&&r.push('class="'+s.class+'"'),s.id&&r.push('id="'+s.id+'"'),t&&r.push('title="'+t+'"'),'"+n+""}}({renderer:e,router:l,linkTarget:t,compilerClass:c}),r.paragraph=function(e){return e.renderer.paragraph=function(e){return/^!>/.test(e)?oe("tip",e):/^\?>/.test(e)?oe("warn",e):""+e+" "}}({renderer:e}),r.image=function(e){var t=e.renderer,h=e.contentBase,p=e.router;return t.image=function(e,t,n){var r=e,i=[],a=ge(t),s=a.str,o=a.config;if(t=s,o["no-zoom"]&&i.push("data-no-zoom"),t&&i.push('title="'+t+'"'),o.size){var l=o.size.split("x"),c=l[0],u=l[1];u?i.push('width="'+c+'" height="'+u+'"'):i.push('width="'+c+'" height="'+c+'"')}return o.class&&i.push('class="'+o.class+'"'),o.id&&i.push('id="'+o.id+'"'),H(e)||(r=D(h,I(p.getCurrentPath()),e)),0 "}}({renderer:e,contentBase:n,router:l}),r.list=function(e){return e.renderer.list=function(e,t,n){var r=t?"ol":"ul";return"<"+r+" "+[//.test(e.split('class="task-list"')[0])?'class="task-list"':"",n&&1"+e+""}}({renderer:e}),r.listitem=function(e){return e.renderer.listitem=function(e){return/^(]*>)/.test(e)?'":""+e+" "}}({renderer:e}),e.origin=r,e},_e.prototype.sidebar=function(e,t){var n=this.toc,r=this.router.getCurrentPath(),i="";if(e)i=this.compile(e);else{for(var a=0;a{inner}"),this.cacheTree[r]=l}return i},_e.prototype.subSidebar=function(e){if(e){var t=this.router.getCurrentPath(),n=this.cacheTree,r=this.toc;r[0]&&r[0].ignoreAllSubs&&r.splice(0),r[0]&&1===r[0].level&&r.shift();for(var i=0;i\n'+e+"\n"}]).links={}:(t=[{type:"html",text:e}]).links={};s({token:a,embedToken:t}),++c>=l&&s({})}}(t);t.embed.url?L(t.embed.url).then(r):r(t.embed.html)}}({compile:o,embedTokens:c,fetch:t},function(e){var t=e.embedToken,n=e.token;if(n){var r=n.index+p;d(h,t.links),l=l.slice(0,r).concat(t,l.slice(r+1)),p+=t.length-1}else Ae[a]=l.concat(),l.links=Ae[a].links=h,i(l)})}var Ee=/([^{]*?)\w(?=\})/g,Ce={YYYY:"getFullYear",YY:"getYear",MM:function(e){return e.getMonth()+1},DD:"getDate",HH:"getHours",mm:"getMinutes",ss:"getSeconds",fff:"getMilliseconds"};function Fe(){var e=y(".markdown-section>script").filter(function(e){return!/template/.test(e.type)})[0];if(!e)return!1;var t=e.innerText.trim();if(!t)return!1;setTimeout(function(e){window.__EXECUTE_RESULT__=new Function(t)()},0)}function Le(e,t,n){return t="function"==typeof n?n(t):"string"==typeof n?function(r,i){var a=[],s=0;return r.replace(Ee,function(t,e,n){a.push(r.substring(s,n-1)),s=n+=t.length+1,a.push(i&&i[t]||function(e){return("00"+("string"==typeof Ce[t]?e[Ce[t]]():Ce[t](e))).slice(-t.length)})}),s!==r.length&&a.push(r.substring(s)),function(e){for(var t="",n=0,r=e||new Date;n404 - Not found",this._renderTo(".markdown-section",e),this.config.loadSidebar||this._renderSidebar(),!1===this.config.executeScript||void 0===window.Vue||Fe()?this.config.executeScript&&Fe():setTimeout(function(e){var t=window.__EXECUTE_RESULT__;t&&t.$destroy&&t.$destroy(),window.__EXECUTE_RESULT__=(new window.Vue).$mount("#main")},0)}function Re(e){var t=e.config;e.compiler=new _e(t,e.router),window.__current_docsify_compiler__=e.compiler;var n=t.el||"#app",r=b("nav")||k("nav"),i=b(n),a="",s=v;if(i){if(t.repo&&(a+=function(e,t){return e?(/\/\//.test(e)||(e="https://github.com/"+e),''):""}(t.repo,t.cornerExternalLinkTarge)),t.coverpage&&(a+=function(){var e=", 100%, 85%";return'\x3c!--cover--\x3e '}()),t.logo){var o=/^data:image/.test(t.logo),l=/(?:http[s]?:)?\/\//.test(t.logo),c=/^\./.test(t.logo);o||l||c||(t.logo=D(e.router.getBasePath(),t.logo))}a+=function(e){var t=e.name?e.name:"",n='';return(g?n+"":""+n)+'\x3c!--main--\x3e '}(t),e._renderTo(i,a,!0)}else e.rendered=!0;t.mergeNavbar&&g?s=b(".sidebar"):(r.classList.add("app-nav"),t.repo||r.classList.add("no-badge")),t.loadNavbar&&x(s,r),t.themeColor&&(p.head.appendChild(k("div",function(e){return""}(t.themeColor)).firstElementChild),function(n){if(!(window.CSS&&window.CSS.supports&&window.CSS.supports("(--v:red)"))){var e=y("style:not(.inserted),link");[].forEach.call(e,function(e){if("STYLE"===e.nodeName)T(e,n);else if("LINK"===e.nodeName){var t=e.getAttribute("href");if(!/\.css$/.test(t))return;L(t).then(function(e){var t=k("style",e);f.appendChild(t),T(t,n)})}})}}(t.themeColor)),e._updateRender(),A(v,"ready")}var Oe={};function Pe(e){this.config=e}function ze(e){var t=location.href.indexOf("#");location.replace(location.href.slice(0,0<=t?t:0)+"#"+e)}Pe.prototype.getBasePath=function(){return this.config.basePath},Pe.prototype.getFile=function(e,t){void 0===e&&(e=this.getCurrentPath());var n=this.config,r=this.getBasePath(),i="string"==typeof n.ext?n.ext:".md";return e=(e=function(e,t){return new RegExp("\\.("+t.replace(/^\./,"")+"|html)$","g").test(e)?e:/\/$/g.test(e)?e+"README"+t:""+e+t}(e=n.alias?function e(t,n,r){var i=Object.keys(n).filter(function(e){return(Oe[e]||(Oe[e]=new RegExp("^"+e+"$"))).test(t)&&t!==r})[0];return i?e(t.replace(Oe[i],n[i]),n,t):t}(e,n.alias):e,i))==="/README"+i&&n.homepage||e,e=H(e)?e:D(r,e),t&&(e=e.replace(new RegExp("^"+r),"")),e},Pe.prototype.onchange=function(e){void 0===e&&(e=h),e()},Pe.prototype.getCurrentPath=function(){},Pe.prototype.normalize=function(){},Pe.prototype.parse=function(){},Pe.prototype.toURL=function(e,t,n){var r=n&&"#"===e[0],i=this.parse(U(e));if(i.query=d({},i.query,t),e=(e=i.path+q(i.query)).replace(/\.md(\?)|\.md$/,"$1"),r){var a=n.indexOf("?");e=(0([^<]*?)$');if(i){if("color"===i[2])n.style.background=i[1]+(i[3]||"");else{var a=i[1];A(n,"add","has-mask"),H(i[1])||(a=D(this.router.getBasePath(),i[1])),n.style.backgroundImage="url("+a+")",n.style.backgroundSize="cover",n.style.backgroundPosition="center center"}r=r.replace(i[0],"")}this._renderTo(".cover-main",r),P()}else A(n,"remove","show")},De._updateRender=function(){!function(e){var t=m(".app-name-link"),n=e.config.nameLink,r=e.route.path;if(t)if(c(e.config.nameLink))t.setAttribute("href",n);else if("object"==typeof n){var i=Object.keys(n).filter(function(e){return-1 nav {
- display: none;
-}
-div#app {
- font-size: 30px;
- font-weight: lighter;
- margin: 40vh auto;
- text-align: center;
-}
-div#app:empty::before {
- content: 'Loading...';
-}
-.emoji {
- height: 1.2rem;
- vertical-align: middle;
-}
-.progress {
- background-color: var(--theme-color, #42b983);
- height: 2px;
- left: 0px;
- position: fixed;
- right: 0px;
- top: 0px;
- transition: width 0.2s, opacity 0.4s;
- width: 0%;
- z-index: 999999;
-}
-.search a:hover {
- color: var(--theme-color, #42b983);
-}
-.search .search-keyword {
- color: var(--theme-color, #42b983);
- font-style: normal;
- font-weight: bold;
-}
-html,
-body {
- height: 100%;
-}
-body {
- -moz-osx-font-smoothing: grayscale;
- -webkit-font-smoothing: antialiased;
- color: #34495e;
- font-family: 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
- font-size: 15px;
- letter-spacing: 0;
- margin: 0;
- overflow-x: hidden;
-}
-img {
- max-width: 100%;
-}
-a[disabled] {
- cursor: not-allowed;
- opacity: 0.6;
-}
-kbd {
- border: solid 1px #ccc;
- border-radius: 3px;
- display: inline-block;
- font-size: 12px !important;
- line-height: 12px;
- margin-bottom: 3px;
- padding: 3px 5px;
- vertical-align: middle;
-}
-li input[type='checkbox'] {
- margin: 0 0.2em 0.25em 0;
- vertical-align: middle;
-}
-.app-nav {
- margin: 25px 60px 0 0;
- position: absolute;
- right: 0;
- text-align: right;
- z-index: 10;
-/* navbar dropdown */
-}
-.app-nav.no-badge {
- margin-right: 25px;
-}
-.app-nav p {
- margin: 0;
-}
-.app-nav > a {
- margin: 0 1rem;
- padding: 5px 0;
-}
-.app-nav ul,
-.app-nav li {
- display: inline-block;
- list-style: none;
- margin: 0;
-}
-.app-nav a {
- color: inherit;
- font-size: 16px;
- text-decoration: none;
- transition: color 0.3s;
-}
-.app-nav a:hover {
- color: var(--theme-color, #42b983);
-}
-.app-nav a.active {
- border-bottom: 2px solid var(--theme-color, #42b983);
- color: var(--theme-color, #42b983);
-}
-.app-nav li {
- display: inline-block;
- margin: 0 1rem;
- padding: 5px 0;
- position: relative;
- cursor: pointer;
-}
-.app-nav li ul {
- background-color: #fff;
- border: 1px solid #ddd;
- border-bottom-color: #ccc;
- border-radius: 4px;
- box-sizing: border-box;
- display: none;
- max-height: calc(100vh - 61px);
- overflow-y: auto;
- padding: 10px 0;
- position: absolute;
- right: -15px;
- text-align: left;
- top: 100%;
- white-space: nowrap;
-}
-.app-nav li ul li {
- display: block;
- font-size: 14px;
- line-height: 1rem;
- margin: 0;
- margin: 8px 14px;
- white-space: nowrap;
-}
-.app-nav li ul a {
- display: block;
- font-size: inherit;
- margin: 0;
- padding: 0;
-}
-.app-nav li ul a.active {
- border-bottom: 0;
-}
-.app-nav li:hover ul {
- display: block;
-}
-.github-corner {
- border-bottom: 0;
- position: fixed;
- right: 0;
- text-decoration: none;
- top: 0;
- z-index: 1;
-}
-.github-corner:hover .octo-arm {
- -webkit-animation: octocat-wave 560ms ease-in-out;
- animation: octocat-wave 560ms ease-in-out;
-}
-.github-corner svg {
- color: #fff;
- fill: var(--theme-color, #42b983);
- height: 80px;
- width: 80px;
-}
-main {
- display: block;
- position: relative;
- width: 100vw;
- height: 100%;
- z-index: 0;
-}
-main.hidden {
- display: none;
-}
-.anchor {
- display: inline-block;
- text-decoration: none;
- transition: all 0.3s;
-}
-.anchor span {
- color: #34495e;
-}
-.anchor:hover {
- text-decoration: underline;
-}
-.sidebar {
- border-right: 1px solid rgba(0,0,0,0.07);
- overflow-y: auto;
- padding: 40px 0 0;
- position: absolute;
- top: 0;
- bottom: 0;
- left: 0;
- transition: transform 250ms ease-out;
- width: 300px;
- z-index: 20;
-}
-.sidebar > h1 {
- margin: 0 auto 1rem;
- font-size: 1.5rem;
- font-weight: 300;
- text-align: center;
-}
-.sidebar > h1 a {
- color: inherit;
- text-decoration: none;
-}
-.sidebar > h1 .app-nav {
- display: block;
- position: static;
-}
-.sidebar .sidebar-nav {
- line-height: 2em;
- padding-bottom: 40px;
-}
-.sidebar li.collapse .app-sub-sidebar {
- display: none;
-}
-.sidebar ul {
- margin: 0 0 0 15px;
- padding: 0;
-}
-.sidebar li > p {
- font-weight: 700;
- margin: 0;
-}
-.sidebar ul,
-.sidebar ul li {
- list-style: none;
-}
-.sidebar ul li a {
- border-bottom: none;
- display: block;
-}
-.sidebar ul li ul {
- padding-left: 20px;
-}
-.sidebar::-webkit-scrollbar {
- width: 4px;
-}
-.sidebar::-webkit-scrollbar-thumb {
- background: transparent;
- border-radius: 4px;
-}
-.sidebar:hover::-webkit-scrollbar-thumb {
- background: rgba(136,136,136,0.4);
-}
-.sidebar:hover::-webkit-scrollbar-track {
- background: rgba(136,136,136,0.1);
-}
-.sidebar-toggle {
- background-color: transparent;
- background-color: rgba(255,255,255,0.8);
- border: 0;
- outline: none;
- padding: 10px;
- position: absolute;
- bottom: 0;
- left: 0;
- text-align: center;
- transition: opacity 0.3s;
- width: 284px;
- z-index: 30;
- cursor: pointer;
-}
-.sidebar-toggle:hover .sidebar-toggle-button {
- opacity: 0.4;
-}
-.sidebar-toggle span {
- background-color: var(--theme-color, #42b983);
- display: block;
- margin-bottom: 4px;
- width: 16px;
- height: 2px;
-}
-body.sticky .sidebar,
-body.sticky .sidebar-toggle {
- position: fixed;
-}
-.content {
- padding-top: 60px;
- position: absolute;
- top: 0;
- right: 0;
- bottom: 0;
- left: 300px;
- transition: left 250ms ease;
-}
-.markdown-section {
- margin: 0 auto;
- max-width: 80%;
- padding: 30px 15px 40px 15px;
- position: relative;
-}
-.markdown-section > * {
- box-sizing: border-box;
- font-size: inherit;
-}
-.markdown-section > :first-child {
- margin-top: 0 !important;
-}
-.markdown-section hr {
- border: none;
- border-bottom: 1px solid #eee;
- margin: 2em 0;
-}
-.markdown-section iframe {
- border: 1px solid #eee;
-/* fix horizontal overflow on iOS Safari */
- width: 1px;
- min-width: 100%;
-}
-.markdown-section table {
- border-collapse: collapse;
- border-spacing: 0;
- display: block;
- margin-bottom: 1rem;
- overflow: auto;
- width: 100%;
-}
-.markdown-section th {
- border: 1px solid #ddd;
- font-weight: bold;
- padding: 6px 13px;
-}
-.markdown-section td {
- border: 1px solid #ddd;
- padding: 6px 13px;
-}
-.markdown-section tr {
- border-top: 1px solid #ccc;
-}
-.markdown-section tr:nth-child(2n) {
- background-color: #f8f8f8;
-}
-.markdown-section p.tip {
- background-color: #f8f8f8;
- border-bottom-right-radius: 2px;
- border-left: 4px solid #f66;
- border-top-right-radius: 2px;
- margin: 2em 0;
- padding: 12px 24px 12px 30px;
- position: relative;
-}
-.markdown-section p.tip:before {
- background-color: #f66;
- border-radius: 100%;
- color: #fff;
- content: '!';
- font-family: 'Dosis', 'Source Sans Pro', 'Helvetica Neue', Arial, sans-serif;
- font-size: 14px;
- font-weight: bold;
- left: -12px;
- line-height: 20px;
- position: absolute;
- height: 20px;
- width: 20px;
- text-align: center;
- top: 14px;
-}
-.markdown-section p.tip code {
- background-color: #efefef;
-}
-.markdown-section p.tip em {
- color: #34495e;
-}
-.markdown-section p.warn {
- background: rgba(66,185,131,0.1);
- border-radius: 2px;
- padding: 1rem;
-}
-.markdown-section ul.task-list > li {
- list-style-type: none;
-}
-body.close .sidebar {
- transform: translateX(-300px);
-}
-body.close .sidebar-toggle {
- width: auto;
-}
-body.close .content {
- left: 0;
-}
-@media print {
- .github-corner,
- .sidebar-toggle,
- .sidebar,
- .app-nav {
- display: none;
- }
-}
-@media screen and (max-width: 768px) {
- .github-corner,
- .sidebar-toggle,
- .sidebar {
- position: fixed;
- }
- .app-nav {
- margin-top: 16px;
- }
- .app-nav li ul {
- top: 30px;
- }
- main {
- height: auto;
- overflow-x: hidden;
- }
- .sidebar {
- left: -300px;
- transition: transform 250ms ease-out;
- }
- .content {
- left: 0;
- max-width: 100vw;
- position: static;
- padding-top: 20px;
- transition: transform 250ms ease;
- }
- .app-nav,
- .github-corner {
- transition: transform 250ms ease-out;
- }
- .sidebar-toggle {
- background-color: transparent;
- width: auto;
- padding: 30px 30px 10px 10px;
- }
- body.close .sidebar {
- transform: translateX(300px);
- }
- body.close .sidebar-toggle {
- background-color: rgba(255,255,255,0.8);
- transition: 1s background-color;
- width: 284px;
- padding: 10px;
- }
- body.close .content {
- transform: translateX(300px);
- }
- body.close .app-nav,
- body.close .github-corner {
- display: none;
- }
- .github-corner:hover .octo-arm {
- -webkit-animation: none;
- animation: none;
- }
- .github-corner .octo-arm {
- -webkit-animation: octocat-wave 560ms ease-in-out;
- animation: octocat-wave 560ms ease-in-out;
- }
-}
-@-webkit-keyframes octocat-wave {
- 0%, 100% {
- transform: rotate(0);
- }
- 20%, 60% {
- transform: rotate(-25deg);
- }
- 40%, 80% {
- transform: rotate(10deg);
- }
-}
-@keyframes octocat-wave {
- 0%, 100% {
- transform: rotate(0);
- }
- 20%, 60% {
- transform: rotate(-25deg);
- }
- 40%, 80% {
- transform: rotate(10deg);
- }
-}
-section.cover {
- align-items: center;
- background-position: center center;
- background-repeat: no-repeat;
- background-size: cover;
- height: 100vh;
- display: none;
-}
-section.cover.show {
- display: flex;
-}
-section.cover.has-mask .mask {
- background-color: #fff;
- opacity: 0.8;
- position: absolute;
- top: 0;
- height: 100%;
- width: 100%;
-}
-section.cover .cover-main {
- flex: 1;
- margin: -20px 16px 0;
- text-align: center;
- z-index: 1;
-}
-section.cover a {
- color: inherit;
- text-decoration: none;
-}
-section.cover a:hover {
- text-decoration: none;
-}
-section.cover p {
- line-height: 1.5rem;
- margin: 1em 0;
-}
-section.cover h1 {
- color: inherit;
- font-size: 2.5rem;
- font-weight: 300;
- margin: 0.625rem 0 2.5rem;
- position: relative;
- text-align: center;
-}
-section.cover h1 a {
- display: block;
-}
-section.cover h1 small {
- bottom: -0.4375rem;
- font-size: 1rem;
- position: absolute;
-}
-section.cover blockquote {
- font-size: 1.5rem;
- text-align: center;
-}
-section.cover ul {
- line-height: 1.8;
- list-style-type: none;
- margin: 1em auto;
- max-width: 500px;
- padding: 0;
-}
-section.cover .cover-main > p:last-child a {
- border-color: var(--theme-color, #42b983);
- border-radius: 2rem;
- border-style: solid;
- border-width: 1px;
- box-sizing: border-box;
- color: var(--theme-color, #42b983);
- display: inline-block;
- font-size: 1.05rem;
- letter-spacing: 0.1rem;
- margin: 0.5rem 1rem;
- padding: 0.75em 2rem;
- text-decoration: none;
- transition: all 0.15s ease;
-}
-section.cover .cover-main > p:last-child a:last-child {
- background-color: var(--theme-color, #42b983);
- color: #fff;
-}
-section.cover .cover-main > p:last-child a:last-child:hover {
- color: inherit;
- opacity: 0.8;
-}
-section.cover .cover-main > p:last-child a:hover {
- color: inherit;
-}
-section.cover blockquote > p > a {
- border-bottom: 2px solid var(--theme-color, #42b983);
- transition: color 0.3s;
-}
-section.cover blockquote > p > a:hover {
- color: var(--theme-color, #42b983);
-}
-body {
- background-color: #fff;
-}
-/* sidebar */
-.sidebar {
- background-color: #fff;
- color: #364149;
-}
-.sidebar li {
- margin: 6px 0 6px 0;
-}
-.sidebar ul li a {
- color: #505d6b;
- font-size: 14px;
- font-weight: normal;
- overflow: hidden;
- text-decoration: none;
- text-overflow: ellipsis;
- white-space: nowrap;
-}
-.sidebar ul li a:hover {
- text-decoration: underline;
-}
-.sidebar ul li ul {
- padding: 0;
-}
-.sidebar ul li.active > a {
- border-right: 2px solid;
- color: var(--theme-color, #42b983);
- font-weight: 600;
-}
-.app-sub-sidebar li::before {
- content: '-';
- padding-right: 4px;
- float: left;
-}
-/* markdown content found on pages */
-.markdown-section h1,
-.markdown-section h2,
-.markdown-section h3,
-.markdown-section h4,
-.markdown-section strong {
- color: #2c3e50;
- font-weight: 600;
-}
-.markdown-section a {
- color: var(--theme-color, #42b983);
- font-weight: 600;
-}
-.markdown-section h1 {
- font-size: 2rem;
- margin: 0 0 1rem;
-}
-.markdown-section h2 {
- font-size: 1.75rem;
- margin: 45px 0 0.8rem;
-}
-.markdown-section h3 {
- font-size: 1.5rem;
- margin: 40px 0 0.6rem;
-}
-.markdown-section h4 {
- font-size: 1.25rem;
-}
-.markdown-section h5 {
- font-size: 1rem;
-}
-.markdown-section h6 {
- color: #777;
- font-size: 1rem;
-}
-.markdown-section figure,
-.markdown-section p {
- margin: 1.2em 0;
-}
-.markdown-section p,
-.markdown-section ul,
-.markdown-section ol {
- line-height: 1.6rem;
- word-spacing: 0.05rem;
-}
-.markdown-section ul,
-.markdown-section ol {
- padding-left: 1.5rem;
-}
-.markdown-section blockquote {
- border-left: 4px solid var(--theme-color, #42b983);
- color: #858585;
- margin: 2em 0;
- padding-left: 20px;
-}
-.markdown-section blockquote p {
- font-weight: 600;
- margin-left: 0;
-}
-.markdown-section iframe {
- margin: 1em 0;
-}
-.markdown-section em {
- color: #7f8c8d;
-}
-.markdown-section code {
- background-color: #f8f8f8;
- border-radius: 2px;
- color: #e96900;
- font-family: 'Roboto Mono', Monaco, courier, monospace;
- font-size: 0.8rem;
- margin: 0 2px;
- padding: 3px 5px;
- white-space: pre-wrap;
-}
-.markdown-section pre {
- -moz-osx-font-smoothing: initial;
- -webkit-font-smoothing: initial;
- background-color: #f8f8f8;
- font-family: 'Roboto Mono', Monaco, courier, monospace;
- line-height: 1.5rem;
- margin: 1.2em 0;
- overflow: auto;
- padding: 0 1.4rem;
- position: relative;
- word-wrap: normal;
-}
-/* code highlight */
-.token.comment,
-.token.prolog,
-.token.doctype,
-.token.cdata {
- color: #8e908c;
-}
-.token.namespace {
- opacity: 0.7;
-}
-.token.boolean,
-.token.number {
- color: #c76b29;
-}
-.token.punctuation {
- color: #525252;
-}
-.token.property {
- color: #c08b30;
-}
-.token.tag {
- color: #2973b7;
-}
-.token.string {
- color: var(--theme-color, #42b983);
-}
-.token.selector {
- color: #6679cc;
-}
-.token.attr-name {
- color: #2973b7;
-}
-.token.entity,
-.token.url,
-.language-css .token.string,
-.style .token.string {
- color: #22a2c9;
-}
-.token.attr-value,
-.token.control,
-.token.directive,
-.token.unit {
- color: var(--theme-color, #42b983);
-}
-.token.keyword,
-.token.function {
- color: #e96900;
-}
-.token.statement,
-.token.regex,
-.token.atrule {
- color: #22a2c9;
-}
-.token.placeholder,
-.token.variable {
- color: #3d8fd1;
-}
-.token.deleted {
- text-decoration: line-through;
-}
-.token.inserted {
- border-bottom: 1px dotted #202746;
- text-decoration: none;
-}
-.token.italic {
- font-style: italic;
-}
-.token.important,
-.token.bold {
- font-weight: bold;
-}
-.token.important {
- color: #c94922;
-}
-.token.entity {
- cursor: help;
-}
-.markdown-section pre > code {
- -moz-osx-font-smoothing: initial;
- -webkit-font-smoothing: initial;
- background-color: #f8f8f8;
- border-radius: 2px;
- color: #525252;
- display: block;
- font-family: 'Roboto Mono', Monaco, courier, monospace;
- font-size: 0.8rem;
- line-height: inherit;
- margin: 0 2px;
- max-width: inherit;
- overflow: inherit;
- padding: 2.2em 5px;
- white-space: inherit;
-}
-.markdown-section code::after,
-.markdown-section code::before {
- letter-spacing: 0.05rem;
-}
-code .token {
- -moz-osx-font-smoothing: initial;
- -webkit-font-smoothing: initial;
- min-height: 1.5rem;
- position: relative;
- left: auto;
-}
-pre::after {
- color: #ccc;
- content: attr(data-lang);
- font-size: 0.6rem;
- font-weight: 600;
- height: 15px;
- line-height: 15px;
- padding: 5px 10px 0;
- position: absolute;
- right: 0;
- text-align: right;
- top: 0;
-}
diff --git a/src/main/resources/simplelogger.properties b/src/main/resources/simplelogger.properties
index a157795..66281f8 100644
--- a/src/main/resources/simplelogger.properties
+++ b/src/main/resources/simplelogger.properties
@@ -1,52 +1,34 @@
-
-# SLF4J's SimpleLogger configuration file for the command line client
-# Simple implementation of Logger that sends all enabled log messages, for all defined loggers, to System.err.
-
-# Default logging detail level for all instances of SimpleLogger.
-# Must be one of ("trace", "debug", "info", "warn", or "error").
-# If not specified, defaults to "info".
+#
+# Copyright 2017-2026 Koordinierungsstelle fr IT-Standards (KoSIT)
+#
+# 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.
+#
org.slf4j.simpleLogger.defaultLogLevel=info
-
-
# Set to true if you want the current date and time to be included in output messages.
# Default is false, and will output the number of milliseconds elapsed since startup.
org.slf4j.simpleLogger.showDateTime=true
-
# The date and time format to be used in the output messages.
# The pattern describing the date and time format is the same that is used in java.text.SimpleDateFormat.
# If the format is not specified or is invalid, the default format is used.
# The default format is yyyy-MM-dd HH:mm:ss:SSS Z.
org.slf4j.simpleLogger.dateTimeFormat=yyyy-MM-dd HH:mm:ss
-
# Set to true if you want to output the current thread name.
# Defaults to true.
org.slf4j.simpleLogger.showThreadName=false
-
# Set to true if you want the Logger instance name to be included in output messages.
# Defaults to true.
org.slf4j.simpleLogger.showLogName=false
-
# Set to true if you want the last component of the name to be included in output messages.
# Defaults to false.
org.slf4j.simpleLogger.showShortLogName=false
-
org.slf4j.simpleLogger.levelInBrackets=true
-
-#
-# Licensed to the Koordinierungsstelle f�r IT-Standards (KoSIT) under
-# one or more contributor license agreements. See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership. KoSIT licenses this file
-# to you 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.
-#
diff --git a/src/main/resources/transform/identity.xsl b/src/main/resources/transform/identity.xsl
new file mode 100644
index 0000000..4ddc79e
--- /dev/null
+++ b/src/main/resources/transform/identity.xsl
@@ -0,0 +1,27 @@
+
+
+ | | | |