path: root/src/esieequest/ui/rich/UserInterface.java

package esieequest.ui.rich;

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.GridLayout;
import java.awt.Image;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.KeyEvent;
import java.awt.image.BufferedImage;
import java.io.FileWriter;
import java.io.IOException;
import java.net.URL;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.HashMap;
import java.util.Map.Entry;
import java.util.Timer;
import java.util.TimerTask;

import javax.swing.AbstractAction;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JFileChooser;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.KeyStroke;
import javax.swing.border.EmptyBorder;
import javax.swing.filechooser.FileNameExtensionFilter;

import lombok.Getter;

import org.newdawn.easyogg.OggClip;

import com.wordpress.tipsforjava.swing.StretchIcon;

import esieequest.engine.GameEngine;
import esieequest.engine.commands.Command;
import esieequest.game.Text;
import esieequest.game.items.Inventory;
import esieequest.game.items.Item;
import esieequest.game.map.Direction;
import esieequest.game.map.Orientation;
import esieequest.game.map.Room;
import esieequest.game.map.Side;
import esieequest.game.states.Callback;
import esieequest.game.states.Quest;
import esieequest.game.states.Scene;
import esieequest.ui.Viewable;

/**
 * The Swing based graphical user interface.
 * 
 * @author Pacien TRAN-GIRARD
 * @author Benoît LUBRANO DI SBARAGLIONE
 */
abstract class UserInterface implements Viewable, ActionListener {

	private static final String ILLUSTRATION_DIR = "resources/images/";
	private static final String ILLUSTRATION_EXT = ".png";

	private static final String SOUND_DIR = "resources/audio/";
	private static final String SOUND_EXT = ".ogg";

	private static final String SAVE_LABEL = "ESIEEquest Game";
	private static final String SAVE_EXT = "eqg";

	private GameEngine gameEngine;

	@Getter
	private JPanel layout;

	private JTextPane questTextPane;

	private JLabel imageLabel;

	private JPanel menuPanel;
	private JPanel questPanel;
	private JPanel gamePanel;

	private JButton newButton;
	private JButton soundButton;
	private JPanel filePanel;
	private JButton loadButton;
	private JButton saveButton;

	private JPanel imagePanel;

	private JPanel userPanel;
	private JPanel dispPanel;

	private JPanel consolePanel;
	private JPanel inventoryPanel;

	private JPanel controlPanel;
	private JPanel topControlPanel;
	private JPanel bottomControlPanel;

	private JTextPane infoTextPane;
	private JTextField inputField;

	private JButton forwardButton;
	private JButton inventoryButton;
	private JButton actionButton;
	private JButton backButton;
	private JButton leftButton;
	private JButton rightButton;

	private Timer timer;
	private TimerTask timerTask;
	private boolean scenePlaying;

	private OggClip audio;
	private boolean muted;

	/**
	 * The default constructor.
	 */
	public UserInterface() {
		this.buildUI();
		this.setActionListener(this);
		this.bindKeys();
		this.bindFocus();
		this.setControlsState(false);
		this.muted = false;
	}

