-
Notifications
You must be signed in to change notification settings - Fork 142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
StrictXmir #3652
+453
−9
Merged
StrictXmir #3652
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
c039166
#3636: XMIR on XML
yegor256 a7a76c4
#3636: StrictXmir
yegor256 9e0b464
#3636: cache
yegor256 13b70ee
#3636: typo
yegor256 30650b9
#3636: renames
yegor256 7d6c669
#3636: cache folder
yegor256 6f07f8f
#3636: tests
yegor256 fa589e6
#3636: explained
yegor256 a1a64bc
#3636: retry three times
yegor256 062f8bd
Merge branch 'master' into 3636
yegor256 04af5af
#3636: explained the usage
yegor256 d0bf3b8
#3636: local XSD used if matches
yegor256 fc8fbec
#3636: tested and better logging
yegor256 809adde
#3636: duplication reduced
yegor256 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
263 changes: 263 additions & 0 deletions
263
eo-parser/src/main/java/org/eolang/parser/StrictXmir.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,263 @@ | ||
| /* | ||
| * 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 com.jcabi.xml.XMLDocument; | ||
| 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. | ||
| * | ||
| * <p>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.</p> | ||
| * | ||
| * @since 0.49.0 | ||
| */ | ||
| @SuppressWarnings("PMD.TooManyMethods") | ||
| public final class StrictXmir implements XML { | ||
|
|
||
| /** | ||
| * The XML. | ||
| */ | ||
| private final XML xml; | ||
|
|
||
| /** | ||
| * Ctor. | ||
| * @param src The source | ||
| */ | ||
| public StrictXmir(final XML src) { | ||
| this(src, Paths.get("target/xsd")); | ||
| } | ||
|
|
||
| /** | ||
| * Ctor. | ||
| * @param src The source | ||
| * @param tmp The directory with cached XSD files | ||
| */ | ||
| public StrictXmir(final XML src, final Path tmp) { | ||
| this.xml = new StrictXML(StrictXmir.reset(src, tmp)); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return this.xml.toString(); | ||
| } | ||
|
|
||
| @Override | ||
| public List<String> xpath(final String query) { | ||
| return this.xml.xpath(query); | ||
| } | ||
|
|
||
| @Override | ||
| public List<XML> 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<SAXParseException> validate() { | ||
| return this.xml.validate(); | ||
| } | ||
|
|
||
| @Override | ||
| public Collection<SAXParseException> 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 Node node = xml.inner(); | ||
| final List<String> location = xml.xpath("/program/@xsi:noNamespaceSchemaLocation"); | ||
| if (!location.isEmpty()) { | ||
| String uri = location.get(0); | ||
| if (uri.startsWith("http")) { | ||
| uri = String.format( | ||
| "file:///%s", | ||
| StrictXmir.fetch( | ||
| uri, | ||
| tmp.resolve( | ||
| uri.substring(uri.lastIndexOf('/') + 1) | ||
| ) | ||
| ).toString().replace("\\", "/") | ||
| ); | ||
| } | ||
| new Xembler( | ||
| new Directives().xpath("/program").attr( | ||
| "noNamespaceSchemaLocation xsi http://www.w3.org/2001/XMLSchema-instance", | ||
| uri | ||
| ) | ||
| ).applyQuietly(node); | ||
| } | ||
| return new XMLDocument(node); | ||
| } | ||
|
|
||
| /** | ||
| * Fetch the XSD and place into the path. | ||
| * @param uri The URI | ||
| * @param path The file | ||
| * @return Where it was saved | ||
| */ | ||
| private static File fetch(final String uri, final Path path) { | ||
| final File ret; | ||
| final String mine = String.format( | ||
| "https://www.eolang.org/xsd/XMIR-%s.xsd", | ||
| Manifests.read("EO-Version") | ||
| ); | ||
| if (uri.equals(mine)) { | ||
| 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); | ||
| } | ||
| return ret; | ||
| } | ||
|
|
||
| /** | ||
| * Download URI from Internet and save to file. | ||
| * @param uri The URI | ||
| * @param path The file | ||
| * @return Where it was saved | ||
| */ | ||
| @SuppressWarnings("PMD.CognitiveComplexity") | ||
| private static File download(final String uri, final Path path) { | ||
| final File abs = path.toFile().getAbsoluteFile(); | ||
| 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; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yegor256 Do we need to change the
xmirin case!uri.startWith("http")?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@volodya-lombrozo nope, when it's
file://....we keep it as isThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yegor256 I see. I've overlooked indentations. Thank you.