/*
 * Copyright (C) 1994-2021 Altair Engineering, Inc.
 * For more information, contact Altair at www.altair.com.
 *
 * This file is part of both the OpenPBS software ("OpenPBS")
 * and the PBS Professional ("PBS Pro") software.
 *
 * Open Source License Information:
 *
 * OpenPBS is free software. You can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * OpenPBS 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 Affero General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Commercial License Information:
 *
 * PBS Pro is commercially licensed software that shares a common core with
 * the OpenPBS software.  For a copy of the commercial license terms and
 * conditions, go to: (http://www.pbspro.com/agreement.html) or contact the
 * Altair Legal Department.
 *
 * Altair's dual-license business model allows companies, individuals, and
 * organizations to create proprietary derivative works of OpenPBS and
 * distribute them - whether embedded or bundled with other software -
 * under a commercial license agreement.
 *
 * Use of Altair's trademarks, including but not limited to "PBS™",
 * "OpenPBS®", "PBS Professional®", and "PBS Pro™" and Altair's logos is
 * subject to Altair's trademark licensing policies.
 */

/**
 * @file	pbs_connect.c
 * @brief
 *	Open a connection with the pbs server.  At this point several
 *	things are stubbed out, and other things are hard-wired.
 *
 */

#include <pbs_config.h> /* the master config generated by configure */

#include <ctype.h>
#include <stdlib.h>
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <pwd.h>
#include <string.h>
#include <netdb.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/time.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <pbs_ifl.h>
#include "libpbs.h"
#include "net_connect.h"
#include "dis.h"
#include "libsec.h"
#include "pbs_ecl.h"
#include "pbs_internal.h"
#include "log.h"
#include "auth.h"
#include "ifl_internal.h"
#include "libutil.h"
#include "portability.h"

/**
 * @brief
 *	-returns the default server name.
 *
 * @return	string
 * @retval	dflt srvr name	success
 * @retval	NULL		error
 *
 */
char *
__pbs_default(void)
{
	char dflt_server[PBS_MAXSERVERNAME + 1];
	struct pbs_client_thread_context *p;

	/* initialize the thread context data, if not already initialized */
	if (pbs_client_thread_init_thread_context() != 0)
		return NULL;

	p = pbs_client_thread_get_context_data();

	if (pbs_loadconf(0) == 0)
		return NULL;

	if (p->th_pbs_defserver[0] == '\0') {
		/* The check for PBS_DEFAULT is done in pbs_loadconf() */
		if (pbs_conf.pbs_primary && pbs_conf.pbs_secondary) {
			strncpy(dflt_server, pbs_conf.pbs_primary, PBS_MAXSERVERNAME);
		} else if (pbs_conf.pbs_server_host_name) {
			strncpy(dflt_server, pbs_conf.pbs_server_host_name, PBS_MAXSERVERNAME);
		} else if (pbs_conf.pbs_server_name) {
			strncpy(dflt_server, pbs_conf.pbs_server_name, PBS_MAXSERVERNAME);
		} else {
			dflt_server[0] = '\0';
		}
		strcpy(p->th_pbs_defserver, dflt_server);
	}
	return (p->th_pbs_defserver);
}

/**
 * @brief
 *	Return the IP address used in binding a socket to a host
 *	Attempts to find IPv4 address for the named host,  first address found
 *	is returned.
 *
 * @param[in]	host - The name of the host to whose address is needed
 * @param[out]	sap  - pointer to the sockaddr_in structure into which
 *						the address will be returned.
 *
 * @return	int
 * @retval  0	- success, address set in *sap
 * @retval -1	- error, *sap is left zero-ed
 */
static int
get_hostsockaddr(const char *host, struct sockaddr_in *sap)
{
	struct addrinfo hints;
	struct addrinfo *aip, *pai;

	memset(sap, 0, sizeof(struct sockaddr));
	memset(&hints, 0, sizeof(struct addrinfo));
	/*
	 *	Why do we use AF_UNSPEC rather than AF_INET?  Some
	 *	implementations of getaddrinfo() will take an IPv6
	 *	address and map it to an IPv4 one if we ask for AF_INET
	 *	only.  We don't want that - we want only the addresses
	 *	that are genuinely, natively, IPv4 so we start with
	 *	AF_UNSPEC and filter ai_family below.
	 */
	hints.ai_family = AF_UNSPEC;
	hints.ai_socktype = SOCK_STREAM;
	hints.ai_protocol = IPPROTO_TCP;

	if (getaddrinfo(host, NULL, &hints, &pai) != 0) {
		pbs_errno = PBSE_BADHOST;
		return -1;
	}
	for (aip = pai; aip != NULL; aip = aip->ai_next) {
		/* skip non-IPv4 addresses */
		if (aip->ai_family == AF_INET) {
			*sap = *((struct sockaddr_in *) aip->ai_addr);
			freeaddrinfo(pai);
			return 0;
		}
	}
	/* treat no IPv4 addresses as getaddrinfo() failure */
	pbs_errno = PBSE_BADHOST;
	freeaddrinfo(pai);
	return -1;
}

