OSXService.java

// Copyright 2015 Eivind Vegsundvåg
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package ninja.eivind.hotsreplayuploader.services.platform;

import javafx.event.EventType;
import javafx.scene.input.KeyCode;
import javafx.scene.input.KeyEvent;
import javafx.stage.Stage;
import ninja.eivind.hotsreplayuploader.files.tempwatcher.BattleLobbyTempDirectories;
import ninja.eivind.hotsreplayuploader.utils.SimpleHttpClient;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.awt.*;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.util.concurrent.TimeUnit;

/**
 * {@link PlatformService} that is active on Apple OSX systems.
 */
public class OSXService implements PlatformService {
    private static final Logger LOG = LoggerFactory.getLogger(OSXService.class);
    private static final String LIBRARY_PATH = "/Library/Application Support";

    @Override
    public File getApplicationHome() {
        return new File(USER_HOME + "/" + LIBRARY_PATH + "/" + APPLICATION_DIRECTORY_NAME);
    }

    @Override
    public File getHotSHome() {
        return new File(USER_HOME + "/" + LIBRARY_PATH + "/" + "Blizzard/Heroes of the Storm/Accounts/");
    }

    @Override
    public void browse(final String uri) {
        try {
            Desktop.getDesktop().browse(SimpleHttpClient.encode(uri));
        } catch (IOException e) {
            LOG.error("Could not open " + uri + " in browser.", e);
        }
    }

    @Override
    public URL getLogoUrl() {
        final String logoVariant = isMacMenuBarDarkMode() ? "" : "-black";
        return getClass().getResource(
                "/images/logo-desktop" + logoVariant + ".png");
    }

    @Override
    public void setupWindowBehaviour(Stage primaryStage)
    {
        PlatformService.super.setupWindowBehaviour(primaryStage);

        //don't close the window on clicking x, just hide
        primaryStage.setOnCloseRequest(primaryStage.getOnHiding());

        //register key handlers to react on standard shortcuts
        final EventType<KeyEvent> keyPressed = KeyEvent.KEY_PRESSED;
        primaryStage.addEventHandler(keyPressed, event -> {
            if (event.isMetaDown()) {
                if (event.getCode() == KeyCode.Q) {
                    LOG.info("Exiting application due to keyboard shortcut.");
                    shutdown();
                } else if (event.getCode() == KeyCode.H) {
                    LOG.info("Hiding application due to keyboard shortcut.");
                    primaryStage.setIconified(true);
                }
            }
        });
    }

    @Override
    public boolean isPreloaderSupported() {
        return false;
    }

    @Override
    public BattleLobbyTempDirectories getBattleLobbyTempDirectories() {
        final File root = new File(System.getProperty("java.io.tmpdir"));
        final File remainder = new File(root + "/TemporaryItems/Blizzard/Heroes of the Storm");
        return new BattleLobbyTempDirectories(
                root,
                remainder
        );
    }

    @Override
    public TrayIcon getTrayIcon(final Stage primaryStage) throws PlatformNotSupportedException {
        final URL imageURL = getLogoUrl();
        return buildTrayIcon(imageURL, primaryStage);
    }

    /**
     * Checks, if the OS X dark mode is used by querying the defaults CLI.<br>
     * This is needed for adding the correct tray icon once at the startup.
     *
     * @return true if <code>defaults read -g AppleInterfaceStyle</code>
     * has an exit status of <code>0</code> (i.e. _not_ returning "key not found").
     */
    private static boolean isMacMenuBarDarkMode() {
        try {
            /* check for exit status only.
             * Once there are more modes than "dark" and "default",
             *  we might need to analyze string contents...
             */
            final Process proc = Runtime.getRuntime().exec(
                    new String[]{"defaults", "read", "-g", "AppleInterfaceStyle"});
            proc.waitFor(100, TimeUnit.MILLISECONDS);
            return proc.exitValue() == 0;
        } catch (IOException | InterruptedException | IllegalThreadStateException ex) {
            //process didn't terminate properly
            LOG.warn("Could not determine, whether 'dark mode' is being used. "
                    + "Falling back to default (light) mode.");
            return false;
        }
    }

}