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;
006import static org.openstreetmap.josm.tools.Utils.getSystemEnv;
007import static org.openstreetmap.josm.tools.Utils.getSystemProperty;
008
009import java.awt.Dimension;
010import java.awt.DisplayMode;
011import java.awt.GraphicsEnvironment;
012import java.awt.event.ActionEvent;
013import java.awt.event.KeyEvent;
014import java.lang.management.ManagementFactory;
015import java.util.ArrayList;
016import java.util.Arrays;
017import java.util.Collection;
018import java.util.LinkedHashMap;
019import java.util.List;
020import java.util.ListIterator;
021import java.util.Locale;
022import java.util.Map;
023import java.util.Map.Entry;
024import java.util.Set;
025import java.util.stream.Collectors;
026
027import org.openstreetmap.josm.data.Preferences;
028import org.openstreetmap.josm.data.Version;
029import org.openstreetmap.josm.data.osm.DataSet;
030import org.openstreetmap.josm.data.osm.DatasetConsistencyTest;
031import org.openstreetmap.josm.data.preferences.sources.MapPaintPrefHelper;
032import org.openstreetmap.josm.data.preferences.sources.PresetPrefHelper;
033import org.openstreetmap.josm.data.preferences.sources.SourcePrefHelper;
034import org.openstreetmap.josm.data.preferences.sources.ValidatorPrefHelper;
035import org.openstreetmap.josm.gui.ExtendedDialog;
036import org.openstreetmap.josm.gui.MainApplication;
037import org.openstreetmap.josm.gui.bugreport.DebugTextDisplay;
038import org.openstreetmap.josm.gui.util.GuiHelper;
039import org.openstreetmap.josm.io.OsmApi;
040import org.openstreetmap.josm.plugins.PluginHandler;
041import org.openstreetmap.josm.spi.preferences.Config;
042import org.openstreetmap.josm.tools.Logging;
043import org.openstreetmap.josm.tools.PlatformHookUnixoid;
044import org.openstreetmap.josm.tools.PlatformManager;
045import org.openstreetmap.josm.tools.Shortcut;
046import org.openstreetmap.josm.tools.Utils;
047import org.openstreetmap.josm.tools.bugreport.BugReportSender;
048
049/**
050 * Opens a dialog with useful status information like version numbers for Java, JOSM and plugins
051 * Also includes preferences with stripped username and password.
052 *
053 * @author xeen
054 */
055public final class ShowStatusReportAction extends JosmAction {
056
057    /**
058     * Constructs a new {@code ShowStatusReportAction}
059     */
060    public ShowStatusReportAction() {
061        super(
062                tr("Show Status Report"),
063                "clock",
064                tr("Show status report with useful information that can be attached to bugs"),
065                Shortcut.registerShortcut("help:showstatusreport", tr("Help: {0}",
066                        tr("Show Status Report")), KeyEvent.CHAR_UNDEFINED, Shortcut.NONE), false);
067
068        setHelpId(ht("/Action/ShowStatusReport"));
069        putValue("toolbar", "help/showstatusreport");
070        MainApplication.getToolbar().register(this);
071    }
072
073    private static boolean isRunningJavaWebStart() {
074        try {
075            // See http://stackoverflow.com/a/16200769/2257172
076            return Class.forName("javax.jnlp.ServiceManager") != null;
077        } catch (ClassNotFoundException e) {
078            return false;
079        }
080    }
081
082    /**
083     * Replies the report header (software and system info)
084     * @return The report header (software and system info)
085     */
086    public static String getReportHeader() {
087        StringBuilder text = new StringBuilder(256);
088        String runtimeVersion = getSystemProperty("java.runtime.version");
089        text.append(Version.getInstance().getReleaseAttributes())
090            .append("\nIdentification: ").append(Version.getInstance().getAgentString());
091        String buildNumber = PlatformManager.getPlatform().getOSBuildNumber();
092        if (!buildNumber.isEmpty()) {
093            text.append("\nOS Build number: ").append(buildNumber);
094        }
095        text.append("\nMemory Usage: ")
096            .append(Runtime.getRuntime().totalMemory()/1024/1024)
097            .append(" MB / ")
098            .append(Runtime.getRuntime().maxMemory()/1024/1024)
099            .append(" MB (")
100            .append(Runtime.getRuntime().freeMemory()/1024/1024)
101            .append(" MB allocated, but free)\nJava version: ")
102            .append(runtimeVersion != null ? runtimeVersion : getSystemProperty("java.version")).append(", ")
103            .append(getSystemProperty("java.vendor")).append(", ")
104            .append(getSystemProperty("java.vm.name"))
105            .append("\nScreen: ");
106        if (!GraphicsEnvironment.isHeadless()) {
107            text.append(Arrays.stream(GraphicsEnvironment.getLocalGraphicsEnvironment().getScreenDevices()).map(gd -> {
108                        StringBuilder b = new StringBuilder(gd.getIDstring());
109                        DisplayMode dm = gd.getDisplayMode();
110                        if (dm != null) {
111                            b.append(' ').append(dm.getWidth()).append('x').append(dm.getHeight());
112                        }
113                        return b.toString();
114                    }).collect(Collectors.joining(", ")));
115        }
116        Dimension maxScreenSize = GuiHelper.getMaximumScreenSize();
117        text.append("\nMaximum Screen Size: ")
118            .append((int) maxScreenSize.getWidth()).append('x')
119            .append((int) maxScreenSize.getHeight()).append('\n');
120
121        if (PlatformManager.isPlatformUnixoid()) {
122            PlatformHookUnixoid platform = (PlatformHookUnixoid) PlatformManager.getPlatform();
123            // Add Java package details
124            String packageDetails = platform.getJavaPackageDetails();
125            if (packageDetails != null) {
126                text.append("Java package: ")
127                    .append(packageDetails)
128                    .append('\n');
129            }
130            // Add WebStart package details if run from JNLP
131            if (isRunningJavaWebStart()) {
132                String webStartDetails = platform.getWebStartPackageDetails();
133                if (webStartDetails != null) {
134                    text.append("WebStart package: ")
135                        .append(webStartDetails)
136                        .append('\n');
137                }
138            }
139            // Add Gnome Atk wrapper details if found
140            String atkWrapperDetails = platform.getAtkWrapperPackageDetails();
141            if (atkWrapperDetails != null) {
142                text.append("Java ATK Wrapper package: ")
143                    .append(atkWrapperDetails)
144                    .append('\n');
145            }
146            // Add dependencies details if found
147            for (String p : new String[] {
148                    "apache-commons-compress", "libcommons-compress-java",
149                    "apache-commons-jcs-core",
150                    "apache-commons-logging", "libcommons-logging-java",
151                    "fonts-noto",
152                    "jsonp",
153                    "metadata-extractor2",
154                    "signpost-core", "liboauth-signpost-java",
155                    "svgsalamander"
156            }) {
157                String details = PlatformHookUnixoid.getPackageDetails(p);
158                if (details != null) {
159                    text.append(p).append(": ").append(details).append('\n');
160                }
161            }
162        }
163        try {
164            // Build a new list of VM parameters to modify it below if needed (default implementation returns an UnmodifiableList instance)
165            List<String> vmArguments = new ArrayList<>(ManagementFactory.getRuntimeMXBean().getInputArguments());
166            for (ListIterator<String> it = vmArguments.listIterator(); it.hasNext();) {
167                String value = it.next();
168                if (value.contains("=")) {
169                    String[] param = value.split("=");
170                    // Hide some parameters for privacy concerns
171                    if (param[0].toLowerCase(Locale.ENGLISH).startsWith("-dproxy")) {
172                        it.set(param[0]+"=xxx");
173                    } else if ("-Djnlpx.vmargs".equals(param[0])) {
174                        // Remove jnlpx.vmargs (base64 encoded copy of VM arguments already included in clear)
175                        it.remove();
176                    } else {
177                        // Replace some paths for readability and privacy concerns
178                        String val = paramCleanup(param[1]);
179                        if (!val.equals(param[1])) {
180                            it.set(param[0] + '=' + val);
181                        }
182                    }
183                } else if (value.startsWith("-X")) {
184                    // Remove arguments like -Xbootclasspath/a, -Xverify:remote, that can be very long and unhelpful
185                    it.remove();
186                }
187            }
188            if (!vmArguments.isEmpty()) {
189                text.append("VM arguments: ").append(vmArguments.toString().replace("\\\\", "\\")).append('\n');
190            }
191        } catch (SecurityException e) {
192            Logging.trace(e);
193        }
194        List<String> commandLineArgs = MainApplication.getCommandLineArgs();
195        if (!commandLineArgs.isEmpty()) {
196            text.append("Program arguments: ").append(Arrays.toString(paramCleanup(commandLineArgs).toArray())).append('\n');
197        }
198        DataSet dataset = MainApplication.getLayerManager().getActiveDataSet();
199        if (dataset != null) {
200            String result = DatasetConsistencyTest.runTests(dataset);
201            if (result.isEmpty()) {
202                text.append("Dataset consistency test: No problems found\n");
203            } else {
204                text.append("\nDataset consistency test:\n").append(result).append('\n');
205            }
206        }
207        text.append('\n');
208        appendCollection(text, "Plugins", Utils.transform(PluginHandler.getBugReportInformation(), i -> "+ " + i));
209        appendCollection(text, "Tagging presets", getCustomUrls(PresetPrefHelper.INSTANCE));
210        appendCollection(text, "Map paint styles", getCustomUrls(MapPaintPrefHelper.INSTANCE));
211        appendCollection(text, "Validator rules", getCustomUrls(ValidatorPrefHelper.INSTANCE));
212        appendCollection(text, "Last errors/warnings", Utils.transform(Logging.getLastErrorAndWarnings(), i -> "- " + i));
213
214        String osmApi = OsmApi.getOsmApi().getServerUrl();
215        if (!Config.getUrls().getDefaultOsmApiUrl().equals(osmApi.trim())) {
216            text.append("OSM API: ").append(osmApi).append("\n\n");
217        }
218
219        return text.toString();
220    }
221
222    private static Collection<String> getCustomUrls(SourcePrefHelper helper) {
223        final Set<String> defaultUrls = helper.getDefault().stream()
224                .map(i -> i.url)
225                .collect(Collectors.toSet());
226        return helper.get().stream()
227                .filter(i -> !defaultUrls.contains(i.url))
228                .map(i -> (i.active ? "+ " : "- ") + i.url)
229                .collect(Collectors.toList());
230    }
231
232    private static List<String> paramCleanup(Collection<String> params) {
233        List<String> result = new ArrayList<>(params.size());
234        for (String param : params) {
235            result.add(paramCleanup(param));
236        }
237        return result;
238    }
239
240    /**
241     * Fill map with anonymized name to the actual used path.
242     * @return map that maps shortened name to full directory path
243     */
244    static Map<String, String> getAnonimicDirectorySymbolMap() {
245        /** maps the anonymized name to the actual used path */
246        Map<String, String> map = new LinkedHashMap<>();
247        map.put(PlatformManager.isPlatformWindows() ? "%JAVA_HOME%" : "${JAVA_HOME}", getSystemEnv("JAVA_HOME"));
248        map.put("<java.home>", getSystemProperty("java.home"));
249        map.put("<josm.pref>", Config.getDirs().getPreferencesDirectory(false).toString());
250        map.put("<josm.userdata>", Config.getDirs().getUserDataDirectory(false).toString());
251        map.put("<josm.cache>", Config.getDirs().getCacheDirectory(false).toString());
252        map.put(PlatformManager.isPlatformWindows() ? "%UserProfile%" : "${HOME}", getSystemProperty("user.home"));
253        return map;
254    }
255
256    /**
257     * Shortens and removes private informations from a parameter used for status report.
258     * @param param parameter to cleanup
259     * @return shortened/anonymized parameter
260     */
261    static String paramCleanup(String param) {
262        final String userName = getSystemProperty("user.name");
263        final String userNameAlt = "<user.name>";
264
265        String val = param;
266        for (Entry<String, String> entry : getAnonimicDirectorySymbolMap().entrySet()) {
267            val = paramReplace(val, entry.getValue(), entry.getKey());
268        }
269        if (userName != null && userName.length() >= 3) {
270            val = paramReplace(val, userName, userNameAlt);
271        }
272        return val;
273    }
274
275    private static String paramReplace(String str, String target, String replacement) {
276        return target == null ? str : str.replace(target, replacement);
277    }
278
279    private static void appendCollection(StringBuilder text, String label, Collection<String> col) {
280        if (!col.isEmpty()) {
281            text.append(label).append(":\n");
282            for (String o : col) {
283                text.append(paramCleanup(o)).append('\n');
284            }
285            text.append('\n');
286        }
287    }
288
289    @Override
290    public void actionPerformed(ActionEvent e) {
291        StringBuilder text = new StringBuilder();
292        String reportHeader = getReportHeader();
293        text.append(reportHeader);
294
295        Preferences.main().getAllSettings().forEach((key, setting) -> {
296            if (key.startsWith("marker.show")
297                    || "file-open.history".equals(key)
298                    || "download.overpass.query".equals(key)
299                    || "download.overpass.queries".equals(key)
300                    || key.contains("username")
301                    || key.contains("password")
302                    || key.contains("access-token")) {
303                // Remove sensitive information from status report
304                return;
305            }
306            text.append(paramCleanup(key))
307                    .append('=')
308                    .append(paramCleanup(setting.getValue().toString()))
309                    .append('\n');
310        });
311
312        DebugTextDisplay ta = new DebugTextDisplay(text.toString());
313
314        ExtendedDialog ed = new ExtendedDialog(MainApplication.getMainFrame(),
315                tr("Status Report"),
316                tr("Copy to clipboard and close"), tr("Report bug"), tr("Close"));
317        ed.setButtonIcons("copy", "bug", "cancel");
318        ed.setContent(ta, false);
319        ed.setMinimumSize(new Dimension(380, 200));
320        ed.setPreferredSize(new Dimension(700, MainApplication.getMainFrame().getHeight()-50));
321
322        switch (ed.showDialog().getValue()) {
323            case 1: ta.copyToClipboard(); break;
324            case 2: BugReportSender.reportBug(reportHeader); break;
325            default: // do nothing
326        }
327        GuiHelper.destroyComponents(ed, false);
328    }
329}