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