Changeset 16422 in josm

Timestamp:

2020-05-16T16:38:31+02:00 (4 years ago)

Author:

simon04

Message:

fix #18820, see #13872 - Make OAuth signing of all API requests configurable

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/preferences/server/OAuthAuthenticationPreferencesPanel.java (modified) (6 diffs)
• io/OsmApi.java (modified) (2 diffs)
• io/OsmServerReader.java (modified) (1 diff)

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

@@ -34 +34 @@
 import org.openstreetmap.josm.io.OsmApi;
 import org.openstreetmap.josm.io.auth.CredentialsManager;
+import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.ImageProvider;
 import org.openstreetmap.josm.tools.Logging;
@@ -47 +48 @@
  */
 public class OAuthAuthenticationPreferencesPanel extends JPanel implements PropertyChangeListener {
-    private final JCheckBox cbShowAdvancedParameters = new JCheckBox();
+    private final JCheckBox cbUseForAllRequests = new JCheckBox();
+    private final JCheckBox cbShowAdvancedParameters = new JCheckBox(tr("Display Advanced OAuth Parameters"));
     private final JCheckBox cbSaveToPreferences = new JCheckBox(tr("Save to preferences"));
     private final JPanel pnlAuthorisationMessage = new JPanel(new BorderLayout());
@@ -70 +72 @@
     protected JPanel buildAdvancedPropertiesPanel() {
         JPanel pnl = new JPanel(new GridBagLayout());
-        GridBagConstraints gc = new GridBagConstraints();
-
-        gc.anchor = GridBagConstraints.NORTHWEST;
-        gc.fill = GridBagConstraints.HORIZONTAL;
-        gc.weightx = 0.0;
-        gc.insets = new Insets(0, 0, 0, 3);
-        pnl.add(cbShowAdvancedParameters, gc);
+
+        cbUseForAllRequests.setText(tr("Use OAuth for all requests to {0}", OsmApi.getOsmApi().getServerUrl()));
+        cbUseForAllRequests.setToolTipText(tr("For user-based bandwith limit instead of IP-based one"));
+        pnl.add(cbUseForAllRequests, GBC.eol().fill(GBC.HORIZONTAL));
+
+        pnl.add(cbShowAdvancedParameters, GBC.eol().fill(GBC.HORIZONTAL));
         cbShowAdvancedParameters.setSelected(false);
         cbShowAdvancedParameters.addItemListener(
@@ -82 +83 @@
         );
 
-        gc.gridx = 1;
-        gc.weightx = 1.0;
-        JMultilineLabel lbl = new JMultilineLabel(tr("Display Advanced OAuth Parameters"));
-        lbl.setFont(lbl.getFont().deriveFont(Font.PLAIN));
-        pnl.add(lbl, gc);
-
-        gc.gridy = 1;
-        gc.gridx = 1;
-        gc.insets = new Insets(3, 0, 3, 0);
-        gc.fill = GridBagConstraints.BOTH;
-        gc.weightx = 1.0;
-        gc.weighty = 1.0;
-        pnl.add(pnlAdvancedProperties, gc);
+        pnl.add(pnlAdvancedProperties, GBC.eol().fill(GBC.HORIZONTAL).insets(0, 3, 0, 0));
         pnlAdvancedProperties.initialize(OsmApi.getOsmApi().getServerUrl());
         pnlAdvancedProperties.setBorder(
@@ -153 +142 @@
     public void initFromPreferences() {
         setApiUrl(OsmApi.getOsmApi().getServerUrl().trim());
+        cbUseForAllRequests.setSelected(OsmApi.USE_OAUTH_FOR_ALL_REQUESTS.get());
         refreshView();
     }
@@ -162 +152 @@
         OAuthAccessTokenHolder.getInstance().setSaveToPreferences(cbSaveToPreferences.isSelected());
         OAuthAccessTokenHolder.getInstance().save(CredentialsManager.getInstance());
+        OsmApi.USE_OAUTH_FOR_ALL_REQUESTS.put(cbUseForAllRequests.isSelected());
         pnlAdvancedProperties.rememberPreferences();
     }

trunk/src/org/openstreetmap/josm/io/OsmApi.java

@@ -31 +31 @@
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.OsmPrimitiveType;
+import org.openstreetmap.josm.data.preferences.BooleanProperty;
 import org.openstreetmap.josm.gui.progress.NullProgressMonitor;
 import org.openstreetmap.josm.gui.progress.ProgressMonitor;
@@ -69 +70 @@
      */
     public static final int MAX_DOWNLOAD_THREADS = 2;
+
+    /**
+     * Defines whether all OSM API requests should be signed with an OAuth token (user-based bandwith limit instead of IP-based one)
+     */
+    public static final BooleanProperty USE_OAUTH_FOR_ALL_REQUESTS = new BooleanProperty("oauth.use-for-all-requests", true);
 
     // The collection of instantiated OSM APIs

trunk/src/org/openstreetmap/josm/io/OsmServerReader.java

@@ -50 +50 @@
     public OsmServerReader() {
         try {
-            doAuthenticate = OsmApi.isUsingOAuth() && CredentialsManager.getInstance().lookupOAuthAccessToken() != null;
+            doAuthenticate = OsmApi.isUsingOAuth()
+                    && CredentialsManager.getInstance().lookupOAuthAccessToken() != null
+                    && OsmApi.USE_OAUTH_FOR_ALL_REQUESTS.get();
         } catch (CredentialsAgentException e) {
             Logging.warn(e);