001// License: GPL. For details, see LICENSE file. 002package org.openstreetmap.josm.gui.preferences.remotecontrol; 003 004import static org.openstreetmap.josm.tools.I18n.tr; 005 006import java.awt.Color; 007import java.awt.Font; 008import java.awt.GridBagLayout; 009import java.awt.event.ActionListener; 010import java.io.IOException; 011import java.security.GeneralSecurityException; 012import java.security.KeyStore; 013import java.security.KeyStoreException; 014import java.security.NoSuchAlgorithmException; 015import java.security.cert.CertificateException; 016import java.util.LinkedHashMap; 017import java.util.Map; 018import java.util.Map.Entry; 019 020import javax.swing.BorderFactory; 021import javax.swing.Box; 022import javax.swing.JButton; 023import javax.swing.JCheckBox; 024import javax.swing.JLabel; 025import javax.swing.JOptionPane; 026import javax.swing.JPanel; 027import javax.swing.JSeparator; 028 029import org.openstreetmap.josm.Main; 030import org.openstreetmap.josm.gui.help.HelpUtil; 031import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting; 032import org.openstreetmap.josm.gui.preferences.PreferenceSetting; 033import org.openstreetmap.josm.gui.preferences.PreferenceSettingFactory; 034import org.openstreetmap.josm.gui.preferences.PreferenceTabbedPane; 035import org.openstreetmap.josm.gui.util.GuiHelper; 036import org.openstreetmap.josm.gui.widgets.VerticallyScrollablePanel; 037import org.openstreetmap.josm.io.remotecontrol.PermissionPrefWithDefault; 038import org.openstreetmap.josm.io.remotecontrol.RemoteControl; 039import org.openstreetmap.josm.io.remotecontrol.RemoteControlHttpsServer; 040import org.openstreetmap.josm.io.remotecontrol.handler.RequestHandler; 041import org.openstreetmap.josm.spi.preferences.Config; 042import org.openstreetmap.josm.tools.GBC; 043import org.openstreetmap.josm.tools.Logging; 044import org.openstreetmap.josm.tools.PlatformHookWindows; 045 046/** 047 * Preference settings for Remote Control. 048 * 049 * @author Frederik Ramm 050 */ 051public final class RemoteControlPreference extends DefaultTabPreferenceSetting { 052 053 /** 054 * Factory used to build a new instance of this preference setting 055 */ 056 public static class Factory implements PreferenceSettingFactory { 057 058 @Override 059 public PreferenceSetting createPreferenceSetting() { 060 return new RemoteControlPreference(); 061 } 062 } 063 064 private RemoteControlPreference() { 065 super(/* ICON(preferences/) */ "remotecontrol", tr("Remote Control"), tr("Settings for the remote control feature.")); 066 for (PermissionPrefWithDefault p : PermissionPrefWithDefault.getPermissionPrefs()) { 067 JCheckBox cb = new JCheckBox(p.preferenceText); 068 cb.setSelected(p.isAllowed()); 069 prefs.put(p, cb); 070 } 071 } 072 073 private final Map<PermissionPrefWithDefault, JCheckBox> prefs = new LinkedHashMap<>(); 074 private JCheckBox enableRemoteControl; 075 private JCheckBox enableHttpsSupport; 076 077 private JButton installCertificate; 078 private JButton uninstallCertificate; 079 080 private final JCheckBox loadInNewLayer = new JCheckBox(tr("Download as new layer")); 081 private final JCheckBox alwaysAskUserConfirm = new JCheckBox(tr("Confirm all Remote Control actions manually")); 082 083 @Override 084 public void addGui(final PreferenceTabbedPane gui) { 085 086 JPanel remote = new VerticallyScrollablePanel(new GridBagLayout()); 087 088 final JLabel descLabel = new JLabel("<html>" 089 + tr("Allows JOSM to be controlled from other applications, e.g. from a web browser.") 090 + "</html>"); 091 descLabel.setFont(descLabel.getFont().deriveFont(Font.PLAIN)); 092 remote.add(descLabel, GBC.eol().insets(5, 5, 0, 10).fill(GBC.HORIZONTAL)); 093 094 final JLabel portLabel = new JLabel("<html>" 095 + tr("JOSM will always listen at <b>port {0}</b> (http) and <b>port {1}</b> (https) on localhost." 096 + "<br>These ports are not configurable because they are referenced by external applications talking to JOSM.", 097 Config.getPref().get("remote.control.port", "8111"), 098 Config.getPref().get("remote.control.https.port", "8112")) + "</html>"); 099 portLabel.setFont(portLabel.getFont().deriveFont(Font.PLAIN)); 100 remote.add(portLabel, GBC.eol().insets(5, 5, 0, 10).fill(GBC.HORIZONTAL)); 101 102 enableRemoteControl = new JCheckBox(tr("Enable remote control"), RemoteControl.PROP_REMOTECONTROL_ENABLED.get()); 103 remote.add(enableRemoteControl, GBC.eol()); 104 105 final JPanel wrapper = new JPanel(new GridBagLayout()); 106 wrapper.setBorder(BorderFactory.createTitledBorder(BorderFactory.createLineBorder(Color.gray))); 107 108 remote.add(wrapper, GBC.eol().fill(GBC.HORIZONTAL).insets(5, 5, 5, 5)); 109 110 boolean https = RemoteControl.PROP_REMOTECONTROL_HTTPS_ENABLED.get(); 111 112 enableHttpsSupport = new JCheckBox(tr("Enable HTTPS support"), https); 113 wrapper.add(enableHttpsSupport, GBC.eol().fill(GBC.HORIZONTAL)); 114 115 // Certificate installation only available on Windows for now, see #10033 116 if (Main.isPlatformWindows()) { 117 installCertificate = new JButton(tr("Install...")); 118 uninstallCertificate = new JButton(tr("Uninstall...")); 119 installCertificate.setToolTipText(tr("Install JOSM localhost certificate to system/browser root keystores")); 120 uninstallCertificate.setToolTipText(tr("Uninstall JOSM localhost certificate from system/browser root keystores")); 121 wrapper.add(new JLabel(tr("Certificate:")), GBC.std().insets(15, 5, 0, 0)); 122 wrapper.add(installCertificate, GBC.std().insets(5, 5, 0, 0)); 123 wrapper.add(uninstallCertificate, GBC.eol().insets(5, 5, 0, 0)); 124 enableHttpsSupport.addActionListener(e -> installCertificate.setEnabled(enableHttpsSupport.isSelected())); 125 installCertificate.addActionListener(e -> { 126 try { 127 boolean changed = RemoteControlHttpsServer.setupPlatform( 128 RemoteControlHttpsServer.loadJosmKeystore()); 129 String msg = changed ? 130 tr("Certificate has been successfully installed.") : 131 tr("Certificate is already installed. Nothing to do."); 132 Logging.info(msg); 133 JOptionPane.showMessageDialog(wrapper, msg); 134 } catch (IOException | GeneralSecurityException ex) { 135 Logging.error(ex); 136 } 137 }); 138 uninstallCertificate.addActionListener(e -> { 139 try { 140 String msg; 141 KeyStore ks = PlatformHookWindows.getRootKeystore(); 142 if (ks.containsAlias(RemoteControlHttpsServer.ENTRY_ALIAS)) { 143 Logging.info(tr("Removing certificate {0} from root keystore.", RemoteControlHttpsServer.ENTRY_ALIAS)); 144 ks.deleteEntry(RemoteControlHttpsServer.ENTRY_ALIAS); 145 msg = tr("Certificate has been successfully uninstalled."); 146 } else { 147 msg = tr("Certificate is not installed. Nothing to do."); 148 } 149 Logging.info(msg); 150 JOptionPane.showMessageDialog(wrapper, msg); 151 } catch (KeyStoreException | NoSuchAlgorithmException | CertificateException | IOException ex) { 152 Logging.error(ex); 153 } 154 }); 155 installCertificate.setEnabled(https); 156 } 157 158 wrapper.add(new JSeparator(), GBC.eop().fill(GBC.HORIZONTAL).insets(15, 5, 15, 5)); 159 160 wrapper.add(new JLabel(tr("Permitted actions:")), GBC.eol().insets(5, 0, 0, 0)); 161 for (JCheckBox p : prefs.values()) { 162 wrapper.add(p, GBC.eol().insets(15, 5, 0, 0).fill(GBC.HORIZONTAL)); 163 } 164 165 wrapper.add(new JSeparator(), GBC.eop().fill(GBC.HORIZONTAL).insets(15, 5, 15, 5)); 166 wrapper.add(loadInNewLayer, GBC.eol().fill(GBC.HORIZONTAL)); 167 wrapper.add(alwaysAskUserConfirm, GBC.eol().fill(GBC.HORIZONTAL)); 168 169 remote.add(Box.createVerticalGlue(), GBC.eol().fill(GBC.VERTICAL)); 170 171 loadInNewLayer.setSelected(Config.getPref().getBoolean( 172 RequestHandler.loadInNewLayerKey, RequestHandler.loadInNewLayerDefault)); 173 alwaysAskUserConfirm.setSelected(Config.getPref().getBoolean( 174 RequestHandler.globalConfirmationKey, RequestHandler.globalConfirmationDefault)); 175 176 ActionListener remoteControlEnabled = e -> { 177 GuiHelper.setEnabledRec(wrapper, enableRemoteControl.isSelected()); 178 enableHttpsSupport.setEnabled(RemoteControl.supportsHttps()); 179 // 'setEnabled(false)' does not work for JLabel with html text, so do it manually 180 // FIXME: use QuadStateCheckBox to make checkboxes unset when disabled 181 if (installCertificate != null && uninstallCertificate != null) { 182 // Install certificate button is enabled if HTTPS is also enabled 183 installCertificate.setEnabled(enableRemoteControl.isSelected() 184 && enableHttpsSupport.isSelected() && RemoteControl.supportsHttps()); 185 // Uninstall certificate button is always enabled 186 uninstallCertificate.setEnabled(RemoteControl.supportsHttps()); 187 } 188 }; 189 enableRemoteControl.addActionListener(remoteControlEnabled); 190 remoteControlEnabled.actionPerformed(null); 191 createPreferenceTabWithScrollPane(gui, remote); 192 } 193 194 @Override 195 public boolean ok() { 196 boolean enabled = enableRemoteControl.isSelected(); 197 boolean httpsEnabled = enableHttpsSupport.isSelected(); 198 boolean changed = RemoteControl.PROP_REMOTECONTROL_ENABLED.put(enabled); 199 boolean httpsChanged = RemoteControl.PROP_REMOTECONTROL_HTTPS_ENABLED.put(httpsEnabled); 200 if (enabled) { 201 for (Entry<PermissionPrefWithDefault, JCheckBox> p : prefs.entrySet()) { 202 Config.getPref().putBoolean(p.getKey().pref, p.getValue().isSelected()); 203 } 204 Config.getPref().putBoolean(RequestHandler.loadInNewLayerKey, loadInNewLayer.isSelected()); 205 Config.getPref().putBoolean(RequestHandler.globalConfirmationKey, alwaysAskUserConfirm.isSelected()); 206 } 207 if (changed) { 208 if (enabled) { 209 RemoteControl.start(); 210 } else { 211 RemoteControl.stop(); 212 } 213 } else if (httpsChanged) { 214 if (httpsEnabled) { 215 RemoteControlHttpsServer.restartRemoteControlHttpsServer(); 216 } else { 217 RemoteControlHttpsServer.stopRemoteControlHttpsServer(); 218 } 219 } 220 return false; 221 } 222 223 @Override 224 public String getHelpContext() { 225 return HelpUtil.ht("/Preferences/RemoteControl"); 226 } 227}