package jmri.jmrix.lenz.xntcp;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.DatagramPacket;
import java.net.DatagramSocket;
import java.net.InetAddress;
import java.net.Socket;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.nio.charset.StandardCharsets;
import java.util.Vector;

import jmri.jmrix.ConnectionStatus;
import jmri.jmrix.lenz.LenzCommandStation;
import jmri.jmrix.lenz.XNetInitializationManager;
import jmri.jmrix.lenz.XNetNetworkPortController;
import jmri.jmrix.lenz.XNetTrafficController;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Provide access to XpressNet via a XnTcp interface attached on the Ethernet
 * port.
 *
 * @author Giorgio Terdina Copyright (C) 2008-2011, based on LI100 adapter by
 * Bob Jacobsen, Copyright (C) 2002
 * @author Portions by Paul Bender, Copyright (C) 2003
 * GT - May 2008 - Added possibility of manually
 * defining the IP address and the TCP port number GT - May 2008 - Added
 * updating of connection status in the main menu panel (using ConnectionStatus
 * by Daniel Boudreau) PB - December 2010 - refactored to be based off of
 * AbstractNetworkController. GT - May 2011 - Fixed problems arising from recent
 * refactoring
 */
public class XnTcpAdapter extends XNetNetworkPortController {

    static final int DEFAULT_UDP_PORT = 61234;
    static final int DEFAULT_TCP_PORT = 61235;
    static final String DEFAULT_IP_ADDRESS = "10.1.0.1";
    static final int UDP_LENGTH = 18;   // Length of UDP packet
    static final int BROADCAST_TIMEOUT = 1000;
    static final int READ_TIMEOUT = 8000;
    // Increasing MAX_PENDING_PACKETS makes output to CS faster, but may delay reception of unexpected notifications from CS
    static final int MAX_PENDING_PACKETS = 15; // Allow a buffer of up to 128 bytes to be sent before waiting for acknowledgment
    private static final String MANUAL = "Manual";

    private Vector<String> hostNameVector = null;  // Contains the list of interfaces found on the LAN
    private Vector<HostAddress> hostAddressVector = null; // Contains their IP and port numbers
    private InputStream inTcpStream = null;
    private OutputTcpStream outTcpStream = null;
    private int pendingPackets = 0;   // Number of packets sent and not yet acknowledged
    private String outName = MANUAL;  // Interface name, used for possible error messages (can be either the netBios name or the IP address)

    public XnTcpAdapter() {
        super();
        option1Name = "XnTcpInterface"; // NOI18N
        options.put(option1Name, new Option(Bundle.getMessage("XnTcpInterfaceLabel"), getInterfaces()));
        m_HostName = DEFAULT_IP_ADDRESS;
        m_port = DEFAULT_TCP_PORT;
    }

    // Internal class, used to keep track of IP and port number
    // of each interface found on the LAN
    private static class HostAddress {

        private final String ipNumber;
        private final int portNumber;

        private HostAddress(String h, int p) {
            ipNumber = h;
            portNumber = p;
        }
    }

    String[] getInterfaces() {
        Vector<String> v = getInterfaceNames();
        String[] a = new String[v.size() + 1];
        for (int i = 0; i < v.size(); i++) {
            a[i + 1] = v.elementAt(i);
        }
        a[0] = Bundle.getMessage(MANUAL);
        return a;
    }

    public Vector<String> getInterfaceNames() {
        // Return the list of XnTcp interfaces connected to the LAN
        findInterfaces();
        return hostNameVector;
    }

