// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.tools;
import static org.openstreetmap.josm.tools.I18n.tr;
import java.awt.Desktop;
import java.awt.Dimension;
import java.awt.event.KeyEvent;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.List;
import java.util.Locale;
import javax.swing.JOptionPane;
import org.openstreetmap.josm.Main;
import org.openstreetmap.josm.gui.ExtendedDialog;
import org.openstreetmap.josm.gui.util.GuiHelper;
/**
* {@code PlatformHook} base implementation.
*
* Don't write (Main.platform instanceof PlatformHookUnixoid) because other platform
* hooks are subclasses of this class.
*/
public class PlatformHookUnixoid implements PlatformHook {
private String osDescription;
@Override
public void preStartupHook() {
// See #12022 - Disable GNOME ATK Java wrapper as it causes a lot of serious trouble
if ("org.GNOME.Accessibility.AtkWrapper".equals(System.getProperty("assistive_technologies"))) {
System.clearProperty("assistive_technologies");
}
}
@Override
public void openUrl(String url) throws IOException {
for (String program : Main.pref.getCollection("browser.unix",
Arrays.asList("xdg-open", "#DESKTOP#", "$BROWSER", "gnome-open", "kfmclient openURL", "firefox"))) {
try {
if ("#DESKTOP#".equals(program)) {
Desktop.getDesktop().browse(new URI(url));
} else if (program.startsWith("$")) {
program = System.getenv().get(program.substring(1));
Runtime.getRuntime().exec(new String[]{program, url});
} else {
Runtime.getRuntime().exec(new String[]{program, url});
}
return;
} catch (IOException | URISyntaxException e) {
Main.warn(e);
}
}
}
@Override
public void initSystemShortcuts() {
// CHECKSTYLE.OFF: LineLength
// TODO: Insert system shortcuts here. See Windows and especially OSX to see how to.
for (int i = KeyEvent.VK_F1; i <= KeyEvent.VK_F12; ++i) {
Shortcut.registerSystemShortcut("screen:toogle"+i, tr("reserved"), i, KeyEvent.CTRL_DOWN_MASK | KeyEvent.ALT_DOWN_MASK)
.setAutomatic();
}
Shortcut.registerSystemShortcut("system:reset", tr("reserved"), KeyEvent.VK_DELETE, KeyEvent.CTRL_DOWN_MASK | KeyEvent.ALT_DOWN_MASK)
.setAutomatic();
Shortcut.registerSystemShortcut("system:resetX", tr("reserved"), KeyEvent.VK_BACK_SPACE, KeyEvent.CTRL_DOWN_MASK | KeyEvent.ALT_DOWN_MASK)
.setAutomatic();
// CHECKSTYLE.ON: LineLength
}
@Override
public String getDefaultStyle() {
return "javax.swing.plaf.metal.MetalLookAndFeel";
}
/**
* Determines if the distribution is Debian or Ubuntu, or a derivative.
* @return {@code true} if the distribution is Debian, Ubuntu or Mint, {@code false} otherwise
*/
public static boolean isDebianOrUbuntu() {
try {
String dist = Utils.execOutput(Arrays.asList("lsb_release", "-i", "-s"));
return "Debian".equalsIgnoreCase(dist) || "Ubuntu".equalsIgnoreCase(dist) || "Mint".equalsIgnoreCase(dist);
} catch (IOException e) {
// lsb_release is not available on all Linux systems, so don't log at warning level
Main.debug(e);
return false;
}
}
/**
* Determines if the JVM is OpenJDK-based.
* @return {@code true} if {@code java.home} contains "openjdk", {@code false} otherwise
* @since 6951
*/
public static boolean isOpenJDK() {
String javaHome = System.getProperty("java.home");
return javaHome != null && javaHome.contains("openjdk");
}
/**
* Get the package name including detailed version.
* @param packageNames The possible package names (when a package can have different names on different distributions)
* @return The package name and package version if it can be identified, null otherwise
* @since 7314
*/
public static String getPackageDetails(String... packageNames) {
try {
// CHECKSTYLE.OFF: SingleSpaceSeparator
boolean dpkg = Paths.get("/usr/bin/dpkg-query").toFile().exists();
boolean eque = Paths.get("/usr/bin/equery").toFile().exists();
boolean rpm = Paths.get("/bin/rpm").toFile().exists();
// CHECKSTYLE.ON: SingleSpaceSeparator
if (dpkg || rpm || eque) {
for (String packageName : packageNames) {
String[] args;
if (dpkg) {
args = new String[] {"dpkg-query", "--show", "--showformat", "${Architecture}-${Version}", packageName};
} else if (eque) {
args = new String[] {"equery", "-q", "list", "-e", "--format=$fullversion", packageName};
} else {
args = new String[] {"rpm", "-q", "--qf", "%{arch}-%{version}", packageName};
}
String version = Utils.execOutput(Arrays.asList(args));
if (version != null && !version.contains("not installed")) {
return packageName + ':' + version;
}
}
}
} catch (IOException e) {
Main.warn(e);
}
return null;
}
/**
* Get the Java package name including detailed version.
*
* Some Java bugs are specific to a certain security update, so in addition
* to the Java version, we also need the exact package version.
*
* @return The package name and package version if it can be identified, null otherwise
*/
public String getJavaPackageDetails() {
String home = System.getProperty("java.home");
if (home.contains("java-8-openjdk") || home.contains("java-1.8.0-openjdk")) {
return getPackageDetails("openjdk-8-jre", "java-1_8_0-openjdk", "java-1.8.0-openjdk");
} else if (home.contains("java-9-openjdk") || home.contains("java-1.9.0-openjdk")) {
return getPackageDetails("openjdk-9-jre", "java-1_9_0-openjdk", "java-1.9.0-openjdk");
} else if (home.contains("icedtea")) {
return getPackageDetails("icedtea-bin");
} else if (home.contains("oracle")) {
return getPackageDetails("oracle-jdk-bin", "oracle-jre-bin");
}
return null;
}
/**
* Get the Web Start package name including detailed version.
*
* OpenJDK packages are shipped with icedtea-web package,
* but its version generally does not match main java package version.
*
* Simply return {@code null} if there's no separate package for Java WebStart.
*
* @return The package name and package version if it can be identified, null otherwise
*/
public String getWebStartPackageDetails() {
if (isOpenJDK()) {
return getPackageDetails("icedtea-netx", "icedtea-web");
}
return null;
}
/**
* Get the Gnome ATK wrapper package name including detailed version.
*
* Debian and Ubuntu derivatives come with a pre-enabled accessibility software
* completely buggy that makes Swing crash in a lot of different ways.
*
* Simply return {@code null} if it's not found.
*
* @return The package name and package version if it can be identified, null otherwise
*/
public String getAtkWrapperPackageDetails() {
if (isOpenJDK() && isDebianOrUbuntu()) {
return getPackageDetails("libatk-wrapper-java");
}
return null;
}
protected String buildOSDescription() {
String osName = System.getProperty("os.name");
if ("Linux".equalsIgnoreCase(osName)) {
try {
// Try lsb_release (only available on LSB-compliant Linux systems,
// see https://www.linuxbase.org/lsb-cert/productdir.php?by_prod )
Process p = Runtime.getRuntime().exec("lsb_release -ds");
try (BufferedReader input = new BufferedReader(new InputStreamReader(p.getInputStream(), StandardCharsets.UTF_8))) {
String line = Utils.strip(input.readLine());
if (line != null && !line.isEmpty()) {
line = line.replaceAll("\"+", "");
line = line.replaceAll("NAME=", ""); // strange code for some Gentoo's
if (line.startsWith("Linux ")) // e.g. Linux Mint
return line;
else if (!line.isEmpty())
return "Linux " + line;
}
}
} catch (IOException e) {
Main.debug(e);
// Non LSB-compliant Linux system. List of common fallback release files: http://linuxmafia.com/faq/Admin/release-files.html
for (LinuxReleaseInfo info : new LinuxReleaseInfo[]{
new LinuxReleaseInfo("/etc/lsb-release", "DISTRIB_DESCRIPTION", "DISTRIB_ID", "DISTRIB_RELEASE"),
new LinuxReleaseInfo("/etc/os-release", "PRETTY_NAME", "NAME", "VERSION"),
new LinuxReleaseInfo("/etc/arch-release"),
new LinuxReleaseInfo("/etc/debian_version", "Debian GNU/Linux "),
new LinuxReleaseInfo("/etc/fedora-release"),
new LinuxReleaseInfo("/etc/gentoo-release"),
new LinuxReleaseInfo("/etc/redhat-release"),
new LinuxReleaseInfo("/etc/SuSE-release")
}) {
String description = info.extractDescription();
if (description != null && !description.isEmpty()) {
return "Linux " + description;
}
}
}
}
return osName;
}
@Override
public String getOSDescription() {
if (osDescription == null) {
osDescription = buildOSDescription();
}
return osDescription;
}
protected static class LinuxReleaseInfo {
private final String path;
private final String descriptionField;
private final String idField;
private final String releaseField;
private final boolean plainText;
private final String prefix;
public LinuxReleaseInfo(String path, String descriptionField, String idField, String releaseField) {
this(path, descriptionField, idField, releaseField, false, null);
}
public LinuxReleaseInfo(String path) {
this(path, null, null, null, true, null);
}
public LinuxReleaseInfo(String path, String prefix) {
this(path, null, null, null, true, prefix);
}
private LinuxReleaseInfo(String path, String descriptionField, String idField, String releaseField, boolean plainText, String prefix) {
this.path = path;
this.descriptionField = descriptionField;
this.idField = idField;
this.releaseField = releaseField;
this.plainText = plainText;
this.prefix = prefix;
}
@Override public String toString() {
return "ReleaseInfo [path=" + path + ", descriptionField=" + descriptionField +
", idField=" + idField + ", releaseField=" + releaseField + ']';
}
/**
* Extracts OS detailed information from a Linux release file (/etc/xxx-release)
* @return The OS detailed information, or {@code null}
*/
public String extractDescription() {
String result = null;
if (path != null) {
Path p = Paths.get(path);
if (p.toFile().exists()) {
try (BufferedReader reader = Files.newBufferedReader(p, StandardCharsets.UTF_8)) {
String id = null;
String release = null;
String line;
while (result == null && (line = reader.readLine()) != null) {
if (line.contains("=")) {
String[] tokens = line.split("=");
if (tokens.length >= 2) {
// Description, if available, contains exactly what we need
if (descriptionField != null && descriptionField.equalsIgnoreCase(tokens[0])) {
result = Utils.strip(tokens[1]);
} else if (idField != null && idField.equalsIgnoreCase(tokens[0])) {
id = Utils.strip(tokens[1]);
} else if (releaseField != null && releaseField.equalsIgnoreCase(tokens[0])) {
release = Utils.strip(tokens[1]);
}
}
} else if (plainText && !line.isEmpty()) {
// Files composed of a single line
result = Utils.strip(line);
}
}
// If no description has been found, try to rebuild it with "id" + "release" (i.e. "name" + "version")
if (result == null && id != null && release != null) {
result = id + ' ' + release;
}
} catch (IOException e) {
// Ignore
Main.trace(e);
}
}
}
// Append prefix if any
if (result != null && !result.isEmpty() && prefix != null && !prefix.isEmpty()) {
result = prefix + result;
}
if (result != null)
result = result.replaceAll("\"+", "");
return result;
}
}
// Method unused, but kept for translation already done. To reuse during Java 9 migration
protected void askUpdateJava(final String version, final String url) {
GuiHelper.runInEDTAndWait(() -> {
ExtendedDialog ed = new ExtendedDialog(
Main.parent,
tr("Outdated Java version"),
new String[]{tr("OK"), tr("Update Java"), tr("Cancel")});
// Check if the dialog has not already been permanently hidden by user
if (!ed.toggleEnable("askUpdateJava9").toggleCheckState()) {
ed.setButtonIcons(new String[]{"ok", "java", "cancel"}).setCancelButton(3);
ed.setMinimumSize(new Dimension(480, 300));
ed.setIcon(JOptionPane.WARNING_MESSAGE);
StringBuilder content = new StringBuilder(tr("You are running version {0} of Java.", "<b>"+version+"</b>"))
.append("<br><br>");
if ("Sun Microsystems Inc.".equals(System.getProperty("java.vendor")) && !isOpenJDK()) {
content.append("<b>").append(tr("This version is no longer supported by {0} since {1} and is not recommended for use.",
"Oracle", tr("April 2015"))).append("</b><br><br>"); // TODO: change date once Java 8 EOL is announced
}
content.append("<b>")
.append(tr("JOSM will soon stop working with this version; we highly recommend you to update to Java {0}.", "8"))
.append("</b><br><br>")
.append(tr("Would you like to update now ?"));
ed.setContent(content.toString());
if (ed.showDialog().getValue() == 2) {
try {
openUrl(url);
} catch (IOException e) {
Main.warn(e);
}
}
}
});
}
/**
* Get the dot directory <code>~/.josm</code>.
* @return the dot directory
*/
private static File getDotDirectory() {
String dirName = "." + Main.pref.getJOSMDirectoryBaseName().toLowerCase(Locale.ENGLISH);
return new File(System.getProperty("user.home"), dirName);
}
/**
* Returns true if the dot directory should be used for storing preferences,
* cache and user data.
* Currently this is the case, if the dot directory already exists.
* @return true if the dot directory should be used
*/
private static boolean useDotDirectory() {
return getDotDirectory().exists();
}
@Override
public File getDefaultCacheDirectory() {
if (useDotDirectory()) {
return new File(getDotDirectory(), "cache");
} else {
String xdgCacheDir = System.getenv("XDG_CACHE_HOME");
if (xdgCacheDir != null && !xdgCacheDir.isEmpty()) {
return new File(xdgCacheDir, Main.pref.getJOSMDirectoryBaseName());
} else {
return new File(System.getProperty("user.home") + File.separator +
".cache" + File.separator + Main.pref.getJOSMDirectoryBaseName());
}
}
}
@Override
public File getDefaultPrefDirectory() {
if (useDotDirectory()) {
return getDotDirectory();
} else {
String xdgConfigDir = System.getenv("XDG_CONFIG_HOME");
if (xdgConfigDir != null && !xdgConfigDir.isEmpty()) {
return new File(xdgConfigDir, Main.pref.getJOSMDirectoryBaseName());
} else {
return new File(System.getProperty("user.home") + File.separator +
".config" + File.separator + Main.pref.getJOSMDirectoryBaseName());
}
}
}
@Override
public File getDefaultUserDataDirectory() {
if (useDotDirectory()) {
return getDotDirectory();
} else {
String xdgDataDir = System.getenv("XDG_DATA_HOME");
if (xdgDataDir != null && !xdgDataDir.isEmpty()) {
return new File(xdgDataDir, Main.pref.getJOSMDirectoryBaseName());
} else {
return new File(System.getProperty("user.home") + File.separator +
".local" + File.separator + "share" + File.separator + Main.pref.getJOSMDirectoryBaseName());
}
}
}
@Override
public List<File> getDefaultProj4NadshiftDirectories() {
return Arrays.asList(new File("/usr/local/share/proj"), new File("/usr/share/proj"));
}
}