	/**
	 * Creates the interface widgets.
	 */
	private void buildUI() {

		// main window
		this.layout = new JPanel();
		this.layout.setLayout(new BorderLayout(0, 0));

		// top bar
		this.menuPanel = new JPanel();
		this.layout.add(this.menuPanel, BorderLayout.NORTH);
		this.menuPanel.setLayout(new BorderLayout(0, 0));

		this.questPanel = new JPanel();
		this.menuPanel.add(this.questPanel, BorderLayout.CENTER);

		this.questTextPane = new JTextPane();
		this.questTextPane.setEditable(false);
		this.questTextPane.setText(Text.DEFAULT_QUEST_TITLE.toString());
		this.questPanel.add(this.questTextPane);

		this.gamePanel = new JPanel();
		this.menuPanel.add(this.gamePanel, BorderLayout.WEST);

		this.newButton = new JButton(Text.NEW_GAME_BUTTON.toString());
		this.newButton.setToolTipText(Text.NEW_GAME_TOOLTIP.toString());
		this.newButton.setActionCommand(Command.NEW.name());
		this.gamePanel.add(this.newButton);

		this.soundButton = new JButton(Text.TOGGLE_SOUND_BUTTON.toString());
		this.soundButton.setToolTipText(Text.TOGGLE_SOUND_TOOLTIP.toString());
		this.soundButton.setActionCommand(Command.SOUND.name());
		this.gamePanel.add(this.soundButton);

		this.filePanel = new JPanel();
		this.menuPanel.add(this.filePanel, BorderLayout.EAST);

		this.loadButton = new JButton(Text.LOAD_GAME_BUTTON.toString());
		this.loadButton.setToolTipText(Text.LOAD_GAME_TOOLTIP.toString());
		this.loadButton.setActionCommand(Command.LOAD.name());
		this.filePanel.add(this.loadButton);

		this.saveButton = new JButton(Text.SAVE_GAME_BUTTON.toString());
		this.saveButton.setToolTipText(Text.SAVE_GAME_TOOLTIP.toString());
		this.saveButton.setActionCommand(Command.SAVE.name());
		this.filePanel.add(this.saveButton);

		// central illustration panel
		this.imagePanel = new JPanel();
		this.layout.add(this.imagePanel, BorderLayout.CENTER);
		this.imagePanel.setLayout(new BorderLayout(0, 0));

		this.imageLabel = new JLabel();
		this.imagePanel.add(this.imageLabel);

		// bottom panel
		this.userPanel = new JPanel();
		this.layout.add(this.userPanel, BorderLayout.SOUTH);
		this.userPanel.setLayout(new BorderLayout(0, 0));

		// console and inventory
		this.dispPanel = new JPanel();
		this.dispPanel.setBorder(new EmptyBorder(5, 5, 5, 0));
		this.userPanel.add(this.dispPanel, BorderLayout.CENTER);
		this.dispPanel.setLayout(new BorderLayout(0, 0));

		this.consolePanel = new JPanel();
		this.dispPanel.add(this.consolePanel, BorderLayout.CENTER);
		this.consolePanel.setLayout(new BorderLayout(0, 0));

		this.infoTextPane = new JTextPane();
		this.consolePanel.add(this.infoTextPane, BorderLayout.CENTER);
		this.infoTextPane.setEditable(false);
		this.infoTextPane.setText(Text.DEFAULT_CONSOLE.toString());

		this.inputField = new JTextField();
		this.consolePanel.add(this.inputField, BorderLayout.SOUTH);
		this.inputField.setColumns(10);

		this.inventoryPanel = new JPanel();
		this.dispPanel.add(this.inventoryPanel, BorderLayout.NORTH);
		this.inventoryPanel.setLayout(new GridLayout(4, 3, 0, 0));

		final JTextPane emptyTextPane = new JTextPane();
		emptyTextPane.setText(Text.INVENTORY_EMPTY.toString());
		this.inventoryPanel.add(emptyTextPane);
		this.inventoryPanel.setVisible(false);

		// control buttons
		this.controlPanel = new JPanel();
		this.controlPanel.setBorder(new EmptyBorder(5, 5, 5, 5));
		this.userPanel.add(this.controlPanel, BorderLayout.EAST);
		this.controlPanel.setLayout(new BorderLayout(0, 0));

		final Font font = new Font("Dialog", Font.BOLD, 19);
		final Dimension squareButton = new Dimension(50, 50);

		this.topControlPanel = new JPanel();
		this.controlPanel.add(this.topControlPanel, BorderLayout.NORTH);
		this.topControlPanel.setLayout(new BorderLayout(0, 0));

		this.forwardButton = new JButton(Text.GO_FORWARD_BUTTON.toString());
		this.forwardButton.setToolTipText(Text.GO_FORWARD_TOOLTIP.toString());
		this.forwardButton.setActionCommand(Command.GO.name());
		this.forwardButton.setFont(font);
		this.forwardButton.setPreferredSize(squareButton);
		this.topControlPanel.add(this.forwardButton, BorderLayout.CENTER);

		this.inventoryButton = new JButton(Text.INVENTORY_BUTTON.toString());
		this.inventoryButton.setToolTipText(Text.INVENTORY_TOOLTIP.toString());
		this.inventoryButton.setActionCommand(Command.INVENTORY.name());
		this.inventoryButton.setFont(font);
		this.inventoryButton.setPreferredSize(squareButton);
		this.topControlPanel.add(this.inventoryButton, BorderLayout.WEST);

		this.actionButton = new JButton(Text.ACTION_BUTTON.toString());
		this.actionButton.setToolTipText(Text.ACTION_TOOLTIP.toString());
		this.actionButton.setActionCommand(Command.DO.name());
		this.actionButton.setFont(font);
		this.actionButton.setPreferredSize(squareButton);
		this.topControlPanel.add(this.actionButton, BorderLayout.EAST);

		this.bottomControlPanel = new JPanel();
		this.controlPanel.add(this.bottomControlPanel, BorderLayout.SOUTH);
		this.bottomControlPanel.setLayout(new BorderLayout(0, 0));

		this.backButton = new JButton(Text.GO_BACK_BUTTON.toString());
		this.backButton.setToolTipText(Text.GO_BACK_TOOLTIP.toString());
		this.backButton.setActionCommand(Command.BACK.name());
		this.backButton.setFont(font);
		this.backButton.setPreferredSize(squareButton);
		this.bottomControlPanel.add(this.backButton, BorderLayout.CENTER);

		this.leftButton = new JButton(Text.TURN_LEFT_BUTTON.toString());
		this.leftButton.setToolTipText(Text.TURN_LEFT_TOOLTIP.toString());
		this.leftButton.setActionCommand(Command.TURN.name() + Text.COMMAND_SEPARATOR.toString()
				+ Orientation.LEFT.name());
		this.leftButton.setFont(font);
		this.leftButton.setPreferredSize(squareButton);
		this.bottomControlPanel.add(this.leftButton, BorderLayout.WEST);

		this.rightButton = new JButton(Text.TURN_RIGHT_BUTTON.toString());
		this.rightButton.setToolTipText(Text.TURN_RIGHT_TOOLTIP.toString());
		this.rightButton.setActionCommand(Command.TURN.name() + Text.COMMAND_SEPARATOR.toString()
				+ Orientation.RIGHT.name());
		this.rightButton.setFont(font);
		this.rightButton.setPreferredSize(squareButton);
		this.bottomControlPanel.add(this.rightButton, BorderLayout.EAST);

	}