    @Override
    public void connect() throws java.io.IOException {
        // Connect to the choosen XpressNet/TCP interface
        int ind;
        // Retrieve XnTcp interface name from Option1
        if (getOptionState(option1Name) != null) {
            outName = getOptionState(option1Name);
        }
        // Did user manually provide IP number and port?
        if (outName.equals(Bundle.getMessage(MANUAL)) || outName.equals(MANUAL)) {
            // Yes - retrieve IP number and port
            if (m_HostName == null) {
                m_HostName = DEFAULT_IP_ADDRESS;
            }
            if (m_port == 0) {
                m_port = DEFAULT_TCP_PORT;
            }
            outName = m_HostName;
        } else {
            // User specified a XnTcp interface name. Check if it's available on the LAN.
            if (hostNameVector == null) {
                findInterfaces();
            }
            if ((ind = hostNameVector.indexOf(outName)) < 0) {
                throw (new IOException("XpressNet/TCP interface " + outName + " not found"));
            }
            // Interface card found. Get the relevantIP number and port
            m_HostName = hostAddressVector.get(ind).ipNumber;
            m_port = hostAddressVector.get(ind).portNumber;
        }
        try {
            // Connect!
            try {
                socketConn = new Socket(m_HostName, m_port);
                socketConn.setSoTimeout(READ_TIMEOUT);
            } catch (UnknownHostException e) {
                ConnectionStatus.instance().setConnectionState(
                        this.getSystemConnectionMemo().getUserName(),
                        outName, ConnectionStatus.CONNECTION_DOWN);
                throw (e);
            }
            // get and save input stream
            inTcpStream = socketConn.getInputStream();

            // purge contents, if any
            purgeStream(inTcpStream);

            // Connection established.
            opened = true;
            ConnectionStatus.instance().setConnectionState(
                        this.getSystemConnectionMemo().getUserName(),
                        outName, ConnectionStatus.CONNECTION_UP);

        } // Report possible errors encountered while opening the connection
        catch (SocketException se) {
            log.error("Socket exception while opening TCP connection with {} trace follows", outName, se);
            ConnectionStatus.instance().setConnectionState(
                        this.getSystemConnectionMemo().getUserName(),
                        outName, ConnectionStatus.CONNECTION_DOWN);
            throw (se);
        }
        catch (IOException e) {
            log.error("Unexpected exception while opening TCP connection with {} trace follows", outName, e);
            ConnectionStatus.instance().setConnectionState(
                        this.getSystemConnectionMemo().getUserName(),
                        outName, ConnectionStatus.CONNECTION_DOWN);
            throw (e);
        }
    }

    /**
     * Retrieve all XnTcp interfaces available on the network
 by broadcasting a UDP request on port 61234, listening
 to all possible replies, storing in hostNameVector
 the NETBIOS names of interfaces found and their IP
 and port numbers in hostAddressVector.
     */
    private void findInterfaces() {

        DatagramSocket udpSocket = null;

        hostNameVector = new Vector<>(10, 1);
        hostAddressVector = new Vector<>(10, 1);

        try {
            byte[] udpBuffer = new byte[UDP_LENGTH];
            // Create a UDP socket
            udpSocket = new DatagramSocket();
            // Prepare the output message (it should contain ASCII '%')
            udpBuffer[0] = 0x25;
            DatagramPacket udpPacket = new DatagramPacket(udpBuffer, 1, InetAddress.getByName("255.255.255.255"), DEFAULT_UDP_PORT);
            // Broadcast the request
            udpSocket.send(udpPacket);
            // Set a timeout limit for replies
            udpSocket.setSoTimeout(BROADCAST_TIMEOUT);
            // Loop listening until timeout occurs
            while (true) {
                // Wait for a reply
                udpPacket.setLength(UDP_LENGTH);
                udpSocket.receive(udpPacket);
                // Reply received, make sure that we got all data
                if (udpPacket.getLength() >= UDP_LENGTH) {
                    // Retrieve the NETBIOS name of the interface
                    hostNameVector.addElement((new String(udpBuffer, 0, 16, StandardCharsets.US_ASCII)).trim());
                    // Retrieve the IP and port numbers of the interface
                    hostAddressVector.addElement(new HostAddress(cleanIP((udpPacket.getAddress()).getHostAddress()),
                            ((udpBuffer[16]) & 0xff) * 256 + ((udpBuffer[17]) & 0xff)));
                }
            }
        } // When timeout or any error occurs, simply exit the loop // When timeout or any error occurs, simply exit the loop
        catch (IOException e) {
            log.debug("Exception occured",e);
        } finally {
            // Before exiting, release resources
            if (udpSocket != null) {
                udpSocket.close();
                udpSocket = null;
            }
        }
    }

    /**
     * TCP/IP stack and the XnTcp interface provide enough buffering to avoid
     * overrun. However, queueing commands faster than they can be processed
     * should in general be avoided.
     * <p>
     * To this purpose, a counter is incremented
     * each time a packet is queued and decremented when a reply from the
     * interface is received. When the counter reaches the pre-defined maximum
     * (e.g. 15) queuing of commands is blocked. Owing to broadcasts from the
     * command station, the number of commands received can actually be higher
     * than that of commands sent, but this fact simply implies that we may have
     * a higher number of pending commands for a while, without any negative
     * consequence (the maximum is however arbitrary).
     *
     * @param s number to send
     */
    protected synchronized void xnTcpSetPendingPackets(int s) {
        pendingPackets += s;
        if (pendingPackets < 0) {
            pendingPackets = 0;
        }
    }

