001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.actions; 003 004import static org.openstreetmap.josm.gui.help.HelpUtil.ht; 005import static org.openstreetmap.josm.tools.I18n.tr; 006 007import java.awt.GridBagLayout; 008import java.awt.GridLayout; 009import java.awt.event.ActionEvent; 010import java.awt.event.KeyEvent; 011import java.util.ArrayList; 012import java.util.Collection; 013import java.util.Collections; 014import java.util.LinkedList; 015import java.util.List; 016import java.util.Objects; 017import java.util.concurrent.Future; 018import java.util.stream.Collectors; 019 020import javax.swing.JCheckBox; 021import javax.swing.JLabel; 022import javax.swing.JList; 023import javax.swing.JOptionPane; 024import javax.swing.JPanel; 025 026import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask; 027import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesTask; 028import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesUrlBoundsTask; 029import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesUrlIdTask; 030import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmChangeCompressedTask; 031import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmChangeTask; 032import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmCompressedTask; 033import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmIdTask; 034import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask; 035import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmUrlTask; 036import org.openstreetmap.josm.actions.downloadtasks.DownloadParams; 037import org.openstreetmap.josm.actions.downloadtasks.DownloadSessionTask; 038import org.openstreetmap.josm.actions.downloadtasks.DownloadTask; 039import org.openstreetmap.josm.actions.downloadtasks.PostDownloadHandler; 040import org.openstreetmap.josm.data.preferences.BooleanProperty; 041import org.openstreetmap.josm.gui.ExtendedDialog; 042import org.openstreetmap.josm.gui.HelpAwareOptionPane; 043import org.openstreetmap.josm.gui.MainApplication; 044import org.openstreetmap.josm.gui.progress.swing.PleaseWaitProgressMonitor; 045import org.openstreetmap.josm.gui.util.WindowGeometry; 046import org.openstreetmap.josm.gui.widgets.HistoryComboBox; 047import org.openstreetmap.josm.spi.preferences.Config; 048import org.openstreetmap.josm.tools.GBC; 049import org.openstreetmap.josm.tools.Logging; 050import org.openstreetmap.josm.tools.Shortcut; 051import org.openstreetmap.josm.tools.Utils; 052 053/** 054 * Open an URL input dialog and load data from the given URL. 055 * 056 * @author imi 057 */ 058public class OpenLocationAction extends JosmAction { 059 /** 060 * true if the URL needs to be opened in a new layer, false otherwise 061 */ 062 private static final BooleanProperty USE_NEW_LAYER = new BooleanProperty("download.location.newlayer", false); 063 /** 064 * true to zoom to entire newly downloaded data, false otherwise 065 */ 066 private static final BooleanProperty DOWNLOAD_ZOOMTODATA = new BooleanProperty("download.location.zoomtodata", true); 067 /** 068 * the list of download tasks 069 */ 070 protected final transient List<Class<? extends DownloadTask>> downloadTasks; 071 072 static class WhichTasksToPerformDialog extends ExtendedDialog { 073 WhichTasksToPerformDialog(JList<DownloadTask> list) { 074 super(MainApplication.getMainFrame(), tr("Which tasks to perform?"), new String[]{tr("Ok"), tr("Cancel")}, true); 075 setButtonIcons("ok", "cancel"); 076 final JPanel pane = new JPanel(new GridLayout(2, 1)); 077 pane.add(new JLabel(tr("Which tasks to perform?"))); 078 pane.add(list); 079 setContent(pane); 080 } 081 } 082 083 /** 084 * Create an open action. The name is "Open a file". 085 */ 086 public OpenLocationAction() { 087 /* I18N: Command to download a specific location/URL */ 088 super(tr("Open Location..."), "openlocation", tr("Open an URL."), 089 Shortcut.registerShortcut("system:open_location", tr("File: {0}", tr("Open Location...")), 090 KeyEvent.VK_L, Shortcut.CTRL), true); 091 setHelpId(ht("/Action/OpenLocation")); 092 this.downloadTasks = new ArrayList<>(); 093 addDownloadTaskClass(DownloadOsmTask.class); 094 addDownloadTaskClass(DownloadGpsTask.class); 095 addDownloadTaskClass(DownloadNotesTask.class); 096 addDownloadTaskClass(DownloadOsmChangeTask.class); 097 addDownloadTaskClass(DownloadOsmUrlTask.class); 098 addDownloadTaskClass(DownloadOsmIdTask.class); 099 addDownloadTaskClass(DownloadOsmCompressedTask.class); 100 addDownloadTaskClass(DownloadOsmChangeCompressedTask.class); 101 addDownloadTaskClass(DownloadSessionTask.class); 102 addDownloadTaskClass(DownloadNotesUrlBoundsTask.class); 103 addDownloadTaskClass(DownloadNotesUrlIdTask.class); 104 } 105 106 /** 107 * Restore the current history from the preferences 108 * 109 * @param cbHistory the history combo box 110 */ 111 protected void restoreUploadAddressHistory(HistoryComboBox cbHistory) { 112 List<String> cmtHistory = new LinkedList<>(Config.getPref().getList(getClass().getName() + ".uploadAddressHistory", 113 new LinkedList<String>())); 114 // we have to reverse the history, because ComboBoxHistory will reverse it again in addElement() 115 // 116 Collections.reverse(cmtHistory); 117 cbHistory.setPossibleItems(cmtHistory); 118 } 119 120 /** 121 * Remind the current history in the preferences 122 * @param cbHistory the history combo box 123 */ 124 protected void remindUploadAddressHistory(HistoryComboBox cbHistory) { 125 cbHistory.addCurrentItemToHistory(); 126 Config.getPref().putList(getClass().getName() + ".uploadAddressHistory", cbHistory.getHistory()); 127 } 128 129 @Override 130 public void actionPerformed(ActionEvent e) { 131 JPanel all = new JPanel(new GridBagLayout()); 132 133 // download URL selection 134 all.add(new JLabel(tr("Enter URL to download:")), GBC.eol()); 135 HistoryComboBox uploadAddresses = new HistoryComboBox(); 136 uploadAddresses.setToolTipText(tr("Enter an URL from where data should be downloaded")); 137 restoreUploadAddressHistory(uploadAddresses); 138 all.add(uploadAddresses, GBC.eop().fill(GBC.BOTH)); 139 140 // use separate layer 141 JCheckBox layer = new JCheckBox(tr("Download as new layer")); 142 layer.setToolTipText(tr("Select if the data should be downloaded into a new layer")); 143 layer.setSelected(USE_NEW_LAYER.get()); 144 all.add(layer, GBC.eop().fill(GBC.BOTH)); 145 146 // zoom to downloaded data 147 JCheckBox zoom = new JCheckBox(tr("Zoom to downloaded data")); 148 zoom.setToolTipText(tr("Select to zoom to entire newly downloaded data.")); 149 zoom.setSelected(DOWNLOAD_ZOOMTODATA.get()); 150 all.add(zoom, GBC.eop().fill(GBC.BOTH)); 151 152 ExpertToggleAction.addVisibilitySwitcher(zoom); 153 154 ExtendedDialog dialog = new ExtendedDialog(MainApplication.getMainFrame(), 155 tr("Download Location"), 156 tr("Download URL"), tr("Cancel")) 157 .setContent(all, false /* don't embedded content in JScrollpane */) 158 .setButtonIcons("download", "cancel") 159 .setToolTipTexts( 160 tr("Start downloading data"), 161 tr("Close dialog and cancel downloading")) 162 .configureContextsensitiveHelp("/Action/OpenLocation", true /* show help button */); 163 dialog.setupDialog(); 164 dialog.pack(); 165 dialog.setRememberWindowGeometry(getClass().getName() + ".geometry", 166 WindowGeometry.centerInWindow(MainApplication.getMainFrame(), dialog.getPreferredSize())); 167 if (dialog.showDialog().getValue() == 1) { 168 USE_NEW_LAYER.put(layer.isSelected()); 169 DOWNLOAD_ZOOMTODATA.put(zoom.isSelected()); 170 remindUploadAddressHistory(uploadAddresses); 171 openUrl(Utils.strip(uploadAddresses.getText())); 172 } 173 } 174 175 /** 176 * Replies the list of download tasks accepting the given url. 177 * @param url The URL to open 178 * @param isRemotecontrol True if download request comes from remotecontrol. 179 * @return The list of download tasks accepting the given url. 180 * @since 5691 181 */ 182 public Collection<DownloadTask> findDownloadTasks(final String url, boolean isRemotecontrol) { 183 return downloadTasks.stream() 184 .filter(Objects::nonNull) 185 .map(taskClass -> { 186 try { 187 return taskClass.getConstructor().newInstance(); 188 } catch (ReflectiveOperationException e) { 189 Logging.error(e); 190 return null; 191 } 192 }) 193 .filter(Objects::nonNull) 194 .filter(task -> task.acceptsUrl(url, isRemotecontrol)) 195 .collect(Collectors.toList()); 196 } 197 198 /** 199 * Summarizes acceptable urls for error message purposes. 200 * @return The HTML message to be displayed 201 * @since 6031 202 */ 203 public String findSummaryDocumentation() { 204 StringBuilder result = new StringBuilder("<table>"); 205 for (Class<? extends DownloadTask> taskClass : downloadTasks) { 206 if (taskClass != null) { 207 try { 208 DownloadTask task = taskClass.getConstructor().newInstance(); 209 result.append(task.acceptsDocumentationSummary()); 210 } catch (ReflectiveOperationException e) { 211 Logging.error(e); 212 } 213 } 214 } 215 result.append("</table>"); 216 return result.toString(); 217 } 218 219 /** 220 * Open the given URL. 221 * @param newLayer true if the URL needs to be opened in a new layer, false otherwise 222 * @param url The URL to open 223 * @return the list of tasks that have been started successfully (can be empty). 224 * @since 11986 (return type) 225 */ 226 public List<Future<?>> openUrl(boolean newLayer, String url) { 227 return openUrl(new DownloadParams().withNewLayer(newLayer), url); 228 } 229 230 /** 231 * Open the given URL. 232 * @param settings download settings 233 * @param url The URL to open 234 * @return the list of tasks that have been started successfully (can be empty). 235 * @since 13927 236 */ 237 public List<Future<?>> openUrl(DownloadParams settings, String url) { 238 return openUrl(settings, DOWNLOAD_ZOOMTODATA.get(), url); 239 } 240 241 /** 242 * Open the given URL. This class checks the {@link #USE_NEW_LAYER} preference to check if a new layer should be used. 243 * @param url The URL to open 244 * @return the list of tasks that have been started successfully (can be empty). 245 * @since 11986 (return type) 246 */ 247 public List<Future<?>> openUrl(String url) { 248 return openUrl(USE_NEW_LAYER.get(), DOWNLOAD_ZOOMTODATA.get(), url); 249 } 250 251 /** 252 * Open the given URL. 253 * @param newLayer true if the URL needs to be opened in a new layer, false otherwise 254 * @param zoomToData true to zoom to entire newly downloaded data, false otherwise 255 * @param url The URL to open 256 * @return the list of tasks that have been started successfully (can be empty). 257 * @since 13261 258 */ 259 public List<Future<?>> openUrl(boolean newLayer, boolean zoomToData, String url) { 260 return openUrl(new DownloadParams().withNewLayer(newLayer), zoomToData, url); 261 } 262 263 /** 264 * Open the given URL. 265 * @param settings download settings 266 * @param zoomToData true to zoom to entire newly downloaded data, false otherwise 267 * @param url The URL to open 268 * @return the list of tasks that have been started successfully (can be empty). 269 * @since 13927 270 */ 271 public List<Future<?>> openUrl(DownloadParams settings, boolean zoomToData, String url) { 272 Collection<DownloadTask> tasks = findDownloadTasks(url, false); 273 274 if (tasks.size() > 1) { 275 tasks = askWhichTasksToLoad(tasks); 276 } else if (tasks.isEmpty()) { 277 warnNoSuitableTasks(url); 278 return Collections.emptyList(); 279 } 280 281 PleaseWaitProgressMonitor monitor = new PleaseWaitProgressMonitor(tr("Download data")); 282 283 List<Future<?>> result = new ArrayList<>(); 284 for (final DownloadTask task : tasks) { 285 try { 286 task.setZoomAfterDownload(zoomToData); 287 result.add(MainApplication.worker.submit(new PostDownloadHandler(task, task.loadUrl(settings, url, monitor)))); 288 } catch (IllegalArgumentException e) { 289 Logging.error(e); 290 } 291 } 292 return result; 293 } 294 295 /** 296 * Asks the user which of the possible tasks to perform. 297 * @param tasks a list of possible tasks 298 * @return the selected tasks from the user or an empty list if the dialog has been canceled 299 */ 300 Collection<DownloadTask> askWhichTasksToLoad(final Collection<DownloadTask> tasks) { 301 final JList<DownloadTask> list = new JList<>(tasks.toArray(new DownloadTask[0])); 302 list.addSelectionInterval(0, tasks.size() - 1); 303 final ExtendedDialog dialog = new WhichTasksToPerformDialog(list); 304 dialog.showDialog(); 305 return dialog.getValue() == 1 ? list.getSelectedValuesList() : Collections.<DownloadTask>emptyList(); 306 } 307 308 /** 309 * Displays an error message dialog that no suitable tasks have been found for the given url. 310 * @param url the given url 311 */ 312 protected void warnNoSuitableTasks(final String url) { 313 final String details = findSummaryDocumentation(); // Explain what patterns are supported 314 HelpAwareOptionPane.showMessageDialogInEDT(MainApplication.getMainFrame(), "<html><p>" + tr( 315 "Cannot open URL ''{0}''<br>The following download tasks accept the URL patterns shown:<br>{1}", 316 url, details) + "</p></html>", tr("Download Location"), JOptionPane.ERROR_MESSAGE, ht("/Action/OpenLocation")); 317 } 318 319 /** 320 * Adds a new download task to the supported ones. 321 * @param taskClass The new download task to add 322 * @return <code>true</code> (as specified by {@link Collection#add}) 323 */ 324 public final boolean addDownloadTaskClass(Class<? extends DownloadTask> taskClass) { 325 return this.downloadTasks.add(taskClass); 326 } 327}