//License: GPL. See README for details.
package org.openstreetmap.josm.io;
import static org.openstreetmap.josm.tools.I18n.tr;
import static org.openstreetmap.josm.tools.I18n.trn;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.StringReader;
import java.io.StringWriter;
import java.net.ConnectException;
import java.net.HttpURLConnection;
import java.net.SocketTimeoutException;
import java.net.URL;
import java.net.UnknownHostException;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.logging.Logger;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParserFactory;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.data.osm.Changeset;
import org.openstreetmap.josm.data.osm.OsmPrimitive;
import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
import org.openstreetmap.josm.gui.progress.ProgressMonitor;
import org.openstreetmap.josm.tools.CheckParameterUtil;
import org.xml.sax.Attributes;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
/**
* Class that encapsulates the communications with the OSM API.
*
* All interaction with the server-side OSM API should go through this class.
*
* It is conceivable to extract this into an interface later and create various
* classes implementing the interface, to be able to talk to various kinds of servers.
*
*/
public class OsmApi extends OsmConnection {
@SuppressWarnings("unused")
static private final Logger logger = Logger.getLogger(OsmApi.class.getName());
/** max number of retries to send a request in case of HTTP 500 errors or timeouts */
static public final int DEFAULT_MAX_NUM_RETRIES = 5;
/** the collection of instantiated OSM APIs */
private static HashMap<String, OsmApi> instances = new HashMap<String, OsmApi>();
/**
* replies the {@see OsmApi} for a given server URL
*
* @param serverUrl the server URL
* @return the OsmApi
* @throws IllegalArgumentException thrown, if serverUrl is null
*
*/
static public OsmApi getOsmApi(String serverUrl) {
OsmApi api = instances.get(serverUrl);
if (api == null) {
api = new OsmApi(serverUrl);
instances.put(serverUrl,api);
}
return api;
}
/**
* replies the {@see OsmApi} for the URL given by the preference <code>osm-server.url</code>
*
* @return the OsmApi
* @exception IllegalStateException thrown, if the preference <code>osm-server.url</code> is not set
*
*/
static public OsmApi getOsmApi() {
String serverUrl = Main.pref.get("osm-server.url", "http://api.openstreetmap.org/api");
if (serverUrl == null)
throw new IllegalStateException(tr("Preference ''{0}'' missing. Cannot initialize OsmApi.", "osm-server.url"));
return getOsmApi(serverUrl);
}
/** the server URL */
private String serverUrl;
/**
* Object describing current changeset
*/
private Changeset changeset;
/**
* API version used for server communications
*/
private String version = null;
/** the api capabilities */
private Capabilities capabilities = new Capabilities();
/**
* true if successfully initialized
*/
private boolean initialized = false;
private StringWriter swriter = new StringWriter();
private OsmWriter osmWriter = new OsmWriter(new PrintWriter(swriter), true, null);
/**
* A parser for the "capabilities" response XML
*/
private class CapabilitiesParser extends DefaultHandler {
@Override
public void startDocument() throws SAXException {
capabilities.clear();
}
@Override public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {
for (int i=0; i< qName.length(); i++) {
capabilities.put(qName, atts.getQName(i), atts.getValue(i));
}
}
}
/**
* creates an OSM api for a specific server URL
*
* @param serverUrl the server URL. Must not be null
* @exception IllegalArgumentException thrown, if serverUrl is null
*/
protected OsmApi(String serverUrl) {
CheckParameterUtil.ensureParameterNotNull(serverUrl, "serverUrl");
this.serverUrl = serverUrl;
}
/**
* Returns the OSM protocol version we use to talk to the server.
* @return protocol version, or null if not yet negotiated.
*/
public String getVersion() {
return version;
}
/**
* Initializes this component by negotiating a protocol version with the server.
*
* @exception OsmApiInitializationException thrown, if an exception occurs
*/
public void initialize(ProgressMonitor monitor) throws OsmApiInitializationException, OsmTransferCancelledException {
if (initialized)
return;
cancel = false;
try {
String s = sendRequest("GET", "capabilities", null,monitor, false);
InputSource inputSource = new InputSource(new StringReader(s));
SAXParserFactory.newInstance().newSAXParser().parse(inputSource, new CapabilitiesParser());
if (capabilities.supportsVersion("0.6")) {
version = "0.6";
} else {
System.err.println(tr("This version of JOSM is incompatible with the configured server."));
System.err.println(tr("It supports protocol version 0.6, while the server says it supports {0} to {1}.",
capabilities.get("version", "minimum"), capabilities.get("version", "maximum")));
initialized = false;
}
System.out.println(tr("Communications with {0} established using protocol version {1}.",
serverUrl,
version));
osmWriter.setVersion(version);
initialized = true;
} catch(IOException e) {
initialized = false;
throw new OsmApiInitializationException(e);
} catch(SAXException e) {
initialized = false;
throw new OsmApiInitializationException(e);
} catch(ParserConfigurationException e) {
initialized = false;
throw new OsmApiInitializationException(e);
} catch(OsmTransferCancelledException e){
throw e;
} catch(OsmTransferException e) {
initialized = false;
throw new OsmApiInitializationException(e);
}
}
/**
* Makes an XML string from an OSM primitive. Uses the OsmWriter class.
* @param o the OSM primitive
* @param addBody true to generate the full XML, false to only generate the encapsulating tag
* @return XML string
*/
private String toXml(OsmPrimitive o, boolean addBody) {
swriter.getBuffer().setLength(0);
osmWriter.setWithBody(addBody);
osmWriter.setChangeset(changeset);
osmWriter.header();
o.visit(osmWriter);
osmWriter.footer();
osmWriter.out.flush();
return swriter.toString();
}
/**
* Makes an XML string from an OSM primitive. Uses the OsmWriter class.
* @param o the OSM primitive
* @param addBody true to generate the full XML, false to only generate the encapsulating tag
* @return XML string
*/
private String toXml(Changeset s) {
swriter.getBuffer().setLength(0);
osmWriter.header();
s.visit(osmWriter);
osmWriter.footer();
osmWriter.out.flush();
return swriter.toString();
}
/**
* Returns the base URL for API requests, including the negotiated version number.
* @return base URL string
*/
public String getBaseUrl() {
StringBuffer rv = new StringBuffer(serverUrl);
if (version != null) {
rv.append("/");
rv.append(version);
}
rv.append("/");
// this works around a ruby (or lighttpd) bug where two consecutive slashes in
// an URL will cause a "404 not found" response.
int p; while ((p = rv.indexOf("//", 6)) > -1) { rv.delete(p, p + 1); }
return rv.toString();
}
/**
* Creates an OSM primitive on the server. The OsmPrimitive object passed in
* is modified by giving it the server-assigned id.
*
* @param osm the primitive
* @throws OsmTransferException if something goes wrong
*/
public void createPrimitive(OsmPrimitive osm, ProgressMonitor monitor) throws OsmTransferException {
String ret = "";
try {
ensureValidChangeset();
initialize(monitor);
ret = sendRequest("PUT", OsmPrimitiveType.from(osm).getAPIName()+"/create", toXml(osm, true),monitor);
osm.setOsmId(Long.parseLong(ret.trim()), 1);
osm.setChangesetId(getChangeset().getId());
} catch(NumberFormatException e){
throw new OsmTransferException(tr("Unexpected format of ID replied by the server. Got ''{0}''.", ret));
}
}
/**
* Modifies an OSM primitive on the server.
*
* @param osm the primitive. Must not be null.
* @param monitor the progress monitor
* @throws OsmTransferException if something goes wrong
*/
public void modifyPrimitive(OsmPrimitive osm, ProgressMonitor monitor) throws OsmTransferException {
String ret = null;
try {
ensureValidChangeset();
initialize(monitor);
// normal mode (0.6 and up) returns new object version.
ret = sendRequest("PUT", OsmPrimitiveType.from(osm).getAPIName()+"/" + osm.getId(), toXml(osm, true), monitor);
osm.setOsmId(osm.getId(), Integer.parseInt(ret.trim()));
osm.setChangesetId(getChangeset().getId());
} catch(NumberFormatException e) {
throw new OsmTransferException(tr("Unexpected format of new version of modified primitive ''{0}''. Got ''{1}''.", osm.getId(), ret));
}
}
/**
* Deletes an OSM primitive on the server.
* @param osm the primitive
* @throws OsmTransferException if something goes wrong
*/
public void deletePrimitive(OsmPrimitive osm, ProgressMonitor monitor) throws OsmTransferException {
ensureValidChangeset();
initialize(monitor);
// can't use a the individual DELETE method in the 0.6 API. Java doesn't allow
// submitting a DELETE request with content, the 0.6 API requires it, however. Falling back
// to diff upload.
//
uploadDiff(Collections.singleton(osm), monitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false));
}
/**
* Creates a new changeset based on the keys in <code>changeset</code>. If this
* method succeeds, changeset.getId() replies the id the server assigned to the new
* changeset
*
* The changeset must not be null, but its key/value-pairs may be empty.
*
* @param changeset the changeset toe be created. Must not be null.
* @param progressMonitor the progress monitor
* @throws OsmTransferException signifying a non-200 return code, or connection errors
* @throws IllegalArgumentException thrown if changeset is null
*/
public void openChangeset(Changeset changeset, ProgressMonitor progressMonitor) throws OsmTransferException {
CheckParameterUtil.ensureParameterNotNull(changeset, "changeset");
try {
progressMonitor.beginTask((tr("Creating changeset...")));
initialize(progressMonitor);
String ret = "";
try {
ret = sendRequest("PUT", "changeset/create", toXml(changeset),progressMonitor);
changeset.setId(Integer.parseInt(ret.trim()));
changeset.setOpen(true);
} catch(NumberFormatException e){
throw new OsmTransferException(tr("Unexpected format of ID replied by the server. Got ''{0}''.", ret));
}
progressMonitor.setCustomText((tr("Successfully opened changeset {0}",changeset.getId())));
} finally {
progressMonitor.finishTask();
}
}
/**
* Updates a changeset with the keys in <code>changesetUpdate</code>. The changeset must not
* be null and id > 0 must be true.
*
* @param changeset the changeset to update. Must not be null.
* @param monitor the progress monitor. If null, uses the {@see NullProgressMonitor#INSTANCE}.
*
* @throws OsmTransferException if something goes wrong.
* @throws IllegalArgumentException if changeset is null
* @throws IllegalArgumentException if changeset.getId() <= 0
*
*/
public void updateChangeset(Changeset changeset, ProgressMonitor monitor) throws OsmTransferException {
CheckParameterUtil.ensureParameterNotNull(changeset, "changeset");
if (monitor == null) {
monitor = NullProgressMonitor.INSTANCE;
}
if (changeset.getId() <= 0)
throw new IllegalArgumentException(tr("Changeset ID > 0 expected. Got {0}.", changeset.getId()));
try {
monitor.beginTask(tr("Updating changeset..."));
initialize(monitor);
monitor.setCustomText(tr("Updating changeset {0}...", changeset.getId()));
sendRequest(
"PUT",
"changeset/" + changeset.getId(),
toXml(changeset),
monitor
);
} catch(ChangesetClosedException e) {
e.setSource(ChangesetClosedException.Source.UPDATE_CHANGESET);
throw e;
} catch(OsmApiException e) {
if (e.getResponseCode() == HttpURLConnection.HTTP_CONFLICT && ChangesetClosedException.errorHeaderMatchesPattern(e.getErrorHeader()))
throw new ChangesetClosedException(e.getErrorHeader(), ChangesetClosedException.Source.UPDATE_CHANGESET);
throw e;
} finally {
monitor.finishTask();
}
}
/**
* Closes a changeset on the server. Sets changeset.setOpen(false) if this operation
* succeeds.
*
* @param changeset the changeset to be closed. Must not be null. changeset.getId() > 0 required.
* @param monitor the progress monitor. If null, uses {@see NullProgressMonitor#INSTANCE}
*
* @throws OsmTransferException if something goes wrong.
* @throws IllegalArgumentException thrown if changeset is null
* @throws IllegalArgumentException thrown if changeset.getId() <= 0
*/
public void closeChangeset(Changeset changeset, ProgressMonitor monitor) throws OsmTransferException {
CheckParameterUtil.ensureParameterNotNull(changeset, "changeset");
if (monitor == null) {
monitor = NullProgressMonitor.INSTANCE;
}
if (changeset.getId() <= 0)
throw new IllegalArgumentException(tr("Changeset ID > 0 expected. Got {0}.", changeset.getId()));
try {
monitor.beginTask(tr("Closing changeset..."));
initialize(monitor);
sendRequest("PUT", "changeset" + "/" + changeset.getId() + "/close", null, monitor);
changeset.setOpen(false);
} finally {
monitor.finishTask();
}
}
/**
* Uploads a list of changes in "diff" form to the server.
*
* @param list the list of changed OSM Primitives
* @param monitor the progress monitor
* @return list of processed primitives
* @throws OsmTransferException if something is wrong
*/
public Collection<OsmPrimitive> uploadDiff(Collection<OsmPrimitive> list, ProgressMonitor monitor) throws OsmTransferException {
try {
monitor.beginTask("", list.size() * 2);
if (changeset == null)
throw new OsmTransferException(tr("No changeset present for diff upload."));
initialize(monitor);
// prepare upload request
//
OsmChangeBuilder changeBuilder = new OsmChangeBuilder(changeset);
monitor.subTask(tr("Preparing upload request..."));
changeBuilder.start();
changeBuilder.append(list);
changeBuilder.finish();
String diffUploadRequest = changeBuilder.getDocument();
// Upload to the server
//
monitor.indeterminateSubTask(
trn("Uploading {0} object...", "Uploading {0} objects...", list.size(), list.size()));
String diffUploadResponse = sendRequest("POST", "changeset/" + changeset.getId() + "/upload", diffUploadRequest,monitor);
// Process the response from the server
//
DiffResultProcessor reader = new DiffResultProcessor(list);
reader.parse(diffUploadResponse, monitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false));
return reader.postProcess(
getChangeset(),
monitor.createSubTaskMonitor(ProgressMonitor.ALL_TICKS, false)
);
} catch(OsmTransferException e) {
throw e;
} catch(OsmDataParsingException e) {
throw new OsmTransferException(e);
} finally {
monitor.finishTask();
}
}
private void sleepAndListen(int retry, ProgressMonitor monitor) throws OsmTransferCancelledException {
System.out.print(tr("Waiting 10 seconds ... "));
for(int i=0; i < 10; i++) {
if (monitor != null) {
monitor.setCustomText(tr("Starting retry {0} of {1} in {2} seconds ...", getMaxRetries() - retry,getMaxRetries(), 10-i));
}
if (cancel)
throw new OsmTransferCancelledException();
try {
Thread.sleep(1000);
} catch (InterruptedException ex) {}
}
System.out.println(tr("OK - trying again."));
}
/**
* Replies the max. number of retries in case of 5XX errors on the server
*
* @return the max number of retries
*/
protected int getMaxRetries() {
int ret = Main.pref.getInteger("osm-server.max-num-retries", DEFAULT_MAX_NUM_RETRIES);
return Math.max(ret,0);
}
protected boolean isUsingOAuth() {
String authMethod = Main.pref.get("osm-server.auth-method", "basic");
return authMethod.equals("oauth");
}
private String sendRequest(String requestMethod, String urlSuffix,String requestBody, ProgressMonitor monitor) throws OsmTransferException {
return sendRequest(requestMethod, urlSuffix, requestBody, monitor, true);
}
/**
* Generic method for sending requests to the OSM API.
*
* This method will automatically re-try any requests that are answered with a 5xx
* error code, or that resulted in a timeout exception from the TCP layer.
*
* @param requestMethod The http method used when talking with the server.
* @param urlSuffix The suffix to add at the server url, not including the version number,
* but including any object ids (e.g. "/way/1234/history").
* @param requestBody the body of the HTTP request, if any.
* @param monitor the progress monitor
* @param doAuthenticate set to true, if the request sent to the server shall include authentication
* credentials;
*
* @return the body of the HTTP response, if and only if the response code was "200 OK".
* @exception OsmTransferException if the HTTP return code was not 200 (and retries have
* been exhausted), or rewrapping a Java exception.
*/
private String sendRequest(String requestMethod, String urlSuffix,String requestBody, ProgressMonitor monitor, boolean doAuthenticate) throws OsmTransferException {
StringBuffer responseBody = new StringBuffer();
int retries = getMaxRetries();
while(true) { // the retry loop
try {
URL url = new URL(new URL(getBaseUrl()), urlSuffix);
System.out.print(requestMethod + " " + url + "... ");
activeConnection = (HttpURLConnection)url.openConnection();
activeConnection.setConnectTimeout(15000);
activeConnection.setRequestMethod(requestMethod);
if (doAuthenticate) {
addAuth(activeConnection);
}
if (requestMethod.equals("PUT") || requestMethod.equals("POST") || requestMethod.equals("DELETE")) {
activeConnection.setDoOutput(true);
activeConnection.setRequestProperty("Content-type", "text/xml");
OutputStream out = activeConnection.getOutputStream();
// It seems that certain bits of the Ruby API are very unhappy upon
// receipt of a PUT/POST message without a Content-length header,
// even if the request has no payload.
// Since Java will not generate a Content-length header unless
// we use the output stream, we create an output stream for PUT/POST
// even if there is no payload.
if (requestBody != null) {
BufferedWriter bwr = new BufferedWriter(new OutputStreamWriter(out, "UTF-8"));
bwr.write(requestBody);
bwr.flush();
}
out.close();
}
activeConnection.connect();
System.out.println(activeConnection.getResponseMessage());
int retCode = activeConnection.getResponseCode();
if (retCode >= 500) {
if (retries-- > 0) {
sleepAndListen(retries, monitor);
System.out.println(tr("Starting retry {0} of {1}.", getMaxRetries() - retries,getMaxRetries()));
continue;
}
}
// populate return fields.
responseBody.setLength(0);
// If the API returned an error code like 403 forbidden, getInputStream
// will fail with an IOException.
InputStream i = null;
try {
i = activeConnection.getInputStream();
} catch (IOException ioe) {
i = activeConnection.getErrorStream();
}
if (i != null) {
// the input stream can be null if both the input and the error stream
// are null. Seems to be the case if the OSM server replies a 401
// Unauthorized, see #3887.
//
BufferedReader in = new BufferedReader(new InputStreamReader(i));
String s;
while((s = in.readLine()) != null) {
responseBody.append(s);
responseBody.append("\n");
}
}
String errorHeader = null;
// Look for a detailed error message from the server
if (activeConnection.getHeaderField("Error") != null) {
errorHeader = activeConnection.getHeaderField("Error");
System.err.println("Error header: " + errorHeader);
} else if (retCode != 200 && responseBody.length()>0) {
System.err.println("Error body: " + responseBody);
}
activeConnection.disconnect();
errorHeader = errorHeader == null? null : errorHeader.trim();
String errorBody = responseBody.length() == 0? null : responseBody.toString().trim();
switch(retCode) {
case HttpURLConnection.HTTP_OK:
return responseBody.toString();
case HttpURLConnection.HTTP_GONE:
throw new OsmApiPrimitiveGoneException(errorHeader, errorBody);
case HttpURLConnection.HTTP_CONFLICT:
if (ChangesetClosedException.errorHeaderMatchesPattern(errorHeader))
throw new ChangesetClosedException(errorBody, ChangesetClosedException.Source.UPLOAD_DATA);
else
throw new OsmApiException(retCode, errorHeader, errorBody);
case HttpURLConnection.HTTP_FORBIDDEN:
OsmApiException e = new OsmApiException(retCode, errorHeader, errorBody);
e.setAccessedUrl(activeConnection.getURL().toString());
throw e;
default:
throw new OsmApiException(retCode, errorHeader, errorBody);
}
} catch (UnknownHostException e) {
throw new OsmTransferException(e);
} catch (SocketTimeoutException e) {
if (retries-- > 0) {
continue;
}
throw new OsmTransferException(e);
} catch (ConnectException e) {
if (retries-- > 0) {
continue;
}
throw new OsmTransferException(e);
} catch(IOException e){
throw new OsmTransferException(e);
} catch(OsmTransferCancelledException e){
throw e;
} catch(OsmTransferException e) {
throw e;
}
}
}
/**
* returns the API capabilities; null, if the API is not initialized yet
*
* @return the API capabilities
*/
public Capabilities getCapabilities() {
return capabilities;
}
/**
* Ensures that the current changeset can be used for uploading data
*
* @throws OsmTransferException thrown if the current changeset can't be used for
* uploading data
*/
protected void ensureValidChangeset() throws OsmTransferException {
if (changeset == null)
throw new OsmTransferException(tr("Current changeset is null. Cannot upload data."));
if (changeset.getId() <= 0)
throw new OsmTransferException(tr("ID of current changeset > 0 required. Current ID is {0}.", changeset.getId()));
}
/**
* Replies the changeset data uploads are currently directed to
*
* @return the changeset data uploads are currently directed to
*/
public Changeset getChangeset() {
return changeset;
}
/**
* Sets the changesets to which further data uploads are directed. The changeset
* can be null. If it isn't null it must have been created, i.e. id > 0 is required. Furthermore,
* it must be open.
*
* @param changeset the changeset
* @throws IllegalArgumentException thrown if changeset.getId() <= 0
* @throws IllegalArgumentException thrown if !changeset.isOpen()
*/
public void setChangeset(Changeset changeset) {
if (changeset == null) {
this.changeset = null;
return;
}
if (changeset.getId() <= 0)
throw new IllegalArgumentException(tr("Changeset ID > 0 expected. Got {0}.", changeset.getId()));
if (!changeset.isOpen())
throw new IllegalArgumentException(tr("Open changeset expected. Got closed changeset with id {0}.", changeset.getId()));
this.changeset = changeset;
}
}