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