//License: GPL. Copyright 2007 by Immanuel Scholz and others
//TODO: this is far from complete, but can emulate old RawGps behaviour
package org.openstreetmap.josm.io;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Stack;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
import org.openstreetmap.josm.data.coor.LatLon;
import org.openstreetmap.josm.data.gpx.GpxData;
import org.openstreetmap.josm.data.gpx.GpxLink;
import org.openstreetmap.josm.data.gpx.GpxRoute;
import org.openstreetmap.josm.data.gpx.ImmutableGpxTrack;
import org.openstreetmap.josm.data.gpx.WayPoint;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
/**
* Read a gpx file. Bounds are not read, as we caluclate them. @see
* GpxData.recalculateBounds()
*
* @author imi, ramack
*/
public class GpxReader {
// TODO: implement GPX 1.0 parsing
/**
* The resulting gpx data
*/
public GpxData data;
private enum State {
init, metadata, wpt, rte, trk, ext, author, link, trkseg, copyright
}
private InputSource inputSource;
private class Parser extends DefaultHandler {
private GpxData currentData;
private Collection<Collection<WayPoint>> currentTrack;
private Map<String, Object> currentTrackAttr;
private Collection<WayPoint> currentTrackSeg;
private GpxRoute currentRoute;
private WayPoint currentWayPoint;
private State currentState = State.init;
private GpxLink currentLink;
private Stack<State> states;
private final Stack<String> elements = new Stack<String>();
private StringBuffer accumulator = new StringBuffer();
private boolean nokiaSportsTrackerBug = false;
@Override
public void startDocument() {
accumulator = new StringBuffer();
states = new Stack<State>();
currentData = new GpxData();
}
private double parseCoord(String s) {
try {
return Double.parseDouble(s);
} catch (NumberFormatException ex) {
return Double.NaN;
}
}
private LatLon parseLatLon(Attributes atts) {
return new LatLon(parseCoord(atts.getValue("lat")), parseCoord(atts
.getValue("lon")));
}
@Override
public void startElement(String namespaceURI, String qName,
String rqName, Attributes atts) throws SAXException {
elements.push(qName);
switch (currentState) {
case init:
if (qName.equals("metadata")) {
states.push(currentState);
currentState = State.metadata;
} else if (qName.equals("wpt")) {
states.push(currentState);
currentState = State.wpt;
currentWayPoint = new WayPoint(parseLatLon(atts));
} else if (qName.equals("rte")) {
states.push(currentState);
currentState = State.rte;
currentRoute = new GpxRoute();
} else if (qName.equals("trk")) {
states.push(currentState);
currentState = State.trk;
currentTrack = new ArrayList<Collection<WayPoint>>();
currentTrackAttr = new HashMap<String, Object>();
} else if (qName.equals("extensions")) {
states.push(currentState);
currentState = State.ext;
} else if (qName.equals("gpx")
&& atts.getValue("creator") != null
&& atts.getValue("creator").startsWith(
"Nokia Sports Tracker")) {
nokiaSportsTrackerBug = true;
}
break;
case author:
if (qName.equals("link")) {
states.push(currentState);
currentState = State.link;
currentLink = new GpxLink(atts.getValue("href"));
} else if (qName.equals("email")) {
currentData.attr.put(GpxData.META_AUTHOR_EMAIL, atts
.getValue("id")
+ "@" + atts.getValue("domain"));
}
break;
case trk:
if (qName.equals("trkseg")) {
states.push(currentState);
currentState = State.trkseg;
currentTrackSeg = new ArrayList<WayPoint>();
} else if (qName.equals("link")) {
states.push(currentState);
currentState = State.link;
currentLink = new GpxLink(atts.getValue("href"));
} else if (qName.equals("extensions")) {
states.push(currentState);
currentState = State.ext;
}
break;
case metadata:
if (qName.equals("author")) {
states.push(currentState);
currentState = State.author;
} else if (qName.equals("extensions")) {
states.push(currentState);
currentState = State.ext;
} else if (qName.equals("copyright")) {
states.push(currentState);
currentState = State.copyright;
currentData.attr.put(GpxData.META_COPYRIGHT_AUTHOR, atts
.getValue("author"));
} else if (qName.equals("link")) {
states.push(currentState);
currentState = State.link;
currentLink = new GpxLink(atts.getValue("href"));
}
break;
case trkseg:
if (qName.equals("trkpt")) {
states.push(currentState);
currentState = State.wpt;
currentWayPoint = new WayPoint(parseLatLon(atts));
}
break;
case wpt:
if (qName.equals("link")) {
states.push(currentState);
currentState = State.link;
currentLink = new GpxLink(atts.getValue("href"));
} else if (qName.equals("extensions")) {
states.push(currentState);
currentState = State.ext;
}
break;
case rte:
if (qName.equals("link")) {
states.push(currentState);
currentState = State.link;
currentLink = new GpxLink(atts.getValue("href"));
} else if (qName.equals("rtept")) {
states.push(currentState);
currentState = State.wpt;
currentWayPoint = new WayPoint(parseLatLon(atts));
} else if (qName.equals("extensions")) {
states.push(currentState);
currentState = State.ext;
}
break;
default:
}
accumulator.setLength(0);
}
@Override
public void characters(char[] ch, int start, int length) {
/**
* Remove illegal characters generated by the Nokia Sports Tracker
* device. Don't do this crude substitution for all files, since it
* would destroy certain unicode characters.
*/
if (nokiaSportsTrackerBug) {
for (int i = 0; i < ch.length; ++i) {
if (ch[i] == 1) {
ch[i] = 32;
}
}
nokiaSportsTrackerBug = false;
}
accumulator.append(ch, start, length);
}
private Map<String, Object> getAttr() {
switch (currentState) {
case rte:
return currentRoute.attr;
case metadata:
return currentData.attr;
case wpt:
return currentWayPoint.attr;
case trk:
return currentTrackAttr;
default:
return null;
}
}
@SuppressWarnings("unchecked")
@Override
public void endElement(String namespaceURI, String qName, String rqName) {
elements.pop();
switch (currentState) {
case metadata:
if (qName.equals("name")) {
currentData.attr.put(GpxData.META_NAME, accumulator
.toString());
} else if (qName.equals("desc")) {
currentData.attr.put(GpxData.META_DESC, accumulator
.toString());
} else if (qName.equals("time")) {
currentData.attr.put(GpxData.META_TIME, accumulator
.toString());
} else if (qName.equals("keywords")) {
currentData.attr.put(GpxData.META_KEYWORDS, accumulator
.toString());
} else if (qName.equals("metadata")) {
currentState = states.pop();
}
// TODO: parse bounds, extensions
break;
case author:
if (qName.equals("author")) {
currentState = states.pop();
} else if (qName.equals("name")) {
currentData.attr.put(GpxData.META_AUTHOR_NAME, accumulator
.toString());
} else if (qName.equals("email")) {
// do nothing, has been parsed on startElement
} else if (qName.equals("link")) {
currentData.attr.put(GpxData.META_AUTHOR_LINK, currentLink);
}
break;
case copyright:
if (qName.equals("copyright")) {
currentState = states.pop();
} else if (qName.equals("year")) {
currentData.attr.put(GpxData.META_COPYRIGHT_YEAR,
accumulator.toString());
} else if (qName.equals("license")) {
currentData.attr.put(GpxData.META_COPYRIGHT_LICENSE,
accumulator.toString());
}
break;
case link:
if (qName.equals("text")) {
currentLink.text = accumulator.toString();
} else if (qName.equals("type")) {
currentLink.type = accumulator.toString();
} else if (qName.equals("link")) {
if (currentLink.uri == null && accumulator != null
&& accumulator.toString().length() != 0) {
currentLink = new GpxLink(accumulator.toString());
}
currentState = states.pop();
}
if (currentState == State.author) {
currentData.attr.put(GpxData.META_AUTHOR_LINK, currentLink);
} else if (currentState != State.link) {
Map<String, Object> attr = getAttr();
if (!attr.containsKey(GpxData.META_LINKS)) {
attr.put(GpxData.META_LINKS, new LinkedList<GpxLink>());
}
((Collection<GpxLink>) attr.get(GpxData.META_LINKS))
.add(currentLink);
}
break;
case wpt:
if (qName.equals("ele") || qName.equals("magvar")
|| qName.equals("name") || qName.equals("geoidheight")
|| qName.equals("type") || qName.equals("sym")) {
currentWayPoint.attr.put(qName, accumulator.toString());
} else if (qName.equals("hdop") /*
* || qName.equals("vdop") ||
* qName.equals("pdop")
*/) {
try {
currentWayPoint.attr.put(qName, Float
.parseFloat(accumulator.toString()));
} catch (Exception e) {
currentWayPoint.attr.put(qName, new Float(0));
}
} else if (qName.equals("time")) {
currentWayPoint.attr.put(qName, accumulator.toString());
currentWayPoint.setTime();
} else if (qName.equals("cmt") || qName.equals("desc")) {
currentWayPoint.attr.put(qName, accumulator.toString());
currentWayPoint.setTime();
} else if (qName.equals("rtept")) {
currentState = states.pop();
currentRoute.routePoints.add(currentWayPoint);
} else if (qName.equals("trkpt")) {
currentState = states.pop();
currentTrackSeg.add(currentWayPoint);
} else if (qName.equals("wpt")) {
currentState = states.pop();
currentData.waypoints.add(currentWayPoint);
}
break;
case trkseg:
if (qName.equals("trkseg")) {
currentState = states.pop();
currentTrack.add(currentTrackSeg);
}
break;
case trk:
if (qName.equals("trk")) {
currentState = states.pop();
currentData.tracks.add(new ImmutableGpxTrack(currentTrack,
currentTrackAttr));
} else if (qName.equals("name") || qName.equals("cmt")
|| qName.equals("desc") || qName.equals("src")
|| qName.equals("type") || qName.equals("number")
|| qName.equals("url")) {
currentTrackAttr.put(qName, accumulator.toString());
}
break;
case ext:
if (qName.equals("extensions")) {
currentState = states.pop();
}
break;
default:
if (qName.equals("wpt")) {
currentState = states.pop();
} else if (qName.equals("rte")) {
currentState = states.pop();
currentData.routes.add(currentRoute);
}
}
}
@Override
public void endDocument() throws SAXException {
if (!states.empty())
throw new SAXException(
"Parse error: invalid document structure for GPX document.");
data = currentData;
}
public void tryToFinish() throws SAXException {
List<String> remainingElements = new ArrayList<String>(elements);
for (int i = remainingElements.size() - 1; i >= 0; i--) {
endElement(null, remainingElements.get(i), null);
}
endDocument();
}
}
/**
* Parse the input stream and store the result in trackData and markerData
*
*/
public GpxReader(InputStream source) throws IOException {
this.inputSource = new InputSource(new InputStreamReader(source,
"UTF-8"));
}
/**
*
* @return True if file was properly parsed, false if there was error during
* parsing but some data were parsed anyway
* @throws SAXException
* @throws IOException
*/
public boolean parse(boolean tryToFinish) throws SAXException, IOException {
Parser parser = new Parser();
try {
SAXParserFactory factory = SAXParserFactory.newInstance();
factory.setNamespaceAware(true);
factory.newSAXParser().parse(inputSource, parser);
return true;
} catch (SAXException e) {
if (tryToFinish) {
parser.tryToFinish();
if (parser.currentData.isEmpty())
throw e;
return false;
} else
throw e;
} catch (ParserConfigurationException e) {
e.printStackTrace(); // broken SAXException chaining
throw new SAXException(e);
}
}
}