source: josm/trunk/src/org/openstreetmap/josm/actions/ShowStatusReportAction.java@ 10138

Last change on this file since 10138 was 10138, checked in by bastiK, 8 years ago

status report: replace some paths, so the user's home directory doesn't get posted on the bug tracker
  • Property svn:eol-style set to native
File size: 11.3 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.actions;
3
4import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.Dimension;
8import java.awt.event.ActionEvent;
9import java.awt.event.KeyEvent;
10import java.lang.management.ManagementFactory;
11import java.util.ArrayList;
12import java.util.Arrays;
13import java.util.Collection;
14import java.util.HashSet;
15import java.util.List;
16import java.util.ListIterator;
17import java.util.Locale;
18import java.util.Map;
19import java.util.Map.Entry;
20import java.util.Set;
21import java.util.TreeSet;
22import java.util.regex.Pattern;
23
24import org.openstreetmap.josm.Main;
25import org.openstreetmap.josm.data.Version;
26import org.openstreetmap.josm.data.osm.DataSet;
27import org.openstreetmap.josm.data.osm.DatasetConsistencyTest;
28import org.openstreetmap.josm.data.preferences.Setting;
29import org.openstreetmap.josm.gui.ExtendedDialog;
30import org.openstreetmap.josm.gui.preferences.SourceEditor;
31import org.openstreetmap.josm.gui.preferences.SourceEditor.ExtendedSourceEntry;
32import org.openstreetmap.josm.gui.preferences.SourceEntry;
33import org.openstreetmap.josm.gui.preferences.map.MapPaintPreference;
34import org.openstreetmap.josm.gui.preferences.map.TaggingPresetPreference;
35import org.openstreetmap.josm.gui.preferences.validator.ValidatorTagCheckerRulesPreference;
36import org.openstreetmap.josm.plugins.PluginHandler;
37import org.openstreetmap.josm.tools.PlatformHookUnixoid;
38import org.openstreetmap.josm.tools.Shortcut;
39import org.openstreetmap.josm.tools.bugreport.BugReportSender;
40import org.openstreetmap.josm.tools.bugreport.DebugTextDisplay;
41
42/**
43 * @author xeen
44 *
45 * Opens a dialog with useful status information like version numbers for Java, JOSM and plugins
46 * Also includes preferences with stripped username and password
47 */
48public final class ShowStatusReportAction extends JosmAction {
49
50 /**
51 * Constructs a new {@code ShowStatusReportAction}
52 */
53 public ShowStatusReportAction() {
54 super(
55 tr("Show Status Report"),
56 "clock",
57 tr("Show status report with useful information that can be attached to bugs"),
58 Shortcut.registerShortcut("help:showstatusreport", tr("Help: {0}",
59 tr("Show Status Report")), KeyEvent.CHAR_UNDEFINED, Shortcut.NONE), false);
60
61 putValue("help", ht("/Action/ShowStatusReport"));
62 putValue("toolbar", "help/showstatusreport");
63 Main.toolbar.register(this);
64 }
65
66 private static boolean isRunningJavaWebStart() {
67 try {
68 // See http://stackoverflow.com/a/16200769/2257172
69 return Class.forName("javax.jnlp.ServiceManager") != null;
70 } catch (ClassNotFoundException e) {
71 return false;
72 }
73 }
74
75 /**
76 * Replies the report header (software and system info)
77 * @return The report header (software and system info)
78 */
79 public static String getReportHeader() {
80 StringBuilder text = new StringBuilder();
81 String runtimeVersion = System.getProperty("java.runtime.version");
82 text.append(Version.getInstance().getReleaseAttributes())
83 .append("\nIdentification: ").append(Version.getInstance().getAgentString())
84 .append("\nMemory Usage: ")
85 .append(Runtime.getRuntime().totalMemory()/1024/1024)
86 .append(" MB / ")
87 .append(Runtime.getRuntime().maxMemory()/1024/1024)
88 .append(" MB (")
89 .append(Runtime.getRuntime().freeMemory()/1024/1024)
90 .append(" MB allocated, but free)\nJava version: ")
91 .append(runtimeVersion != null ? runtimeVersion : System.getProperty("java.version")).append(", ")
92 .append(System.getProperty("java.vendor")).append(", ")
93 .append(System.getProperty("java.vm.name")).append('\n');
94 if (Main.platform.getClass() == PlatformHookUnixoid.class) {
95 // Add Java package details
96 String packageDetails = ((PlatformHookUnixoid) Main.platform).getJavaPackageDetails();
97 if (packageDetails != null) {
98 text.append("Java package: ")
99 .append(packageDetails)
100 .append('\n');
101 }
102 // Add WebStart package details if run from JNLP
103 if (isRunningJavaWebStart()) {
104 String webStartDetails = ((PlatformHookUnixoid) Main.platform).getWebStartPackageDetails();
105 if (webStartDetails != null) {
106 text.append("WebStart package: ")
107 .append(webStartDetails)
108 .append('\n');
109 }
110 }
111 }
112 try {
113 final String envJavaHome = System.getenv("JAVA_HOME");
114 final String envJavaHomeAlt = Main.isPlatformWindows() ? "%JAVA_HOME%" : "${JAVA_HOME}";
115 final String propJavaHome = System.getProperty("java.home");
116 final String propJavaHomeAlt = "<java.home>";
117 final String prefDir = Main.pref.getPreferencesDirectory().toString();
118 final String prefDirAlt = "<josm.pref>";
119 final String userDataDir = Main.pref.getUserDataDirectory().toString();
120 final String userDataDirAlt = "<josm.userdata>";
121 final String userCacheDir = Main.pref.getCacheDirectory().toString();
122 final String userCacheDirAlt = "<josm.cache>";
123 final String userHomeDir = System.getProperty("user.home");
124 final String userHomeDirAlt = Main.isPlatformWindows() ? "%UserProfile%" : "${HOME}";
125
126 // Build a new list of VM parameters to modify it below if needed (default implementation returns an UnmodifiableList instance)
127 List<String> vmArguments = new ArrayList<>(ManagementFactory.getRuntimeMXBean().getInputArguments());
128 for (ListIterator<String> it = vmArguments.listIterator(); it.hasNext();) {
129 String value = it.next();
130 if (value.contains("=")) {
131 String[] param = value.split("=");
132 // Hide some parameters for privacy concerns
133 if (param[0].toLowerCase(Locale.ENGLISH).startsWith("-dproxy")) {
134 it.set(param[0]+"=xxx");
135 } else {
136 // Replace some paths for readability and privacy concerns
137 String val = param[1];
138 val = paramReplace(val, envJavaHome, envJavaHomeAlt);
139 val = paramReplace(val, envJavaHome, envJavaHomeAlt);
140 val = paramReplace(val, propJavaHome, propJavaHomeAlt);
141 val = paramReplace(val, prefDir, prefDirAlt);
142 val = paramReplace(val, userDataDir, userDataDirAlt);
143 val = paramReplace(val, userCacheDir, userCacheDirAlt);
144 val = paramReplace(val, userHomeDir, userHomeDirAlt);
145 if (!val.equals(param[1])) {
146 it.set(param[0] + '=' + val);
147 }
148 }
149 } else if (value.startsWith("-X")) {
150 // Remove arguments like -Xbootclasspath/a, -Xverify:remote, that can be very long and unhelpful
151 it.remove();
152 }
153 }
154 if (!vmArguments.isEmpty()) {
155 text.append("VM arguments: ").append(vmArguments.toString().replace("\\\\", "\\")).append('\n');
156 }
157 } catch (SecurityException e) {
158 // Ignore exception
159 if (Main.isTraceEnabled()) {
160 Main.trace(e.getMessage());
161 }
162 }
163 List<String> commandLineArgs = Main.getCommandLineArgs();
164 if (!commandLineArgs.isEmpty()) {
165 text.append("Program arguments: ").append(Arrays.toString(commandLineArgs.toArray())).append('\n');
166 }
167 if (Main.main != null) {
168 DataSet dataset = Main.main.getCurrentDataSet();
169 if (dataset != null) {
170 String result = DatasetConsistencyTest.runTests(dataset);
171 if (result.isEmpty()) {
172 text.append("Dataset consistency test: No problems found\n");
173 } else {
174 text.append("\nDataset consistency test:\n").append(result).append('\n');
175 }
176 }
177 }
178 text.append('\n').append(PluginHandler.getBugReportText()).append('\n');
179
180 appendCollection(text, "Tagging presets", getCustomUrls(TaggingPresetPreference.PresetPrefHelper.INSTANCE));
181 appendCollection(text, "Map paint styles", getCustomUrls(MapPaintPreference.MapPaintPrefHelper.INSTANCE));
182 appendCollection(text, "Validator rules", getCustomUrls(ValidatorTagCheckerRulesPreference.RulePrefHelper.INSTANCE));
183 appendCollection(text, "Last errors/warnings", Main.getLastErrorAndWarnings());
184
185 return text.toString();
186 }
187
188 protected static Collection<String> getCustomUrls(SourceEditor.SourcePrefHelper helper) {
189 Set<String> set = new TreeSet<>();
190 for (SourceEntry entry : helper.get()) {
191 set.add(entry.url);
192 }
193 for (ExtendedSourceEntry def : helper.getDefault()) {
194 set.remove(def.url);
195 }
196 return set;
197 }
198
199 private static String paramReplace(String str, String target, String replacement) {
200 if (target == null) return str;
201 return str.replace(target, replacement);
202 }
203
204 protected static <T> void appendCollection(StringBuilder text, String label, Collection<T> col) {
205 if (!col.isEmpty()) {
206 text.append(label+":\n");
207 for (T o : col) {
208 text.append("- ").append(o.toString()).append('\n');
209 }
210 text.append('\n');
211 }
212 }
213
214 @Override
215 public void actionPerformed(ActionEvent e) {
216 StringBuilder text = new StringBuilder();
217 String reportHeader = getReportHeader();
218 text.append(reportHeader);
219 try {
220 Map<String, Setting<?>> settings = Main.pref.getAllSettings();
221 Set<String> keys = new HashSet<>(settings.keySet());
222 for (String key : keys) {
223 // Remove sensitive information from status report
224 if (key.startsWith("marker.show") || key.contains("username") || key.contains("password") || key.contains("access-token")) {
225 settings.remove(key);
226 }
227 }
228 for (Entry<String, Setting<?>> entry : settings.entrySet()) {
229 text.append(entry.getKey()).append('=').append(entry.getValue().getValue()).append('\n');
230 }
231 } catch (Exception x) {
232 Main.error(x);
233 }
234
235 DebugTextDisplay ta = new DebugTextDisplay(text.toString());
236
237 ExtendedDialog ed = new ExtendedDialog(Main.parent,
238 tr("Status Report"),
239 new String[] {tr("Copy to clipboard and close"), tr("Report bug"), tr("Close") });
240 ed.setButtonIcons(new String[] {"copy", "bug", "cancel" });
241 ed.setContent(ta, false);
242 ed.setMinimumSize(new Dimension(380, 200));
243 ed.setPreferredSize(new Dimension(700, Main.parent.getHeight()-50));
244
245 switch (ed.showDialog().getValue()) {
246 case 1: ta.copyToClippboard(); break;
247 case 2: BugReportSender.reportBug(reportHeader); break;
248 }
249 }
250}
Note: See TracBrowser for help on using the repository browser.