SystemTrayFrame.java

/**
 * Copyright (c) 2005-2017, KoLmafia development team
 * http://kolmafia.sourceforge.net/
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  [1] Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *  [2] Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in
 *      the documentation and/or other materials provided with the
 *      distribution.
 *  [3] Neither the name "KoLmafia" nor the names of its contributors may
 *      be used to endorse or promote products derived from this software
 *      without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

package net.sourceforge.kolmafia.swingui;

import com.jeans.trayicon.TrayIconPopup;
import com.jeans.trayicon.TrayIconPopupSimpleItem;
import com.jeans.trayicon.WindowsTrayIcon;

import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.io.File;

import javax.swing.ImageIcon;

import net.java.dev.spellcast.utilities.JComponentUtilities;
import net.sourceforge.kolmafia.KoLCharacter;
import net.sourceforge.kolmafia.KoLConstants;
import net.sourceforge.kolmafia.KoLDesktop;
import net.sourceforge.kolmafia.KoLmafia;
import net.sourceforge.kolmafia.KoLmafiaGUI;
import net.sourceforge.kolmafia.RequestThread;
import net.sourceforge.kolmafia.StaticEntity;
import net.sourceforge.kolmafia.session.LogoutManager;
import net.sourceforge.kolmafia.utilities.FileUtilities;

public abstract class SystemTrayFrame
{
	private static WindowsTrayIcon icon = null;

	public synchronized static final void addTrayIcon()
	{
		if ( SystemTrayFrame.icon != null )
		{
			return;
		}

		// Now, make calls to SystemTrayIconManager in order
		// to make use of the system tray.

		FileUtilities.loadLibrary( KoLConstants.IMAGE_LOCATION, "", "TrayIcon12.gif" );

		try
		{
			File iconfile = new File( KoLConstants.IMAGE_LOCATION, "TrayIcon12.dll" );
			System.load( iconfile.getCanonicalPath() );
			WindowsTrayIcon.initTrayIcon( "KoLmafia" );

			ImageIcon image = JComponentUtilities.getImage( "", "TrayIcon12.gif" );

			WindowsTrayIcon icon = new WindowsTrayIcon( image.getImage(), 16, 16 );
			icon.addMouseListener( new SetVisibleListener() );

			TrayIconPopup popup = new TrayIconPopup();
			popup.addMenuItem( new ShowMainWindowPopupItem() );
			popup.addMenuItem( new ConstructFramePopupItem( "Graphical CLI", "CommandDisplayFrame" ) );
			popup.addMenuItem( new ConstructFramePopupItem( "Preferences", "OptionsFrame" ) );
			popup.addMenuItem( new ConstructFramePopupItem( "Relay Browser", "LocalRelayServer" ) );
			popup.addMenuItem( new ConstructFramePopupItem( "KoLmafia Chat", "ChatManager" ) );
			popup.addMenuItem( new LogoutPopupItem() );
			popup.addMenuItem( new EndSessionPopupItem() );

			icon.setPopup( popup );
			SystemTrayFrame.icon = icon;
			SystemTrayFrame.updateToolTip();
		}
		catch ( Exception e )
		{
			StaticEntity.printStackTrace( e );
			return;
		}
	}

	public static final void removeTrayIcon()
	{
		if ( SystemTrayFrame.icon != null )
		{
			WindowsTrayIcon.cleanUp();
		}
	}

	public static final void updateToolTip()
	{
		if ( KoLCharacter.getUserName().equals( "" ) )
		{
			SystemTrayFrame.updateToolTip( StaticEntity.getVersion() );
		}
		else
		{
			SystemTrayFrame.updateToolTip( StaticEntity.getVersion() + ": " + KoLCharacter.getUserName() );
		}
	}

	public static final void updateToolTip( final String message )
	{
		if ( SystemTrayFrame.icon == null )
		{
			return;
		}

		SystemTrayFrame.icon.setVisible( true );
		SystemTrayFrame.icon.setToolTipText( message );
	}

	public static final void showBalloon( final String message )
	{
		if ( SystemTrayFrame.icon == null )
		{
			return;
		}

		Frame[] frames = Frame.getFrames();
		boolean anyFrameVisible = false;
		for ( int i = 0; i < frames.length; ++i )
		{
			anyFrameVisible |= frames[ i ].isVisible();
		}

		anyFrameVisible |= KoLDesktop.instanceExists() && KoLDesktop.getInstance().isVisible();

		if ( anyFrameVisible )
		{
			return;
		}

		try
		{
			SystemTrayFrame.icon.showBalloon( message, StaticEntity.getVersion(), 0, WindowsTrayIcon.BALLOON_INFO );
		}
		catch ( Exception e )
		{
			// Just an error when alerting the user.  It's
			// not important, so ignore the error for now.
		}
	}

	private static class SetVisibleListener
		extends MouseAdapter
	{
		@Override
		public void mousePressed( final MouseEvent e )
		{
			if ( e.isPopupTrigger() )
			{
				return;
			}

			SystemTrayFrame.showDisplay();
		}
	}

	public static final void showDisplay()
	{
		KoLmafiaGUI.checkFrameSettings();
		KoLDesktop.getInstance().setVisible( true );
	}

	private static abstract class ThreadedTrayIconPopupSimpleItem
		extends TrayIconPopupSimpleItem
		implements ActionListener, Runnable
	{
		public ThreadedTrayIconPopupSimpleItem( final String title )
		{
			super( title );
			this.addActionListener( this );
		}

		public final void actionPerformed( final ActionEvent e )
		{
			RequestThread.runInParallel( this, false );
		}
	}

	private static class ShowMainWindowPopupItem
		extends ThreadedTrayIconPopupSimpleItem
	{
		public ShowMainWindowPopupItem()
		{
			super( "Main Interface" );
		}

		public void run()
		{
			SystemTrayFrame.showDisplay();
		}
	}

	private static class ConstructFramePopupItem
		extends ThreadedTrayIconPopupSimpleItem
	{
		private final String frame;

		public ConstructFramePopupItem( final String title, final String frame )
		{
			super( title );
			this.frame = frame;
		}

		public void run()
		{
			KoLmafiaGUI.constructFrame( this.frame );
		}
	}

	private static class LogoutPopupItem
		extends ThreadedTrayIconPopupSimpleItem
	{
		public LogoutPopupItem()
		{
			super( "Logout of KoL" );
		}

		public void run()
		{
			LogoutManager.logout();
		}
	}

	private static class EndSessionPopupItem
		extends ThreadedTrayIconPopupSimpleItem
	{
		public EndSessionPopupItem()
		{
			super( "Exit KoLmafia" );
		}

		public void run()
		{
			KoLmafia.quit();
		}
	}
}