Changeset 18663 in josm for trunk

Timestamp:

2023-02-15T16:39:22+01:00 (22 months ago)

Author:

taylor.smock

Message:

Fix #22497: Add setting to only proxy specific hosts (patch by TrickyFoxy)

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/preferences/server/ProxyPreferencesPanel.java (modified) (9 diffs)
• io/DefaultProxySelector.java (modified) (5 diffs)

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

@@ -20 +20 @@
 import java.util.Map;
 import java.util.Optional;
+import java.util.ArrayList;
 
 import javax.swing.BorderFactory;
@@ -32 +33 @@
 import org.openstreetmap.josm.gui.widgets.JosmTextField;
 import org.openstreetmap.josm.gui.widgets.VerticallyScrollablePanel;
+import org.openstreetmap.josm.gui.widgets.EditableList;
 import org.openstreetmap.josm.io.DefaultProxySelector;
 import org.openstreetmap.josm.io.ProxyPolicy;
@@ -47 +49 @@
 public class ProxyPreferencesPanel extends VerticallyScrollablePanel {
 
+    private static final long serialVersionUID = -2479852374189976764L;
+
     static final class AutoSizePanel extends JPanel {
+        private static final long serialVersionUID = 7469560761925020366L;
+
         AutoSizePanel() {
             super(new GridBagLayout());
@@ -65 +71 @@
     private final JosmTextField tfProxyHttpUser = new JosmTextField(20);
     private final JosmPasswordField tfProxyHttpPassword = new JosmPasswordField(20);
+    private final EditableList tfExceptionHosts = new EditableList(tr("No proxy for"));
+    private final EditableList tfIncludeHosts = new EditableList(tr("Proxy only for"));
 
     private JPanel pnlHttpProxyConfigurationPanel;
     private JPanel pnlSocksProxyConfigurationPanel;
+    private JPanel pnlIncludeOrExcludeHostsPanel;
 
     /**
@@ -168 +177 @@
         pnl.add(tfProxySocksPort, gc);
         tfProxySocksPort.setMinimumSize(tfProxySocksPort.getPreferredSize());
+
+        // add an extra spacer, otherwise the layout is broken
+        gc.gridy = 2;
+        gc.gridx = 0;
+        gc.gridwidth = 2;
+        gc.fill = GridBagConstraints.BOTH;
+        gc.weightx = 1.0;
+        gc.weighty = 1.0;
+        pnl.add(new JPanel(), gc);
+        return pnl;
+    }
+
+    protected final JPanel buildExceptionIncludesHostsProxyConfigurationPanel() {
+        JPanel pnl = new AutoSizePanel();
+        GridBagConstraints gc = new GridBagConstraints();
+        gc.anchor = GridBagConstraints.LINE_START;
+        gc.insets = new Insets(5, 5, 0, 0);
+        gc.weightx = 0.0;
+        pnl.add(new JLabel(tr("No proxy for (hosts):")), gc);
+
+        gc.gridx = 1;
+        gc.weightx = 0.0;
+        gc.fill = GridBagConstraints.NONE;
+        pnl.add(new JLabel(tr("Proxy only for (hosts):")), gc);
+
+        gc.gridy = 1;
+        gc.gridx = 0;
+        gc.weightx = 1.0;
+        gc.fill = HORIZONTAL;
+        tfExceptionHosts.setMinimumSize(tfExceptionHosts.getPreferredSize());
+        pnl.add(tfExceptionHosts, gc);
+
+        gc.gridx = 1;
+        gc.weightx = 1.0;
+        gc.fill = HORIZONTAL;
+        tfIncludeHosts.setMinimumSize(tfIncludeHosts.getPreferredSize());
+        pnl.add(tfIncludeHosts, gc);
 
         // add an extra spacer, otherwise the layout is broken
@@ -215 +261 @@
         pnlSocksProxyConfigurationPanel = buildSocksProxyConfigurationPanel();
         pnl.add(pnlSocksProxyConfigurationPanel, GBC.eop().fill(HORIZONTAL));
+
+        pnl.add(Box.createVerticalGlue(), GBC.eol().fill());
+
+        // the panel with the exception and includes hosts
+        pnlIncludeOrExcludeHostsPanel = buildExceptionIncludesHostsProxyConfigurationPanel();
+        pnl.add(pnlIncludeOrExcludeHostsPanel, GBC.eop().fill(HORIZONTAL));
 
         pnl.add(Box.createVerticalGlue(), GBC.eol().fill());
@@ -239 +291 @@
         tfProxySocksHost.setText(pref.get(DefaultProxySelector.PROXY_SOCKS_HOST, ""));
         tfProxySocksPort.setText(pref.get(DefaultProxySelector.PROXY_SOCKS_PORT, ""));
+        tfExceptionHosts.setItems(pref.getList(DefaultProxySelector.PROXY_EXCEPTIONS, new ArrayList<>()));
+        tfIncludeHosts.setItems(pref.getList(DefaultProxySelector.PROXY_INCLUDES, new ArrayList<>()));
 
         if (pp == ProxyPolicy.USE_SYSTEM_SETTINGS && !DefaultProxySelector.willJvmRetrieveSystemProxies()) {
@@ -278 +332 @@
 
         rbProxyPolicy.get(ProxyPolicy.USE_SYSTEM_SETTINGS).setEnabled(DefaultProxySelector.willJvmRetrieveSystemProxies());
+
+        boolean proxyEnabled = !rbProxyPolicy.get(ProxyPolicy.NO_PROXY).isSelected();
+        for (Component c : pnlIncludeOrExcludeHostsPanel.getComponents()) {
+            c.setEnabled(proxyEnabled);
+        }
     }
 
@@ -312 +371 @@
         pref.put(DefaultProxySelector.PROXY_SOCKS_HOST, tfProxySocksHost.getText());
         pref.put(DefaultProxySelector.PROXY_SOCKS_PORT, tfProxySocksPort.getText());
+        pref.putList(DefaultProxySelector.PROXY_EXCEPTIONS, tfExceptionHosts.getItems());
+        pref.putList(DefaultProxySelector.PROXY_INCLUDES, tfIncludeHosts.getItems());
+
 
         // update the proxy selector

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

@@ -44 +44 @@
     /** Property key for proxy exceptions list */
     public static final String PROXY_EXCEPTIONS = "proxy.exceptions";
+    /**
+     * Property key for hosts that should be proxied (if this is set, only specified hosts should be proxied)
+     * @since 18663
+     */
+    public static final String PROXY_INCLUDES = "proxy.includes.hosts";
 
     private static final List<Proxy> NO_PROXY_LIST = Collections.singletonList(Proxy.NO_PROXY);
@@ -87 +92 @@
     private final Set<String> errorMessages = new HashSet<>();
     private Set<String> proxyExceptions;
+    private Set<String> proxyIncludes;
 
     /**
@@ -165 +171 @@
                     Arrays.asList("localhost", IPV4_LOOPBACK, IPV6_LOOPBACK))
         );
+        proxyIncludes = new HashSet<>(
+            Config.getPref().getList(PROXY_INCLUDES,
+                    Collections.emptyList())
+        );
     }
 
@@ -215 +225 @@
     @Override
     public List<Proxy> select(URI uri) {
-        if (uri != null && proxyExceptions.contains(uri.getHost())) {
+        // This is specified in ProxySelector#select, "@throws IllegalArgumentException if the argument is null"
+        if (uri == null) {
+            throw new IllegalArgumentException("URI cannot be null");
+        }
+        if (proxyExceptions.contains(uri.getHost())) {
             return NO_PROXY_LIST;
         }
-        switch(proxyPolicy) {
+        if (!proxyIncludes.isEmpty() && !proxyIncludes.contains(uri.getHost())) {
+            return NO_PROXY_LIST;
+        }
+        switch (proxyPolicy) {
         case USE_SYSTEM_SETTINGS:
             if (!jvmWillUseSystemProxies) {
-                Logging.warn(tr("The JVM is not configured to lookup proxies from the system settings. "+
+                Logging.warn(tr("The JVM is not configured to lookup proxies from the system settings. " +
                         "The property ''java.net.useSystemProxies'' was missing at startup time.  Will not use a proxy."));
                 return NO_PROXY_LIST;
@@ -239 +256 @@
         }
         // should not happen
-        return null;
+        return Collections.emptyList();
     }
 }