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

Last change on this file since 17210 was 17210, checked in by simon04, 4 years ago

Checkstyle
  • Property svn:eol-style set to native
File size: 16.6 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;
6import static org.openstreetmap.josm.tools.Utils.getSystemEnv;
7import static org.openstreetmap.josm.tools.Utils.getSystemProperty;
8
9import java.awt.Dimension;
10import java.awt.DisplayMode;
11import java.awt.GraphicsEnvironment;
12import java.awt.Toolkit;
13import java.awt.event.ActionEvent;
14import java.awt.event.KeyEvent;
15import java.awt.geom.AffineTransform;
16import java.lang.management.ManagementFactory;
17import java.util.ArrayList;
18import java.util.Arrays;
19import java.util.Collection;
20import java.util.LinkedHashMap;
21import java.util.List;
22import java.util.ListIterator;
23import java.util.Locale;
24import java.util.Map;
25import java.util.Map.Entry;
26import java.util.Optional;
27import java.util.Set;
28import java.util.stream.Collectors;
29
30import javax.swing.UIManager;
31
32import org.openstreetmap.josm.data.Preferences;
33import org.openstreetmap.josm.data.Version;
34import org.openstreetmap.josm.data.osm.DataSet;
35import org.openstreetmap.josm.data.osm.DatasetConsistencyTest;
36import org.openstreetmap.josm.data.preferences.sources.MapPaintPrefHelper;
37import org.openstreetmap.josm.data.preferences.sources.PresetPrefHelper;
38import org.openstreetmap.josm.data.preferences.sources.SourcePrefHelper;
39import org.openstreetmap.josm.data.preferences.sources.ValidatorPrefHelper;
40import org.openstreetmap.josm.gui.ExtendedDialog;
41import org.openstreetmap.josm.gui.MainApplication;
42import org.openstreetmap.josm.gui.bugreport.DebugTextDisplay;
43import org.openstreetmap.josm.gui.util.GuiHelper;
44import org.openstreetmap.josm.io.OsmApi;
45import org.openstreetmap.josm.plugins.PluginHandler;
46import org.openstreetmap.josm.spi.preferences.Config;
47import org.openstreetmap.josm.tools.Logging;
48import org.openstreetmap.josm.tools.PlatformHookUnixoid;
49import org.openstreetmap.josm.tools.PlatformManager;
50import org.openstreetmap.josm.tools.Shortcut;
51import org.openstreetmap.josm.tools.Utils;
52import org.openstreetmap.josm.tools.bugreport.BugReportSender;
53
54/**
55 * Opens a dialog with useful status information like version numbers for Java, JOSM and plugins
56 * Also includes preferences with stripped username and password.
57 *
58 * @author xeen
59 */
60public final class ShowStatusReportAction extends JosmAction {
61
62 /**
63 * Constructs a new {@code ShowStatusReportAction}
64 */
65 public ShowStatusReportAction() {
66 super(
67 tr("Show Status Report"),
68 "misc/statusreport",
69 tr("Show status report with useful information that can be attached to bugs"),
70 Shortcut.registerShortcut("help:showstatusreport", tr("Help: {0}",
71 tr("Show Status Report")), KeyEvent.CHAR_UNDEFINED, Shortcut.NONE), true, "help/showstatusreport", false);
72
73 setHelpId(ht("/Action/ShowStatusReport"));
74 }
75
76 /**
77 * Replies the report header (software and system info)
78 * @return The report header (software and system info)
79 */
80 public static String getReportHeader() {
81 StringBuilder text = new StringBuilder(256);
82 String runtimeVersion = getSystemProperty("java.runtime.version");
83 text.append(Version.getInstance().getReleaseAttributes())
84 .append("\nIdentification: ").append(Version.getInstance().getAgentString());
85 String buildNumber = PlatformManager.getPlatform().getOSBuildNumber();
86 if (!buildNumber.isEmpty()) {
87 text.append("\nOS Build number: ").append(buildNumber);
88 }
89 text.append("\nMemory Usage: ")
90 .append(Runtime.getRuntime().totalMemory()/1024/1024)
91 .append(" MB / ")
92 .append(Runtime.getRuntime().maxMemory()/1024/1024)
93 .append(" MB (")
94 .append(Runtime.getRuntime().freeMemory()/1024/1024)
95 .append(" MB allocated, but free)\nJava version: ")
96 .append(runtimeVersion != null ? runtimeVersion : getSystemProperty("java.version")).append(", ")
97 .append(getSystemProperty("java.vendor")).append(", ")
98 .append(getSystemProperty("java.vm.name"))
99 .append("\nLook and Feel: ")
100 .append(Optional.ofNullable(UIManager.getLookAndFeel()).map(laf -> laf.getClass().getName()).orElse("null"))
101 .append("\nScreen: ");
102 if (!GraphicsEnvironment.isHeadless()) {
103 text.append(Arrays.stream(GraphicsEnvironment.getLocalGraphicsEnvironment().getScreenDevices()).map(gd -> {
104 StringBuilder b = new StringBuilder(gd.getIDstring());
105 DisplayMode dm = gd.getDisplayMode();
106 if (dm != null) {
107 // Java 11: use DisplayMode#toString
108 b.append(' ').append(dm.getWidth()).append('x').append(dm.getHeight());
109 AffineTransform transform = gd.getDefaultConfiguration().getDefaultTransform();
110 b.append(" (scaling ").append(transform.getScaleX()).append('x').append(transform.getScaleY()).append(')');
111 }
112 return b.toString();
113 }).collect(Collectors.joining(", ")));
114 }
115 Dimension maxScreenSize = GuiHelper.getMaximumScreenSize();
116 text.append("\nMaximum Screen Size: ")
117 .append((int) maxScreenSize.getWidth()).append('x')
118 .append((int) maxScreenSize.getHeight()).append('\n');
119 if (!GraphicsEnvironment.isHeadless()) {
120 Dimension bestCursorSize16 = Toolkit.getDefaultToolkit().getBestCursorSize(16, 16);
121 Dimension bestCursorSize32 = Toolkit.getDefaultToolkit().getBestCursorSize(32, 32);
122 text.append("Best cursor sizes: 16x16 -> ")
123 .append(bestCursorSize16.width).append('x').append(bestCursorSize16.height)
124 .append(", 32x32 -> ")
125 .append(bestCursorSize32.width).append('x').append(bestCursorSize32.height)
126 .append('\n');
127 }
128
129 if (PlatformManager.isPlatformUnixoid()) {
130 PlatformHookUnixoid platform = (PlatformHookUnixoid) PlatformManager.getPlatform();
131 // Add desktop environment
132 platform.getDesktopEnvironment().ifPresent(desktop -> text
133 .append("Desktop environment: ")
134 .append(desktop)
135 .append('\n'));
136 // Add Java package details
137 String packageDetails = platform.getJavaPackageDetails();
138 if (packageDetails != null) {
139 text.append("Java package: ")
140 .append(packageDetails)
141 .append('\n');
142 }
143 // Add WebStart package details if run from JNLP
144 if (Utils.isRunningJavaWebStart()) {
145 String webStartDetails = platform.getWebStartPackageDetails();
146 if (webStartDetails != null) {
147 text.append("WebStart package: ")
148 .append(webStartDetails)
149 .append('\n');
150 }
151 }
152 // Add Gnome Atk wrapper details if found
153 String atkWrapperDetails = platform.getAtkWrapperPackageDetails();
154 if (atkWrapperDetails != null) {
155 text.append("Java ATK Wrapper package: ")
156 .append(atkWrapperDetails)
157 .append('\n');
158 }
159 String lang = System.getenv("LANG");
160 if (lang != null) {
161 text.append("Environment variable LANG: ")
162 .append(lang)
163 .append('\n');
164 }
165 // Add dependencies details if found
166 for (String p : new String[] {
167 "apache-commons-compress", "libcommons-compress-java",
168 "apache-commons-jcs-core",
169 "apache-commons-logging", "libcommons-logging-java",
170 "fonts-noto",
171 "jsonp",
172 "metadata-extractor2",
173 "signpost-core", "liboauth-signpost-java",
174 "svgsalamander"
175 }) {
176 String details = PlatformHookUnixoid.getPackageDetails(p);
177 if (details != null) {
178 text.append(p).append(": ").append(details).append('\n');
179 }
180 }
181 }
182 try {
183 // Build a new list of VM parameters to modify it below if needed (default implementation returns an UnmodifiableList instance)
184 List<String> vmArguments = new ArrayList<>(ManagementFactory.getRuntimeMXBean().getInputArguments());
185 for (ListIterator<String> it = vmArguments.listIterator(); it.hasNext();) {
186 String value = it.next();
187 if (value.contains("=")) {
188 String[] param = value.split("=", 2);
189 // Hide some parameters for privacy concerns
190 if (param[0].toLowerCase(Locale.ENGLISH).startsWith("-dproxy")) {
191 it.set(param[0]+"=xxx");
192 } else if ("-Djnlpx.vmargs".equals(param[0])) {
193 // Remove jnlpx.vmargs (base64 encoded copy of VM arguments already included in clear)
194 it.remove();
195 } else {
196 // Replace some paths for readability and privacy concerns
197 String val = paramCleanup(param[1]);
198 if (!val.equals(param[1])) {
199 it.set(param[0] + '=' + val);
200 }
201 }
202 } else if (value.startsWith("-X")) {
203 // Remove arguments like -Xbootclasspath/a, -Xverify:remote, that can be very long and unhelpful
204 it.remove();
205 }
206 }
207 if (!vmArguments.isEmpty()) {
208 text.append("VM arguments: ").append(vmArguments.toString().replace("\\\\", "\\")).append('\n');
209 }
210 } catch (SecurityException e) {
211 Logging.trace(e);
212 }
213 List<String> commandLineArgs = MainApplication.getCommandLineArgs();
214 if (!commandLineArgs.isEmpty()) {
215 text.append("Program arguments: ").append(Arrays.toString(paramCleanup(commandLineArgs).toArray())).append('\n');
216 }
217 DataSet dataset = MainApplication.getLayerManager().getActiveDataSet();
218 if (dataset != null) {
219 String result = DatasetConsistencyTest.runTests(dataset);
220 if (result.isEmpty()) {
221 text.append("Dataset consistency test: No problems found\n");
222 } else {
223 text.append("\nDataset consistency test:\n").append(result).append('\n');
224 }
225 }
226 text.append('\n');
227 appendCollection(text, "Plugins", Utils.transform(PluginHandler.getBugReportInformation(), i -> "+ " + i));
228 appendCollection(text, "Tagging presets", getCustomUrls(PresetPrefHelper.INSTANCE));
229 appendCollection(text, "Map paint styles", getCustomUrls(MapPaintPrefHelper.INSTANCE));
230 appendCollection(text, "Validator rules", getCustomUrls(ValidatorPrefHelper.INSTANCE));
231 appendCollection(text, "Last errors/warnings", Utils.transform(Logging.getLastErrorAndWarnings(), i -> "- " + i));
232
233 String osmApi = OsmApi.getOsmApi().getServerUrl();
234 if (!Config.getUrls().getDefaultOsmApiUrl().equals(osmApi.trim())) {
235 text.append("OSM API: ").append(osmApi).append("\n\n");
236 }
237
238 return text.toString();
239 }
240
241 private static Collection<String> getCustomUrls(SourcePrefHelper helper) {
242 final Set<String> defaultUrls = helper.getDefault().stream()
243 .map(i -> i.url)
244 .collect(Collectors.toSet());
245 return helper.get().stream()
246 .filter(i -> !defaultUrls.contains(i.url))
247 .map(i -> (i.active ? "+ " : "- ") + i.url)
248 .collect(Collectors.toList());
249 }
250
251 private static List<String> paramCleanup(Collection<String> params) {
252 return params.stream()
253 .map(ShowStatusReportAction::paramCleanup)
254 .collect(Collectors.toList());
255 }
256
257 /**
258 * Fill map with anonymized name to the actual used path.
259 * @return map that maps shortened name to full directory path
260 */
261 static Map<String, String> getAnonimicDirectorySymbolMap() {
262 /** maps the anonymized name to the actual used path */
263 Map<String, String> map = new LinkedHashMap<>();
264 map.put(PlatformManager.isPlatformWindows() ? "%JAVA_HOME%" : "${JAVA_HOME}", getSystemEnv("JAVA_HOME"));
265 map.put("<java.home>", getSystemProperty("java.home"));
266 map.put("<josm.pref>", Config.getDirs().getPreferencesDirectory(false).toString());
267 map.put("<josm.userdata>", Config.getDirs().getUserDataDirectory(false).toString());
268 map.put("<josm.cache>", Config.getDirs().getCacheDirectory(false).toString());
269 map.put(PlatformManager.isPlatformWindows() ? "%UserProfile%" : "${HOME}", getSystemProperty("user.home"));
270 return map;
271 }
272
273 /**
274 * Shortens and removes private informations from a parameter used for status report.
275 * @param param parameter to cleanup
276 * @return shortened/anonymized parameter
277 */
278 static String paramCleanup(String param) {
279 final String userName = getSystemProperty("user.name");
280 final String userNameAlt = "<user.name>";
281
282 String val = param;
283 for (Entry<String, String> entry : getAnonimicDirectorySymbolMap().entrySet()) {
284 val = paramReplace(val, entry.getValue(), entry.getKey());
285 }
286 if (userName != null && userName.length() >= 3) {
287 val = paramReplace(val, userName, userNameAlt);
288 }
289 return val;
290 }
291
292 private static String paramReplace(String str, String target, String replacement) {
293 return target == null ? str : str.replace(target, replacement);
294 }
295
296 private static void appendCollection(StringBuilder text, String label, Collection<String> col) {
297 if (!col.isEmpty()) {
298 text.append(col.stream().map(o -> paramCleanup(o) + '\n')
299 .collect(Collectors.joining("", label + ":\n", "\n")));
300 }
301 }
302
303 private static String valueCleanup(Object value) {
304 String valueString = value.toString();
305 if (valueString.length() > 512 && value instanceof Collection<?>) {
306 valueString = ((Collection<?>) value).stream().map(v -> {
307 if (v instanceof Map<?, ?>) {
308 LinkedHashMap<Object, Object> map = new LinkedHashMap<>(((Map<?, ?>) v));
309 map.computeIfPresent("icon", (k, icon) -> Utils.shortenString(icon.toString(), 32)); // see #19058
310 return map.toString();
311 } else {
312 return String.valueOf(v);
313 }
314 }).collect(Collectors.joining(",\n ", "[", "\n]"));
315 }
316 return paramCleanup(valueString);
317 }
318
319 @Override
320 public void actionPerformed(ActionEvent e) {
321 StringBuilder text = new StringBuilder();
322 String reportHeader = getReportHeader();
323 text.append(reportHeader);
324
325 Preferences.main().getAllSettings().forEach((key, setting) -> {
326 if ("file-open.history".equals(key)
327 || "download.overpass.query".equals(key)
328 || "download.overpass.queries".equals(key)
329 || key.contains("username")
330 || key.contains("password")
331 || key.contains("access-token")) {
332 // Remove sensitive information from status report
333 return;
334 }
335 text.append(paramCleanup(key))
336 .append('=')
337 .append(valueCleanup(setting.getValue()))
338 .append('\n');
339 });
340
341 DebugTextDisplay ta = new DebugTextDisplay(text.toString());
342
343 ExtendedDialog ed = new ExtendedDialog(MainApplication.getMainFrame(),
344 tr("Status Report"),
345 tr("Copy to clipboard and close"), tr("Report bug"), tr("Close"));
346 ed.setButtonIcons("copy", "bug", "cancel");
347 ed.configureContextsensitiveHelp("/Action/ShowStatusReport", true);
348 ed.setContent(ta, false);
349 ed.setMinimumSize(new Dimension(380, 200));
350 ed.setPreferredSize(new Dimension(700, MainApplication.getMainFrame().getHeight()-50));
351
352 switch (ed.showDialog().getValue()) {
353 case 1: ta.copyToClipboard(); break;
354 case 2: BugReportSender.reportBug(reportHeader); break;
355 default: // do nothing
356 }
357 GuiHelper.destroyComponents(ed, false);
358 }
359}
Note: See TracBrowser for help on using the repository browser.