Changeset 4246 in josm for trunk

Timestamp:

2011-07-14T21:38:33+02:00 (13 years ago)

Author:

bastiK

Message:

plugin hook for credentials handling

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/ExtendedDialog.java (modified) (5 diffs)
• gui/JosmUserIdentityManager.java (modified) (1 diff)
• gui/preferences/server/OsmApiUrlInputPanel.java (modified) (1 diff)
• gui/preferences/server/ProxyPreferencesPanel.java (modified) (2 diffs)
• io/auth/AbstractCredentialsAgent.java (added)
• io/auth/CredentialsManager.java (modified) (3 diffs)
• io/auth/JosmPreferencesCredentialAgent.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java

@@ -53 +53 @@
  * So for getValue(), setDefaultButton(int) and setCancelButton(int) the
  * first button has index 1.
+ * 
+ * Simple example:
+ * <code>
+ *  ExtendedDialog ed = new ExtendedDialog(
+ *          Main.parent, tr("Dialog Title"),
+ *          new String[] {tr("Ok"), tr("Cancel")});
+ *  ed.setButtonIcons(new String[] {"ok", "cancel"});   // optional
+ *  ed.setIcon(JOptionPane.WARNING_MESSAGE);            // optional
+ *  ed.setContent(tr("Really proceed? Interesting things may happen..."));
+ *  ed.showDialog();
+ *  if (ed.getValue() == 1) { // user clicked first button "Ok"
+ *      // proceed...
+ *  }
+ * </code>
  */
 public class ExtendedDialog extends JDialog {
@@ -282 +296 @@
         JPanel buttonsPanel = new JPanel(new GridBagLayout());
 
-        for(int i=0; i < bTexts.length; i++) {
+        for (int i=0; i < bTexts.length; i++) {
             final int final_i = i;
             Action action = new AbstractAction(bTexts[i]) {
-                public void actionPerformed(ActionEvent evt) {
+                @Override public void actionPerformed(ActionEvent evt) {
                     buttonAction(final_i, evt);
                 }
@@ -415 +429 @@
     private void setupEscListener() {
         Action actionListener = new AbstractAction() {
-            public void actionPerformed(ActionEvent actionEvent) {
+            @Override public void actionPerformed(ActionEvent actionEvent) {
                 // 0 means that the dialog has been closed otherwise.
                 // We need to set it to zero again, in case the dialog has been re-used
@@ -535 +549 @@
         if (toggleable && defaultButton != null) {
             SwingUtilities.invokeLater(new Runnable() {
-                public void run() {
+                @Override public void run() {
                     defaultButton.requestFocusInWindow();
                 }
@@ -611 +625 @@
         }
 
-        public void actionPerformed(ActionEvent e) {
+        @Override public void actionPerformed(ActionEvent e) {
             HelpBrowser.setUrlForHelpTopic(helpTopic);
         }

trunk/src/org/openstreetmap/josm/gui/JosmUserIdentityManager.java

@@ -25 +25 @@
  *
  * The current user is fully identified if JOSM knows both the user name and the unique
- * id of the users OSM account. The later is retrieved from the OSM server with a
+ * id of the users OSM account. The latter is retrieved from the OSM server with a
  * <tt>GET /api/0.6/user/details</tt> request, submitted with the user name and password
  * of the current user.

trunk/src/org/openstreetmap/josm/gui/preferences/server/OsmApiUrlInputPanel.java

@@ -38 +38 @@
     static public final String API_URL_PROP = OsmApiUrlInputPanel.class.getName() + ".apiUrl";
 
-    static private final String defaulturl = "http://api.openstreetmap.org/api";
+    static public final String defaulturl = "http://api.openstreetmap.org/api";
     private JLabel lblValid;
     private JLabel lblApiUrl;

trunk/src/org/openstreetmap/josm/gui/preferences/server/ProxyPreferencesPanel.java

@@ -292 +292 @@
         String policy = Main.pref.get(PROXY_POLICY, null);
         ProxyPolicy pp = ProxyPolicy.fromName(policy);
-        pp = pp == null? ProxyPolicy.NO_PROXY: pp;
+        if (pp == null) {
+            pp = ProxyPolicy.NO_PROXY;
+        }
         rbProxyPolicy.get(pp).setSelected(true);
         String value = Main.pref.get("proxy.host", null);
@@ -353 +355 @@
 
     class ProxyPolicyChangeListener implements ItemListener {
+        @Override
         public void itemStateChanged(ItemEvent arg0) {
             updateEnabledState();

trunk/src/org/openstreetmap/josm/io/auth/CredentialsManager.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.io.auth;
+
+import java.net.Authenticator.RequestorType;
+import java.net.PasswordAuthentication;
+
+import org.openstreetmap.josm.data.oauth.OAuthToken;
 
 /**
@@ -8 +13 @@
  *
  */
-public class CredentialsManager {
-    private static CredentialsAgent instance;
+public class CredentialsManager implements CredentialsAgent {
+   
+    private static CredentialsManager instance;
 
     /**
@@ -16 +22 @@
      * @return the single credential agent used in JOSM
      */
-    static public CredentialsAgent getInstance() {
+    static public CredentialsManager getInstance() {
         if (instance == null) {
-            instance =  new JosmPreferencesCredentialAgent();
+            CredentialsAgent delegate;
+            if (agentFactory == null) {
+                delegate = new JosmPreferencesCredentialAgent();
+            } else {
+                delegate = agentFactory.getCredentialsAgent();
+            }
+            instance = new CredentialsManager(delegate);
         }
         return instance;
     }
+    
+    private static CredentialsAgentFactory agentFactory;
+
+    public interface CredentialsAgentFactory {
+        CredentialsAgent getCredentialsAgent();
+    }
+    
+    /**
+     * Plugins can register a CredentialsAgentFactory, thereby overriding
+     * JOSM's default credentials agent.
+     */
+    public static void registerCredentialsAgentFactory(CredentialsAgentFactory agentFactory) {
+        CredentialsManager.agentFactory = agentFactory;
+        CredentialsManager.instance = null;
+    }
+
+    /*****
+     * non-static fields and methods
+     */
+    
+    private CredentialsAgent delegate;
+
+    public CredentialsManager(CredentialsAgent delegate) {
+        this.delegate = delegate;
+    }
+
+    @Override
+    public PasswordAuthentication lookup(RequestorType requestorType) throws CredentialsAgentException {
+        return delegate.lookup(requestorType);
+    }
+
+    @Override
+    public void store(RequestorType requestorType, PasswordAuthentication credentials) throws CredentialsAgentException {
+        delegate.store(requestorType, credentials);
+    }
+
+    @Override
+    public CredentialsAgentResponse getCredentials(RequestorType requestorType, boolean noSuccessWithLastResponse) throws CredentialsAgentException {
+        return delegate.getCredentials(requestorType, noSuccessWithLastResponse);
+    }
+
+    @Override
+    public OAuthToken lookupOAuthAccessToken() throws CredentialsAgentException {
+        return delegate.lookupOAuthAccessToken();
+    }
+
+    @Override
+    public void storeOAuthAccessToken(OAuthToken accessToken) throws CredentialsAgentException {
+        delegate.storeOAuthAccessToken(accessToken);
+    }
 }

trunk/src/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgent.java

@@ -4 +4 @@
 import java.net.PasswordAuthentication;
 import java.net.Authenticator.RequestorType;
-import java.util.HashMap;
-import java.util.Map;
 
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.oauth.OAuthToken;
-import org.openstreetmap.josm.gui.io.CredentialDialog;
 import org.openstreetmap.josm.gui.preferences.server.ProxyPreferencesPanel;
 
@@ -17 +14 @@
  *
  */
-public class JosmPreferencesCredentialAgent implements CredentialsAgent {
+public class JosmPreferencesCredentialAgent extends AbstractCredentialsAgent {
 
-    Map<RequestorType, PasswordAuthentication> memoryCredentialsCache = new HashMap<RequestorType, PasswordAuthentication>();
     /**
      * @see CredentialsAgent#lookup(RequestorType)
@@ -74 +70 @@
 
     /**
-     * @see CredentialsAgent#getCredentials(RequestorType, boolean)
-     */
-    @Override
-    public CredentialsAgentResponse getCredentials(RequestorType requestorType, boolean noSuccessWithLastResponse) throws CredentialsAgentException{
-        if (requestorType == null)
-            return null;
-        PasswordAuthentication credentials =  lookup(requestorType);
-        String username = (credentials == null || credentials.getUserName() == null) ? "" : credentials.getUserName();
-        String password = (credentials == null || credentials.getPassword() == null) ? "" : String.valueOf(credentials.getPassword());
-
-        CredentialsAgentResponse response = new CredentialsAgentResponse();
-
-        /*
-         * Last request was successful and there was no credentials stored
-         * in file (or only the username is stored).
-         * -> Try to recall credentials that have been entered
-         * manually in this session.
-         */
-        if (!noSuccessWithLastResponse && memoryCredentialsCache.containsKey(requestorType) &&
-                (credentials == null || credentials.getPassword() == null || credentials.getPassword().length == 0)) {
-            PasswordAuthentication pa = memoryCredentialsCache.get(requestorType);
-            response.setUsername(pa.getUserName());
-            response.setPassword(pa.getPassword());
-            response.setCanceled(false);
-        /*
-         * Prompt the user for credentials. This happens the first time each
-         * josm start if the user does not save the credentials to preference
-         * file (username=="") and each time after authentication failed
-         * (noSuccessWithLastResponse == true).
-         */
-        } else if (noSuccessWithLastResponse || username.equals("") || password.equals("")) {
-            CredentialDialog dialog = null;
-            switch(requestorType) {
-            case SERVER: dialog = CredentialDialog.getOsmApiCredentialDialog(username, password); break;
-            case PROXY: dialog = CredentialDialog.getHttpProxyCredentialDialog(username, password); break;
-            }
-            dialog.setVisible(true);
-            response.setCanceled(dialog.isCanceled());
-            if (dialog.isCanceled())
-                return response;
-            response.setUsername(dialog.getUsername());
-            response.setPassword(dialog.getPassword());
-            if (dialog.isSaveCredentials()) {
-                store(requestorType, new PasswordAuthentication(
-                        response.getUsername(),
-                        response.getPassword()
-                ));
-            /*
-             * User decides not to save credentials to file. Keep it
-             * in memory so we don't have to ask over and over again.
-             */
-            } else {
-                PasswordAuthentication pa = new PasswordAuthentication(dialog.getUsername(), dialog.getPassword());
-                memoryCredentialsCache.put(requestorType, pa);
-            }
-        /*
-         * We got it from file.
-         */
-        } else {
-            response.setUsername(username);
-            response.setPassword(password.toCharArray());
-            response.setCanceled(false);
-        }
-        return response;
-    }
-
-    /**
      * Lookup the current OAuth Access Token to access the OSM server. Replies null, if no
      * Access Token is currently managed by this CredentialManager.