source: josm/trunk/src/org/openstreetmap/josm/actions/OpenLocationAction.java@ 11301

Last change on this file since 11301 was 11286, checked in by michael2402, 7 years ago

Fix #14008: Do not break loop.
  • Property svn:eol-style set to native
File size: 11.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.GridBagLayout;
8import java.awt.GridLayout;
9import java.awt.event.ActionEvent;
10import java.awt.event.KeyEvent;
11import java.util.ArrayList;
12import java.util.Collection;
13import java.util.Collections;
14import java.util.LinkedList;
15import java.util.List;
16import java.util.Objects;
17import java.util.concurrent.Future;
18import java.util.stream.Collectors;
19
20import javax.swing.JCheckBox;
21import javax.swing.JLabel;
22import javax.swing.JList;
23import javax.swing.JOptionPane;
24import javax.swing.JPanel;
25
26import org.openstreetmap.josm.Main;
27import org.openstreetmap.josm.actions.downloadtasks.DownloadGeoUrlTask;
28import org.openstreetmap.josm.actions.downloadtasks.DownloadGpsTask;
29import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesTask;
30import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesUrlBoundsTask;
31import org.openstreetmap.josm.actions.downloadtasks.DownloadNotesUrlIdTask;
32import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmChangeCompressedTask;
33import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmChangeTask;
34import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmCompressedTask;
35import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmIdTask;
36import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmTask;
37import org.openstreetmap.josm.actions.downloadtasks.DownloadOsmUrlTask;
38import org.openstreetmap.josm.actions.downloadtasks.DownloadSessionTask;
39import org.openstreetmap.josm.actions.downloadtasks.DownloadTask;
40import org.openstreetmap.josm.actions.downloadtasks.PostDownloadHandler;
41import org.openstreetmap.josm.data.preferences.BooleanProperty;
42import org.openstreetmap.josm.gui.ExtendedDialog;
43import org.openstreetmap.josm.gui.HelpAwareOptionPane;
44import org.openstreetmap.josm.gui.progress.PleaseWaitProgressMonitor;
45import org.openstreetmap.josm.gui.widgets.HistoryComboBox;
46import org.openstreetmap.josm.tools.GBC;
47import org.openstreetmap.josm.tools.Shortcut;
48import org.openstreetmap.josm.tools.Utils;
49
50/**
51 * Open an URL input dialog and load data from the given URL.
52 *
53 * @author imi
54 */
55public class OpenLocationAction extends JosmAction {
56 /**
57 * true if the URL needs to be opened in a new layer, false otherwise
58 */
59 private static final BooleanProperty USE_NEW_LAYER = new BooleanProperty("download.newlayer", true);
60 protected final transient List<Class<? extends DownloadTask>> downloadTasks;
61
62 /**
63 * Create an open action. The name is "Open a file".
64 */
65 public OpenLocationAction() {
66 /* I18N: Command to download a specific location/URL */
67 super(tr("Open Location..."), "openlocation", tr("Open an URL."),
68 Shortcut.registerShortcut("system:open_location", tr("File: {0}", tr("Open Location...")),
69 KeyEvent.VK_L, Shortcut.CTRL), true);
70 putValue("help", ht("/Action/OpenLocation"));
71 this.downloadTasks = new ArrayList<>();
72 addDownloadTaskClass(DownloadOsmTask.class);
73 addDownloadTaskClass(DownloadGpsTask.class);
74 addDownloadTaskClass(DownloadNotesTask.class);
75 addDownloadTaskClass(DownloadOsmChangeTask.class);
76 addDownloadTaskClass(DownloadOsmUrlTask.class);
77 addDownloadTaskClass(DownloadGeoUrlTask.class);
78 addDownloadTaskClass(DownloadOsmIdTask.class);
79 addDownloadTaskClass(DownloadOsmCompressedTask.class);
80 addDownloadTaskClass(DownloadOsmChangeCompressedTask.class);
81 addDownloadTaskClass(DownloadSessionTask.class);
82 addDownloadTaskClass(DownloadNotesUrlBoundsTask.class);
83 addDownloadTaskClass(DownloadNotesUrlIdTask.class);
84 }
85
86 /**
87 * Restore the current history from the preferences
88 *
89 * @param cbHistory the history combo box
90 */
91 protected void restoreUploadAddressHistory(HistoryComboBox cbHistory) {
92 List<String> cmtHistory = new LinkedList<>(Main.pref.getCollection(getClass().getName() + ".uploadAddressHistory",
93 new LinkedList<String>()));
94 // we have to reverse the history, because ComboBoxHistory will reverse it again in addElement()
95 //
96 Collections.reverse(cmtHistory);
97 cbHistory.setPossibleItems(cmtHistory);
98 }
99
100 /**
101 * Remind the current history in the preferences
102 * @param cbHistory the history combo box
103 */
104 protected void remindUploadAddressHistory(HistoryComboBox cbHistory) {
105 cbHistory.addCurrentItemToHistory();
106 Main.pref.putCollection(getClass().getName() + ".uploadAddressHistory", cbHistory.getHistory());
107 }
108
109 @Override
110 public void actionPerformed(ActionEvent e) {
111 JPanel all = new JPanel(new GridBagLayout());
112
113 // download URL selection
114 all.add(new JLabel(tr("Enter URL to download:")), GBC.eol());
115 HistoryComboBox uploadAddresses = new HistoryComboBox();
116 uploadAddresses.setToolTipText(tr("Enter an URL from where data should be downloaded"));
117 restoreUploadAddressHistory(uploadAddresses);
118 all.add(uploadAddresses, GBC.eop().fill(GBC.BOTH));
119
120 // use separate layer
121 JCheckBox layer = new JCheckBox(tr("Separate Layer"));
122 layer.setToolTipText(tr("Select if the data should be downloaded into a new layer"));
123 layer.setSelected(USE_NEW_LAYER.get());
124 all.add(layer, GBC.eop().fill(GBC.BOTH));
125
126 ExtendedDialog dialog = new ExtendedDialog(Main.parent,
127 tr("Download Location"),
128 new String[] {tr("Download URL"), tr("Cancel")}
129 );
130 dialog.setContent(all, false /* don't embedded content in JScrollpane */);
131 dialog.setButtonIcons(new String[] {"download", "cancel"});
132 dialog.setToolTipTexts(new String[] {
133 tr("Start downloading data"),
134 tr("Close dialog and cancel downloading")
135 });
136 dialog.configureContextsensitiveHelp("/Action/OpenLocation", true /* show help button */);
137 dialog.showDialog();
138 if (dialog.getValue() == 1) {
139 USE_NEW_LAYER.put(layer.isSelected());
140 remindUploadAddressHistory(uploadAddresses);
141 openUrl(Utils.strip(uploadAddresses.getText()));
142 }
143 }
144
145 /**
146 * Replies the list of download tasks accepting the given url.
147 * @param url The URL to open
148 * @param isRemotecontrol True if download request comes from remotecontrol.
149 * @return The list of download tasks accepting the given url.
150 * @since 5691
151 */
152 public Collection<DownloadTask> findDownloadTasks(final String url, boolean isRemotecontrol) {
153 return downloadTasks.stream()
154 .filter(Objects::nonNull)
155 .map(taskClass -> {
156 try {
157 return taskClass.getConstructor().newInstance();
158 } catch (ReflectiveOperationException e) {
159 Main.error(e);
160 return null;
161 }
162 })
163 .filter(Objects::nonNull)
164 .filter(task -> task.acceptsUrl(url, isRemotecontrol))
165 .collect(Collectors.toList());
166 }
167
168 /**
169 * Summarizes acceptable urls for error message purposes.
170 * @return The HTML message to be displayed
171 * @since 6031
172 */
173 public String findSummaryDocumentation() {
174 StringBuilder result = new StringBuilder("<table>");
175 for (Class<? extends DownloadTask> taskClass : downloadTasks) {
176 if (taskClass != null) {
177 try {
178 DownloadTask task = taskClass.getConstructor().newInstance();
179 result.append(task.acceptsDocumentationSummary());
180 } catch (ReflectiveOperationException e) {
181 Main.error(e);
182 }
183 }
184 }
185 result.append("</table>");
186 return result.toString();
187 }
188
189 /**
190 * Open the given URL.
191 * @param newLayer true if the URL needs to be opened in a new layer, false otherwise
192 * @param url The URL to open
193 */
194 public void openUrl(boolean newLayer, String url) {
195 realOpenUrl(newLayer, url);
196 }
197
198 /**
199 * Open the given URL. This class checks the {@link #USE_NEW_LAYER} preference to check if a new layer should be used.
200 * @param url The URL to open
201 * @return <code>true</code> if at least one task was started successfully.
202 * @since 11279
203 */
204 public boolean openUrl(String url) {
205 return realOpenUrl(USE_NEW_LAYER.get(), url);
206 }
207
208 private boolean realOpenUrl(boolean newLayer, String url) {
209 Collection<DownloadTask> tasks = findDownloadTasks(url, false);
210
211 if (tasks.size() > 1) {
212 tasks = askWhichTasksToLoad(tasks);
213 } else if (tasks.isEmpty()) {
214 warnNoSuitableTasks(url);
215 return false;
216 }
217
218 PleaseWaitProgressMonitor monitor = new PleaseWaitProgressMonitor(tr("Download Data"));
219
220 boolean hadAnySuccess = false;
221 for (final DownloadTask task : tasks) {
222 try {
223 Future<?> future = task.loadUrl(newLayer, url, monitor);
224 Main.worker.submit(new PostDownloadHandler(task, future));
225 hadAnySuccess = true;
226 } catch (IllegalArgumentException e) {
227 Main.error(e);
228 }
229 }
230 return hadAnySuccess;
231 }
232
233 /**
234 * Asks the user which of the possible tasks to perform.
235 * @param tasks a list of possible tasks
236 * @return the selected tasks from the user or an empty list if the dialog has been canceled
237 */
238 Collection<DownloadTask> askWhichTasksToLoad(final Collection<DownloadTask> tasks) {
239 final JList<DownloadTask> list = new JList<>(tasks.toArray(new DownloadTask[tasks.size()]));
240 list.addSelectionInterval(0, tasks.size() - 1);
241 final ExtendedDialog dialog = new ExtendedDialog(Main.parent,
242 tr("Which tasks to perform?"), new String[]{tr("Ok"), tr("Cancel")}, true) { {
243 setButtonIcons(new String[]{"ok", "cancel"});
244 final JPanel pane = new JPanel(new GridLayout(2, 1));
245 pane.add(new JLabel(tr("Which tasks to perform?")));
246 pane.add(list);
247 setContent(pane);
248 } };
249 dialog.showDialog();
250 return dialog.getValue() == 1 ? list.getSelectedValuesList() : Collections.<DownloadTask>emptyList();
251 }
252
253 /**
254 * Displays an error message dialog that no suitable tasks have been found for the given url.
255 * @param url the given url
256 */
257 protected void warnNoSuitableTasks(final String url) {
258 final String details = findSummaryDocumentation(); // Explain what patterns are supported
259 HelpAwareOptionPane.showMessageDialogInEDT(Main.parent, "<html><p>" + tr(
260 "Cannot open URL ''{0}''<br>The following download tasks accept the URL patterns shown:<br>{1}",
261 url, details) + "</p></html>", tr("Download Location"), JOptionPane.ERROR_MESSAGE, ht("/Action/OpenLocation"));
262 }
263
264 /**
265 * Adds a new download task to the supported ones.
266 * @param taskClass The new download task to add
267 * @return <tt>true</tt> (as specified by {@link Collection#add})
268 */
269 public final boolean addDownloadTaskClass(Class<? extends DownloadTask> taskClass) {
270 return this.downloadTasks.add(taskClass);
271 }
272}
Note: See TracBrowser for help on using the repository browser.