/***************************************************************************
 *   Copyright 2006-2009 by Christian Ihle                                 *
 *   kontakt@usikkert.net                                                  *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

package net.usikkert.kouchat.net;

import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.util.logging.Level;
import java.util.logging.Logger;

import net.usikkert.kouchat.Constants;
import net.usikkert.kouchat.misc.Settings;
import net.usikkert.kouchat.util.Tools;

/**
 * This class can find information about the network interface
 * the operating system has chosen for multicast.
 *
 * @author Christian Ihle
 */
public class OperatingSystemNetworkInfo
{
	/** The logger. */
	private static final Logger LOG = Logger.getLogger( OperatingSystemNetworkInfo.class.getName() );

	/** The message receiver. */
	private final MessageReceiver receiver;

	/** The message sender. */
	private final MessageSender sender;

	/**
	 * Default constructor.
	 */
	public OperatingSystemNetworkInfo()
	{
		receiver = new MessageReceiver( Constants.NETWORK_TEMP_IP, Constants.NETWORK_TEMP_PORT );
		sender = new MessageSender( Constants.NETWORK_TEMP_IP, Constants.NETWORK_TEMP_PORT );
	}

	/**
	 * Finds the network interface the operating system has chosen for
	 * sending and receiving multicast messages.
	 *
	 * <p>If no network interface has been found within 2 seconds,
	 * then <code>null</code> is returned.
	 *
	 * @return The network interface, or <code>null</code>.
	 */
	public NetworkInterface getOperatingSystemNetworkInterface()
	{
		String message = createMessageToSend();
		SimpleReceiverListener listener = new SimpleReceiverListener( message );
		connect( listener );
		sender.send( message );
		waitForMessage( listener );
		disconnect();
		return findNetworkInterface( listener );
	}

	/**
	 * Connects the sender and receiver to the network,
	 * and registers the message listener.
	 *
	 * @param listener The message listener.
	 */
	private void connect( final SimpleReceiverListener listener )
	{
		receiver.registerReceiverListener( listener );
		receiver.startReceiver( null );
		sender.startSender( null );
	}

	/**
	 * Disconnects the sender and receiver from the network.
	 */
	private void disconnect()
	{
		sender.stopSender();
		receiver.stopReceiver();
	}

	/**
	 * Waits for up to 2 seconds for an ip address to be registered in the listener.
	 *
	 * @param listener The message listener.
	 */
	private void waitForMessage( final SimpleReceiverListener listener )
	{
		for ( int i = 0; i < 40; i++ )
		{
			if ( listener.getIpAddress() == null )
				Tools.sleep( 50 );
			else
				break;
		}
	}

	/**
	 * Gets the ip address from the listener, and tries to convert
	 * it into a network interface.
	 *
	 * <p>Returns <code>null</code> if no ip address is found,
	 * or the conversion fails.</p>
	 *
	 * @param listener The message listener.
	 * @return The found network interface, or <code>null</code>.
	 */
	private NetworkInterface findNetworkInterface( final SimpleReceiverListener listener )
	{
		if ( listener.getIpAddress() == null )
			return null;

		try
		{
			InetAddress osAddress = InetAddress.getByName( listener.getIpAddress() );
			return NetworkInterface.getByInetAddress( osAddress );
		}

		catch ( final UnknownHostException e )
		{
			LOG.log( Level.SEVERE, e.toString(), e );
		}

		catch ( final SocketException e )
		{
			LOG.log( Level.SEVERE, e.toString(), e );
		}

		return null;
	}

	/**
	 * Returns a message with the text <code>getOperatingSystemNetworkInterface(user code)</code>,
	 * where user code is taken from the application user.
	 *
	 * @return A message.
	 */
	private String createMessageToSend()
	{
		int code = Settings.getSettings().getMe().getCode();
		return "getOperatingSystemNetworkInterface(" + code + ")";
	}
}