com.acrolinx.sidebar.utils.SidebarUtils Maven / Gradle / Ivy

Go to download
/* Copyright (c) 2018 Acrolinx GmbH */
package com.acrolinx.sidebar.utils;

import com.acrolinx.sidebar.pojo.settings.SoftwareComponent;
import com.acrolinx.sidebar.pojo.settings.SoftwareComponentCategory;
import java.awt.Desktop;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLConnection;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import java.util.Properties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public final class SidebarUtils {
  private static final Logger logger = LoggerFactory.getLogger(SidebarUtils.class);

  public static final String SIDEBAR_ERROR_HTML =
      "\n"
          + "\n"
          + "\n"
          + "  \n"
          + "  Error while trying to load sidebar\n"
          + "\n"
          + "\n"
          + "Sidebar start page failed to load. Please check log files: \n"
          + LoggingUtils.getLogFileLocation()
          + "\n"
          + "";

  /**
   * Opens the given URL in the default Browser of the current OS. Note that this method is likely
   * to cause JVM crashes within SWT-based applications!
   */
  public static void openWebPageInDefaultBrowser(final String urlString) {
    if (SidebarUtils.isValidUrl(urlString)) {
      try {
        openUriInDefaultBrowser(new URI(urlString));
      } catch (final URISyntaxException e) {
        logger.error("", e);
      }
    } else {
      logger.warn("Attempt to open invalid URL: {}", urlString);
    }
  }

  /**
   * Validates a URL. Local URLs are allowed.
   *
   * @return true if url is valid
   */
  public static boolean isValidUrl(final String urlString) {
    if ((urlString != null) && (!urlString.isEmpty())) {
      boolean matches = urlString.matches("^(https?)://.*$");
      try {
        new URL(urlString);
        return matches;
      } catch (final MalformedURLException e) {
        logger.error("Non valid URL", e);
        return false;
      }
    }

    return false;
  }

  private static void openUriInDefaultBrowser(final URI uri) {
    final Desktop desktop = Desktop.isDesktopSupported() ? Desktop.getDesktop() : null;

    if ((desktop != null) && desktop.isSupported(Desktop.Action.BROWSE)) {
      new Thread(
              () -> {
                try {
                  Desktop.getDesktop().browse(uri);
                } catch (final Exception e) {
                  logger.error("", e);
                }
              })
          .start();
    } else {
      logger.error("Desktop is not available to get systems default browser.");
    }
  }

  /**
   * Opens the log file. For internal use. Attempts to open and preselect log file in systems file
   * manager (only for mac os and windows). If that fails, it just shows the containing folder in
   * the file manager.
   */
  public static void openLogFile() {
    final String logFileLocation = LoggingUtils.getLogFileLocation();

    if (logFileLocation != null) {
      final String logFile = new File(logFileLocation).getPath();

      if (openSystemSpecific(logFile)) {
        return;
      }

      openLogFileFolderInFileManger();
    }
  }

  private static void openLogFileFolderInFileManger() {
    final String logFileLocation = LoggingUtils.getLogFileLocation();

    if (logFileLocation != null) {
      final String folder = new File(logFileLocation).getParent();
      final Desktop desktop = Desktop.isDesktopSupported() ? Desktop.getDesktop() : null;

      if ((desktop != null) && desktop.isSupported(Desktop.Action.OPEN)) {
        new Thread(
                () -> {
                  try {
                    Desktop.getDesktop().open(new File(folder));
                  } catch (final Exception e) {
                    logger.error("", e);
                  }
                })
            .start();
      } else {
        logger.error("Desktop is not available to get systems default browser.");
      }
    }
  }

  /** Returns the sidebar URL for a given Acrolinx Server Address. For internal use. */
  public static String getSidebarUrl(final String serverAddress) {
    return serverAddress
        + (serverAddress.endsWith("/") ? "sidebar/v14/index.html" : "/sidebar/v14/index.html");
  }

  private static String getCurrentSdkImplementationVersion() {
    final Optional versionFromManifestFile = getJavaSdkVersionFromPropertiesFile();

    return versionFromManifestFile.orElseGet(
        () -> SidebarUtils.class.getPackage().getImplementationVersion());
  }

  private static Optional getJavaSdkVersionFromPropertiesFile() {
    final ClassLoader classLoader = SidebarUtils.class.getClassLoader();

    try (InputStream inputStream =
        classLoader.getResourceAsStream("sidebar-sdk-java-version.properties")) {
      Properties properties = new Properties();
      properties.load(inputStream);

      return Optional.ofNullable(properties.getProperty("sidebar-sdk-java-version"));
    } catch (IOException e) {
      logger.error("", e);
    }

    return Optional.empty();
  }

  /**
   * Test if a sidebar is available for the given server address.
   *
   * @return true if sidebar is available
   */
  public static boolean isValidServerAddress(final String serverAddress) {
    try {
      final URL url = new URL(getSidebarUrl(serverAddress));
      final URLConnection urlConnection = url.openConnection();
      urlConnection.connect();
    } catch (final Exception e) {
      logger.error("", e);
      return false;
    }

    return true;
  }

  protected static Path getUserTempDirLocation() {
    final String propertyValueString = System.getProperty("os.name").toLowerCase();

    if (propertyValueString.contains("mac")) {
      String temDirProp = System.getProperty("user.home");
      return Path.of(temDirProp, "Library");
    }

    return Path.of(System.getProperty("java.io.tmpdir"));
  }

  /** Internal use. */
  public static SoftwareComponent getJavaSdkSoftwareComponent() {
    return new SoftwareComponent(
        "com.acrolinx.sidebar.java",
        "Java SDK",
        getCurrentSdkImplementationVersion(),
        SoftwareComponentCategory.DETAIL);
  }

  /**
   * Attempts to show file in system specific file manager. Works only for mac and windows. For
   * internal use only.
   *
   * @param path to file
   * @return boolean
   */
  public static boolean openSystemSpecific(final String path) {
    final OSUtils.EnumOS enumOs = OSUtils.getOS();

    if (enumOs.isMac() && runCommand("open", "-R", path)) {
      return true;
    } else if (enumOs.isWindows() && runCommand("explorer", "/select,", "\"" + path + "\"")) {
      return true;
    }

    return false;
  }

  private static boolean runCommand(final String command, final String args, final String file) {
    logger.info("Trying to exec:\n   cmd = {} \n   args = {} \n   %s = {}", command, args, file);

    final List parts = new ArrayList<>();
    parts.add(command);

    if (args != null) {
      for (final String string : args.split(" ")) {
        parts.add(string.trim());
      }
    }

    parts.add(args);
    parts.add(file);

    try {
      final Process process = Runtime.getRuntime().exec(parts.toArray(new String[parts.size()]));

      try {
        final int retval = process.exitValue();

        if (retval == 0) {
          logger.error("Process ended immediately.");
          return false;
        }

        logger.error("Process crashed.");
        return false;
      } catch (final IllegalThreadStateException e) {
        logger.debug("Process is running", e);
        return true;
      }
    } catch (final IOException e) {
      logger.error("Error running command.", e);
      return false;
    }
  }

  public static int getSystemJavaVersion() {
    String version = SidebarUtils.getFullCurrentJavaVersionString();

    if (version.startsWith("1.")) {
      version = version.substring(2, 3);
    } else {
      int indexOfDot = version.indexOf(".");

      if (indexOfDot != -1) {
        version = version.substring(0, indexOfDot);
      }
    }

    return Integer.parseInt(version);
  }

  public static String getSystemJavaVmName() {
    return System.getProperty("java.vm.name");
  }

  public static String getFullCurrentJavaVersionString() {
    return System.getProperty("java.version");
  }

  public static String getPathOfCurrentJavaJre() {
    return System.getProperty("java.home");
  }

  private SidebarUtils() {
    throw new IllegalStateException();
  }
}