001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.io.remotecontrol.handler; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.util.Collection; 007import java.util.HashSet; 008import java.util.LinkedList; 009import java.util.List; 010 011import org.openstreetmap.josm.data.osm.DataSet; 012import org.openstreetmap.josm.data.osm.OsmPrimitive; 013import org.openstreetmap.josm.data.osm.PrimitiveId; 014import org.openstreetmap.josm.data.osm.SimplePrimitiveId; 015import org.openstreetmap.josm.gui.MainApplication; 016import org.openstreetmap.josm.gui.io.DownloadPrimitivesWithReferrersTask; 017import org.openstreetmap.josm.gui.util.GuiHelper; 018import org.openstreetmap.josm.io.remotecontrol.AddTagsDialog; 019import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault; 020import org.openstreetmap.josm.tools.Logging; 021 022/** 023 * Loads OSM primitives using their ID 024 * similar to the "Download object" dialog (@see DownloadPrimitiveAction}. 025 * For instance, {@code /load_object?objects=n1,w2,r3[&new_layer=false&relation_members=true]}. 026 */ 027public class LoadObjectHandler extends RequestHandler { 028 029 /** 030 * The remote control command name used to load objects using their ID. 031 */ 032 public static final String command = "load_object"; 033 034 private final List<PrimitiveId> ps = new LinkedList<>(); 035 036 @Override 037 public String[] getMandatoryParams() { 038 return new String[]{"objects"}; 039 } 040 041 @Override 042 public String[] getOptionalParams() { 043 return new String[] {"new_layer", "layer_name", "addtags", "relation_members", "referrers"}; 044 } 045 046 @Override 047 public String getUsage() { 048 return "downloads the specified objects from the server"; 049 } 050 051 @Override 052 public String[] getUsageExamples() { 053 return new String[] {"/load_object?new_layer=true&objects=w106159509", 054 "/load_object?new_layer=true&objects=r2263653&relation_members=true", 055 "/load_object?objects=n100000&referrers=false" 056 }; 057 } 058 059 @Override 060 protected void handleRequest() throws RequestHandlerErrorException, RequestHandlerBadRequestException { 061 if (!PermissionPrefWithDefault.LOAD_DATA.isAllowed()) { 062 Logging.info("RemoteControl: download forbidden by preferences"); 063 } 064 if (!ps.isEmpty()) { 065 final boolean newLayer = isLoadInNewLayer(); 066 final boolean relationMembers = Boolean.parseBoolean(args.get("relation_members")); 067 final boolean referrers = Boolean.parseBoolean(args.get("referrers")); 068 final DownloadPrimitivesWithReferrersTask task = new DownloadPrimitivesWithReferrersTask( 069 newLayer, ps, referrers, relationMembers, args.get("layer_name"), null); 070 MainApplication.worker.submit(task); 071 MainApplication.worker.submit(() -> { 072 final List<PrimitiveId> downloaded = task.getDownloadedId(); 073 final DataSet ds = MainApplication.getLayerManager().getEditDataSet(); 074 if (downloaded != null) { 075 GuiHelper.runInEDT(() -> ds.setSelected(downloaded)); 076 Collection<OsmPrimitive> downlPrim = new HashSet<>(); 077 for (PrimitiveId id : downloaded) { 078 downlPrim.add(ds.getPrimitiveById(id)); 079 } 080 AddTagsDialog.addTags(args, sender, downlPrim); 081 } 082 ps.clear(); 083 }); 084 } 085 } 086 087 @Override 088 public String getPermissionMessage() { 089 return tr("Remote Control has been asked to load objects (specified by their id) from the API."); 090 } 091 092 @Override 093 public PermissionPrefWithDefault getPermissionPref() { 094 return PermissionPrefWithDefault.LOAD_DATA; 095 } 096 097 @Override 098 protected void validateRequest() throws RequestHandlerBadRequestException { 099 ps.clear(); 100 for (String i : (args != null ? args.get("objects") : "").split(",\\s*")) { 101 if (!i.isEmpty()) { 102 try { 103 ps.add(SimplePrimitiveId.fromString(i)); 104 } catch (IllegalArgumentException e) { 105 Logging.log(Logging.LEVEL_WARN, "RemoteControl: invalid selection '"+i+"' ignored.", e); 106 } 107 } 108 } 109 } 110}