001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.preferences.server; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.awt.Font; 007import java.awt.GridBagConstraints; 008import java.awt.GridBagLayout; 009import java.awt.Insets; 010import java.awt.event.ActionEvent; 011import java.awt.event.ActionListener; 012import java.awt.event.FocusAdapter; 013import java.awt.event.FocusEvent; 014import java.awt.event.ItemEvent; 015import java.awt.event.ItemListener; 016import java.util.Arrays; 017 018import javax.swing.AbstractAction; 019import javax.swing.JButton; 020import javax.swing.JCheckBox; 021import javax.swing.JComponent; 022import javax.swing.JLabel; 023import javax.swing.JPanel; 024import javax.swing.SwingUtilities; 025import javax.swing.event.DocumentEvent; 026import javax.swing.event.DocumentListener; 027import javax.swing.text.JTextComponent; 028 029import org.openstreetmap.josm.data.preferences.ListProperty; 030import org.openstreetmap.josm.gui.MainApplication; 031import org.openstreetmap.josm.gui.help.HelpUtil; 032import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator; 033import org.openstreetmap.josm.gui.widgets.HistoryComboBox; 034import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator; 035import org.openstreetmap.josm.io.OsmApi; 036import org.openstreetmap.josm.io.OsmApiInitializationException; 037import org.openstreetmap.josm.io.OsmTransferCanceledException; 038import org.openstreetmap.josm.spi.preferences.Config; 039import org.openstreetmap.josm.tools.ImageProvider; 040import org.openstreetmap.josm.tools.Logging; 041import org.openstreetmap.josm.tools.Utils; 042 043/** 044 * Component allowing input os OSM API URL. 045 */ 046public class OsmApiUrlInputPanel extends JPanel { 047 048 /** 049 * OSM API URL property key. 050 */ 051 public static final String API_URL_PROP = OsmApiUrlInputPanel.class.getName() + ".apiUrl"; 052 053 private final JLabel lblValid = new JLabel(); 054 private final JLabel lblApiUrl = new JLabel(tr("OSM Server URL:")); 055 private final HistoryComboBox tfOsmServerUrl = new HistoryComboBox(); 056 private transient ApiUrlValidator valOsmServerUrl; 057 private JButton btnTest; 058 /** indicates whether to use the default OSM URL or not */ 059 private JCheckBox cbUseDefaultServerUrl; 060 private final transient ListProperty SERVER_URL_HISTORY = new ListProperty("osm-server.url-history", Arrays.asList( 061 "https://api06.dev.openstreetmap.org/api", "https://master.apis.dev.openstreetmap.org/api")); 062 063 private transient ApiUrlPropagator propagator; 064 065 /** 066 * Constructs a new {@code OsmApiUrlInputPanel}. 067 */ 068 public OsmApiUrlInputPanel() { 069 build(); 070 HelpUtil.setHelpContext(this, HelpUtil.ht("/Preferences/Connection#ApiUrl")); 071 } 072 073 protected JComponent buildDefaultServerUrlPanel() { 074 cbUseDefaultServerUrl = new JCheckBox(tr("<html>Use the default OSM server URL (<strong>{0}</strong>)</html>", OsmApi.DEFAULT_API_URL)); 075 cbUseDefaultServerUrl.addItemListener(new UseDefaultServerUrlChangeHandler()); 076 cbUseDefaultServerUrl.setFont(cbUseDefaultServerUrl.getFont().deriveFont(Font.PLAIN)); 077 return cbUseDefaultServerUrl; 078 } 079 080 protected final void build() { 081 setLayout(new GridBagLayout()); 082 GridBagConstraints gc = new GridBagConstraints(); 083 084 // the checkbox for the default UL 085 gc.fill = GridBagConstraints.HORIZONTAL; 086 gc.anchor = GridBagConstraints.NORTHWEST; 087 gc.weightx = 1.0; 088 gc.insets = new Insets(0, 0, 0, 0); 089 gc.gridwidth = 4; 090 add(buildDefaultServerUrlPanel(), gc); 091 092 093 // the input field for the URL 094 gc.gridx = 0; 095 gc.gridy = 1; 096 gc.gridwidth = 1; 097 gc.weightx = 0.0; 098 gc.insets = new Insets(0, 0, 0, 3); 099 add(lblApiUrl, gc); 100 101 gc.gridx = 1; 102 gc.weightx = 1.0; 103 add(tfOsmServerUrl, gc); 104 lblApiUrl.setLabelFor(tfOsmServerUrl); 105 SelectAllOnFocusGainedDecorator.decorate(tfOsmServerUrl.getEditorComponent()); 106 valOsmServerUrl = new ApiUrlValidator(tfOsmServerUrl.getEditorComponent()); 107 valOsmServerUrl.validate(); 108 propagator = new ApiUrlPropagator(); 109 tfOsmServerUrl.addActionListener(propagator); 110 tfOsmServerUrl.addFocusListener(propagator); 111 112 gc.gridx = 2; 113 gc.weightx = 0.0; 114 add(lblValid, gc); 115 116 gc.gridx = 3; 117 gc.weightx = 0.0; 118 ValidateApiUrlAction actTest = new ValidateApiUrlAction(); 119 tfOsmServerUrl.getEditorComponent().getDocument().addDocumentListener(actTest); 120 btnTest = new JButton(actTest); 121 add(btnTest, gc); 122 } 123 124 /** 125 * Initializes the configuration panel with values from the preferences 126 */ 127 public void initFromPreferences() { 128 String url = OsmApi.getOsmApi().getServerUrl(); 129 tfOsmServerUrl.setPossibleItems(SERVER_URL_HISTORY.get()); 130 if (OsmApi.DEFAULT_API_URL.equals(url.trim())) { 131 cbUseDefaultServerUrl.setSelected(true); 132 propagator.propagate(OsmApi.DEFAULT_API_URL); 133 } else { 134 cbUseDefaultServerUrl.setSelected(false); 135 tfOsmServerUrl.setText(url); 136 propagator.propagate(url); 137 } 138 } 139 140 /** 141 * Saves the values to the preferences 142 */ 143 public void saveToPreferences() { 144 String oldUrl = OsmApi.getOsmApi().getServerUrl(); 145 String hmiUrl = getStrippedApiUrl(); 146 if (cbUseDefaultServerUrl.isSelected() || OsmApi.DEFAULT_API_URL.equals(hmiUrl)) { 147 Config.getPref().put("osm-server.url", null); 148 } else { 149 Config.getPref().put("osm-server.url", hmiUrl); 150 tfOsmServerUrl.addCurrentItemToHistory(); 151 SERVER_URL_HISTORY.put(tfOsmServerUrl.getHistory()); 152 } 153 String newUrl = OsmApi.getOsmApi().getServerUrl(); 154 155 // When API URL changes, re-initialize API connection so we may adjust server-dependent settings. 156 if (!oldUrl.equals(newUrl)) { 157 try { 158 OsmApi.getOsmApi().initialize(null); 159 } catch (OsmTransferCanceledException | OsmApiInitializationException ex) { 160 Logging.warn(ex); 161 } 162 } 163 } 164 165 /** 166 * Returns the entered API URL, stripped of leading and trailing white characters. 167 * @return the entered API URL, stripped of leading and trailing white characters. 168 * May be an empty string if nothing has been entered. In this case, it means the user wants to use {@link OsmApi#DEFAULT_API_URL}. 169 * @see Utils#strip(String) 170 * @since 6602 171 */ 172 public final String getStrippedApiUrl() { 173 return Utils.strip(tfOsmServerUrl.getText()); 174 } 175 176 class ValidateApiUrlAction extends AbstractAction implements DocumentListener { 177 private String lastTestedUrl; 178 179 ValidateApiUrlAction() { 180 putValue(NAME, tr("Validate")); 181 putValue(SHORT_DESCRIPTION, tr("Test the API URL")); 182 updateEnabledState(); 183 } 184 185 @Override 186 public void actionPerformed(ActionEvent arg0) { 187 final String url = getStrippedApiUrl(); 188 final ApiUrlTestTask task = new ApiUrlTestTask(OsmApiUrlInputPanel.this, url); 189 MainApplication.worker.submit(task); 190 Runnable r = () -> { 191 if (task.isCanceled()) 192 return; 193 Runnable r1 = () -> { 194 if (task.isSuccess()) { 195 lblValid.setIcon(ImageProvider.get("dialogs", "valid")); 196 lblValid.setToolTipText(tr("The API URL is valid.")); 197 lastTestedUrl = url; 198 updateEnabledState(); 199 } else { 200 lblValid.setIcon(ImageProvider.get("warning-small")); 201 lblValid.setToolTipText(tr("Validation failed. The API URL seems to be invalid.")); 202 } 203 }; 204 SwingUtilities.invokeLater(r1); 205 }; 206 MainApplication.worker.submit(r); 207 } 208 209 protected final void updateEnabledState() { 210 String url = getStrippedApiUrl(); 211 boolean enabled = !url.isEmpty() && !url.equals(lastTestedUrl); 212 if (enabled) { 213 lblValid.setIcon(null); 214 } 215 setEnabled(enabled); 216 } 217 218 @Override 219 public void changedUpdate(DocumentEvent arg0) { 220 updateEnabledState(); 221 } 222 223 @Override 224 public void insertUpdate(DocumentEvent arg0) { 225 updateEnabledState(); 226 } 227 228 @Override 229 public void removeUpdate(DocumentEvent arg0) { 230 updateEnabledState(); 231 } 232 } 233 234 /** 235 * Enables or disables the API URL input. 236 * @param enabled {@code true} to enable input, {@code false} otherwise 237 */ 238 public void setApiUrlInputEnabled(boolean enabled) { 239 lblApiUrl.setEnabled(enabled); 240 tfOsmServerUrl.setEnabled(enabled); 241 lblValid.setEnabled(enabled); 242 btnTest.setEnabled(enabled); 243 } 244 245 private static class ApiUrlValidator extends AbstractTextComponentValidator { 246 ApiUrlValidator(JTextComponent tc) { 247 super(tc); 248 } 249 250 @Override 251 public boolean isValid() { 252 if (getComponent().getText().trim().isEmpty()) 253 return false; 254 return Utils.isValidUrl(getComponent().getText().trim()); 255 } 256 257 @Override 258 public void validate() { 259 if (getComponent().getText().trim().isEmpty()) { 260 feedbackInvalid(tr("OSM API URL must not be empty. Please enter the OSM API URL.")); 261 return; 262 } 263 if (!isValid()) { 264 feedbackInvalid(tr("The current value is not a valid URL")); 265 } else { 266 feedbackValid(tr("Please enter the OSM API URL.")); 267 } 268 } 269 } 270 271 /** 272 * Handles changes in the default URL 273 */ 274 class UseDefaultServerUrlChangeHandler implements ItemListener { 275 @Override 276 public void itemStateChanged(ItemEvent e) { 277 switch(e.getStateChange()) { 278 case ItemEvent.SELECTED: 279 setApiUrlInputEnabled(false); 280 propagator.propagate(OsmApi.DEFAULT_API_URL); 281 break; 282 case ItemEvent.DESELECTED: 283 setApiUrlInputEnabled(true); 284 valOsmServerUrl.validate(); 285 tfOsmServerUrl.requestFocusInWindow(); 286 propagator.propagate(); 287 break; 288 default: // Do nothing 289 } 290 } 291 } 292 293 class ApiUrlPropagator extends FocusAdapter implements ActionListener { 294 protected void propagate() { 295 propagate(getStrippedApiUrl()); 296 } 297 298 protected void propagate(String url) { 299 firePropertyChange(API_URL_PROP, null, url); 300 } 301 302 @Override 303 public void actionPerformed(ActionEvent e) { 304 propagate(); 305 } 306 307 @Override 308 public void focusLost(FocusEvent arg0) { 309 propagate(); 310 } 311 } 312}