// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.tools;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.SocketException;
import java.net.URL;
import java.net.UnknownHostException;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.io.ChangesetClosedException;
import org.openstreetmap.josm.io.OsmApi;
import org.openstreetmap.josm.io.OsmApiException;
import org.openstreetmap.josm.io.OsmApiInitializationException;
import org.openstreetmap.josm.io.OsmTransferException;
public class ExceptionUtil {
private ExceptionUtil() {
}
/**
* handles an exception caught during OSM API initialization
*
* @param e the exception
*/
public static String explainOsmApiInitializationException(OsmApiInitializationException e) {
e.printStackTrace();
String msg = tr(
"Failed to initialize communication with the OSM server {0}.
"
+ "Check the server URL in your preferences and your internet connection.", Main.pref.get(
"osm-server.url", "http://api.openstreetmap.org/api"));
return msg;
}
/**
* Explains a precondition exception when a child relation could not be deleted because
* it is still referred to by an undeleted parent relation.
*
* @param e the exception
* @param childRelation the child relation
* @param parentRelation the parent relation
* @return
*/
public static String explainDeletedRelationStillInUse(OsmApiException e, long childRelation, long parentRelation) {
String msg = tr(
"Failed to delete relation {0}."
+ " It is still referred to by relation {1}.
"
+ "Please load relation {1}, remove the reference to relation {0}, and upload again.",
childRelation,parentRelation
);
return msg;
}
/**
* Explains an upload error due to a violated precondition, i.e. a HTTP return code 412
*
* @param e the exception
*/
public static String explainPreconditionFailed(OsmApiException e) {
e.printStackTrace();
String msg = e.getErrorHeader();
if (msg != null) {
String pattern = "Precondition failed: The relation (\\d+) is used in relation (\\d+)\\.";
Pattern p = Pattern.compile(pattern);
Matcher m = p.matcher(msg);
if (m.matches()) {
long childRelation = Long.parseLong(m.group(1));
long parentRelation = Long.parseLong(m.group(2));
return explainDeletedRelationStillInUse(e, childRelation, parentRelation);
}
}
msg = tr(
"Uploading to the server failed because your current
"
+ "dataset violates a precondition.
" + "The error message is:
" + "{0}" + "", e
.getMessage().replace("&", "&").replace("<", "<").replace(">", ">"));
return msg;
}
/**
* Explains an error due to a 409 conflict
*
* @param e the exception
*/
public static String explainConflict(OsmApiException e) {
e.printStackTrace();
String msg = e.getErrorHeader();
if (msg != null) {
String pattern = "The changeset (\\d+) was closed at (.*)";
Pattern p = Pattern.compile(pattern);
Matcher m = p.matcher(msg);
if (m.matches()) {
long changesetId = Long.parseLong(m.group(1));
// Example: Tue Oct 15 10:00:00 UTC 2009. Always parsed with english locale, regardless
// of the current locale in JOSM
DateFormat formatter = new SimpleDateFormat("EEE MMM dd HH:mm:ss zzz yyyy", Locale.ENGLISH);
Date closeDate = null;
try {
closeDate = formatter.parse(m.group(2));
} catch(ParseException ex) {
System.err.println(tr("Failed to parse date ''{0}'' replied by server.", m.group(2)));
ex.printStackTrace();
}
if (closeDate == null) {
msg = tr(
"Closing of changeset {0} failed
because it has already been closed.",
changesetId
);
} else {
SimpleDateFormat dateFormat = new SimpleDateFormat();
msg = tr(
"Closing of changeset {0} failed
"
+" because it has already been closed on {1}.",
changesetId,
dateFormat.format(closeDate)
);
}
return msg;
}
msg = tr(
"The server reported that it has detected a conflict.
" +
"Error message (untranslated):
{0}",
msg
);
}
msg = tr(
"The server reported that it has detected a conflict."
);
return msg;
}
/**
* Explains an exception thrown during upload because the changeset which data is
* uploaded to is already closed.
*
* @param e the exception
*/
public static String explainChangesetClosedException(ChangesetClosedException e) {
String msg;
SimpleDateFormat dateFormat = new SimpleDateFormat();
msg = tr(
"Failed to upload to changeset {0}
"
+"because it has already been closed on {1}.",
e.getChangesetId(),
dateFormat.format(e.getClosedOn())
);
e.printStackTrace();
return msg;
}
/**
* Explains an exception with a generic message dialog
*
* @param e the exception
*/
public static String explainGeneric(Exception e) {
String msg = e.getMessage();
if (msg == null || msg.trim().equals("")) {
msg = e.toString();
}
e.printStackTrace();
return msg;
}
/**
* Explains a {@see SecurityException} which has caused an {@see OsmTransferException}.
* This is most likely happening when user tries to access the OSM API from within an
* applet which wasn't loaded from the API server.
*
* @param e the exception
*/
public static String explainSecurityException(OsmTransferException e) {
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String host = tr("unknown");
try {
host = new URL(apiUrl).getHost();
} catch (MalformedURLException ex) {
// shouldn't happen
}
String message = tr("Failed to open a connection to the remote server
" + "''{0}''
"
+ "for security reasons. This is most likely because you are running
"
+ "in an applet and because you didn''t load your applet from ''{1}''.", apiUrl, host);
return message;
}
/**
* Explains a {@see SocketException} which has caused an {@see OsmTransferException}.
* This is most likely because there's not connection to the Internet or because
* the remote server is not reachable.
*
* @param e the exception
*/
public static String explainNestedSocketException(OsmTransferException e) {
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String message = tr("Failed to open a connection to the remote server
" + "''{0}''.
"
+ "Please check your internet connection.", apiUrl);
e.printStackTrace();
return message;
}
/**
* Explains a {@see IOException} which has caused an {@see OsmTransferException}.
* This is most likely happening when the communication with the remote server is
* interrupted for any reason.
*
* @param e the exception
*/
public static String explainNestedIOException(OsmTransferException e) {
IOException ioe = getNestedException(e, IOException.class);
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String message = tr("Failed to upload data to or download data from
" + "''{0}''
"
+ "due to a problem with transferring data.
" + "Details(untranslated): {1}", apiUrl, ioe
.getMessage());
e.printStackTrace();
return message;
}
/**
* Explains a {@see OsmApiException} which was thrown because of an internal server
* error in the OSM API server..
*
* @param e the exception
*/
public static String explainInternalServerError(OsmTransferException e) {
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String message = tr("The OSM server
" + "''{0}''
" + "reported an internal server error.
"
+ "This is most likely a temporary problem. Please try again later.", apiUrl);
e.printStackTrace();
return message;
}
/**
* Explains a {@see OsmApiException} which was thrown because of a bad
* request
*
* @param e the exception
*/
public static String explainBadRequest(OsmApiException e) {
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String message = tr("The OSM server ''{0}'' reported a bad request.
", apiUrl);
if (e.getErrorHeader() != null && e.getErrorHeader().startsWith("The maximum bbox")) {
message += "
"
+ tr("The area you tried to download is too big or your request was too large."
+ "
Either request a smaller area or use an export file provided by the OSM community.");
} else if (e.getErrorHeader() != null) {
message += tr("
Error message(untranslated): {0}", e.getErrorHeader());
}
message = "" + message + "";
e.printStackTrace();
return message;
}
/**
* Explains a {@see OsmApiException} which was thrown because a resource wasn't found.
*
* @param e the exception
*/
public static String explainNotFound(OsmApiException e) {
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String message = tr("The OSM server ''{0}'' doesn''t know about an object
"
+ "you tried to read, update, or delete. Either the respective object
"
+ "doesn''t exist on the server or you''re using an invalid URL to access
"
+ "it. Please carefully check the servers address ''{0}'' for typos."
, apiUrl);
message = "" + message + "";
e.printStackTrace();
return message;
}
/**
* Explains a {@see UnknownHostException} which has caused an {@see OsmTransferException}.
* This is most likely happening when there is an error in the API URL or when
* local DNS services are not working.
*
* @param e the exception
*/
public static String explainNestedUnkonwnHostException(OsmTransferException e) {
String apiUrl = OsmApi.getOsmApi().getBaseUrl();
String host = tr("unknown");
try {
host = new URL(apiUrl).getHost();
} catch (MalformedURLException ex) {
// shouldn't happen
}
String message = tr("Failed to open a connection to the remote server
" + "''{0}''.
"
+ "Host name ''{1}'' couldn''t be resolved.
"
+ "Please check the API URL in your preferences and your internet connection.", apiUrl, host);
e.printStackTrace();
return message;
}
/**
* Replies the first nested exception of type nestedClass (including
* the root exception e) or null, if no such exception is found.
*
* @param
* @param e the root exception
* @param nestedClass the type of the nested exception
* @return the first nested exception of type nestedClass (including
* the root exception e) or null, if no such exception is found.
*/
protected static T getNestedException(Exception e, Class nestedClass) {
Throwable t = e;
while (t != null && !(nestedClass.isInstance(t))) {
t = t.getCause();
}
if (t == null)
return null;
else if (nestedClass.isInstance(t))
return nestedClass.cast(t);
return null;
}
/**
* Explains an {@see OsmTransferException} to the user.
*
* @param e the {@see OsmTransferException}
*/
public static String explainOsmTransferException(OsmTransferException e) {
if (getNestedException(e, SecurityException.class) != null)
return explainSecurityException(e);
if (getNestedException(e, SocketException.class) != null)
return explainNestedSocketException(e);
if (getNestedException(e, UnknownHostException.class) != null)
return explainNestedUnkonwnHostException(e);
if (getNestedException(e, IOException.class) != null)
return explainNestedIOException(e);
if (e instanceof OsmApiInitializationException)
return explainOsmApiInitializationException((OsmApiInitializationException) e);
if (e instanceof ChangesetClosedException)
return explainChangesetClosedException((ChangesetClosedException)e);
if (e instanceof OsmApiException) {
OsmApiException oae = (OsmApiException) e;
if (oae.getResponseCode() == HttpURLConnection.HTTP_PRECON_FAILED)
return explainPreconditionFailed(oae);
if (oae.getResponseCode() == HttpURLConnection.HTTP_GONE)
return explainGoneForUnknownPrimitive(oae);
if (oae.getResponseCode() == HttpURLConnection.HTTP_INTERNAL_ERROR)
return explainInternalServerError(oae);
if (oae.getResponseCode() == HttpURLConnection.HTTP_BAD_REQUEST)
return explainBadRequest(oae);
}
return explainGeneric(e);
}
/**
* explains the case of an error due to a delete request on an already deleted
* {@see OsmPrimitive}, i.e. a HTTP response code 410, where we don't know which
* {@see OsmPrimitive} is causing the error.
*
* @param e the exception
*/
public static String explainGoneForUnknownPrimitive(OsmApiException e) {
String msg = tr(
"The server reports that an object is deleted.
"
+ "Uploading failed if you tried to update or delete this object.
"
+ "Downloading failed if you tried to download this object.
"
+ "
"
+ "The error message is:
" + "{0}"
+ "", e.getMessage().replace("&", "&").replace("<", "<").replace(">", ">"));
return msg;
}
/**
* Explains an {@see Exception} to the user.
*
* @param e the {@see Exception}
*/
public static String explainException(Exception e) {
String msg = "";
if (e instanceof OsmTransferException) {
msg = explainOsmTransferException((OsmTransferException) e);
} else {
msg = explainGeneric(e);
}
e.printStackTrace();
return msg;
}
}