001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.download; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.awt.GridBagLayout; 007import java.awt.event.ActionEvent; 008import java.util.ArrayList; 009import java.util.Arrays; 010import java.util.Collections; 011import java.util.List; 012import java.util.Optional; 013 014import javax.swing.JEditorPane; 015import javax.swing.JLabel; 016import javax.swing.JOptionPane; 017import javax.swing.JPanel; 018import javax.swing.JScrollPane; 019import javax.swing.event.HyperlinkEvent; 020import javax.swing.text.JTextComponent; 021 022import org.openstreetmap.josm.Main; 023import org.openstreetmap.josm.data.preferences.ListProperty; 024import org.openstreetmap.josm.gui.ExtendedDialog; 025import org.openstreetmap.josm.gui.download.overpass.OverpassWizardRegistration.OverpassWizardCallbacks; 026import org.openstreetmap.josm.gui.util.GuiHelper; 027import org.openstreetmap.josm.gui.widgets.HistoryComboBox; 028import org.openstreetmap.josm.tools.GBC; 029import org.openstreetmap.josm.tools.Logging; 030import org.openstreetmap.josm.tools.OpenBrowser; 031import org.openstreetmap.josm.tools.OverpassTurboQueryWizard; 032import org.openstreetmap.josm.tools.UncheckedParseException; 033import org.openstreetmap.josm.tools.Utils; 034 035/** 036 * This dialog provides an easy and fast way to create an overpass query. 037 * @since 12576 038 * @since 12652: Moved here 039 */ 040public final class OverpassQueryWizardDialog extends ExtendedDialog { 041 042 private final HistoryComboBox queryWizard; 043 private static final String HEADLINE_START = "<h3>"; 044 private static final String HEADLINE_END = "</h3>"; 045 private static final String TR_START = "<tr>"; 046 private static final String TR_END = "</tr>"; 047 private static final String TD_START = "<td>"; 048 private static final String TD_END = "</td>"; 049 private static final String SPAN_START = "<span>"; 050 private static final String SPAN_END = "</span>"; 051 private static final ListProperty OVERPASS_WIZARD_HISTORY = 052 new ListProperty("download.overpass.wizard", new ArrayList<String>()); 053 private final transient OverpassTurboQueryWizard overpassQueryBuilder; 054 055 // dialog buttons 056 private static final int BUILD_QUERY = 0; 057 private static final int BUILD_AN_EXECUTE_QUERY = 1; 058 private static final int CANCEL = 2; 059 060 private static final String DESCRIPTION_STYLE = 061 "<style type=\"text/css\">\n" 062 + "table { border-spacing: 0pt;}\n" 063 + "h3 {text-align: center; padding: 8px;}\n" 064 + "td {border: 1px solid #dddddd; text-align: left; padding: 8px;}\n" 065 + "#desc {width: 350px;}" 066 + "</style>\n"; 067 068 private final OverpassWizardCallbacks dsPanel; 069 070 /** 071 * Create a new {@link OverpassQueryWizardDialog} 072 * @param callbacks The Overpass download source panel. 073 */ 074 public OverpassQueryWizardDialog(OverpassWizardCallbacks callbacks) { 075 super(callbacks.getParent(), tr("Overpass Turbo Query Wizard"), 076 tr("Build query"), tr("Build query and execute"), tr("Cancel")); 077 this.dsPanel = callbacks; 078 079 this.queryWizard = new HistoryComboBox(); 080 this.overpassQueryBuilder = OverpassTurboQueryWizard.getInstance(); 081 082 JPanel panel = new JPanel(new GridBagLayout()); 083 084 JLabel searchLabel = new JLabel(tr("Search:")); 085 JTextComponent descPane = buildDescriptionSection(); 086 JScrollPane scroll = GuiHelper.embedInVerticalScrollPane(descPane); 087 scroll.getVerticalScrollBar().setUnitIncrement(10); // make scrolling smooth 088 089 panel.add(searchLabel, GBC.std().insets(0, 0, 0, 20).anchor(GBC.SOUTHEAST)); 090 panel.add(queryWizard, GBC.eol().insets(0, 0, 0, 15).fill(GBC.HORIZONTAL).anchor(GBC.SOUTH)); 091 panel.add(scroll, GBC.eol().fill(GBC.BOTH).anchor(GBC.CENTER)); 092 093 List<String> items = new ArrayList<>(OVERPASS_WIZARD_HISTORY.get()); 094 if (!items.isEmpty()) { 095 queryWizard.setText(items.get(0)); 096 } 097 // HistoryComboBox needs the reversed list 098 Collections.reverse(items); 099 queryWizard.setPossibleItems(items); 100 101 setCancelButton(CANCEL + 1); 102 setDefaultButton(BUILD_AN_EXECUTE_QUERY + 1); 103 setContent(panel, false); 104 } 105 106 @Override 107 public void buttonAction(int buttonIndex, ActionEvent evt) { 108 switch (buttonIndex) { 109 case BUILD_QUERY: 110 if (this.buildQueryAction()) { 111 this.saveHistory(); 112 super.buttonAction(BUILD_QUERY, evt); 113 } 114 break; 115 case BUILD_AN_EXECUTE_QUERY: 116 if (this.buildQueryAction()) { 117 this.saveHistory(); 118 super.buttonAction(BUILD_AN_EXECUTE_QUERY, evt); 119 120 DownloadDialog.getInstance().startDownload(); 121 } 122 break; 123 default: 124 super.buttonAction(buttonIndex, evt); 125 126 } 127 } 128 129 /** 130 * Saves the latest, successfully parsed search term. 131 */ 132 private void saveHistory() { 133 queryWizard.addCurrentItemToHistory(); 134 OVERPASS_WIZARD_HISTORY.put(queryWizard.getHistory()); 135 } 136 137 /** 138 * Tries to process a search term using {@link OverpassTurboQueryWizard}. If the term cannot 139 * be parsed, the the corresponding dialog is shown. 140 * @param searchTerm The search term to parse. 141 * @return {@link Optional#empty()} if an exception was thrown when parsing, meaning 142 * that the term cannot be processed, or non-empty {@link Optional} containing the result 143 * of parsing. 144 */ 145 private Optional<String> tryParseSearchTerm(String searchTerm) { 146 try { 147 return Optional.of(overpassQueryBuilder.constructQuery(searchTerm)); 148 } catch (UncheckedParseException | IllegalStateException ex) { 149 Logging.error(ex); 150 JOptionPane.showMessageDialog( 151 dsPanel.getParent(), 152 "<html>" + 153 tr("The Overpass wizard could not parse the following query:") + 154 Utils.joinAsHtmlUnorderedList(Collections.singleton(searchTerm)) + 155 "</html>", 156 tr("Parse error"), 157 JOptionPane.ERROR_MESSAGE 158 ); 159 return Optional.empty(); 160 } 161 } 162 163 /** 164 * Builds an Overpass query out from {@link OverpassQueryWizardDialog#queryWizard} contents. 165 * @return {@code true} if the query successfully built, {@code false} otherwise. 166 */ 167 private boolean buildQueryAction() { 168 final String wizardSearchTerm = this.queryWizard.getText(); 169 170 Optional<String> q = this.tryParseSearchTerm(wizardSearchTerm); 171 q.ifPresent(dsPanel::submitWizardResult); 172 return q.isPresent(); 173 } 174 175 private static JTextComponent buildDescriptionSection() { 176 JEditorPane descriptionSection = new JEditorPane("text/html", getDescriptionContent()); 177 descriptionSection.setEditable(false); 178 descriptionSection.addHyperlinkListener(e -> { 179 if (HyperlinkEvent.EventType.ACTIVATED.equals(e.getEventType())) { 180 OpenBrowser.displayUrl(e.getURL().toString()); 181 } 182 }); 183 184 return descriptionSection; 185 } 186 187 private static String getDescriptionContent() { 188 return new StringBuilder("<html>") 189 .append(DESCRIPTION_STYLE) 190 .append("<body>") 191 .append(HEADLINE_START) 192 .append(tr("Query Wizard")) 193 .append(HEADLINE_END) 194 .append("<p>") 195 .append(tr("Allows you to interact with <i>Overpass API</i> by writing declarative, human-readable terms.")) 196 .append(tr("The <i>Query Wizard</i> tool will transform those to a valid overpass query.")) 197 .append(tr("For more detailed description see ")) 198 .append(tr("<a href=\"{0}\">OSM Wiki</a>.", Main.getOSMWebsite() + "/wiki/Overpass_turbo/Wizard")) 199 .append("</p>") 200 .append(HEADLINE_START).append(tr("Hints")).append(HEADLINE_END) 201 .append("<table>").append(TR_START).append(TD_START) 202 .append(Utils.joinAsHtmlUnorderedList(Arrays.asList("<i>type:node</i>", "<i>type:relation</i>", "<i>type:way</i>"))) 203 .append(TD_END).append(TD_START) 204 .append(SPAN_START).append(tr("Download objects of a certain type.")).append(SPAN_END) 205 .append(TD_END).append(TR_END) 206 .append(TR_START).append(TD_START) 207 .append(Utils.joinAsHtmlUnorderedList( 208 Arrays.asList("<i>key=value in <u>location</u></i>", 209 "<i>key=value around <u>location</u></i>", 210 "<i>key=value in bbox</i>"))) 211 .append(TD_END).append(TD_START) 212 .append(tr("Download object by specifying a specific location. For example,")) 213 .append(Utils.joinAsHtmlUnorderedList(Arrays.asList( 214 tr("{0} all objects having {1} as attribute are downloaded.", "<i>tourism=hotel in Berlin</i> -", "'tourism=hotel'"), 215 tr("{0} all object with the corresponding key/value pair located around Berlin. Note, the default value for radius "+ 216 "is set to 1000m, but it can be changed in the generated query.", "<i>tourism=hotel around Berlin</i> -"), 217 tr("{0} all objects within the current selection that have {1} as attribute.", "<i>tourism=hotel in bbox</i> -", 218 "'tourism=hotel'")))) 219 .append(SPAN_START) 220 .append(tr("Instead of <i>location</i> any valid place name can be used like address, city, etc.")) 221 .append(SPAN_END) 222 .append(TD_END).append(TR_END) 223 .append(TR_START).append(TD_START) 224 .append(Utils.joinAsHtmlUnorderedList(Arrays.asList("<i>key=value</i>", "<i>key=*</i>", "<i>key~regex</i>", 225 "<i>key!=value</i>", "<i>key!~regex</i>", "<i>key=\"combined value\"</i>"))) 226 .append(TD_END).append(TD_START) 227 .append(tr("<span>Download objects that have some concrete key/value pair, only the key with any contents for the value, " + 228 "the value matching some regular expression. \"Not equal\" operators are supported as well.</span>")) 229 .append(TD_END).append(TR_END) 230 .append(TR_START).append(TD_START) 231 .append(Utils.joinAsHtmlUnorderedList(Arrays.asList( 232 tr("<i>expression1 {0} expression2</i>", "or"), 233 tr("<i>expression1 {0} expression2</i>", "and")))) 234 .append(TD_END).append(TD_START) 235 .append(SPAN_START) 236 .append(tr("Basic logical operators can be used to create more sophisticated queries. Instead of \"or\" - \"|\", \"||\" " + 237 "can be used, and instead of \"and\" - \"&\", \"&&\".")) 238 .append(SPAN_END) 239 .append(TD_END).append(TR_END).append("</table>") 240 .append("</body>") 241 .append("</html>") 242 .toString(); 243 } 244}