// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.oauth;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.io.IOException;
import java.net.Authenticator.RequestorType;
import java.net.PasswordAuthentication;
import javax.swing.AbstractAction;
import javax.swing.BorderFactory;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JTabbedPane;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.JTextComponent;
import javax.swing.text.html.HTMLEditorKit;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.data.Preferences;
import org.openstreetmap.josm.data.oauth.OAuthToken;
import org.openstreetmap.josm.gui.HelpAwareOptionPane;
import org.openstreetmap.josm.gui.PleaseWaitRunnable;
import org.openstreetmap.josm.gui.SideButton;
import org.openstreetmap.josm.gui.help.HelpUtil;
import org.openstreetmap.josm.gui.util.GuiHelper;
import org.openstreetmap.josm.gui.widgets.AbstractTextComponentValidator;
import org.openstreetmap.josm.gui.widgets.HtmlPanel;
import org.openstreetmap.josm.gui.widgets.JMultilineLabel;
import org.openstreetmap.josm.gui.widgets.JosmPasswordField;
import org.openstreetmap.josm.gui.widgets.JosmTextField;
import org.openstreetmap.josm.gui.widgets.SelectAllOnFocusGainedDecorator;
import org.openstreetmap.josm.gui.widgets.VerticallyScrollablePanel;
import org.openstreetmap.josm.io.OsmApi;
import org.openstreetmap.josm.io.OsmTransferException;
import org.openstreetmap.josm.io.auth.CredentialsAgent;
import org.openstreetmap.josm.io.auth.CredentialsAgentException;
import org.openstreetmap.josm.io.auth.CredentialsManager;
import org.openstreetmap.josm.tools.ImageProvider;
import org.xml.sax.SAXException;
/**
* This is an UI which supports a JOSM user to get an OAuth Access Token in a fully
* automatic process.
*
* @since 2746
*/
public class FullyAutomaticAuthorizationUI extends AbstractAuthorizationUI {
private JosmTextField tfUserName;
private JosmPasswordField tfPassword;
private UserNameValidator valUserName;
private PasswordValidator valPassword;
private AccessTokenInfoPanel pnlAccessTokenInfo;
private OsmPrivilegesPanel pnlOsmPrivileges;
private JPanel pnlPropertiesPanel;
private JPanel pnlActionButtonsPanel;
private JPanel pnlResult;
/**
* Builds the panel with the three privileges the user can grant JOSM
*
* @return constructed panel for the privileges
*/
protected VerticallyScrollablePanel buildGrantsPanel() {
pnlOsmPrivileges = new OsmPrivilegesPanel();
return pnlOsmPrivileges;
}
/**
* Builds the panel for entering the username and password
*
* @return constructed panel for the creditentials
*/
protected VerticallyScrollablePanel buildUserNamePasswordPanel() {
VerticallyScrollablePanel pnl = new VerticallyScrollablePanel(new GridBagLayout());
GridBagConstraints gc = new GridBagConstraints();
pnl.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
gc.anchor = GridBagConstraints.NORTHWEST;
gc.fill = GridBagConstraints.HORIZONTAL;
gc.weightx = 1.0;
gc.gridwidth = 2;
HtmlPanel pnlMessage = new HtmlPanel();
HTMLEditorKit kit = (HTMLEditorKit)pnlMessage.getEditorPane().getEditorKit();
kit.getStyleSheet().addRule(".warning-body {background-color:rgb(253,255,221);padding: 10pt; border-color:rgb(128,128,128);border-style: solid;border-width: 1px;}");
kit.getStyleSheet().addRule("ol {margin-left: 1cm}");
pnlMessage.setText("<html><body><p class=\"warning-body\">"
+ tr("Please enter your OSM user name and password. The password will <strong>not</strong> be saved "
+ "in clear text in the JOSM preferences and it will be submitted to the OSM server <strong>only once</strong>. "
+ "Subsequent data upload requests don''t use your password any more.")
+ "</p>"
+ "</body></html>");
pnl.add(pnlMessage, gc);
// the user name input field
gc.gridy = 1;
gc.gridwidth = 1;
gc.anchor = GridBagConstraints.NORTHWEST;
gc.fill = GridBagConstraints.HORIZONTAL;
gc.weightx = 0.0;
gc.insets = new Insets(0,0,3,3);
pnl.add(new JLabel(tr("Username: ")), gc);
gc.gridx = 1;
gc.weightx = 1.0;
pnl.add(tfUserName = new JosmTextField(), gc);
SelectAllOnFocusGainedDecorator.decorate(tfUserName);
valUserName = new UserNameValidator(tfUserName);
valUserName.validate();
// the password input field
gc.anchor = GridBagConstraints.NORTHWEST;
gc.fill = GridBagConstraints.HORIZONTAL;
gc.gridy = 2;
gc.gridx = 0;
gc.weightx = 0.0;
pnl.add(new JLabel(tr("Password: ")), gc);
gc.gridx = 1;
gc.weightx = 1.0;
pnl.add(tfPassword = new JosmPasswordField(), gc);
SelectAllOnFocusGainedDecorator.decorate(tfPassword);
valPassword = new PasswordValidator(tfPassword);
valPassword.validate();
gc.gridy = 3;
gc.gridx = 0;
gc.anchor = GridBagConstraints.NORTHWEST;
gc.fill = GridBagConstraints.HORIZONTAL;
gc.weightx = 1.0;
gc.gridwidth = 2;
pnlMessage = new HtmlPanel();
kit = (HTMLEditorKit)pnlMessage.getEditorPane().getEditorKit();
kit.getStyleSheet().addRule(".warning-body {background-color:rgb(253,255,221);padding: 10pt; border-color:rgb(128,128,128);border-style: solid;border-width: 1px;}");
kit.getStyleSheet().addRule("ol {margin-left: 1cm}");
pnlMessage.setText("<html><body>"
+ "<p class=\"warning-body\">"
+ tr("<strong>Warning:</strong> JOSM does login <strong>once</strong> using a secure connection.")
+ "</p>"
+ "</body></html>");
pnl.add(pnlMessage, gc);
// filler - grab remaining space
gc.gridy = 4;
gc.gridwidth = 2;
gc.fill = GridBagConstraints.BOTH;
gc.weightx = 1.0;
gc.weighty = 1.0;
pnl.add(new JPanel(), gc);
return pnl;
}
protected JPanel buildPropertiesPanel() {
JPanel pnl = new JPanel(new BorderLayout());
JTabbedPane tpProperties = new JTabbedPane();
tpProperties.add(buildUserNamePasswordPanel().getVerticalScrollPane());
tpProperties.add(buildGrantsPanel().getVerticalScrollPane());
tpProperties.add(getAdvancedPropertiesPanel().getVerticalScrollPane());
tpProperties.setTitleAt(0, tr("Basic"));
tpProperties.setTitleAt(1, tr("Granted rights"));
tpProperties.setTitleAt(2, tr("Advanced OAuth properties"));
pnl.add(tpProperties, BorderLayout.CENTER);
return pnl;
}
/**
* Initializes the panel with values from the preferences
* @param pref Preferences structure
*/
@Override
public void initFromPreferences(Preferences pref) {
super.initFromPreferences(pref);
CredentialsAgent cm = CredentialsManager.getInstance();
try {
PasswordAuthentication pa = cm.lookup(RequestorType.SERVER, OsmApi.getOsmApi().getHost());
if (pa == null) {
tfUserName.setText("");
tfPassword.setText("");
} else {
tfUserName.setText(pa.getUserName() == null ? "" : pa.getUserName());
tfPassword.setText(pa.getPassword() == null ? "" : String.valueOf(pa.getPassword()));
}
} catch(CredentialsAgentException e) {
Main.error(e);
tfUserName.setText("");
tfPassword.setText("");
}
}
/**
* Builds the panel with the action button for starting the authorisation
*
* @return constructed button panel
*/
protected JPanel buildActionButtonPanel() {
JPanel pnl = new JPanel(new FlowLayout(FlowLayout.LEFT));
RunAuthorisationAction runAuthorisationAction= new RunAuthorisationAction();
tfPassword.getDocument().addDocumentListener(runAuthorisationAction);
tfUserName.getDocument().addDocumentListener(runAuthorisationAction);
pnl.add(new SideButton(runAuthorisationAction));
return pnl;
}
/**
* Builds the panel which displays the generated Access Token.
*
* @return constructed panel for the results
*/
protected JPanel buildResultsPanel() {
JPanel pnl = new JPanel(new GridBagLayout());
GridBagConstraints gc = new GridBagConstraints();
pnl.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
// the message panel
gc.anchor = GridBagConstraints.NORTHWEST;
gc.fill = GridBagConstraints.HORIZONTAL;
gc.weightx = 1.0;
JMultilineLabel msg = new JMultilineLabel("");
msg.setFont(msg.getFont().deriveFont(Font.PLAIN));
String lbl = tr("Accept Access Token");
msg.setText(tr("<html>"
+ "You have successfully retrieved an OAuth Access Token from the OSM website. "
+ "Click on <strong>{0}</strong> to accept the token. JOSM will use it in "
+ "subsequent requests to gain access to the OSM API."
+ "</html>",lbl));
pnl.add(msg, gc);
// infos about the access token
gc.gridy = 1;
gc.insets = new Insets(5,0,0,0);
pnl.add(pnlAccessTokenInfo = new AccessTokenInfoPanel(), gc);
// the actions
JPanel pnl1 = new JPanel(new FlowLayout(FlowLayout.LEFT));
pnl1.add(new SideButton(new BackAction()));
pnl1.add(new SideButton(new TestAccessTokenAction()));
gc.gridy = 2;
pnl.add(pnl1, gc);
// filler - grab the remaining space
gc.gridy = 3;
gc.fill = GridBagConstraints.BOTH;
gc.weightx = 1.0;
gc.weighty = 1.0;
pnl.add(new JPanel(), gc);
return pnl;
}
protected final void build() {
setLayout(new BorderLayout());
pnlPropertiesPanel = buildPropertiesPanel();
pnlActionButtonsPanel = buildActionButtonPanel();
pnlResult = buildResultsPanel();
prepareUIForEnteringRequest();
}
/**
* Prepares the UI for the first step in the automatic process: entering the authentication
* and authorisation parameters.
*
*/
protected void prepareUIForEnteringRequest() {
removeAll();
add(pnlPropertiesPanel, BorderLayout.CENTER);
add(pnlActionButtonsPanel, BorderLayout.SOUTH);
pnlPropertiesPanel.revalidate();
pnlActionButtonsPanel.revalidate();
validate();
repaint();
setAccessToken(null);
}
/**
* Prepares the UI for the second step in the automatic process: displaying the access token
*
*/
protected void prepareUIForResultDisplay() {
removeAll();
add(pnlResult, BorderLayout.CENTER);
validate();
repaint();
}
protected String getOsmUserName() {
return tfUserName.getText();
}
protected String getOsmPassword() {
return String.valueOf(tfPassword.getPassword());
}
/**
* Constructs a new {@code FullyAutomaticAuthorizationUI} for the given API URL.
* @param apiUrl The OSM API URL
* @since 5422
*/
public FullyAutomaticAuthorizationUI(String apiUrl) {
super(apiUrl);
build();
}
@Override
public boolean isSaveAccessTokenToPreferences() {
return pnlAccessTokenInfo.isSaveToPreferences();
}
@Override
protected void setAccessToken(OAuthToken accessToken) {
super.setAccessToken(accessToken);
pnlAccessTokenInfo.setAccessToken(accessToken);
}
/**
* Starts the authorisation process
*/
class RunAuthorisationAction extends AbstractAction implements DocumentListener{
public RunAuthorisationAction() {
putValue(NAME, tr("Authorize now"));
putValue(SMALL_ICON, ImageProvider.get("oauth", "oauth"));
putValue(SHORT_DESCRIPTION, tr("Click to redirect you to the authorization form on the JOSM web site"));
updateEnabledState();
}
@Override
public void actionPerformed(ActionEvent evt) {
Main.worker.submit(new FullyAutomaticAuthorisationTask(FullyAutomaticAuthorizationUI.this));
}
protected final void updateEnabledState() {
setEnabled(valPassword.isValid() && valUserName.isValid());
}
@Override
public void changedUpdate(DocumentEvent e) {
updateEnabledState();
}
@Override
public void insertUpdate(DocumentEvent e) {
updateEnabledState();
}
@Override
public void removeUpdate(DocumentEvent e) {
updateEnabledState();
}
}
/**
* Action to go back to step 1 in the process
*/
class BackAction extends AbstractAction {
public BackAction() {
putValue(NAME, tr("Back"));
putValue(SHORT_DESCRIPTION, tr("Run the automatic authorization steps again"));
putValue(SMALL_ICON, ImageProvider.get("dialogs", "previous"));
}
@Override
public void actionPerformed(ActionEvent arg0) {
prepareUIForEnteringRequest();
}
}
/**
* Action to test an access token.
*/
class TestAccessTokenAction extends AbstractAction {
public TestAccessTokenAction() {
putValue(NAME, tr("Test Access Token"));
putValue(SMALL_ICON, ImageProvider.get("about"));
}
@Override
public void actionPerformed(ActionEvent arg0) {
Main.worker.submit(new TestAccessTokenTask(
FullyAutomaticAuthorizationUI.this,
getApiUrl(),
getAdvancedPropertiesPanel().getAdvancedParameters(),
getAccessToken()
));
}
}
private static class UserNameValidator extends AbstractTextComponentValidator {
public UserNameValidator(JTextComponent tc) {
super(tc);
}
@Override
public boolean isValid() {
return getComponent().getText().trim().length() > 0;
}
@Override
public void validate() {
if (isValid()) {
feedbackValid(tr("Please enter your OSM user name"));
} else {
feedbackInvalid(tr("The user name cannot be empty. Please enter your OSM user name"));
}
}
}
private static class PasswordValidator extends AbstractTextComponentValidator {
public PasswordValidator(JTextComponent tc) {
super(tc);
}
@Override
public boolean isValid() {
return getComponent().getText().trim().length() > 0;
}
@Override
public void validate() {
if (isValid()) {
feedbackValid(tr("Please enter your OSM password"));
} else {
feedbackInvalid(tr("The password cannot be empty. Please enter your OSM password"));
}
}
}
class FullyAutomaticAuthorisationTask extends PleaseWaitRunnable {
private boolean canceled;
private OsmOAuthAuthorizationClient authClient;
public FullyAutomaticAuthorisationTask(Component parent) {
super(parent, tr("Authorize JOSM to access the OSM API"), false /* don't ignore exceptions */);
}
@Override
protected void cancel() {
canceled = true;
}
@Override
protected void finish() {}
protected void alertAuthorisationFailed(OsmOAuthAuthorizationException e) {
HelpAwareOptionPane.showOptionDialog(
FullyAutomaticAuthorizationUI.this,
tr("<html>"
+ "The automatic process for retrieving an OAuth Access Token<br>"
+ "from the OSM server failed.<br><br>"
+ "Please try again or choose another kind of authorization process,<br>"
+ "i.e. semi-automatic or manual authorization."
+"</html>"),
tr("OAuth authorization failed"),
JOptionPane.ERROR_MESSAGE,
HelpUtil.ht("/Dialog/OAuthAuthorisationWizard#FullyAutomaticProcessFailed")
);
}
protected void alertInvalidLoginUrl() {
HelpAwareOptionPane.showOptionDialog(
FullyAutomaticAuthorizationUI.this,
tr("<html>"
+ "The automatic process for retrieving an OAuth Access Token<br>"
+ "from the OSM server failed because JOSM was not able to build<br>"
+ "a valid login URL from the OAuth Authorize Endpoint URL ''{0}''.<br><br>"
+ "Please check your advanced setting and try again."
+ "</html>",
getAdvancedPropertiesPanel().getAdvancedParameters().getAuthoriseUrl()),
tr("OAuth authorization failed"),
JOptionPane.ERROR_MESSAGE,
HelpUtil.ht("/Dialog/OAuthAuthorisationWizard#FullyAutomaticProcessFailed")
);
}
protected void alertLoginFailed(OsmLoginFailedException e) {
String loginUrl = null;
try {
loginUrl = authClient.buildOsmLoginUrl();
} catch(OsmOAuthAuthorizationException e1) {
alertInvalidLoginUrl();
return;
}
HelpAwareOptionPane.showOptionDialog(
FullyAutomaticAuthorizationUI.this,
tr("<html>"
+ "The automatic process for retrieving an OAuth Access Token<br>"
+ "from the OSM server failed. JOSM failed to log into {0}<br>"
+ "for user {1}.<br><br>"
+ "Please check username and password and try again."
+"</html>",
loginUrl,
getOsmUserName()),
tr("OAuth authorization failed"),
JOptionPane.ERROR_MESSAGE,
HelpUtil.ht("/Dialog/OAuthAuthorisationWizard#FullyAutomaticProcessFailed")
);
}
protected void handleException(final OsmOAuthAuthorizationException e) {
Runnable r = new Runnable() {
@Override
public void run() {
if (e instanceof OsmLoginFailedException) {
alertLoginFailed((OsmLoginFailedException)e);
} else {
alertAuthorisationFailed(e);
}
}
};
Main.error(e);
GuiHelper.runInEDT(r);
}
@Override
protected void realRun() throws SAXException, IOException, OsmTransferException {
try {
getProgressMonitor().setTicksCount(3);
authClient = new OsmOAuthAuthorizationClient(
getAdvancedPropertiesPanel().getAdvancedParameters()
);
OAuthToken requestToken = authClient.getRequestToken(
getProgressMonitor().createSubTaskMonitor(1, false)
);
getProgressMonitor().worked(1);
if (canceled)return;
authClient.authorise(
requestToken,
getOsmUserName(),
getOsmPassword(),
pnlOsmPrivileges.getPrivileges(),
getProgressMonitor().createSubTaskMonitor(1, false)
);
getProgressMonitor().worked(1);
if (canceled)return;
final OAuthToken accessToken = authClient.getAccessToken(
getProgressMonitor().createSubTaskMonitor(1,false)
);
getProgressMonitor().worked(1);
if (canceled)return;
GuiHelper.runInEDT(new Runnable() {
@Override
public void run() {
prepareUIForResultDisplay();
setAccessToken(accessToken);
}
});
} catch(final OsmOAuthAuthorizationException e) {
handleException(e);
}
}
}
}