/* This file is part of the OWL API.
* The contents of this file are subject to the LGPL License, Version 3.0.
* Copyright 2014, The University of Manchester
*
* This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
* You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
*
* Alternatively, the contents of this file may be used under the terms of the Apache License, Version 2.0 in which case, the provisions of the Apache License Version 2.0 are applicable instead of those above.
* 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 org.semanticweb.owlapi.io;
import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.Serializable;
import java.net.HttpURLConnection;
import java.net.SocketTimeoutException;
import java.net.URL;
import java.net.URLConnection;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.zip.GZIPInputStream;
import java.util.zip.Inflater;
import java.util.zip.InflaterInputStream;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.semanticweb.owlapi.model.IRI;
import org.semanticweb.owlapi.model.OWLDocumentFormat;
import org.semanticweb.owlapi.model.OWLOntology;
import org.semanticweb.owlapi.model.OWLOntologyLoaderConfiguration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.InputSource;
/**
* A convenience base class for parsers, which provides a mechanism to manage
* the setting and getting of the {@code OWLOntologyManager} that should be
* associated with the parser. Note: all current parser implementations are
* stateless.
*
* @author Matthew Horridge, The University Of Manchester, Bio-Health
* Informatics Group
* @since 2.0.0
*/
public abstract class AbstractOWLParser implements OWLParser, Serializable {
private static final long serialVersionUID = 40000L;
private static final Logger LOGGER = LoggerFactory
.getLogger(AbstractOWLParser.class);
private static final String ZIP_FILE_EXTENSION = ".zip";
private static final String CONTENT_DISPOSITION_HEADER = "Content-Disposition";
private static final Pattern CONTENT_DISPOSITION_FILE_NAME_PATTERN = Pattern
.compile(".*filename=\"([^\\s;]*)\".*");
private static final int CONTENT_DISPOSITION_FILE_NAME_PATTERN_GROUP = 1;
private static final Pattern ZIP_ENTRY_ONTOLOGY_NAME_PATTERN = Pattern
.compile(".*owl|rdf|xml|mos");
protected AbstractOWLParser() {}
@Nonnull
protected String getRequestTypes() {
return "application/rdf+xml, application/xml; q=0.5, text/xml; q=0.3, */*; q=0.2";
}
/**
* A convenience method that obtains an input stream from a URI. This method
* sets up the correct request type and wraps the input stream within a
* buffered input stream.
*
* @param documentIRI
* The URI from which the input stream should be returned
* @param config
* the load configuration
* @return The input stream obtained from the URI
* @throws IOException
* if there was an {@code IOException} in obtaining the input stream
* from the URI.
*/
@Nonnull
protected InputStream getInputStream(@Nonnull IRI documentIRI,
@Nonnull OWLOntologyLoaderConfiguration config) throws IOException {
String requestType = getRequestTypes();
URL originalURL = documentIRI.toURI().toURL();
String originalProtocol = originalURL.getProtocol();
URLConnection conn = originalURL.openConnection();
conn.addRequestProperty("Accept", requestType);
if (config.isAcceptingHTTPCompression()) {
conn.setRequestProperty("Accept-Encoding", "gzip, deflate");
}
int connectionTimeout = config.getConnectionTimeout();
conn.setConnectTimeout(connectionTimeout);
if (conn instanceof HttpURLConnection && config.isFollowRedirects()) {
// follow redirects to HTTPS
HttpURLConnection con = (HttpURLConnection) conn;
con.connect();
int responseCode = con.getResponseCode();
// redirect
if (responseCode == HttpURLConnection.HTTP_MOVED_TEMP
|| responseCode == HttpURLConnection.HTTP_MOVED_PERM
|| responseCode == HttpURLConnection.HTTP_SEE_OTHER) {
String location = con.getHeaderField("Location");
URL newURL = new URL(location);
String newProtocol = newURL.getProtocol();
if (!originalProtocol.equals(newProtocol)) {
// then different protocols: redirect won't follow
// automatically
conn = newURL.openConnection();
conn.addRequestProperty("Accept", requestType);
if (config.isAcceptingHTTPCompression()) {
conn.setRequestProperty("Accept-Encoding",
"gzip, deflate");
}
conn.setConnectTimeout(connectionTimeout);
}
}
}
String contentEncoding = conn.getContentEncoding();
InputStream is = null;
int count = 0;
while (count < config.getRetriesToAttempt() && is == null) {
try {
is = getInputStreamFromContentEncoding(conn, contentEncoding);
} catch (SocketTimeoutException e) {
count++;
if (count == 5) {
throw e;
}
conn.setConnectTimeout(connectionTimeout + connectionTimeout
* count);
}
}
if (is == null) {
throw new IOException("cannot connect to " + documentIRI
+ "; retry limit exhausted");
}
if (isZipName(documentIRI, conn)) {
ZipInputStream zis = new ZipInputStream(is);
ZipEntry entry = null;
ZipEntry nextEntry = zis.getNextEntry();
while (entry != null && nextEntry != null) {
if (couldBeOntology(nextEntry)) {
entry = nextEntry;
}
nextEntry = zis.getNextEntry();
}
is = OWLOntologyDocumentSourceBase.wrap(zis);
} else {
is = OWLOntologyDocumentSourceBase.wrap(is);
}
return is;
}
private static boolean couldBeOntology(@Nullable ZipEntry zipEntry) {
if (zipEntry == null) {
return false;
}
return ZIP_ENTRY_ONTOLOGY_NAME_PATTERN.matcher(zipEntry.getName())
.matches();
}
@SuppressWarnings("null")
@Nonnull
private static InputStream getInputStreamFromContentEncoding(
@Nonnull URLConnection conn, @Nullable String contentEncoding)
throws IOException {
InputStream is;
if ("gzip".equals(contentEncoding)) {
LOGGER.info("URL connection input stream is compressed using gzip");
is = new BufferedInputStream(new GZIPInputStream(
conn.getInputStream()));
} else if ("deflate".equals(contentEncoding)) {
LOGGER.info("URL connection input stream is compressed using deflate");
is = OWLOntologyDocumentSourceBase.wrap(new InflaterInputStream(
conn.getInputStream(), new Inflater(true)));
} else {
is = OWLOntologyDocumentSourceBase.wrap(conn.getInputStream());
}
return is;
}
private static boolean isZipName(@Nonnull IRI documentIRI,
@Nonnull URLConnection connection) {
if (isZipFileName(documentIRI.toString())) {
return true;
} else {
String fileName = getFileNameFromContentDisposition(connection);
return fileName != null && isZipFileName(fileName);
}
}
@Nullable
private static String getFileNameFromContentDisposition(
@Nonnull URLConnection connection) {
String contentDispositionHeaderValue = connection
.getHeaderField(CONTENT_DISPOSITION_HEADER);
if (contentDispositionHeaderValue != null) {
Matcher matcher = CONTENT_DISPOSITION_FILE_NAME_PATTERN
.matcher(contentDispositionHeaderValue);
if (matcher.matches()) {
return matcher
.group(CONTENT_DISPOSITION_FILE_NAME_PATTERN_GROUP);
}
}
return null;
}
private static boolean isZipFileName(@Nonnull String fileName) {
return fileName.toLowerCase(Locale.getDefault()).endsWith(
ZIP_FILE_EXTENSION);
}
@Nonnull
protected InputSource getInputSource(
@Nonnull OWLOntologyDocumentSource documentSource,
@Nonnull OWLOntologyLoaderConfiguration config) throws IOException {
InputSource is;
if (documentSource.isReaderAvailable()) {
is = new InputSource(documentSource.getReader());
} else if (documentSource.isInputStreamAvailable()) {
is = new InputSource(documentSource.getInputStream());
} else {
is = new InputSource(getInputStream(
documentSource.getDocumentIRI(), config));
}
is.setSystemId(documentSource.getDocumentIRI().toString());
return is;
}
@Nonnull
@Override
public OWLDocumentFormat parse(IRI documentIRI, OWLOntology ontology)
throws IOException {
return parse(new IRIDocumentSource(documentIRI, null, null), ontology,
ontology.getOWLOntologyManager()
.getOntologyLoaderConfiguration());
}
@SuppressWarnings("null")
@Override
public String getName() {
return getClass().getSimpleName();
}
}