// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.io;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.text.DateFormat;
import java.text.MessageFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.openstreetmap.josm.data.Bounds;
import org.openstreetmap.josm.data.coor.LatLon;
import org.openstreetmap.josm.tools.CheckParameterUtil;
public class ChangesetQuery {
/**
* Replies a changeset query object from the query part of a OSM API URL for querying
* changesets.
*
* @param query the query part
* @return the query object
* @throws ChangesetQueryUrlException thrown if query doesn't consist of valid query parameters
*
*/
static public ChangesetQuery buildFromUrlQuery(String query) throws ChangesetQueryUrlException{
return new ChangesetQueryUrlParser().parse(query);
}
/** the user id this query is restricted to. null, if no restriction to a user id applies */
private Integer uid = null;
/** the user name this query is restricted to. null, if no restriction to a user name applies */
private String userName = null;
/** the bounding box this query is restricted to. null, if no restriction to a bounding box applies */
private Bounds bounds = null;
private Date closedAfter = null;
private Date createdBefore = null;
/** indicates whether only open changesets are queried. null, if no restrictions regarding open changesets apply */
private Boolean open = null;
/** indicates whether only closed changesets are queried. null, if no restrictions regarding open changesets apply */
private Boolean closed = null;
public ChangesetQuery() {}
/**
* Restricts the query to changesets owned by the user with id <code>uid</code>.
*
* @param uid the uid of the user. >0 expected.
* @return the query object with the applied restriction
* @throws IllegalArgumentException thrown if uid <= 0
* @see #forUser(String)
*/
public ChangesetQuery forUser(int uid) throws IllegalArgumentException{
if (uid <= 0)
throw new IllegalArgumentException(MessageFormat.format("Parameter ''{0}'' > 0 expected. Got ''{1}''.", "uid", uid));
this.uid = uid;
this.userName = null;
return this;
}
/**
* Restricts the query to changesets owned by the user with user name <code>username</code>.
*
* Caveat: for historical reasons the username might not be unique! It is recommended to use
* {@see #forUser(int)} to restrict the query to a specific user.
*
* @param username the username. Must not be null.
* @return the query object with the applied restriction
* @throws IllegalArgumentException thrown if username is null.
* @see #forUser(int)
*/
public ChangesetQuery forUser(String username) {
CheckParameterUtil.ensureParameterNotNull(username, "username");
this.userName = username;
this.uid = 0;
return this;
}
/**
* Replies true if this query is restricted to user whom we only know the user name
* for.
*
* @return true if this query is restricted to user whom we only know the user name
* for
*/
public boolean isRestrictedToPartiallyIdentifiedUser() {
return userName != null;
}
/**
* Replies the user name which this query is restricted to. null, if this query isn't
* restricted to a user name, i.e. if {@see #isRestrictedToPartiallyIdentifiedUser()} is false.
*
* @return the user name which this query is restricted to
*/
public String getUserName() {
return userName;
}
/**
* Replies true if this query is restricted to user whom know the user id for.
*
* @return true if this query is restricted to user whom know the user id for
*/
public boolean isRestrictedToFullyIdentifiedUser() {
return uid > 0;
}
/**
* Replies a query which is restricted to a bounding box.
*
* @param minLon min longitude of the bounding box. Valid longitude value expected.
* @param minLat min latitude of the bounding box. Valid latitude value expected.
* @param maxLon max longitude of the bounding box. Valid longitude value expected.
* @param maxLat max latitude of the bounding box. Valid latitude value expected.
*
* @return the restricted changeset query
* @throws IllegalArgumentException thrown if either of the parameters isn't a valid longitude or
* latitude value
*/
public ChangesetQuery inBbox(double minLon, double minLat, double maxLon, double maxLat) throws IllegalArgumentException{
if (!LatLon.isValidLon(minLon))
throw new IllegalArgumentException(tr("Illegal longitude value for parameter ''{0}'', got {1}", "minLon", minLon));
if (!LatLon.isValidLon(maxLon))
throw new IllegalArgumentException(tr("Illegal longitude value for parameter ''{0}'', got {1}", "maxLon", maxLon));
if (!LatLon.isValidLat(minLat))
throw new IllegalArgumentException(tr("Illegal latitude value for parameter ''{0}'', got {1}", "minLat", minLat));
if (!LatLon.isValidLat(maxLat))
throw new IllegalArgumentException(tr("Illegal longitude value for parameter ''{0}'', got {1}", "maxLat", maxLat));
return inBbox(new LatLon(minLon, minLat), new LatLon(maxLon, maxLat));
}
/**
* Replies a query which is restricted to a bounding box.
*
* @param min the min lat/lon coordinates of the bounding box. Must not be null.
* @param max the max lat/lon coordiantes of the bounding box. Must not be null.
*
* @return the restricted changeset query
* @throws IllegalArgumentException thrown if min is null
* @throws IllegalArgumentException thrown if max is null
*/
public ChangesetQuery inBbox(LatLon min, LatLon max) {
CheckParameterUtil.ensureParameterNotNull(min, "min");
CheckParameterUtil.ensureParameterNotNull(max, "max");
this.bounds = new Bounds(min,max);
return this;
}
/**
* Replies a query which is restricted to a bounding box given by <code>bbox</code>.
*
* @param bbox the bounding box. Must not be null.
* @return the changeset query
* @throws IllegalArgumentException thrown if bbox is null.
*/
public ChangesetQuery inBbox(Bounds bbox) throws IllegalArgumentException {
CheckParameterUtil.ensureParameterNotNull(bbox, "bbox");
this.bounds = bbox;
return this;
}
/**
* Restricts the result to changesets which have been closed after the date given by <code>d</code>.
* <code>d</code> d is a date relative to the current time zone.
*
* @param d the date . Must not be null.
* @return the restricted changeset query
* @throws IllegalArgumentException thrown if d is null
*/
public ChangesetQuery closedAfter(Date d) throws IllegalArgumentException{
CheckParameterUtil.ensureParameterNotNull(d, "d");
this.closedAfter = d;
return this;
}
/**
* Restricts the result to changesets which have been closed after <code>closedAfter</code> and which
* habe been created before <code>createdBefore</code>. Both dates are expressed relative to the current
* time zone.
*
* @param closedAfter only reply changesets closed after this date. Must not be null.
* @param createdBefore only reply changesets created before this date. Must not be null.
* @return the restricted changeset query
* @throws IllegalArgumentException thrown if closedAfter is null
* @throws IllegalArgumentException thrown if createdBefore is null
*/
public ChangesetQuery closedAfterAndCreatedBefore(Date closedAfter, Date createdBefore ) throws IllegalArgumentException{
CheckParameterUtil.ensureParameterNotNull(closedAfter, "closedAfter");
CheckParameterUtil.ensureParameterNotNull(createdBefore, "createdBefore");
this.closedAfter = closedAfter;
this.createdBefore = createdBefore;
return this;
}
/**
* Restricts the result to changesets which are or aren't open, depending on the value of
* <code>isOpen</code>
*
* @param isOpen whether changesets should or should not be open
* @return the restricted changeset query
*/
public ChangesetQuery beingOpen(boolean isOpen) {
this.open = isOpen;
return this;
}
/**
* Restricts the result to changesets which are or aren't closed, depending on the value of
* <code>isClosed</code>
*
* @param isClosed whether changesets should or should not be open
* @return the restricted changeset query
*/
public ChangesetQuery beingClosed(boolean isClosed) {
this.closed = isClosed;
return this;
}
/**
* Replies the query string to be used in a query URL for the OSM API.
*
* @return the query string
*/
public String getQueryString() {
StringBuffer sb = new StringBuffer();
if (uid != null) {
sb.append("user").append("=").append(uid);
} else if (userName != null) {
sb.append("display_name").append("=").append(userName);
}
if (bounds != null) {
if (sb.length() > 0) {
sb.append("&");
}
sb.append("bbox=").append(bounds.encodeAsString(","));
}
if (closedAfter != null && createdBefore != null) {
if (sb.length() > 0) {
sb.append("&");
}
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssz");
sb.append("time").append("=").append(df.format(closedAfter));
sb.append(",").append(df.format(createdBefore));
} else if (closedAfter != null) {
if (sb.length() > 0) {
sb.append("&");
}
SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssz");
sb.append("time").append("=").append(df.format(closedAfter));
}
if (open != null) {
if (sb.length() > 0) {
sb.append("&");
}
sb.append("open=").append(Boolean.toString(open));
} else if (closed != null) {
if (sb.length() > 0) {
sb.append("&");
}
sb.append("closed=").append(Boolean.toString(closed));
}
return sb.toString();
}
public static class ChangesetQueryUrlException extends Exception {
public ChangesetQueryUrlException() {
super();
}
public ChangesetQueryUrlException(String arg0, Throwable arg1) {
super(arg0, arg1);
}
public ChangesetQueryUrlException(String arg0) {
super(arg0);
}
public ChangesetQueryUrlException(Throwable arg0) {
super(arg0);
}
}
public static class ChangesetQueryUrlParser {
protected int parseUid(String value) throws ChangesetQueryUrlException {
if (value == null || value.trim().equals(""))
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", "uid",value));
int id;
try {
id = Integer.parseInt(value);
if (id <= 0)
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", "uid",value));
} catch(NumberFormatException e) {
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", "uid",value));
}
return id;
}
protected boolean parseOpen(String value) throws ChangesetQueryUrlException {
if (value == null || value.trim().equals(""))
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", "open",value));
if (value.equals("true"))
return true;
else if (value.equals("false"))
return false;
else
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", "open",value));
}
protected boolean parseBoolean(String value, String parameter) throws ChangesetQueryUrlException {
if (value == null || value.trim().equals(""))
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", parameter,value));
if (value.equals("true"))
return true;
else if (value.equals("false"))
return false;
else
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", parameter,value));
}
protected Date parseDate(String value, String parameter) throws ChangesetQueryUrlException {
if (value == null || value.trim().equals(""))
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", parameter,value));
if (value.endsWith("Z")) {
// OSM API generates date strings we time zone abbreviation "Z" which Java SimpleDateFormat
// doesn't understand. Convert into GMT time zone before parsing.
//
value = value.substring(0,value.length() - 1) + "GMT+00:00";
}
DateFormat formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ssz");
try {
return formatter.parse(value);
} catch(ParseException e) {
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", parameter,value));
}
}
protected Date[] parseTime(String value) throws ChangesetQueryUrlException {
String[] dates = value.split(",");
if (dates == null || dates.length == 0 || dates.length > 2)
throw new ChangesetQueryUrlException(tr("Unexpected value for ''{0}'' in changeset query url, got {1}", "time", value));
if (dates.length == 1)
return new Date[]{parseDate(dates[0], "time")};
else if (dates.length == 2)
return new Date[]{parseDate(dates[0], "time"),parseDate(dates[1], "time")};
return null;
}
protected ChangesetQuery crateFromMap(Map<String,String> queryParams) throws ChangesetQueryUrlException {
ChangesetQuery csQuery = new ChangesetQuery();
for (String k: queryParams.keySet()) {
if (k.equals("uid")) {
if (queryParams.containsKey("display_name"))
throw new ChangesetQueryUrlException(tr("Cannot create a changeset query including both the query parameters ''uid'' and ''display_name''"));
csQuery.forUser(parseUid(queryParams.get("uid")));
} else if (k.equals("display_name")) {
if (queryParams.containsKey("uid"))
throw new ChangesetQueryUrlException(tr("Cannot create a changeset query including both the query parameters ''uid'' and ''display_name''"));
csQuery.forUser(queryParams.get("display_name"));
} else if (k.equals("open")) {
boolean b = parseBoolean(queryParams.get(k), "open");
csQuery.beingOpen(b);
} else if (k.equals("closed")) {
boolean b = parseBoolean(queryParams.get(k), "closed");
csQuery.beingClosed(b);
} else if (k.equals("time")) {
Date[] dates = parseTime(queryParams.get(k));
switch(dates.length) {
case 1:
csQuery.closedAfter(dates[0]);
break;
case 2:
csQuery.closedAfterAndCreatedBefore(dates[0], dates[1]);
break;
}
} else if (k.equals("bbox")) {
try {
csQuery.inBbox(new Bounds(queryParams.get(k), ","));
} catch(IllegalArgumentException e) {
throw new ChangesetQueryUrlException(e);
}
} else
throw new ChangesetQueryUrlException(tr("Unsupported parameter ''{0}'' in changeset query string",k ));
}
return csQuery;
}
protected Map<String,String> createMapFromQueryString(String query) {
Map<String,String> queryParams = new HashMap<String, String>();
String[] keyValuePairs = query.split("&");
for (String keyValuePair: keyValuePairs) {
String[] kv = keyValuePair.split("=");
queryParams.put(kv[0], kv[1]);
}
return queryParams;
}
/**
* Parses the changeset query given as URL query parameters and replies a
* {@see ChangesetQuery}
*
* <code>query</code> is the query part of a API url for querying changesets,
* see <a href="http://wiki.openstreetmap.org/wiki/API_v0.6#Query:_GET_.2Fapi.2F0.6.2Fchangesets">OSM API</a>.
*
* Example for an query string:<br>
* <pre>
* uid=1234&open=true
* </pre>
*
* @param query the query string. If null, an empty query (identical to a query for all changesets) is
* assumed
* @return the changeset query
* @throws ChangesetQueryUrlException if the query string doesn't represent a legal query for changesets
*/
public ChangesetQuery parse(String query) throws ChangesetQueryUrlException{
if (query == null)
return new ChangesetQuery();
query = query.trim();
if (query.equals(""))
return new ChangesetQuery();
Map<String,String> queryParams = createMapFromQueryString(query);
return crateFromMap(queryParams);
}
}
}