/**
 * @brief	This function establishes a network connection to the given server.
 * 			set extend_data to the value of NOBLK_FLAG to do a non-blocking connect
 *
 * @param[in]   server - The hostname of the pbs server to connect to.
 * @param[in]   port - Port number of the pbs server to connect to.
 * @param[in]   extend_data - a string to send as "extend" data
 *
 *
 * @return int
 * @retval >= 0	The physical server socket.
 * @retval -1	error encountered setting up the connection.
 */

static int
tcp_connect(const char *hostname, int server_port, const char *extend_data)
{
	int i;
	int sd;
	struct sockaddr_in server_addr;
	struct batch_reply *reply;
	char errbuf[LOG_BUF_SIZE] = {'\0'};
	bool noblk = false;
	bool connect_err = false;
#ifdef WIN32
	int non_block = 1;
#else
	int oflg = 0;
	int nflg = 0;
#endif

	if (extend_data != NULL && strcmp(NOBLK_FLAG, extend_data) == 0)
		noblk = true;

		/* get socket	*/
#ifdef WIN32
	/* the following lousy hack is needed since the socket call needs */
	/* SYSTEMROOT env variable properly set! */
	if (getenv("SYSTEMROOT") == NULL) {
		setenv("SYSTEMROOT", "C:\\WINDOWS", 1);
		setenv("SystemRoot", "C:\\WINDOWS", 1);
	}
#endif

	sd = socket(AF_INET, SOCK_STREAM, 0);
	if (sd == -1) {
		pbs_errno = PBSE_SYSTEM;
		return -1;
	}
	if (noblk) { /* set socket non-blocking */
#ifdef WIN32
		if (ioctlsocket(sd, FIONBIO, &non_block) == SOCKET_ERROR) {
#else
		oflg = fcntl(sd, F_GETFL) & ~O_ACCMODE;
		nflg = oflg | O_NONBLOCK;
		if (fcntl(sd, F_SETFL, nflg) == -1)
#endif
			{
				pbs_errno = PBSE_SYSTEM;
				return -1;
			}
		}

		pbs_strncpy(pbs_server, hostname, sizeof(pbs_server)); /* set for error messages from commands */
		/* and connect... */

		if (get_hostsockaddr(hostname, &server_addr) != 0)
			return -1;

		server_addr.sin_port = htons(server_port);
		if (connect(sd, (struct sockaddr *) &server_addr, sizeof(struct sockaddr)) != 0)
			connect_err = true;

		if (connect_err && noblk) { /* For non-blocking, wait until timeout before erroring out */
			fd_set fdset;
			struct timeval tv;
			int n;
			pbs_socklen_t l;

			/* connect attempt failed */
			pbs_errno = SOCK_ERRNO;
			switch (pbs_errno) {
#ifdef WIN32
				case WSAEWOULDBLOCK:
#else
			case EINPROGRESS:
			case EWOULDBLOCK:
#endif
					while (1) {
						FD_ZERO(&fdset);
						FD_SET(sd, &fdset);
						tv.tv_sec = NOBLK_TOUT;
						tv.tv_usec = 0;
						n = select(sd + 1, NULL, &fdset, NULL, &tv);
						if (n > 0) {
							pbs_errno = 0;
							l = sizeof(pbs_errno);
							getsockopt(sd, SOL_SOCKET, SO_ERROR, &pbs_errno, &l);
							if (pbs_errno == 0)
								connect_err = false;
							break;
						} else {
#ifdef WIN32
							if (SOCK_ERRNO != WSAEINTR)
#else
						if (SOCK_ERRNO != EINTR)
#endif
								break;
						}
					}
					break;

				default:;
			}
		}
		if (connect_err) {
			if (pbs_errno == PBSE_NONE)
				pbs_errno = PBSE_SYSTEM;
			closesocket(sd);
			return -1; /* cannot connect */
		}

		/* reset socket blocking */
#ifdef WIN32
		non_block = 0;
		if (ioctlsocket(sd, FIONBIO, &non_block) == SOCKET_ERROR)
#else
	if (fcntl(sd, F_SETFL, oflg) < 0)
#endif

			/* setup connection level thread context */
			if (pbs_client_thread_init_connect_context(sd) != 0) {
				closesocket(sd);
				pbs_errno = PBSE_SYSTEM;
				return -1;
			}

		/*
	 * No need for global lock now on, since rest of the code
	 * is only communication on a connection handle.
	 * But we dont need to lock the connection handle, since this
	 * connection handle is not yet been returned to the client
	 */

		if (load_auths(AUTH_CLIENT)) {
			closesocket(sd);
			pbs_errno = PBSE_SYSTEM;
			return -1;
		}

		/* setup DIS support routines for following pbs_* calls */
		DIS_tcp_funcs();

		/* The following code was originally  put in for HPUX systems to deal
	 * with the issue where returning from the connect() call doesn't
	 * mean the connection is complete.  However, this has also been
	 * experienced in some Linux ppc64 systems like js-2. Decision was
	 * made to enable this harmless code for all architectures.
	 * FIX: Need to use the socket to send
	 * a message to complete the process.  For IFF authentication there is
	 * no leading authentication message needing to be sent on the client
	 * socket, so will send a "dummy" message and discard the replyback.
	 */
		if ((i = encode_DIS_ReqHdr(sd, PBS_BATCH_Connect, pbs_current_user)) ||
		    (i = encode_DIS_ReqExtend(sd, extend_data))) {
			closesocket(sd);
			pbs_errno = PBSE_SYSTEM;
			return -1;
		}
		if (dis_flush(sd)) {
			closesocket(sd);
			pbs_errno = PBSE_SYSTEM;
			return -1;
		}

		pbs_errno = PBSE_NONE;
		reply = PBSD_rdrpy(sd);
		PBSD_FreeReply(reply);
		if (pbs_errno != PBSE_NONE) {
			closesocket(sd);
			return -1;
		}

		if (engage_client_auth(sd, hostname, server_port, errbuf, sizeof(errbuf)) != 0) {
			if (pbs_errno == PBSE_NONE)
				pbs_errno = PBSE_PERM;
			fprintf(stderr, "auth: error returned: %d\n", pbs_errno);
			if (errbuf[0] != '\0')
				fprintf(stderr, "auth: %s\n", errbuf);
			closesocket(sd);
			return -1;
		}

		pbs_tcp_timeout = PBS_DIS_TCP_TIMEOUT_VLONG; /* set for 3 hours */

		/*
	 * Disable Nagle's algorithm on the TCP connection to server.
	 * Nagle's algorithm is hurting cmd-server communication.
	 */
		if (pbs_connection_set_nodelay(sd) == -1) {
			closesocket(sd);
			pbs_errno = PBSE_SYSTEM;
			return -1;
		}

		return sd;
	}

	/**
 * @brief	Helper function to connect to a particular server
 *
 * @param[in]	svrname - server hostname to connect to
 * @param[in]	svrport - server port to connect to
 * @param[in]	extend_data - any additional data relevant for connection
 *
 * @return	int
 * @retval	-1 for error
 * @retval	fd of connection
 */
	static int
	connect_to_server(const char *svrname, int svrport, const char *extend_data)
	{
		int sd = -1;
		struct sockaddr_in my_sockaddr;

		/* bind to pbs_public_host_name if given  */
		if (pbs_conf.pbs_public_host_name) {
			if (get_hostsockaddr(pbs_conf.pbs_public_host_name, &my_sockaddr) != 0)
				return -1; /* pbs_errno was set */
			/* my address will be in my_sockaddr,  bind the socket to it */
			my_sockaddr.sin_port = 0;
			if (bind(sd, (struct sockaddr *) &my_sockaddr, sizeof(my_sockaddr)) != 0) {
				return -1;
			}
		}

		sd = tcp_connect(svrname, svrport, extend_data);

		return sd;
	}

	/**
 * @brief	Makes a PBS_BATCH_Connect request to 'server'.
 *
 * @param[in]   server - the hostname of the pbs server to connect to.
 * @param[in]   extend_data - a string to send as "extend" data.
 *
 * @return int
 * @retval >= 0	index to the internal connection table representing the
 *		connection made.
 * @retval -1	error encountered setting up the connection.
 */
	int
	__pbs_connect_extend(const char *server, const char *extend_data)
	{
		char server_name[PBS_MAXSERVERNAME + 1];
		unsigned int server_port;
		char *altservers[2];
		int have_alt = 0;
		int sock = -1;
		int i;
		int f;

		char pbsrc[_POSIX_PATH_MAX];
		struct stat sb;
		int using_secondary = 0;

		/* initialize the thread context data, if not already initialized */
		if (pbs_client_thread_init_thread_context() != 0)
			return -1;

		if (pbs_loadconf(0) == 0)
			return -1;

		if (PBS_get_server(server, server_name, &server_port) == NULL) {
			pbs_errno = PBSE_NOSERVER;
			return -1;
		}

		if (pbs_conf.pbs_primary && pbs_conf.pbs_secondary) {
			/* failover configuered ...   */
			if (is_same_host(server_name, pbs_conf.pbs_primary)) {
				have_alt = 1;

				altservers[0] = pbs_conf.pbs_primary;
				altservers[1] = pbs_conf.pbs_secondary;

				/* We want to try the one last seen as "up" first to not   */
				/* have connection delays.   If the primary was up, there  */
				/* is no .pbsrc.NAME file.  If the last command connected  */
				/* to the Secondary, then it created the .pbsrc.USER file. */

				/* see if already seen Primary down */
				snprintf(pbsrc, _POSIX_PATH_MAX, "%s/.pbsrc.%s", pbs_conf.pbs_tmpdir, pbs_current_user);
				if (stat(pbsrc, &sb) != -1) {
					/* try secondary first */
					altservers[0] = pbs_conf.pbs_secondary;
					altservers[1] = pbs_conf.pbs_primary;
					using_secondary = 1;
				}
			}
		}

		/*
	 * connect to server ...
	 * If attempt to connect fails and if Failover configured and
	 *   if attempting to connect to Primary,  try the Secondary
	 *   if attempting to connect to Secondary, try the Primary
	 */
		for (i = 0; i < (have_alt + 1); ++i) {
			if (have_alt)
				pbs_strncpy(server_name, altservers[i], PBS_MAXSERVERNAME);
			if ((sock = connect_to_server(server_name, server_port, extend_data)) != -1)
				break;
		}

		if (i >= (have_alt + 1) && sock == -1) {
			return -1; /* cannot connect */
		}

		if (have_alt && (i == 1)) {
			/* had to use the second listed server ... */
			if (using_secondary == 1) {
				/* remove file that causes trying the Secondary first */
				unlink(pbsrc);
			} else {
				/* create file that causes trying the Primary first   */
				f = open(pbsrc, O_WRONLY | O_CREAT, 0200);
				if (f != -1)
					close(f);
			}
		}

		return sock;
	}

	/**
 * @brief
 *	Set no-delay option (disable nagles algoritm) on connection
 *
 * @param[in]   connect - connection index
 *
 * @return int
 * @retval  0	Succcess
 * @retval -1	Failure (bad index, or failed to set)
 *
 */
	int
	pbs_connection_set_nodelay(int connect)
	{
		int opt;
		pbs_socklen_t optlen;

		if (connect < 0)
			return -1;
		optlen = sizeof(opt);
		if (getsockopt(connect, IPPROTO_TCP, TCP_NODELAY, &opt, &optlen) == -1)
			return -1;

		if (opt == 1)
			return 0;

		opt = 1;
		return setsockopt(connect, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof(opt));
	}

	/**
 * @brief	A wrapper progarm to pbs_connect_extend() but this one not
 *			passing any 'extend' data to the connection.
 *
 * @param[in] server - server - the hostname of the pbs server to connect to.
 *
 * @retval int	- return value of pbs_connect_extend().
 */
	int
	__pbs_connect(const char *server)
	{
		return (pbs_connect_extend(server, NULL));
	}

	/**
 * @brief
 *	-send close connection batch request
 *
 * @param[in] connect - socket descriptor
 *
 * @return	int
 * @retval	0	success
 * @retval	-1	error
 *
 */
	int
	__pbs_disconnect(int connect)
	{
		char x;

		if (connect < 0)
			return 0;

		/* initialize the thread context data, if not already initialized */
		if (pbs_client_thread_init_thread_context() != 0)
			return -1;

		/*
	 * Use only connection handle level lock since this is
	 * just communication with server
	 */
		if (pbs_client_thread_lock_connection(connect) != 0)
			return -1;

		/*
	 * check again to ensure that another racing thread
	 * had not already closed the connection
	 */
		if (get_conn_chan(connect) == NULL)
			return 0;

		/* send close-connection message */

		DIS_tcp_funcs();
		if ((encode_DIS_ReqHdr(connect, PBS_BATCH_Disconnect, pbs_current_user) == 0) &&
		    (dis_flush(connect) == 0)) {
			for (;;) { /* wait for server to close connection */
#ifdef WIN32
				if (recv(connect, &x, 1, 0) < 1)
#else
			if (read(connect, &x, 1) < 1)
#endif
					break;
			}
		}

		CS_close_socket(connect);
		closesocket(connect);
		dis_destroy_chan(connect);

		/* unlock the connection level lock */
		if (pbs_client_thread_unlock_connection(connect) != 0)
			return -1;

		/*
	 * this is only a per thread work, so outside lock and unlock
	 * connection needs the thread level connect context so this should be
	 * called after unlocking
	 */
		if (pbs_client_thread_destroy_connect_context(connect) != 0)
			return -1;

		destroy_connection(connect);

		return 0;
	}

	/**
 * @brief
 *	-return the number of max connections.
 *
 * @return	int
 * @retval	0	success
 * @retval	!0	error
 *
 */
	int
	pbs_query_max_connections()
	{
		return (NCONNECTS - 1);
	}

	/*
 *	pbs_connect_noblk() - Open a connection with a pbs server.
 *		Do not allow TCP to block us if Server host is down
 *
 *	At this point, this does not attempt to find a fail_over Server
 */

	/**
 * @brief
 *	Open a connection with a pbs server.
 *	Do not allow TCP to block us if Server host is down
 *	At this point, this does not attempt to find a fail_over Server
 *
 * @param[in]   server - specifies the server to which to connect
 *
 * @return int
 * @retval >= 0	index to the internal connection table representing the
 *		connection made.
 * @retval -1	error encountered in getting index
 */
	int
	pbs_connect_noblk(const char *server)
	{
		return pbs_connect_extend(server, NOBLK_FLAG);
	}

	/**
 * @brief Registers the given connection with the Server by sending PBS_BATCH_RegisterSched
 *
 * param[in]	sched_id - sched identifier which is known to server
 * @return int
 * @retval !0  - failure
 * @return 0  - success
 */
	static int
	register_sched_conn(int c, const char *sched_id)
	{
		int rc;
		struct batch_reply *reply = NULL;

		if (sched_id == NULL)
			return -1;

		rc = encode_DIS_ReqHdr(c, PBS_BATCH_RegisterSched, pbs_current_user);
		if (rc != DIS_SUCCESS)
			goto rerr;
		rc = diswst(c, sched_id);
		if (rc != DIS_SUCCESS)
			goto rerr;
		rc = encode_DIS_ReqExtend(c, NULL);
		if (rc != DIS_SUCCESS)
			goto rerr;
		if (dis_flush(c) != 0)
			goto rerr;

		pbs_errno = 0;
		reply = PBSD_rdrpy(c);
		if (reply == NULL)
			goto rerr;

		if (pbs_errno != 0)
			goto rerr;

		PBSD_FreeReply(reply);
		return 0;

	rerr:
		pbs_disconnect(c);
		PBSD_FreeReply(reply);
		return -1;
	}

	/**
 * @brief Registers the Scheduler with all the Servers configured
 *
 * param[in]	sched_id - sched identifier which is known to server
 * param[in]	primary_conn_id - primary connection handle which represents all servers returned by pbs_connect
 * param[in]	secondary_conn_id - secondary connection handle which represents all servers returned by pbs_connect
 *
 * @return int
 * @retval !0  - couldn't register with a connected server
 * @return 0  - success
 */
	int
	__pbs_register_sched(const char *sched_id, int primary_conn_sd, int secondary_conn_sd)
	{
		if (sched_id == NULL || primary_conn_sd < 0 || secondary_conn_sd < 0)
			return -1;

		if (register_sched_conn(primary_conn_sd, sched_id) != 0)
			return -1;
		if (register_sched_conn(secondary_conn_sd, sched_id) != 0)
			return -1;

		return 0;
	}