	/**
	 * Sets the action listener for all UI elements.
	 * 
	 * @param actionListener
	 *            the action listener
	 */
	private void setActionListener(final ActionListener actionListener) {
		this.inputField.addActionListener(actionListener);
		this.newButton.addActionListener(actionListener);
		this.soundButton.addActionListener(actionListener);
		this.loadButton.addActionListener(actionListener);
		this.saveButton.addActionListener(actionListener);
		this.forwardButton.addActionListener(actionListener);
		this.inventoryButton.addActionListener(actionListener);
		this.actionButton.addActionListener(actionListener);
		this.backButton.addActionListener(actionListener);
		this.leftButton.addActionListener(actionListener);
		this.rightButton.addActionListener(actionListener);
	}

	/**
	 * Binds keys to corresponding buttons.
	 */
	private void bindKeys() {

		final HashMap<Integer, JButton> keys = new HashMap<>();
		keys.put(KeyEvent.VK_LEFT, this.leftButton);
		keys.put(KeyEvent.VK_RIGHT, this.rightButton);
		keys.put(KeyEvent.VK_UP, this.forwardButton);
		keys.put(KeyEvent.VK_DOWN, this.backButton);
		keys.put(KeyEvent.VK_HOME, this.inventoryButton);
		keys.put(KeyEvent.VK_PAGE_UP, this.actionButton);

		for (final Entry<Integer, JButton> entry : keys.entrySet()) {
			final int key = entry.getKey();
			final JButton button = entry.getValue();

			this.layout.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
					KeyStroke.getKeyStroke(key, 0), key);

			this.layout.getActionMap().put(key, new AbstractAction() {

				private static final long serialVersionUID = 1L;

				@Override
				public void actionPerformed(final ActionEvent actionEvent) {
					button.doClick();
				}

			});
		}