    /**
     * If an error occurs, either in the input or output thread, set the
     * connection status to disconnected. This status will be reset once a
     * TCP/IP connection is re-established via the reconnection routines defined
     * in the parent classes.
     */
    protected synchronized void xnTcpError() {
        // If the error message was already posted, simply ignore this call
        if (opened) {
            ConnectionStatus.instance().setConnectionState(
                        this.getSystemConnectionMemo().getUserName(),
                        outName, ConnectionStatus.CONNECTION_DOWN);
            // Clear open status, in order to avoid issuing the error
            // message more than than once.
            opened = false;
            log.debug("XnTcpError: TCP/IP communication dropped");
        }
    }

    /**
     * Can the port accept additional characters? There is no CTS signal
     * available. We only limit the number of commands queued in TCP/IP stack
     */
    @Override
    @SuppressFBWarnings(value = "OVERRIDING_METHODS_MUST_INVOKE_SUPER",
            justification = "Further investigation is needed to handle this correctly")
    public boolean okToSend() {
        // If a communication error occurred, return always "true" in order to avoid program hang-up while quitting
        if (!opened) {
            return true;
        }
        synchronized (this) {
            // Return "true" if the maximum number of commands queued has not been reached
            log.debug("XnTcpAdapter.okToSend = {} (pending packets = {})", (pendingPackets < MAX_PENDING_PACKETS), pendingPackets);
            return pendingPackets < MAX_PENDING_PACKETS;
        }
    }

    /**
     * Set up all of the other objects to operate with a XnTcp interface.
     */
    @Override
    public void configure() {
        // connect to a packetizing traffic controller
        XNetTrafficController packets = new XnTcpXNetPacketizer(new LenzCommandStation());
        packets.connectPort(this);
        this.getSystemConnectionMemo().setXNetTrafficController(packets);
        new XNetInitializationManager()
                .memo(this.getSystemConnectionMemo())
                .setDefaults()
                .versionCheck()
                .setTimeout(30000)
                .init();
    }

// Base class methods for the XNetNetworkPortController interface

    @Override
    public DataInputStream getInputStream() {
        if (!opened) {
            log.error("getInputStream called before load(), stream not available");
            return null;
        }
        return new DataInputStream(inTcpStream);
    }

    @Override
    public DataOutputStream getOutputStream() {
        if (!opened) {
            log.error("getOutputStream called before load(), stream not available");
        }
        try {
            outTcpStream = (new OutputTcpStream(socketConn.getOutputStream()));
            return new DataOutputStream(outTcpStream);
        } catch (java.io.IOException e) {
            log.error("getOutputStream exception: {}",e.getMessage());
        }
        return null;
    }

    @Override
    public boolean status() {
        return opened;
    }

    /**
     * Extract the IP number from a URL, by removing the
     * domain name, if present.
     */
    private static String cleanIP(String ip) {
        String outIP = ip;
        int i = outIP.indexOf('/');
        if ((i >= 0) && (i < (outIP.length() - 2))) {
            outIP = outIP.substring(i + 1);
        }
        return outIP;
    }

    /**
     * Output class, used to count output packets and make sure that
     * they are immediatelly sent.
     */
    public class OutputTcpStream extends OutputStream {

        private OutputStream tcpOut = null;
        private int count;

        public OutputTcpStream() {
        }

        public OutputTcpStream(OutputStream out) {
            tcpOut = out; // Save the handle to the actual output stream
            count = -1; // First byte should contain packet's length
        }

        @Override
        public void write(int b) throws java.io.IOException {
            // Make sure that we don't interleave bytes, if called
            // at the same time by different threads
            synchronized (tcpOut) {
                try {
                    tcpOut.write(b);
                    if(log.isDebugEnabled()) {
                        log.debug("XnTcpAdapter: sent {}", Integer.toHexString(b & 0xff));
                    }
                    // If this is the start of a new packet, save its length
                    if (count < 0) {
                        count = b & 0x0f;
                    } // If the whole packet was queued, send it and count it
                    else if (count-- == 0) {
                        tcpOut.flush();
                        log.debug("XnTcpAdapter: flush ");
                        xnTcpSetPendingPackets(1);
                    }
                } catch (java.io.IOException e) {
                    xnTcpError();
                    throw e;
                }
            }
        }

        @Override
        public void write(byte[] b, int off, int len) throws java.io.IOException {
            // Make sure that we don't mix bytes of different packets,
            // if called at the same time by different threads
            synchronized (tcpOut) {
                while (len-- > 0) {
                    write((b[off++]) & 0xff);
                }
            }
        }

        public void write(byte[] b, int len) throws java.io.IOException {
            write(b, 0, len);
        }
    }

    private static final Logger log = LoggerFactory.getLogger(XnTcpAdapter.class);

}