source: josm/trunk/src/org/openstreetmap/josm/gui/oauth/OAuthAuthorizationWizard.java@ 5422

Last change on this file since 5422 was 5422, checked in by Don-vip, 12 years ago

see #7943 - Introduce OsmApi.DEFAULT_API_URL, better handling of change of API URL in OAuth management, javadoc improvements
  • Property svn:eol-style set to native
File size: 13.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui.oauth;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.BorderLayout;
7import java.awt.Component;
8import java.awt.Dimension;
9import java.awt.FlowLayout;
10import java.awt.Font;
11import java.awt.GridBagConstraints;
12import java.awt.GridBagLayout;
13import java.awt.Insets;
14import java.awt.event.ActionEvent;
15import java.awt.event.ComponentEvent;
16import java.awt.event.ComponentListener;
17import java.awt.event.ItemEvent;
18import java.awt.event.ItemListener;
19import java.awt.event.KeyEvent;
20import java.awt.event.WindowAdapter;
21import java.awt.event.WindowEvent;
22import java.beans.PropertyChangeEvent;
23import java.beans.PropertyChangeListener;
24
25import javax.swing.AbstractAction;
26import javax.swing.BorderFactory;
27import javax.swing.JComponent;
28import javax.swing.JDialog;
29import javax.swing.JLabel;
30import javax.swing.JOptionPane;
31import javax.swing.JPanel;
32import javax.swing.JScrollPane;
33import javax.swing.KeyStroke;
34import javax.swing.UIManager;
35import javax.swing.event.HyperlinkEvent;
36import javax.swing.event.HyperlinkListener;
37
38import org.openstreetmap.josm.Main;
39import org.openstreetmap.josm.data.CustomConfigurator;
40import org.openstreetmap.josm.data.Preferences;
41import org.openstreetmap.josm.data.oauth.OAuthParameters;
42import org.openstreetmap.josm.data.oauth.OAuthToken;
43import org.openstreetmap.josm.gui.SideButton;
44import org.openstreetmap.josm.gui.help.ContextSensitiveHelpAction;
45import org.openstreetmap.josm.gui.help.HelpUtil;
46import org.openstreetmap.josm.gui.widgets.HtmlPanel;
47import org.openstreetmap.josm.tools.CheckParameterUtil;
48import org.openstreetmap.josm.tools.ImageProvider;
49import org.openstreetmap.josm.tools.OpenBrowser;
50import org.openstreetmap.josm.tools.WindowGeometry;
51
52/**
53 * This wizard walks the user to the necessary steps to retrieve an OAuth Access Token which
54 * allows JOSM to access the OSM API on the users behalf.
55 *
56 */
57public class OAuthAuthorizationWizard extends JDialog {
58 private HtmlPanel pnlMessage;
59 private boolean canceled;
60 private final String apiUrl;
61
62 private AuthorizationProcedureComboBox cbAuthorisationProcedure;
63 private FullyAutomaticAuthorizationUI pnlFullyAutomaticAuthorisationUI;
64 private SemiAutomaticAuthorizationUI pnlSemiAutomaticAuthorisationUI;
65 private ManualAuthorizationUI pnlManualAuthorisationUI;
66 private JScrollPane spAuthorisationProcedureUI;
67
68 /**
69 * Builds the row with the action buttons
70 *
71 * @return
72 */
73 protected JPanel buildButtonRow(){
74 JPanel pnl = new JPanel(new FlowLayout(FlowLayout.CENTER));
75
76 AcceptAccessTokenAction actAcceptAccessToken = new AcceptAccessTokenAction();
77 pnlFullyAutomaticAuthorisationUI.addPropertyChangeListener(actAcceptAccessToken);
78 pnlSemiAutomaticAuthorisationUI.addPropertyChangeListener(actAcceptAccessToken);
79 pnlManualAuthorisationUI.addPropertyChangeListener(actAcceptAccessToken);
80
81 pnl.add(new SideButton(actAcceptAccessToken));
82 pnl.add(new SideButton(new CancelAction()));
83 pnl.add(new SideButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Dialog/OAuthAuthorisationWizard"))));
84
85 return pnl;
86 }
87
88 /**
89 * Builds the panel with general information in the header
90 *
91 * @return
92 */
93 protected JPanel buildHeaderInfoPanel() {
94 JPanel pnl = new JPanel(new GridBagLayout());
95 pnl.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
96 GridBagConstraints gc = new GridBagConstraints();
97
98 // the oauth logo in the header
99 gc.anchor = GridBagConstraints.NORTHWEST;
100 gc.fill = GridBagConstraints.HORIZONTAL;
101 gc.weightx = 1.0;
102 gc.gridwidth = 2;
103 JLabel lbl = new JLabel();
104 lbl.setIcon(ImageProvider.get("oauth", "oauth-logo"));
105 lbl.setOpaque(true);
106 pnl.add(lbl, gc);
107
108 // OAuth in a nutshell ...
109 gc.gridy = 1;
110 gc.insets = new Insets(5,0,0,5);
111 pnlMessage = new HtmlPanel();
112 pnlMessage.setText("<html><body>"
113 + tr("With OAuth you grant JOSM the right to upload map data and GPS tracks "
114 + "on your behalf (<a href=\"{0}\">more info...</a>).", "http://oauth.net/")
115 + "</body></html>"
116 );
117 pnlMessage.getEditorPane().addHyperlinkListener(new ExternalBrowserLauncher());
118 pnl.add(pnlMessage, gc);
119
120 // the authorisation procedure
121 gc.gridy = 2;
122 gc.gridwidth = 1;
123 gc.weightx = 0.0;
124 lbl = new JLabel(tr("Please select an authorization procedure: "));
125 lbl.setFont(lbl.getFont().deriveFont(Font.PLAIN));
126 pnl.add(lbl,gc);
127
128 gc.gridx = 1;
129 gc.gridwidth = 1;
130 gc.weightx = 1.0;
131 pnl.add(cbAuthorisationProcedure = new AuthorizationProcedureComboBox(),gc);
132 cbAuthorisationProcedure.addItemListener(new AuthorisationProcedureChangeListener());
133 return pnl;
134 }
135
136 /**
137 * Refreshes the view of the authorisation panel, depending on the authorisation procedure
138 * currently selected
139 */
140 protected void refreshAuthorisationProcedurePanel() {
141 AuthorizationProcedure procedure = (AuthorizationProcedure)cbAuthorisationProcedure.getSelectedItem();
142 switch(procedure) {
143 case FULLY_AUTOMATIC:
144 spAuthorisationProcedureUI.getViewport().setView(pnlFullyAutomaticAuthorisationUI);
145 pnlFullyAutomaticAuthorisationUI.revalidate();
146 break;
147 case SEMI_AUTOMATIC:
148 spAuthorisationProcedureUI.getViewport().setView(pnlSemiAutomaticAuthorisationUI);
149 pnlSemiAutomaticAuthorisationUI.revalidate();
150 break;
151 case MANUALLY:
152 spAuthorisationProcedureUI.getViewport().setView(pnlManualAuthorisationUI);
153 pnlManualAuthorisationUI.revalidate();
154 break;
155 }
156 validate();
157 repaint();
158 }
159
160 /**
161 * builds the UI
162 */
163 protected void build() {
164 getContentPane().setLayout(new BorderLayout());
165 getContentPane().add(buildHeaderInfoPanel(), BorderLayout.NORTH);
166
167 setTitle(tr("Get an Access Token for ''{0}''", apiUrl));
168
169 pnlFullyAutomaticAuthorisationUI = new FullyAutomaticAuthorizationUI(apiUrl);
170 pnlSemiAutomaticAuthorisationUI = new SemiAutomaticAuthorizationUI(apiUrl);
171 pnlManualAuthorisationUI = new ManualAuthorizationUI(apiUrl);
172
173 spAuthorisationProcedureUI = new JScrollPane(new JPanel());
174 spAuthorisationProcedureUI.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
175 spAuthorisationProcedureUI.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED);
176 spAuthorisationProcedureUI.getVerticalScrollBar().addComponentListener(
177 new ComponentListener() {
178 public void componentShown(ComponentEvent e) {
179 spAuthorisationProcedureUI.setBorder(UIManager.getBorder("ScrollPane.border"));
180 }
181
182 public void componentHidden(ComponentEvent e) {
183 spAuthorisationProcedureUI.setBorder(null);
184 }
185
186 public void componentResized(ComponentEvent e) {}
187 public void componentMoved(ComponentEvent e) {}
188 }
189 );
190 getContentPane().add(spAuthorisationProcedureUI, BorderLayout.CENTER);
191 getContentPane().add(buildButtonRow(), BorderLayout.SOUTH);
192
193 addWindowListener(new WindowEventHandler());
194 getRootPane().getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "cancel");
195 getRootPane().getActionMap().put("cancel", new CancelAction());
196
197 refreshAuthorisationProcedurePanel();
198
199 HelpUtil.setHelpContext(getRootPane(), HelpUtil.ht("/Dialog/OAuthAuthorisationWizard"));
200 }
201
202 /**
203 * Creates the wizard.
204 *
205 * @param apiUrl the API URL. Must not be null.
206 * @throws IllegalArgumentException thrown if apiUrl is null
207 */
208 public OAuthAuthorizationWizard(String apiUrl) throws IllegalArgumentException {
209 this(Main.parent, apiUrl);
210 }
211
212 /**
213 * Creates the wizard.
214 *
215 * @param parent the component relative to which the dialog is displayed
216 * @param apiUrl the API URL. Must not be null.
217 * @throws IllegalArgumentException thrown if apiUrl is null
218 */
219 public OAuthAuthorizationWizard(Component parent, String apiUrl) {
220 super(JOptionPane.getFrameForComponent(parent), ModalityType.DOCUMENT_MODAL);
221 CheckParameterUtil.ensureParameterNotNull(apiUrl, "apiUrl");
222 this.apiUrl = apiUrl;
223 build();
224 }
225
226 /**
227 * Replies true if the dialog was canceled
228 *
229 * @return true if the dialog was canceled
230 */
231 public boolean isCanceled() {
232 return canceled;
233 }
234
235 protected AbstractAuthorizationUI getCurrentAuthorisationUI() {
236 switch((AuthorizationProcedure)cbAuthorisationProcedure.getSelectedItem()) {
237 case FULLY_AUTOMATIC: return pnlFullyAutomaticAuthorisationUI;
238 case MANUALLY: return pnlManualAuthorisationUI;
239 case SEMI_AUTOMATIC: return pnlSemiAutomaticAuthorisationUI;
240 default: return null;
241 }
242 }
243
244 /**
245 * Replies the Access Token entered using the wizard
246 *
247 * @return the access token. May be null if the wizard was canceled.
248 */
249 public OAuthToken getAccessToken() {
250 return getCurrentAuthorisationUI().getAccessToken();
251 }
252
253 /**
254 * Replies the current OAuth parameters.
255 *
256 * @return the current OAuth parameters.
257 */
258 public OAuthParameters getOAuthParameters() {
259 return getCurrentAuthorisationUI().getOAuthParameters();
260 }
261
262 /**
263 * Replies true if the currently selected Access Token shall be saved to
264 * the preferences.
265 *
266 * @return true if the currently selected Access Token shall be saved to
267 * the preferences
268 */
269 public boolean isSaveAccessTokenToPreferences() {
270 return getCurrentAuthorisationUI().isSaveAccessTokenToPreferences();
271 }
272
273 /**
274 * Initializes the dialog with values from the preferences
275 *
276 */
277 public void initFromPreferences() {
278 // Copy current JOSM preferences to update API url with the one used in this wizard
279 Preferences copyPref = CustomConfigurator.clonePreferences(Main.pref);
280 copyPref.put("osm-server-url", apiUrl);
281 pnlFullyAutomaticAuthorisationUI.initFromPreferences(copyPref);
282 pnlSemiAutomaticAuthorisationUI.initFromPreferences(copyPref);
283 pnlManualAuthorisationUI.initFromPreferences(copyPref);
284 }
285
286 @Override
287 public void setVisible(boolean visible) {
288 if (visible) {
289 new WindowGeometry(
290 getClass().getName() + ".geometry",
291 WindowGeometry.centerInWindow(
292 Main.parent,
293 new Dimension(450,540)
294 )
295 ).applySafe(this);
296 initFromPreferences();
297 } else if (!visible && isShowing()){
298 new WindowGeometry(this).remember(getClass().getName() + ".geometry");
299 }
300 super.setVisible(visible);
301 }
302
303 protected void setCanceled(boolean canceled) {
304 this.canceled = canceled;
305 }
306
307 class AuthorisationProcedureChangeListener implements ItemListener {
308 public void itemStateChanged(ItemEvent arg0) {
309 refreshAuthorisationProcedurePanel();
310 }
311 }
312
313 class CancelAction extends AbstractAction {
314 public CancelAction() {
315 putValue(NAME, tr("Cancel"));
316 putValue(SMALL_ICON, ImageProvider.get("cancel"));
317 putValue(SHORT_DESCRIPTION, tr("Close the dialog and cancel authorization"));
318 }
319
320 public void cancel() {
321 setCanceled(true);
322 setVisible(false);
323 }
324
325 public void actionPerformed(ActionEvent evt) {
326 cancel();
327 }
328 }
329
330 class AcceptAccessTokenAction extends AbstractAction implements PropertyChangeListener {
331 private OAuthToken token;
332
333 public AcceptAccessTokenAction() {
334 putValue(NAME, tr("Accept Access Token"));
335 putValue(SMALL_ICON, ImageProvider.get("ok"));
336 putValue(SHORT_DESCRIPTION, tr("Close the dialog and accept the Access Token"));
337 updateEnabledState(null);
338 }
339
340 public void actionPerformed(ActionEvent evt) {
341 setCanceled(false);
342 setVisible(false);
343 }
344
345 public void updateEnabledState(OAuthToken token) {
346 setEnabled(token != null);
347 }
348
349 public void propertyChange(PropertyChangeEvent evt) {
350 if (!evt.getPropertyName().equals(AbstractAuthorizationUI.ACCESS_TOKEN_PROP))
351 return;
352 token = (OAuthToken)evt.getNewValue();
353 updateEnabledState(token);
354 }
355 }
356
357 class WindowEventHandler extends WindowAdapter {
358 @Override
359 public void windowClosing(WindowEvent arg0) {
360 new CancelAction().cancel();
361 }
362 }
363
364 static class ExternalBrowserLauncher implements HyperlinkListener {
365 public void hyperlinkUpdate(HyperlinkEvent e) {
366 if (e.getEventType().equals(HyperlinkEvent.EventType.ACTIVATED)) {
367 OpenBrowser.displayUrl(e.getDescription());
368 }
369 }
370 }
371}
Note: See TracBrowser for help on using the repository browser.