		this.layout.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(
				KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), KeyEvent.VK_ESCAPE);

		this.layout.getActionMap().put(KeyEvent.VK_ESCAPE, new AbstractAction() {

			private static final long serialVersionUID = 1L;

			@Override
			public void actionPerformed(final ActionEvent actionEvent) {
				UserInterface.this.skipScene();
			}

		});

	}

	/**
	 * Binds focus catching components to delegate key strokes to the main
	 * window.
	 */
	public void bindFocus() {
		final FocusListener focusLossDelegator = new FocusListener() {
			@Override
			public void focusGained(final FocusEvent focusEvent) {
			}

			@Override
			public void focusLost(final FocusEvent focusEvent) {
				UserInterface.this.layout.requestFocus();
			}
		};

		final FocusListener focusGainDelegator = new FocusListener() {
			@Override
			public void focusGained(final FocusEvent focusEvent) {
				UserInterface.this.layout.requestFocus();
			}

			@Override
			public void focusLost(final FocusEvent focusEvent) {
			}
		};

		this.inputField.addFocusListener(focusLossDelegator);
		this.infoTextPane.addFocusListener(focusGainDelegator);
		this.questTextPane.addFocusListener(focusGainDelegator);
	}

	/**
	 * Clears the textual input field.
	 */
	private void clearInputField() {
		this.inputField.setText(null);
	}

	/**
	 * Sets the controls state.
	 * 
	 * @param state
	 *            the controls state
	 */
	private void setControlsState(final boolean state) {
		this.inputField.setEnabled(state);
		this.saveButton.setEnabled(state);
		this.inventoryButton.setEnabled(state);
		this.leftButton.setEnabled(state);
		this.rightButton.setEnabled(state);
		if (!state) {
			this.forwardButton.setEnabled(state);
			this.backButton.setEnabled(state);
			this.actionButton.setEnabled(state);
		}
	}

	/**
	 * Sets the quest title.
	 * 
	 * @param questTitle
	 *            the title of the Quest
	 */
	private void setQuestLabel(final String questTitle) {
		this.questTextPane.setText(questTitle);
	}

	/**
	 * Sets the Room's illustration.
	 * 
	 * @param imageName
	 *            the name of the image
	 */
	private void setIllustration(final String imageName) {
		final URL imageURL = this.getClass().getClassLoader().getResource(
				UserInterface.ILLUSTRATION_DIR + imageName + UserInterface.ILLUSTRATION_EXT);
		final StretchIcon imageIcon;
		if (imageURL == null) {
			imageIcon = new StretchIcon(this.generatePlaceholderImage(imageName), true);
		} else {
			imageIcon = new StretchIcon(imageURL, true);
		}
		this.imageLabel.setIcon(imageIcon);
	}

	/**
	 * Placeholder image generation from
	 * http://stackoverflow.com/a/17802477/1348634
	 * 
	 * @param text
	 *            the image text
	 * @return the Image
	 */
	private Image generatePlaceholderImage(final String text) {
		final BufferedImage bufferedImage = new BufferedImage(240, 135,
				BufferedImage.TYPE_BYTE_BINARY);
		final Graphics graphics = bufferedImage.getGraphics();
		graphics.drawString(text, 5, 10 + 5);
		return bufferedImage;
	}

	/**
	 * Skips the currently player Scene.
	 */
	private void skipScene() {
		if (this.scenePlaying) {
			this.timerTask.run();
			this.timerTask.cancel();
		}
	}

	/**
	 * Opens the inventory (switches to the inventory tab).
	 */
	private void openInventory() {
		this.consolePanel.setVisible(false);
		this.inventoryPanel.setVisible(true);
	}

	/**
	 * Closes the inventory (switches to the console tab).
	 */
	private void closeInventory() {
		this.inventoryPanel.setVisible(false);
		this.consolePanel.setVisible(true);
	}

	/**
	 * Toggles the inventory tab.
	 */
	private void toggleInventory() {
		if (this.inventoryPanel.isVisible()) {
			this.closeInventory();
		} else {
			this.openInventory();
		}
	}

	/**
	 * Sets the current music playing.
	 * 
	 * @param fileName
	 *            the URL of the audio file
	 */
	private void playAudio(final String fileName) {
		if (this.audio != null) {
			// stop() and close() are not working properly...
			this.audio.pause();
		}

		try {
			this.audio = new OggClip(UserInterface.SOUND_DIR + fileName + UserInterface.SOUND_EXT);
			this.audio.play();
			this.setAudioGain();
		} catch (final IOException e) {
			e.printStackTrace();
		}
	}

	/**
	 * Sets the gain.
	 * 
	 * PulseAudio does not comply with the JSAPI => pause/play instead of muting
	 */
	private void setAudioGain() {
		if (this.audio == null) {
			return;
		}
		if (this.audio.stopped()) {
			return;
		}

		if (this.muted) {
			// this.audio.setGain(0.0f);
			this.audio.pause();
		} else if (this.audio.isPaused()) {
			// this.audio.setGain(-1.0f);
			this.audio.resume();
		}
	}

	/**
	 * Translates the received ActionEvent into the corresponding game command
	 * and forwards it to the game engine.
	 */
	@Override
	public void actionPerformed(final ActionEvent actionEvent) {
		if (actionEvent.getActionCommand() == Command.INVENTORY.name()) {
			this.toggleInventory();
		} else if (actionEvent.getActionCommand() == Command.LOAD.name()) {
			final JFileChooser fileChooser = new JFileChooser();
			fileChooser.setFileFilter(new FileNameExtensionFilter(UserInterface.SAVE_LABEL,
					UserInterface.SAVE_EXT));
			final int option = fileChooser.showOpenDialog(this.layout);
			if (option == JFileChooser.APPROVE_OPTION) {
				this.gameEngine.interpret(actionEvent.getActionCommand() + Text.COMMAND_SEPARATOR
						+ fileChooser.getSelectedFile().getPath());
			}
		} else if (actionEvent.getActionCommand() == Command.SAVE.name()) {
			final JFileChooser fileChooser = new JFileChooser();
			fileChooser.setFileFilter(new FileNameExtensionFilter(UserInterface.SAVE_LABEL,
					UserInterface.SAVE_EXT));
			final int option = fileChooser.showSaveDialog(this.layout);
			if (option == JFileChooser.APPROVE_OPTION) {
				final String path = fileChooser.getSelectedFile().getPath();
				final String filePath = path.endsWith(UserInterface.SAVE_EXT) ? path : path + "."
						+ UserInterface.SAVE_EXT;
				this.gameEngine.interpret(actionEvent.getActionCommand() + Text.COMMAND_SEPARATOR
						+ filePath);
			}
		} else {
			this.gameEngine.interpret(actionEvent.getActionCommand());
			this.clearInputField();
		}
	}

	@Override
	public void setController(final GameEngine gameEngine) {
		this.gameEngine = gameEngine;
	}

	@Override
	public void enableInput() {
		this.setControlsState(true);
	}

	@Override
	public void disableInput() {
		this.setControlsState(false);
		this.setQuestLabel(Text.DEFAULT_QUEST_TITLE.toString());
	}

	@Override
	public void echo(final String message) {
		this.closeInventory();
		this.infoTextPane.setText(message);
	}

	@Override
	public void updateQuest(final Quest quest) {
		this.setQuestLabel(quest.getTitle());
		this.playAudio(quest.name());
	}

	@Override
	public void updateLocation(final Room room, final Direction direction, final Side side,
			final boolean canGoBack) {
		String locationImageName = room.name() + Text.FILENAME_SEPARATOR.toString()
				+ direction.name();
		if (side.getInventory().getSize() > 0) {
			locationImageName += Text.FILENAME_SEPARATOR.toString()
					+ side.getInventory().getItem().name();
		}
		this.setIllustration(locationImageName);
		this.backButton.setEnabled(canGoBack);
		this.forwardButton.setEnabled(side.hasDoor());
		this.actionButton.setEnabled(side.hasCharacter() || (side.getInventory().getSize() > 0));

		this.echo(room.getInformations());
	}

	@Override
	public void updateInventory(final Inventory inventory) {
		this.inventoryPanel.removeAll();

		if (inventory.getSize() < 1) {
			final JTextPane emptyTextPane = new JTextPane();
			emptyTextPane.setText(Text.INVENTORY_EMPTY.toString());
			this.inventoryPanel.add(emptyTextPane);
			return;
		}

		for (final Item item : inventory.getItems().values()) {
			final JButton button = new JButton(item.getName());
			button.setActionCommand(Command.USE.name() + Text.COMMAND_SEPARATOR.toString()
					+ item.getName());
			button.addActionListener(this);
			this.inventoryPanel.add(button);
		}

		this.openInventory();
	}

	@Override
	public void playScene(final Scene scene, final Callback callback) {
		if (this.scenePlaying) {
			this.timerTask.cancel();
		}

		this.disableInput();

		this.setQuestLabel(scene.getTitle());
		this.echo(scene.getText());
		this.setIllustration(scene.name());
		this.playAudio(scene.name());

		this.scenePlaying = true;

		this.timerTask = new TimerTask() {
			@Override
			public void run() {
				callback.call();
				UserInterface.this.scenePlaying = false;
			}
		};

		if (this.timer != null) {
			this.timer.cancel();
		}
		this.timer = new Timer();
		this.timer.schedule(this.timerTask, scene.getDuration());
	}

	@Override
	public void stopMusic() {
		if (this.audio != null) {
			// stop() and close() are not working properly...
			this.audio.pause();
		}
	}

	@Override
	public void toggleSound() {
		this.muted = !this.muted;
		this.setAudioGain();
	}

	@Override
	public String load(final String path) {
		final Path filePath = Paths.get(path);
		String serialisedGame = null;
		try {
			serialisedGame = new String(Files.readAllBytes(filePath));
		} catch (final IOException e) {
			e.printStackTrace();
		}
		this.skipScene();
		return serialisedGame;
	}

	@Override
	public void save(final String path, final String serialisedGame) {
		try {
			final FileWriter fileWriter = new FileWriter(path);
			fileWriter.write(serialisedGame);
			fileWriter.close();
		} catch (final IOException e) {
			e.printStackTrace();
		}
	}

}