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