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

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

fix potential NPEs and Sonar issues related to serialization
  • Property svn:eol-style set to native
File size: 13.4 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.util.GuiHelper;
47import org.openstreetmap.josm.gui.widgets.HtmlPanel;
48import org.openstreetmap.josm.tools.CheckParameterUtil;
49import org.openstreetmap.josm.tools.ImageProvider;
50import org.openstreetmap.josm.tools.OpenBrowser;
51import org.openstreetmap.josm.tools.WindowGeometry;
52
53/**
54 * This wizard walks the user to the necessary steps to retrieve an OAuth Access Token which
55 * allows JOSM to access the OSM API on the users behalf.
56 *
57 */
58public class OAuthAuthorizationWizard extends JDialog {
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 panel with buttons
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 panel woth information display
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 HtmlPanel 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 final 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 = GuiHelper.embedInVerticalScrollPane(new JPanel());
174 spAuthorisationProcedureUI.getVerticalScrollBar().addComponentListener(
175 new ComponentListener() {
176 @Override
177 public void componentShown(ComponentEvent e) {
178 spAuthorisationProcedureUI.setBorder(UIManager.getBorder("ScrollPane.border"));
179 }
180
181 @Override
182 public void componentHidden(ComponentEvent e) {
183 spAuthorisationProcedureUI.setBorder(null);
184 }
185
186 @Override
187 public void componentResized(ComponentEvent e) {}
188 @Override
189 public void componentMoved(ComponentEvent e) {}
190 }
191 );
192 getContentPane().add(spAuthorisationProcedureUI, BorderLayout.CENTER);
193 getContentPane().add(buildButtonRow(), BorderLayout.SOUTH);
194
195 addWindowListener(new WindowEventHandler());
196 getRootPane().getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "cancel");
197 getRootPane().getActionMap().put("cancel", new CancelAction());
198
199 refreshAuthorisationProcedurePanel();
200
201 HelpUtil.setHelpContext(getRootPane(), HelpUtil.ht("/Dialog/OAuthAuthorisationWizard"));
202 }
203
204 /**
205 * Creates the wizard.
206 *
207 * @param apiUrl the API URL. Must not be null.
208 * @throws IllegalArgumentException if apiUrl is null
209 */
210 public OAuthAuthorizationWizard(String apiUrl) {
211 this(Main.parent, apiUrl);
212 }
213
214 /**
215 * Creates the wizard.
216 *
217 * @param parent the component relative to which the dialog is displayed
218 * @param apiUrl the API URL. Must not be null.
219 * @throws IllegalArgumentException if apiUrl is null
220 */
221 public OAuthAuthorizationWizard(Component parent, String apiUrl) {
222 super(JOptionPane.getFrameForComponent(parent), ModalityType.DOCUMENT_MODAL);
223 CheckParameterUtil.ensureParameterNotNull(apiUrl, "apiUrl");
224 this.apiUrl = apiUrl;
225 build();
226 }
227
228 /**
229 * Replies true if the dialog was canceled
230 *
231 * @return true if the dialog was canceled
232 */
233 public boolean isCanceled() {
234 return canceled;
235 }
236
237 protected AbstractAuthorizationUI getCurrentAuthorisationUI() {
238 switch((AuthorizationProcedure)cbAuthorisationProcedure.getSelectedItem()) {
239 case FULLY_AUTOMATIC: return pnlFullyAutomaticAuthorisationUI;
240 case MANUALLY: return pnlManualAuthorisationUI;
241 case SEMI_AUTOMATIC: return pnlSemiAutomaticAuthorisationUI;
242 default: return null;
243 }
244 }
245
246 /**
247 * Replies the Access Token entered using the wizard
248 *
249 * @return the access token. May be null if the wizard was canceled.
250 */
251 public OAuthToken getAccessToken() {
252 return getCurrentAuthorisationUI().getAccessToken();
253 }
254
255 /**
256 * Replies the current OAuth parameters.
257 *
258 * @return the current OAuth parameters.
259 */
260 public OAuthParameters getOAuthParameters() {
261 return getCurrentAuthorisationUI().getOAuthParameters();
262 }
263
264 /**
265 * Replies true if the currently selected Access Token shall be saved to
266 * the preferences.
267 *
268 * @return true if the currently selected Access Token shall be saved to
269 * the preferences
270 */
271 public boolean isSaveAccessTokenToPreferences() {
272 return getCurrentAuthorisationUI().isSaveAccessTokenToPreferences();
273 }
274
275 /**
276 * Initializes the dialog with values from the preferences
277 *
278 */
279 public void initFromPreferences() {
280 // Copy current JOSM preferences to update API url with the one used in this wizard
281 Preferences copyPref = CustomConfigurator.clonePreferences(Main.pref);
282 copyPref.put("osm-server.url", apiUrl);
283 pnlFullyAutomaticAuthorisationUI.initFromPreferences(copyPref);
284 pnlSemiAutomaticAuthorisationUI.initFromPreferences(copyPref);
285 pnlManualAuthorisationUI.initFromPreferences(copyPref);
286 }
287
288 @Override
289 public void setVisible(boolean visible) {
290 if (visible) {
291 new WindowGeometry(
292 getClass().getName() + ".geometry",
293 WindowGeometry.centerInWindow(
294 Main.parent,
295 new Dimension(450,540)
296 )
297 ).applySafe(this);
298 initFromPreferences();
299 } else if (isShowing()) { // Avoid IllegalComponentStateException like in #8775
300 new WindowGeometry(this).remember(getClass().getName() + ".geometry");
301 }
302 super.setVisible(visible);
303 }
304
305 protected void setCanceled(boolean canceled) {
306 this.canceled = canceled;
307 }
308
309 class AuthorisationProcedureChangeListener implements ItemListener {
310 @Override
311 public void itemStateChanged(ItemEvent arg0) {
312 refreshAuthorisationProcedurePanel();
313 }
314 }
315
316 class CancelAction extends AbstractAction {
317 public CancelAction() {
318 putValue(NAME, tr("Cancel"));
319 putValue(SMALL_ICON, ImageProvider.get("cancel"));
320 putValue(SHORT_DESCRIPTION, tr("Close the dialog and cancel authorization"));
321 }
322
323 public void cancel() {
324 setCanceled(true);
325 setVisible(false);
326 }
327
328 @Override
329 public void actionPerformed(ActionEvent evt) {
330 cancel();
331 }
332 }
333
334 class AcceptAccessTokenAction extends AbstractAction implements PropertyChangeListener {
335 private transient OAuthToken token;
336
337 public AcceptAccessTokenAction() {
338 putValue(NAME, tr("Accept Access Token"));
339 putValue(SMALL_ICON, ImageProvider.get("ok"));
340 putValue(SHORT_DESCRIPTION, tr("Close the dialog and accept the Access Token"));
341 updateEnabledState(null);
342 }
343
344 @Override
345 public void actionPerformed(ActionEvent evt) {
346 setCanceled(false);
347 setVisible(false);
348 }
349
350 public final void updateEnabledState(OAuthToken token) {
351 setEnabled(token != null);
352 }
353
354 @Override
355 public void propertyChange(PropertyChangeEvent evt) {
356 if (!evt.getPropertyName().equals(AbstractAuthorizationUI.ACCESS_TOKEN_PROP))
357 return;
358 token = (OAuthToken)evt.getNewValue();
359 updateEnabledState(token);
360 }
361 }
362
363 class WindowEventHandler extends WindowAdapter {
364 @Override
365 public void windowClosing(WindowEvent arg0) {
366 new CancelAction().cancel();
367 }
368 }
369
370 static class ExternalBrowserLauncher implements HyperlinkListener {
371 @Override
372 public void hyperlinkUpdate(HyperlinkEvent e) {
373 if (e.getEventType().equals(HyperlinkEvent.EventType.ACTIVATED)) {
374 OpenBrowser.displayUrl(e.getDescription());
375 }
376 }
377 }
378}
Note: See TracBrowser for help on using the repository browser.