org.eolang.parser.StrictXmir Maven / Gradle / Ivy
/*
* The MIT License (MIT)
*
* Copyright (c) 2016-2024 Objectionary.com
*
* 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 NON-INFRINGEMENT. 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.
*/
package org.eolang.parser;
import com.jcabi.log.Logger;
import com.jcabi.manifests.Manifests;
import com.jcabi.xml.StrictXML;
import com.jcabi.xml.XML;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collection;
import java.util.List;
import javax.xml.namespace.NamespaceContext;
import org.cactoos.bytes.BytesOf;
import org.cactoos.bytes.IoCheckedBytes;
import org.cactoos.io.InputOf;
import org.cactoos.io.ResourceOf;
import org.w3c.dom.Node;
import org.xembly.Directives;
import org.xembly.Xembler;
import org.xml.sax.SAXParseException;
/**
* XMIR that validates itself right after construction.
*
* Be careful with this class, because
* it modifies the XML encapsulated by replacing the URI of
* XSD schema with a file, thus making schema validation faster.
* The original URI of the XSD schema will be lost/removed
* from the XML. Thus, you better save the XML to disc and only
* then encapsulate it into this decorator.
*
* @since 0.49.0
*/
@SuppressWarnings("PMD.TooManyMethods")
public final class StrictXmir implements XML {
/**
* XSD for current EO version.
*/
private static final String MINE = String.format(
"https://www.eolang.org/xsd/XMIR-%s.xsd",
Manifests.read("EO-Version")
);
/**
* The XML.
*/
private final XML xml;
/**
* Ctor.
* @param src The source
*/
public StrictXmir(final XML src) {
this(src, Paths.get("target/xsd"));
}
/**
* Ctor.
* Synchronization by XML is necessary in case we're trying to validate the same
* {@link XML} in multiple threads. In such case the path to XSD scheme inside XML should
* be updated only once.
* @param before The XML source
* @param tmp The directory with cached XSD files
*/
@SuppressWarnings("PMD.ConstructorOnlyInitializesOrCallOtherConstructors")
public StrictXmir(final XML before, final Path tmp) {
synchronized (before) {
this.xml = new StrictXML(
StrictXmir.reset(before, tmp)
);
}
}
@Override
public String toString() {
return this.xml.toString();
}
@Override
public List xpath(final String query) {
return this.xml.xpath(query);
}
@Override
public List nodes(final String query) {
return this.xml.nodes(query);
}
@Override
public XML registerNs(final String prefix, final Object uri) {
return this.xml.registerNs(prefix, uri);
}
@Override
public XML merge(final NamespaceContext context) {
return this.xml.merge(context);
}
@Override
@Deprecated
public Node node() {
throw new UnsupportedOperationException("deprecated");
}
@Override
public Node inner() {
return this.xml.inner();
}
@Override
public Node deepCopy() {
return this.xml.deepCopy();
}
@Override
public Collection validate() {
return this.xml.validate();
}
@Override
public Collection validate(final XML schema) {
return this.xml.validate(schema);
}
/**
* Here, we check the location of the XSD in the XML
* and replace with a new one, if necessary.
* @param xml Original XML
* @param tmp Directory with cached XSD files
* @return New XML with the same node
*/
private static XML reset(final XML xml, final Path tmp) {
final List location = xml.xpath("/program/@xsi:noNamespaceSchemaLocation");
if (!location.isEmpty()) {
final String before = location.get(0);
final String after;
if (before.startsWith("http")) {
after = String.format(
"file:///%s",
StrictXmir.fetch(
before,
tmp.resolve(
before.substring(before.lastIndexOf('/') + 1)
),
tmp
).getAbsoluteFile().toString().replace("\\", "/")
);
} else {
after = before;
}
if (!after.equals(before)) {
new Xembler(
new Directives().xpath("/program").attr(
"noNamespaceSchemaLocation xsi http://www.w3.org/2001/XMLSchema-instance",
after
)
).applyQuietly(xml.inner());
}
}
return xml;
}
/**
* Fetch the XSD and place into the path.
* @param uri The URI
* @param path The file
* @param tmp Original directory
* @return Where it was saved
*/
private static File fetch(final String uri, final Path path, final Path tmp) {
final File ret;
if (StrictXmir.MINE.equals(uri)) {
if (path.toFile().getParentFile().mkdirs()) {
Logger.debug(StrictXmir.class, "Directory for %[file]s created", path);
}
try {
Files.write(
path,
new IoCheckedBytes(
new BytesOf(new ResourceOf("XMIR.xsd"))
).asBytes()
);
Logger.debug(StrictXmir.class, "XSD copied to %[file]s", path);
} catch (final IOException ex) {
throw new IllegalArgumentException(
String.format("Failed to save %s to %s", uri, path),
ex
);
}
ret = path.toFile();
} else {
ret = StrictXmir.download(uri, path, tmp);
}
return ret;
}
/**
* Download URI from Internet and save to file.
* @param uri The URI
* @param path The file
* @param tmp Directory to synchronize by
* @return Where it was saved
*/
@SuppressWarnings("PMD.CognitiveComplexity")
private static File download(final String uri, final Path path, final Path tmp) {
final File abs = path.toFile().getAbsoluteFile();
synchronized (tmp) {
if (!abs.exists()) {
if (abs.getParentFile().mkdirs()) {
Logger.debug(StrictXmir.class, "Directory for %[file]s created", path);
}
int attempt = 0;
while (true) {
++attempt;
try {
Files.write(
path,
new IoCheckedBytes(
new BytesOf(new InputOf(new URI(uri)))
).asBytes()
);
Logger.debug(
StrictXmir.class,
"XSD downloaded from %s and copied to %[file]s",
uri, path
);
break;
} catch (final IOException ex) {
if (attempt < 3) {
Logger.warn(
StrictXmir.class,
"Attempt #%d failed to download %s to %s: %[exception]s",
attempt,
uri,
path,
ex
);
continue;
}
throw new IllegalArgumentException(
String.format("Failed to download %s to %s", uri, path),
ex
);
} catch (final URISyntaxException ex) {
throw new IllegalArgumentException(
String.format("Wrong URI: %s", uri),
ex
);
}
}
}
}
return abs;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy