Software Público Brasileiro

/*
 * "Software G3270, desenvolvido com base nos códigos fontes do WC3270  e  X3270
 * (Paul Mattes Paul.Mattes@usa.net), de emulação de terminal 3270 para acesso a
 * aplicativos mainframe. Registro no INPI sob o nome G3270.
 *
 * Copyright (C) <2008> <Banco do Brasil S.A.>
 *
 * Este programa é software livre. Você pode redistribuí-lo e/ou modificá-lo sob
 * os termos da GPL v.2 - Licença Pública Geral  GNU,  conforme  publicado  pela
 * Free Software Foundation.
 *
 * Este programa é distribuído na expectativa de  ser  útil,  mas  SEM  QUALQUER
 * GARANTIA; sem mesmo a garantia implícita de COMERCIALIZAÇÃO ou  de  ADEQUAÇÃO
 * A QUALQUER PROPÓSITO EM PARTICULAR. Consulte a Licença Pública Geral GNU para
 * obter mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral GNU junto com este
 * programa; se não, escreva para a Free Software Foundation, Inc., 51 Franklin
 * St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Este programa está nomeado como private.h e possui - linhas de código.
 *
 * Contatos:
 *
 * perry.werneck@gmail.com	(Alexandre Perry de Souza Werneck)
 * erico.mendonca@gmail.com	(Erico Mascarenhas de Mendonça)
 *
 */

#ifdef WIN32
	#include <winsock2.h>
	#include <windows.h>
#endif // WIN32

/* Autoconf settings. */
#include <lib3270/config.h>		/* autoconf settings */
#include <lib3270.h>			/* lib3270 API calls and defs */
#include <lib3270/charset.h>
#include "api.h"

#if defined(X3270_TN3270E) && !defined(X3270_ANSI) /*[*/
		#define X3270_ANSI	1	/* RFC2355 requires NVT mode */
#endif /*]*/

#if defined(HAVE_VASPRINTF) && !defined(_GNU_SOURCE) /*[*/
	#define _GNU_SOURCE		/* vasprintf isn't POSIX */
#endif /*]*/

/*
 * gettext stuff
 */
#ifdef ANDROID
	#undef HAVE_LIBINTL
	#undef HAVE_LIBSSL
#endif

#ifdef HAVE_LIBINTL
	#include <libintl.h>
	#define _( x ) 			gettext(x)
	#define N_( x ) 		x
#else
	#define _( x ) 			x
	#define N_( x ) 		x
#endif // HAVE_LIBINTL

#define action_name(x)  #x

/*
 * OS-specific #defines.  Except for the blocking-connect workarounds, these
 * should be replaced with autoconf probes as soon as possible.
 */

/*
 * BLOCKING_CONNECT_ONLY
 *   Use only blocking sockets.
 */
#if defined(sco) /*[*/
	#define BLOCKING_CONNECT_ONLY	1
#endif /*]*/

#if defined(apollo) /*[*/
	#define BLOCKING_CONNECT_ONLY	1
#endif /*]*/

/*
 * Compiler-specific #defines.
 */

/* 'unused' explicitly flags an unused parameter */
#if defined(__GNUC__) /*[*/
	#define unused __attribute__((__unused__))
	#define printflike(s,f) __attribute__ ((__format__ (__printf__, s, f)))
#else /*][*/
	#define unused /* nothing */
	#define printflike(s, f) /* nothing */
#endif /*]*/



/*
 * Prerequisite #includes.
 */
#include <stdio.h>				/* Unix standard I/O library */
#include <unistd.h>				/* Unix system calls */
#include <ctype.h>				/* Character classes */
#include <string.h>				/* String manipulations */
#include <sys/types.h>			/* Basic system data types */
#include <sys/time.h>			/* System time-related data types */
#include <time.h>				/* C library time functions */
#include "localdefs.h"			/* {s,tcl,c}3270-specific defines */

/*
 * Cancel out contradictory parts.
 */
#if !defined(X3270_DISPLAY) /*[*/
	#undef X3270_KEYPAD
	#undef X3270_MENUS
#endif /*]*/

/* types of internal actions */
enum iaction {
	IA_STRING, IA_PASTE, IA_REDRAW,
	IA_KEYPAD, IA_DEFAULT, IA_KEY,
	IA_MACRO, IA_SCRIPT, IA_PEEK,
	IA_TYPEAHEAD, IA_FT, IA_COMMAND, IA_KEYMAP,
	IA_IDLE
};

// Version strings
LIB3270_INTERNAL const char * build;
LIB3270_INTERNAL const char * app_defaults_version;
LIB3270_INTERNAL const char * sccsid;
LIB3270_INTERNAL const char * build_rpq_timestamp;
LIB3270_INTERNAL const char * build_rpq_version;
LIB3270_INTERNAL const char * build_rpq_revision;

#if defined(X3270_DBCS) /*[*/
	LIB3270_INTERNAL Boolean		dbcs;
#endif /*]*/


/*   toggle names */
struct toggle_name {
	const char *name;
	int index;
};


/*   input key type */

/* Naming convention for private actions. */
#define PA_PFX	"PA-"

/// @brief Shorthand macros
#define CN	((char *) NULL)
#define PN	((XtPointer) NULL)
#define Replace(var, value) { lib3270_free(var); var = (value); };

/// @brief Configuration change masks.
#define NO_CHANGE		0x0000	/// @brief no change
#define MODEL_CHANGE	0x0001	/// @brief screen dimensions changed
#define FONT_CHANGE		0x0002	/// @brief emulator font changed
#define COLOR_CHANGE	0x0004	/// @brief color scheme or 3278/9 mode changed
#define SCROLL_CHANGE	0x0008	/// @brief scrollbar snapped on or off
#define CHARSET_CHANGE	0x0010	/// @brief character set changed
#define ALL_CHANGE		0xffff	/// @brief everything changed

/* Portability macros */

/*   Equivalent of setlinebuf */

#if defined(_IOLBF) /*[*/
	#define SETLINEBUF(s)	setvbuf(s, (char *)NULL, _IOLBF, BUFSIZ)
#else /*][*/
	#define SETLINEBUF(s)	setlinebuf(s)
#endif /*]*/

/*   Motorola version of gettimeofday */

#if defined(MOTOROLA)
	#define gettimeofday(tp,tz)	gettimeofday(tp)
#endif

/* Default DFT file transfer buffer size. */
#if defined(X3270_FT) && !defined(DFT_BUF) /*[*/
	#define DFT_BUF		(4 * 1024)
#endif /*]*/

/* DBCS Preedit Types */
#if defined(X3270_DBCS) /*[*/
	#define PT_ROOT				"Root"
	#define PT_OVER_THE_SPOT	"OverTheSpot"
	#define PT_OFF_THE_SPOT		"OffTheSpot"
	#define PT_ON_THE_SPOT		"OnTheSpot"
#endif /*]*/

/** input key type */
enum keytype
{
	KT_STD,
	KT_GE
};

LIB3270_INTERNAL struct _ansictl
{
	char     vintr;
	char     vquit;
	char     verase;
	char     vkill;
	char     veof;
	char     vwerase;
	char     vrprnt;
	char     vlnext;
} ansictl;

/** @brief Extended attributes */
struct lib3270_ea
{
	unsigned char cc;		///< @brief EBCDIC or ASCII character code
	unsigned char fa;		///< @brief field attribute, it nonzero
	unsigned char fg;		///< @brief foreground color (0x00 or 0xf<n>)
	unsigned char bg;		///< @brief background color (0x00 or 0xf<n>)
	unsigned char gr;		///< @brief ANSI graphics rendition bits
	unsigned char cs;		///< @brief character set (GE flag, or 0..2)
	unsigned char ic;		///< @brief input control (DBCS)
	unsigned char db;		///< @brief DBCS state
};

struct lib3270_text
{
	unsigned char  chr;		///< @brief ASCII character code
	unsigned short attr;	///< @brief Converted character attribute (color & etc)
};

#ifndef HEADER_SSL_H
	#define SSL void
#endif // !HEADER_SSL_H

#ifndef LIB3270_TA
	#define LIB3270_TA void
#endif // !LIB3270_TA

#define LIB3270_MB_MAX					16
#define LIB3270_DEFAULT_CGEN			0x02b90000
#define LIB3270_DEFAULT_CSET			0x00000025

#define LIB3270_FULL_MODEL_NAME_LENGTH	13
#define LIB3270_LU_MAX					32

#define LIB3270_TELNET_N_OPTS			256

/**
 *
 * @brief Timeout control structure.
 *
 */
typedef struct timeout
{
	struct timeout *next;

#if defined(_WIN32) /*[*/
	unsigned long long ts;
#else /*][*/
	struct timeval tv;
#endif /*]*/

	void (*proc)(H3270 *session);

	H3270 *session;

	unsigned char in_play;
} timeout_t;


/**
 *
 * @brief I/O events.
 *
 */
typedef struct input
{
        struct input	* next;
        H3270			* session;
        int 			  fd;
        LIB3270_IO_FLAG	  flag;
        void			* userdata;

        void (*call)(H3270 *, int, LIB3270_IO_FLAG, void *);

} input_t;


/**
 *
 * @brief lib3270 session data
 *
 */
struct _h3270
{
	struct lib3270_session_callbacks	  cbk;		// Callback table - Always the first one.

//	unsigned short 		  	  sz;								/**< Struct size */

	// Connection info
	int						  sock;								/**< Network socket */
	LIB3270_CSTATE			  cstate;							/**< Connection state */

	// flags
	LIB3270_OPTION			  options;							/**< Session options */

	int						  bgthread					: 1;	/**< Running on a background thread ? */
	int					  	  selected					: 1;	/**< Has selected region? */
	int						  rectsel					: 1;	/**< Selected region is a rectangle ? */
	int						  vcontrol					: 1;	/**< Visible control ? */
	int						  modified_sel				: 1;
	int						  mono						: 1;	/**< Forces monochrome display */
	int						  m3279						: 1;
	int 					  extended					: 1;
	int						  typeahead					: 1;
	int						  numeric_lock				: 1;
	int						  oerr_lock					: 1;
	int						  unlock_delay				: 1;
	int			 			  auto_reconnect_inprogress	: 1;
	unsigned int			  colors					: 5;
	int						  apl_mode					: 1;
	int						  icrnl						: 1;
	int						  inlcr						: 1;
	int						  onlcr						: 1;
	int						  bsd_tm					: 1;
	int 					  syncing					: 1;
	int						  reverse 					: 1;	/**< reverse-input mode */
	int						  dbcs						: 1;
	int             		  linemode					: 1;
	int						  trace_skipping			: 1;
	int						  need_tls_follows			: 1;
	int						  cut_xfer_in_progress		: 1;
//		int						  auto_keymap				: 1;
	int						  formatted					: 1;	/**< Formatted screen flag */
	int						  starting					: 1;	/**< Is starting (no first screen)? */

	char					* oversize;

	LIB3270_SSL_STATE		  secure;

	struct lib3270_toggle
	{
		char value;																/**< toggle value */
		void (*upcall)(H3270 *, struct lib3270_toggle *, LIB3270_TOGGLE_TYPE);	/**< change value */
	}						  toggle[LIB3270_TOGGLE_COUNT];

	// Network & Termtype
	char					* connected_type;
	char					* connected_lu;
	char					  luname[LIB3270_LUNAME_LENGTH+1];

	char					  full_model_name[LIB3270_FULL_MODEL_NAME_LENGTH+1];
	char					* model_name;
	int						  model_num;
	char  	     	    	* termtype;

	struct
	{
		char				* current;		/**< The hostname part, stripped of qualifiers, luname and port number */
		char 	   	    	* full;			/**< The entire string, for use in reconnecting */
		char				* srvc;			/**< The service name */
		char	   	    	* qualified;
	} host;

	char					* proxy;				/**< Proxy server (type:host[:port]) */
	char					* termname;

	struct lib3270_charset	  charset;

	LIB3270_MESSAGE			  oia_status;

	unsigned char	 		  oia_flag[LIB3270_FLAG_COUNT];

	unsigned short			  current_port;

	// Misc
	H3270FT					* ft;					/**< Active file transfer data */

	// screen info
	int						  ov_rows;
	int						  ov_cols;
	int						  maxROWS;
	int						  maxCOLS;
	unsigned short			  rows;
	unsigned short			  cols;
	unsigned short			  pointer;				/**< @brief Current pointer. */
	int						  cursor_addr;
	int						  buffer_addr;
	char					  flipped;
	int						  screen_alt;			/**< alternate screen? */
	int						  is_altbuffer;

	// Screen contents
	void 					* buffer[2];			/**< Internal buffers */
	struct lib3270_ea  		* ea_buf;				/**< 3270 device buffer. ea_buf[-1] is the dummy default field attribute */
	struct lib3270_ea		* aea_buf;				/**< alternate 3270 extended attribute buffer */
	struct lib3270_text		* text;					/**< Converted 3270 chars */

	// host.c
	char	 				  std_ds_host;
	char 					  no_login_host;
	char 					  non_tn3270e_host;
	char 					  passthru_host;
	char 					  ssl_host;
	char 					  ever_3270;

	// ctlr.c
	int						  sscp_start;
	unsigned char			  default_fg;
	unsigned char			  default_bg;
	unsigned char			  default_gr;
	unsigned char			  default_cs;
	unsigned char			  default_ic;
	char					  reply_mode;
	int 					  trace_primed 		: 1;
	int						  ticking			: 1;
	int						  mticking			: 1;
	int						  crm_nattr;
	unsigned char			  crm_attr[16];
	unsigned char 			* zero_buf;				/**< empty buffer, for area clears */

	struct timeval			  t_start;
	void					* tick_id;
	struct timeval			  t_want;

	// Telnet.c
	unsigned char 			* ibuf;
	int      				  ibuf_size;			/**< size of ibuf */
	unsigned char			* obuf;					/**< 3270 output buffer */
	unsigned char			* obptr;
	time_t          		  ns_time;
	int             		  ns_brcvd;
	int             		  ns_rrcvd;
	int             		  ns_bsent;
	int             		  ns_rsent;
	struct timeval 			  ds_ts;
	unsigned long			  e_funcs;				/**< negotiated TN3270E functions */
	unsigned short			  e_xmit_seq;			/**< transmit sequence number */
	int						  response_required;
	int						  tn3270e_bound;
	int						  tn3270e_negotiated;
	int						  ansi_data;
	int						  lnext;
	int						  backslashed;
	char					  plu_name[LIB3270_BIND_PLU_NAME_MAX+1];
	char					**lus;
	char					**curr_lu;
	char					* try_lu;
	int						  proxy_type;
	char					* proxy_host;
	char					* proxy_portname;
	unsigned short			  proxy_port;
	char					  reported_lu[LIB3270_LU_MAX+1];
	char					  reported_type[LIB3270_LU_MAX+1];

	enum
	{
		E_NONE,
		E_3270,
		E_NVT,
		E_SSCP
	}						  tn3270e_submode;

	unsigned char 			* lbuf;					/**< line-mode input buffer */
	unsigned char 			* lbptr;


	// 3270 input buffer
	unsigned char 			* ibptr;
	unsigned char 			* obuf_base;
	int						  obuf_size;
//		unsigned char 			* netrbuf;

	// network input buffer
	unsigned char 			* sbbuf;

	// telnet sub-option buffer
	unsigned char 			* sbptr;
	unsigned char			  telnet_state;
//		char					  ttype_tmpval[13];

	unsigned char 			  myopts[LIB3270_TELNET_N_OPTS];
	unsigned char			  hisopts[LIB3270_TELNET_N_OPTS];

	// kybd.c
	unsigned int			  kybdlock;				///< @brief keyboard lock state
	unsigned char			  aid;					///< @brief current attention ID
	void					* unlock_id;
	time_t					  unlock_delay_time;
	unsigned long 			  unlock_delay_ms;		///< @brief Delay before actually unlocking the keyboard after the host permits it.
	LIB3270_TA				* ta_head;
	LIB3270_TA				* ta_tail;

	// ft_dft.c
	int						  dft_buffersize;		///< @brief Buffer size (LIMIN, LIMOUT)

	// rpq.c
	int						  rpq_complained : 1;
#if !defined(_WIN32)
	int						  omit_due_space_limit : 1;
#endif

	char					* rpq_warnbuf;
	int						  rpq_wbcnt;

	// User data (Usually points to session's widget)
	void					* user_data;

	// selection
	char					* paste_buffer;
	struct
	{
		int start;
		int end;
	} select;

	// ansi.c
	int      				  scroll_top;
	int						  scroll_bottom;
	int						  once_cset;
	int						  saved_cursor;

	int						  held_wrap					: 1;

	int						  insert_mode				: 1;
	int						  auto_newline_mode			: 1;

	int						  appl_cursor				: 1;
	int						  saved_appl_cursor			: 1;

	int  					  wraparound_mode			: 1;
	int						  saved_wraparound_mode		: 1;

	int						  rev_wraparound_mode 		: 1;
	int						  saved_rev_wraparound_mode	: 1;

	int						  allow_wide_mode			: 1;
	int						  saved_allow_wide_mode		: 1;

	int						  wide_mode 				: 1;
	int						  saved_wide_mode			: 1;

	int						  saved_altbuffer			: 1;
	int						  ansi_reset				: 1;	/**< Non zero if the ansi_reset() was called in this session */

	int      				  ansi_ch;
	int						  cs_to_change;

	/** ANSI Character sets. */
	enum lib3270_ansi_cs
	{
		LIB3270_ANSI_CS_G0 = 0,
		LIB3270_ANSI_CS_G1 = 1,
		LIB3270_ANSI_CS_G2 = 2,
		LIB3270_ANSI_CS_G3 = 3
	}						  cset;
	enum lib3270_ansi_cs	  saved_cset;

	/** Character set designations. */
	enum lib3270_ansi_csd
	{
		LIB3270_ANSI_CSD_LD = 0,
		LIB3270_ANSI_CSD_UK = 1,
		LIB3270_ANSI_CSD_US = 2
	} 						  csd[4];
	enum lib3270_ansi_csd 	  saved_csd[4];

	enum lib3270_ansi_state
	{
		LIB3270_ANSI_STATE_DATA		= 0,
		LIB3270_ANSI_STATE_ESC		= 1,
		LIB3270_ANSI_STATE_CSDES	= 2,
		LIB3270_ANSI_STATE_N1		= 3,
		LIB3270_ANSI_STATE_DECP		= 4,
		LIB3270_ANSI_STATE_TEXT		= 5,
		LIB3270_ANSI_STATE_TEXT2	= 6,
		LIB3270_ANSI_STATE_MBPEND	= 7
	}						  state;

	unsigned char			* tabs;

	int						  pmi;
	char					  pending_mbs[LIB3270_MB_MAX];

	unsigned char 			  gr;
	unsigned char			  saved_gr;

	unsigned char			  fg;
	unsigned char			  saved_fg;

	unsigned char			  bg;
	unsigned char			  saved_bg;

	// xio
	void 					* ns_read_id;
	void 					* ns_write_id;
	void 					* ns_exception_id;

	// SSL Data (Always defined to mantain the same structure size)
	unsigned long 			  ssl_error;
	SSL 					* ssl_con;

	timeout_t				* timeouts;
	input_t 				* inputs;
	int						  inputs_changed : 1;

	// Callbacks.
	struct lib3270_state_callback		* st_callbacks[LIB3270_STATE_USER];
	struct lib3270_state_callback		* st_last[LIB3270_STATE_USER];

};

/* Library internal calls */
LIB3270_INTERNAL void	key_ACharacter(H3270 *hSession, unsigned char c, enum keytype keytype, enum iaction cause,Boolean *skipped);
LIB3270_INTERNAL void	lib3270_initialize(void);
LIB3270_INTERNAL int	cursor_move(H3270 *session, int baddr);

LIB3270_INTERNAL void	toggle_rectselect(H3270 *session, struct lib3270_toggle *t, LIB3270_TOGGLE_TYPE tt);
LIB3270_INTERNAL void	remove_input_calls(H3270 *session);

LIB3270_INTERNAL int	lib3270_sock_send(H3270 *hSession, unsigned const char *buf, int len);
LIB3270_INTERNAL void	lib3270_sock_disconnect(H3270 *hSession);

LIB3270_INTERNAL int	lib3270_default_event_dispatcher(H3270 *hSession, int block);

#if defined(DEBUG)
	#define CHECK_SESSION_HANDLE(x) check_session_handle(&x,__FUNCTION__);
	LIB3270_INTERNAL void check_session_handle(H3270 **hSession, const char *fname);
#else
	#define CHECK_SESSION_HANDLE(x) check_session_handle(&x);
	LIB3270_INTERNAL void check_session_handle(H3270 **hSession);
#endif // DEBUG

LIB3270_INTERNAL int	non_blocking(H3270 *session, Boolean on);

#if defined(HAVE_LIBSSL) /*[*/

	LIB3270_INTERNAL int	ssl_init(H3270 *session);
	LIB3270_INTERNAL int	ssl_negotiate(H3270 *hSession);
	LIB3270_INTERNAL void	set_ssl_state(H3270 *session, LIB3270_SSL_STATE state);


	#if OPENSSL_VERSION_NUMBER >= 0x00907000L /*[*/
		#define INFO_CONST const
	#else /*][*/
		#define INFO_CONST
	#endif /*]*/

	LIB3270_INTERNAL void ssl_info_callback(INFO_CONST SSL *s, int where, int ret);

#endif /*]*/