/*
* Copyright (C) 2014 Camptocamp
*
* This file is part of MapFish Print
*
* MapFish Print 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.
*
* MapFish Print 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 MapFish Print. If not, see <http://www.gnu.org/licenses/>.
*/
package org.mapfish.print.map.geotools;
import org.geotools.data.FeatureSource;
import org.geotools.data.collection.CollectionFeatureSource;
import org.geotools.data.simple.SimpleFeatureCollection;
import org.geotools.gml2.GMLConfiguration;
import org.geotools.xml.Parser;
import org.mapfish.print.ExceptionUtils;
import org.mapfish.print.FileUtils;
import org.mapfish.print.URIUtils;
import org.mapfish.print.attribute.map.MapfishMapContext;
import org.mapfish.print.config.Template;
import org.mapfish.print.http.MfClientHttpRequestFactory;
import org.xml.sax.SAXException;
import java.io.IOException;
import java.io.StringReader;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.concurrent.ExecutorService;
import javax.annotation.Nonnull;
import javax.xml.namespace.QName;
import javax.xml.parsers.ParserConfigurationException;
/**
* Parses Gml from the requestData.
*
* @author Jesse on 3/26/14.
*/
public final class GmlLayer extends AbstractFeatureSourceLayer {
/**
* Constructor.
*
* @param executorService the thread pool for doing the rendering.
* @param featureSourceSupplier a function that creates the feature source. This will only be called once.
* @param styleSupplier a function that creates the style for styling the features. This will only be called once.
* @param renderAsSvg is the layer rendered as SVG?
*/
public GmlLayer(final ExecutorService executorService,
final FeatureSourceSupplier featureSourceSupplier,
final StyleSupplier<FeatureSource> styleSupplier,
final boolean renderAsSvg) {
super(executorService, featureSourceSupplier, styleSupplier, renderAsSvg);
}
/**
* Parser for creating {@link org.mapfish.print.map.geotools.GmlLayer} layers from request data.
*/
public static final class Plugin extends AbstractFeatureSourceLayerPlugin<GmlParam> {
private static final String TYPE = "gml";
private static final GMLConfiguration GML_2_PARSER = new GMLConfiguration();
private static final org.geotools.gml3.GMLConfiguration GML_3_PARSER = new org.geotools.gml3.GMLConfiguration();
private static final org.geotools.gml3.v3_2.GMLConfiguration GML_32_PARSER = new org.geotools.gml3.v3_2.GMLConfiguration(true);
/**
* Constructor.
*/
public Plugin() {
super(TYPE);
}
@Override
public GmlParam createParameter() {
return new GmlParam();
}
@Nonnull
@Override
public GmlLayer parse(final Template template,
@Nonnull final GmlParam param) throws IOException {
return new GmlLayer(
this.forkJoinPool,
createFeatureSourceSupplier(template, param.url),
createStyleFunction(template, param.style),
template.getConfiguration().renderAsSvg(param.renderAsSvg));
}
private FeatureSourceSupplier createFeatureSourceSupplier(final Template template,
final String url) {
return new FeatureSourceSupplier() {
@Nonnull
@Override
public FeatureSource load(@Nonnull final MfClientHttpRequestFactory requestFactory,
@Nonnull final MapfishMapContext mapContext) {
SimpleFeatureCollection featureCollection;
try {
featureCollection = createFeatureSource(template, requestFactory, url);
} catch (IOException e) {
throw ExceptionUtils.getRuntimeException(e);
}
if (featureCollection == null) {
throw new IllegalArgumentException(url + " does not reference a GML file");
}
return new CollectionFeatureSource(featureCollection);
}
};
}
private SimpleFeatureCollection createFeatureSource(final Template template,
final MfClientHttpRequestFactory httpRequestFactory,
final String gmlString) throws IOException {
try {
URL url = new URL(gmlString);
FileUtils.testForLegalFileUrl(template.getConfiguration(), url);
try {
final String gmlData = URIUtils.toString(httpRequestFactory, url.toURI());
final int endIndex = 200;
String startOfData = gmlData.substring(0, endIndex);
if (startOfData.contains("\"http://www.opengis.net/gml/3.2\"")) {
return parseGml32(gmlData);
} else {
return parseGml3(gmlData);
}
} catch (URISyntaxException e) {
throw ExceptionUtils.getRuntimeException(e);
}
} catch (MalformedURLException e) {
return null;
}
}
private SimpleFeatureCollection parseGml3(final String gmlData) throws IOException {
Parser gmlV3Parser = new Parser(GML_3_PARSER);
gmlV3Parser.setStrict(false);
gmlV3Parser.setRootElementType(new QName("http://www.opengis.net/wfs", "FeatureCollection"));
try {
final Object featureCollection = gmlV3Parser.parse(new StringReader(gmlData));
if (featureCollection != null) {
return (SimpleFeatureCollection) featureCollection;
}
} catch (SAXException e) {
// do nothing try to load as gml2
} catch (ParserConfigurationException e) {
// do nothing try to load as gml2
}
return parseGml2(gmlData);
}
private SimpleFeatureCollection parseGml2(final String gmlData) throws IOException {
Parser gmlV2Parser = new Parser(GML_2_PARSER);
gmlV2Parser.setStrict(false);
gmlV2Parser.setRootElementType(new QName("http://www.opengis.net/wfs", "FeatureCollection"));
try {
final Object featureCollection = gmlV2Parser.parse(new StringReader(gmlData));
if (featureCollection != null) {
return (SimpleFeatureCollection) featureCollection;
}
} catch (SAXException e) {
// do nothing try to load as gml32
} catch (ParserConfigurationException e) {
// do nothing try to load as gml32
}
return parseGml32(gmlData);
}
private SimpleFeatureCollection parseGml32(final String gmlData) throws IOException {
Parser gmlV32Parser = new Parser(GML_32_PARSER);
gmlV32Parser.setStrict(false);
gmlV32Parser.setRootElementType(new QName("http://www.opengis.net/wfs/2.0", "FeatureCollection"));
try {
final Object featureCollection = gmlV32Parser.parse(new StringReader(gmlData));
if (featureCollection != null) {
return (SimpleFeatureCollection) featureCollection;
} else {
throw new RuntimeException("unable to parse gml: \n\n" + gmlData);
}
} catch (SAXException e) {
throw ExceptionUtils.getRuntimeException(e);
} catch (ParserConfigurationException e) {
throw ExceptionUtils.getRuntimeException(e);
}
}
}
/**
* The parameters for creating a layer that renders Gml formatted data.
*/
public static class GmlParam extends AbstractVectorLayerParam {
/**
* A url to the gml or the raw Gml data.
* <p/>
* The url can be a file url, however if it is it must be relative to the configuration directory.
*/
public String url;
}
}