001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.actions;
003
004import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
005import static org.openstreetmap.josm.tools.I18n.tr;
006
007import java.awt.event.ActionEvent;
008import java.awt.event.KeyEvent;
009import java.io.File;
010import java.io.IOException;
011import java.lang.management.ManagementFactory;
012import java.util.ArrayList;
013import java.util.Arrays;
014import java.util.Collection;
015import java.util.List;
016
017import org.openstreetmap.josm.Main;
018import org.openstreetmap.josm.gui.HelpAwareOptionPane.ButtonSpec;
019import org.openstreetmap.josm.tools.ImageProvider;
020import org.openstreetmap.josm.tools.Shortcut;
021
022/**
023 * Restarts JOSM as it was launched. Comes from "restart" plugin, originally written by Upliner.
024 * <br><br>
025 * Mechanisms have been improved based on #8561 discussions and
026 * <a href="http://lewisleo.blogspot.jp/2012/08/programmatically-restart-java.html">this article</a>.
027 * @since 5857
028 */
029public class RestartAction extends JosmAction {
030
031    // AppleScript to restart OS X package
032    private static final String RESTART_APPLE_SCRIPT =
033              "tell application \"System Events\"\n"
034            + "repeat until not (exists process \"JOSM\")\n"
035            + "delay 0.2\n"
036            + "end repeat\n"
037            + "end tell\n"
038            + "tell application \"JOSM\" to activate";
039
040    /**
041     * Constructs a new {@code RestartAction}.
042     */
043    public RestartAction() {
044        super(tr("Restart"), "restart", tr("Restart the application."),
045                Shortcut.registerShortcut("file:restart", tr("File: {0}", tr("Restart")), KeyEvent.VK_J, Shortcut.ALT_CTRL_SHIFT), false);
046        putValue("help", ht("/Action/Restart"));
047        putValue("toolbar", "action/restart");
048        if (Main.toolbar != null) {
049            Main.toolbar.register(this);
050        }
051        setEnabled(isRestartSupported());
052    }
053
054    @Override
055    public void actionPerformed(ActionEvent e) {
056        // If JOSM has been started with property 'josm.restart=true' this means
057        // it is executed by a start script that can handle restart.
058        // Request for restart is indicated by exit code 9.
059        String scriptRestart = System.getProperty("josm.restart");
060        if ("true".equals(scriptRestart)) {
061            Main.exitJosm(true, 9);
062        }
063
064        try {
065            restartJOSM();
066        } catch (IOException ex) {
067            Main.error(ex);
068        }
069    }
070
071    /**
072     * Determines if restarting the application should be possible on this platform.
073     * @return {@code true} if the mandatory system property {@code sun.java.command} is defined, {@code false} otherwise.
074     * @since 5951
075     */
076    public static boolean isRestartSupported() {
077        return System.getProperty("sun.java.command") != null;
078    }
079
080    /**
081     * Restarts the current Java application
082     * @throws IOException in case of any error
083     */
084    public static void restartJOSM() throws IOException {
085        if (isRestartSupported() && !Main.exitJosm(false, 0)) return;
086        final List<String> cmd;
087        try {
088            // special handling for OSX .app package
089            if (Main.isPlatformOsx() && System.getProperty("java.library.path").contains("/JOSM.app/Contents/MacOS")) {
090                cmd = getAppleCommands();
091            } else {
092                cmd = getCommands();
093            }
094            Main.info("Restart "+cmd);
095            if (Main.isDebugEnabled() && Main.pref.getBoolean("restart.debug.simulation")) {
096                Main.debug("Restart cancelled to get debug info");
097                return;
098            }
099            // execute the command in a shutdown hook, to be sure that all the
100            // resources have been disposed before restarting the application
101            Runtime.getRuntime().addShutdownHook(new Thread("josm-restarter") {
102                @Override
103                public void run() {
104                    try {
105                        Runtime.getRuntime().exec(cmd.toArray(new String[cmd.size()]));
106                    } catch (IOException e) {
107                        Main.error(e);
108                    }
109                }
110            });
111            // exit
112            System.exit(0);
113        } catch (Exception e) {
114            // something went wrong
115            throw new IOException("Error while trying to restart the application", e);
116        }
117    }
118
119    private static List<String> getAppleCommands() {
120        final List<String> cmd = new ArrayList<>();
121        cmd.add("/usr/bin/osascript");
122        for (String line : RESTART_APPLE_SCRIPT.split("\n")) {
123            cmd.add("-e");
124            cmd.add(line);
125        }
126        return cmd;
127    }
128
129    private static List<String> getCommands() throws IOException {
130        final List<String> cmd = new ArrayList<>();
131        // java binary
132        cmd.add(getJavaRuntime());
133        // vm arguments
134        addVMArguments(cmd);
135        // Determine webstart JNLP file. Use jnlpx.origFilenameArg instead of jnlp.application.href,
136        // because only this one is present when run from j2plauncher.exe (see #10795)
137        final String jnlp = System.getProperty("jnlpx.origFilenameArg");
138        // program main and program arguments (be careful a sun property. might not be supported by all JVM)
139        final String javaCommand = System.getProperty("sun.java.command");
140        String[] mainCommand = javaCommand.split(" ");
141        if (javaCommand.endsWith(".jnlp") && jnlp == null) {
142            // see #11751 - jnlp on Linux
143            if (Main.isDebugEnabled()) {
144                Main.debug("Detected jnlp without jnlpx.origFilenameArg property set");
145            }
146            cmd.addAll(Arrays.asList(mainCommand));
147        } else {
148            // look for a .jar in all chunks to support paths with spaces (fix #9077)
149            StringBuilder sb = new StringBuilder(mainCommand[0]);
150            for (int i = 1; i < mainCommand.length && !mainCommand[i-1].endsWith(".jar"); i++) {
151                sb.append(' ').append(mainCommand[i]);
152            }
153            String jarPath = sb.toString();
154            // program main is a jar
155            if (jarPath.endsWith(".jar")) {
156                // if it's a jar, add -jar mainJar
157                cmd.add("-jar");
158                cmd.add(new File(jarPath).getPath());
159            } else {
160                // else it's a .class, add the classpath and mainClass
161                cmd.add("-cp");
162                cmd.add('"' + System.getProperty("java.class.path") + '"');
163                cmd.add(mainCommand[0]);
164            }
165            // add JNLP file.
166            if (jnlp != null) {
167                cmd.add(jnlp);
168            }
169        }
170        // finally add program arguments
171        cmd.addAll(Main.getCommandLineArgs());
172        return cmd;
173    }
174
175    private static String getJavaRuntime() throws IOException {
176        final String java = System.getProperty("java.home") + File.separator + "bin" + File.separator +
177                (Main.isPlatformWindows() ? "java.exe" : "java");
178        if (!new File(java).isFile()) {
179            throw new IOException("Unable to find suitable java runtime at "+java);
180        }
181        return java;
182    }
183
184    private static void addVMArguments(Collection<String> cmd) {
185        List<String> arguments = ManagementFactory.getRuntimeMXBean().getInputArguments();
186        if (Main.isDebugEnabled()) {
187            Main.debug("VM arguments: "+arguments);
188        }
189        for (String arg : arguments) {
190            // When run from jp2launcher.exe, jnlpx.remove is true, while it is not when run from javaws
191            // Always set it to false to avoid error caused by a missing jnlp file on the second restart
192            arg = arg.replace("-Djnlpx.remove=true", "-Djnlpx.remove=false");
193            // if it's the agent argument : we ignore it otherwise the
194            // address of the old application and the new one will be in conflict
195            if (!arg.contains("-agentlib")) {
196                cmd.add(arg);
197            }
198        }
199    }
200
201    /**
202     * Returns a new {@code ButtonSpec} instance that performs this action.
203     * @return A new {@code ButtonSpec} instance that performs this action.
204     */
205    public static ButtonSpec getRestartButtonSpec() {
206        return new ButtonSpec(
207                tr("Restart"),
208                ImageProvider.get("restart"),
209                tr("Restart the application."),
210                ht("/Action/Restart"),
211                isRestartSupported()
212        );
213    }
214
215    /**
216     * Returns a new {@code ButtonSpec} instance that do not perform this action.
217     * @return A new {@code ButtonSpec} instance that do not perform this action.
218     */
219    public static ButtonSpec getCancelButtonSpec() {
220        return new ButtonSpec(
221                tr("Cancel"),
222                ImageProvider.get("cancel"),
223                tr("Click to restart later."),
224                null /* no specific help context */
225        );
226    }
227
228    /**
229     * Returns default {@code ButtonSpec} instances for this action (Restart/Cancel).
230     * @return Default {@code ButtonSpec} instances for this action.
231     * @see #getRestartButtonSpec
232     * @see #getCancelButtonSpec
233     */
234    public static ButtonSpec[] getButtonSpecs() {
235        return new ButtonSpec[] {
236                getRestartButtonSpec(),
237                getCancelButtonSpec()
238        };
239    }
240}