[libfaim.git] / faim / aim.h

/* 
 * Main libfaim header.  Must be included in client for prototypes/macros.
 *
 */

#ifndef __AIM_H__
#define __AIM_H__

#include <faim/faimconfig.h>
#include <faim/aim_cbtypes.h>

#include <stdio.h>
#include <string.h>
#include <fcntl.h>
#include <sys/types.h>
#include <stdlib.h>
#include <stdarg.h>
#include <errno.h>

#ifdef _WIN32
#include <windows.h>
#include <time.h>
#include <io.h>
#else
#include <netdb.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <sys/time.h>
#include <unistd.h>
#endif

/* Portability stuff (DMP) */

#ifdef _WIN32
#define sleep Sleep
#define strlen(x) (int)strlen(x)  /* win32 has a unsigned size_t */
#endif

#if defined(_WIN32) || (defined(mach) && defined(__APPLE__)) 
#define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */
#endif 

/* 
 * Current Maximum Length for Screen Names (not including NULL) 
 */
#define MAXSNLEN 16

/*
 * Standard size of an AIM authorization cookie
 */
#define AIM_COOKIELEN            0x100

#if debug > 0
#define faimdprintf(l, x...) {if (l >= debug) printf(x); }
#else
#define faimdprintf(l, x...)
#endif

/*
 * Login info.  Passes information from the Authorization
 * stage of login to the service (BOS, etc) connection
 * phase.
 *
 */
struct aim_login_struct {
  char screen_name[MAXSNLEN+1];
  char *BOSIP;
  char cookie[AIM_COOKIELEN];
  char *email;
  u_short regstatus;
  char *errorurl;
  u_short errorcode;
};

/*
 * Client info.  Filled in by the client and passed
 * in to aim_login().  The information ends up
 * getting passed to OSCAR through the initial
 * login command.
 *
 * XXX: Should this be per-session? -mid
 *
 */
struct client_info_s {
  char clientstring[100]; /* arbitrary size */
  int major;
  int minor;
  int build;
  char country[3];
  char lang[3];
};

#ifndef TRUE
#define TRUE 1
#define FALSE 0
#endif

/* 
 * These could be arbitrary, but its easier to use the actual AIM values 
 */
#define AIM_CONN_TYPE_AUTH          0x0007
#define AIM_CONN_TYPE_ADS           0x0005
#define AIM_CONN_TYPE_BOS           0x0002
#define AIM_CONN_TYPE_CHAT          0x000e
#define AIM_CONN_TYPE_CHATNAV       0x000d

/*
 * Status values returned from aim_conn_new().  ORed together.
 */
#define AIM_CONN_STATUS_READY       0x0001
#define AIM_CONN_STATUS_INTERNALERR 0x0002
#define AIM_CONN_STATUS_RESOLVERR   0x0080
#define AIM_CONN_STATUS_CONNERR     0x0040

struct aim_conn_t {
  int fd;
  int type;
  int seqnum;
  int status;
  void *priv; /* misc data the client may want to store */
  time_t lastactivity; /* time of last transmit */
  int forcedlatency; 
  struct aim_rxcblist_t *handlerlist;
};

/* struct for incoming commands */
struct command_rx_struct {
                            /* byte 1 assumed to always be 0x2a */
  char type;                /* type code (byte 2) */
  u_int seqnum;             /* sequence number (bytes 3 and 4) */
  u_int commandlen;         /* total packet len - 6 (bytes 5 and 6) */
  u_char *data;             /* packet data (from 7 byte on) */
  u_int lock;               /* 0 = open, !0 = locked */
  u_int handled;            /* 0 = new, !0 = been handled */
  u_int nofree;		    /* 0 = free data on purge, 1 = only unlink */
  struct aim_conn_t *conn;  /* the connection it came in on... */
  struct command_rx_struct *next; /* ptr to next struct in list */
};

/* struct for outgoing commands */
struct command_tx_struct {
                            /* byte 1 assumed to be 0x2a */
  char type;                /* type/family code */
  u_int seqnum;             /* seqnum dynamically assigned on tx */
  u_int commandlen;         /* SNAC length */
  u_char *data;             /* packet data */
  u_int lock;               /* 0 = open, !0 = locked */
  u_int sent;               /* 0 = pending, !0 = has been sent */
  struct aim_conn_t *conn; 
  struct command_tx_struct *next; /* ptr to next struct in list */
};


/*
 * AIM Session: The main client-data interface.  
 *
 */
struct aim_session_t {

  /* ---- Client Accessible ------------------------ */
  /* 
   * Login information.  See definition above.
   *
   */
  struct aim_login_struct logininfo;
  
  /*
   * Pointer to anything the client wants to 
   * explicitly associate with this session.
   */
  void *aux_data;


  /* ---- Internal Use Only ------------------------ */
  /* 
   * Connection information
   */
  struct aim_conn_t conns[AIM_CONN_MAX];
  
  /* 
   * TX/RX queues 
   */
  struct command_tx_struct *queue_outgoing; 
  struct command_rx_struct *queue_incoming; 
  
  /*
   * This is a dreadful solution to the what-room-are-we-joining
   * problem.  (There's no connection between the service
   * request and the resulting redirect.)
   */ 
  char *pendingjoin;

  /*
   * Outstanding snac handling 
   *
   * XXX: Should these be per-connection? -mid
   **/
  struct aim_snac_t *outstanding_snacs;
  u_long snac_nextid;
};


/*
 * AIM User Info, Standard Form.
 */
struct aim_userinfo_s {
  char sn[MAXSNLEN+1];
  u_short warnlevel;
  u_short idletime;
  u_short class;
  u_long membersince;
  u_long onlinesince;
  u_long sessionlen;  
  u_short capabilities;
};

#define AIM_CLASS_TRIAL 	0x0001
#define AIM_CLASS_UNKNOWN2	0x0002
#define AIM_CLASS_AOL		0x0004
#define AIM_CLASS_UNKNOWN4	0x0008
#define AIM_CLASS_FREE 		0x0010
#define AIM_CLASS_AWAY		0x0020
#define AIM_CLASS_UNKNOWN40	0x0040
#define AIM_CLASS_UNKNOWN80	0x0080

/*
 * TLV handling
 */

/* Generic TLV structure. */
struct aim_tlv_t {
  u_short type;
  u_short length;
  u_char *value;
};

/* List of above. */
struct aim_tlvlist_t {
  struct aim_tlv_t *tlv;
  struct aim_tlvlist_t *next;
};

/* TLV-handling functions */
struct aim_tlvlist_t *aim_readtlvchain(u_char *buf, int maxlen);
void aim_freetlvchain(struct aim_tlvlist_t **list);
struct aim_tlv_t *aim_grabtlv(u_char *src);
struct aim_tlv_t *aim_grabtlvstr(u_char *src);
struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *, u_short, int);
char *aim_gettlv_str(struct aim_tlvlist_t *, u_short, int);
int aim_puttlv (u_char *dest, struct aim_tlv_t *newtlv);
struct aim_tlv_t *aim_createtlv(void);
int aim_freetlv(struct aim_tlv_t **oldtlv);
int aim_puttlv_16(u_char *, u_short, u_short);
int aim_puttlv_32(u_char *, u_short, u_long);
int aim_puttlv_str(u_char *buf, u_short t, u_short l, u_char *v);
int aim_writetlvchain(u_char *buf, int buflen, struct aim_tlvlist_t **list);
int aim_addtlvtochain16(struct aim_tlvlist_t **list, unsigned short type, unsigned short val);
int aim_addtlvtochain32(struct aim_tlvlist_t **list, unsigned short type, unsigned long val);
int aim_addtlvtochain_str(struct aim_tlvlist_t **list, unsigned short type, char *str, int len);
int aim_counttlvchain(struct aim_tlvlist_t **list);

/*
 * Get command from connections / Dispatch commands
 * already in queue.
 */
int aim_get_command(struct aim_session_t *, struct aim_conn_t *);
int aim_rxdispatch(struct aim_session_t *);

int aim_logoff(struct aim_session_t *);


typedef int (*rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...);
int aim_register_callbacks(rxcallback_t *);

u_long aim_genericreq_n(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype);
u_long aim_genericreq_l(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_long *);
u_long aim_genericreq_s(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_short *);

/* aim_login.c */
int aim_sendconnack(struct aim_session_t *sess, struct aim_conn_t *conn);
int aim_request_login (struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);
int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *);
int aim_encode_password(const char *, u_char *);
unsigned long aim_sendauthresp(struct aim_session_t *sess, 
			       struct aim_conn_t *conn, 
			       char *sn, char *bosip, 
			       char *cookie, char *email, 
			       int regstatus);
int aim_gencookie(unsigned char *buf);
int aim_sendserverready(struct aim_session_t *sess, struct aim_conn_t *conn);
unsigned long aim_sendredirect(struct aim_session_t *sess, 
			       struct aim_conn_t *conn, 
			       unsigned short servid, 
			       char *ip,
			       char *cookie);
void aim_purge_rxqueue(struct aim_session_t *);


int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *command, ...);
int aim_parse_missed_im(struct aim_session_t *, struct command_rx_struct *, ...);
int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);

struct command_tx_struct *aim_tx_new(int, struct aim_conn_t *, int);
int aim_tx_enqueue(struct aim_session_t *, struct command_tx_struct *);
u_int aim_get_next_txseqnum(struct aim_conn_t *);
int aim_tx_flushqueue(struct aim_session_t *);
int aim_tx_printqueue(struct aim_session_t *);
void aim_tx_purgequeue(struct aim_session_t *);

struct aim_rxcblist_t {
  u_short family;
  u_short type;
  rxcallback_t handler;
  u_short flags;
  struct aim_rxcblist_t *next;
};

int aim_conn_setlatency(struct aim_conn_t *conn, int newval);

int aim_conn_addhandler(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short type, rxcallback_t newhandler, u_short flags);
rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type);
int aim_clearhandlers(struct aim_conn_t *conn);

/*
 * Generic SNAC structure.  Rarely if ever used.
 */
struct aim_snac_t {
  u_long id;
  u_short family;
  u_short type;
  u_short flags;
  void *data;
  time_t issuetime;
  struct aim_snac_t *next;
};
u_long aim_newsnac(struct aim_session_t *, struct aim_snac_t *newsnac);
struct aim_snac_t *aim_remsnac(struct aim_session_t *, u_long id);
int aim_cleansnacs(struct aim_session_t *, int maxage);
int aim_putsnac(u_char *, int, int, int, u_long);


void aim_connrst(struct aim_session_t *);
struct aim_conn_t *aim_conn_getnext(struct aim_session_t *);
void aim_conn_close(struct aim_conn_t *deadconn);
struct aim_conn_t *aim_getconn_type(struct aim_session_t *, int type);
struct aim_conn_t *aim_newconn(struct aim_session_t *, int type, char *dest);
int aim_conngetmaxfd(struct aim_session_t *);
struct aim_conn_t *aim_select(struct aim_session_t *, struct timeval *, int *);
int aim_conn_isready(struct aim_conn_t *);
int aim_conn_setstatus(struct aim_conn_t *, int);
void aim_session_init(struct aim_session_t *);

/* aim_misc.c */

#define AIM_VISIBILITYCHANGE_PERMITADD    0x05
#define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
#define AIM_VISIBILITYCHANGE_DENYADD      0x07
#define AIM_VISIBILITYCHANGE_DENYREMOVE   0x08

u_long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long);
u_long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *);
u_long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *);
u_long aim_bos_setprofile(struct aim_session_t *, struct aim_conn_t *, char *, char *, unsigned int);
u_long aim_bos_setgroupperm(struct aim_session_t *, struct aim_conn_t *, u_long);
u_long aim_bos_clientready(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_reqrate(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_ackrateresp(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_setprivacyflags(struct aim_session_t *, struct aim_conn_t *, u_long);
u_long aim_bos_reqpersonalinfo(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_reqservice(struct aim_session_t *, struct aim_conn_t *, u_short);
u_long aim_bos_reqrights(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_reqbuddyrights(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *);
u_long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *);
u_long aim_setversions(struct aim_session_t *sess, struct aim_conn_t *conn);

/* aim_rxhandlers.c */
int aim_rxdispatch(struct aim_session_t *);
int aim_authparse(struct aim_session_t *, struct command_rx_struct *);
int aim_handleredirect_middle(struct aim_session_t *, struct command_rx_struct *, ...);
int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *, ...);
int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
int aim_parse_generalerrs(struct aim_session_t *, struct command_rx_struct *command, ...);
int aim_parsemotd_middle(struct aim_session_t *sess, struct command_rx_struct *command, ...);

/* aim_im.c */
#define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
#define AIM_IMFLAGS_ACK  0x02 /* request a receipt notice */

u_long aim_send_im(struct aim_session_t *, struct aim_conn_t *, char *, u_int, char *);
int aim_parse_incoming_im_middle(struct aim_session_t *, struct command_rx_struct *);
u_long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn);
int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *);

/* aim_info.c */
#define AIM_CAPS_BUDDYICON 0x01
#define AIM_CAPS_VOICE 0x02
#define AIM_CAPS_IMIMAGE 0x04
#define AIM_CAPS_CHAT 0x08
#define AIM_CAPS_GETFILE 0x10
#define AIM_CAPS_SENDFILE 0x20
extern u_char aim_caps[6][16];
u_long aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *);
int aim_extractuserinfo(u_char *, struct aim_userinfo_s *);
int aim_parse_userinfo_middle(struct aim_session_t *, struct command_rx_struct *);
int aim_parse_oncoming_middle(struct aim_session_t *, struct command_rx_struct *);
int aim_parse_offgoing_middle(struct aim_session_t *, struct command_rx_struct *);
int aim_putuserinfo(u_char *buf, int buflen, struct aim_userinfo_s *info);
int aim_sendbuddyoncoming(struct aim_session_t *sess, struct aim_conn_t *conn, struct aim_userinfo_s *info);
int aim_sendbuddyoffgoing(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);


/* aim_auth.c */
int aim_auth_sendcookie(struct aim_session_t *, struct aim_conn_t *, u_char *);
u_long aim_auth_clientready(struct aim_session_t *, struct aim_conn_t *);
u_long aim_auth_changepasswd(struct aim_session_t *, struct aim_conn_t *, char *, char *);

/* aim_buddylist.c */
u_long aim_add_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
u_long aim_remove_buddy(struct aim_session_t *, struct aim_conn_t *, char *);

/* aim_search.c */
u_long aim_usersearch_address(struct aim_session_t *, struct aim_conn_t *, char *);
/* u_long aim_usersearch_name(struct aim_session_t *, struct aim_conn_t *, char *); */


struct aim_chat_roominfo {
  u_short exchange;
  char *name;
  u_short instance;
};
int aim_chat_readroominfo(u_char *buf, struct aim_chat_roominfo *outinfo);
int aim_chat_parse_infoupdate(struct aim_session_t *sess, struct command_rx_struct *command);
int aim_chat_parse_joined(struct aim_session_t *sess, struct command_rx_struct *command);
int aim_chat_parse_leave(struct aim_session_t *sess, struct command_rx_struct *command);
int aim_chat_parse_incoming(struct aim_session_t *sess, struct command_rx_struct *command);
u_long aim_chat_send_im(struct aim_session_t *sess, struct aim_conn_t *conn, char *msg);
u_long aim_chat_join(struct aim_session_t *sess, struct aim_conn_t *conn, u_short exchange, const char *roomname);
u_long aim_chat_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);
int aim_chat_attachname(struct aim_conn_t *conn, char *roomname);
char *aim_chat_getname(struct aim_conn_t *conn);
struct aim_conn_t *aim_chat_getconn(struct aim_session_t *, char *name);

u_long aim_chatnav_reqrights(struct aim_session_t *sess, struct aim_conn_t *conn);
u_long aim_chatnav_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);

u_long aim_chat_invite(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn, char *msg, u_short exchange, char *roomname, u_short instance);

struct aim_chat_exchangeinfo {
  u_short number;
  char *name;
  char *charset1;
  char *lang1;
  char *charset2;
  char *lang2;
};
int aim_chatnav_parse_info(struct aim_session_t *sess, struct command_rx_struct *command);
u_long aim_chatnav_createroom(struct aim_session_t *sess, struct aim_conn_t *conn, char *name, u_short exchange);
int aim_chat_leaveroom(struct aim_session_t *sess, char *name);

/* aim_util.c */
#ifdef AIMUTIL_USEMACROS
/*
 * These are really ugly.  You'd think this was LISP.  I wish it was.
 */
#define aimutil_put8(buf, data) ((*(buf) = (u_char)(data)&0xff),1)
#define aimutil_get8(buf) ((*(buf))&0xff)
#define aimutil_put16(buf, data) ( \
                                  (*(buf) = (u_char)((data)>>8)&0xff), \
				  (*((buf)+1) = (u_char)(data)&0xff),  \
				  2)
#define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
#define aimutil_put32(buf, data) ( \
                                  (*((buf)) = (u_char)((data)>>24)&0xff), \
				  (*((buf)+1) = (u_char)((data)>>16)&0xff), \
				  (*((buf)+2) = (u_char)((data)>>8)&0xff), \
				  (*((buf)+3) = (u_char)(data)&0xff), \
                                  4)
#define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
                            (((*((buf)+1))<<16)&0x00ff0000) + \
                            (((*((buf)+2))<< 8)&0x0000ff00) + \
                            (((*((buf)+3)    )&0x000000ff)))
#else
#warning Not using aimutil macros.  May have performance problems.
int aimutil_put8(u_char *, u_char);
u_char aimutil_get8(u_char *buf);
int aimutil_put16(u_char *, u_short);
u_short aimutil_get16(u_char *);
int aimutil_put32(u_char *, u_long);
u_long aimutil_get32(u_char *);
#endif

int aimutil_putstr(u_char *, const u_char *, int);
int aimutil_tokslen(char *toSearch, int index, char dl);
int aimutil_itemcnt(char *toSearch, char dl);
char *aimutil_itemidx(char *toSearch, int index, char dl);

int aim_snlen(const char *sn);
int aim_sncmp(const char *sn1, const char *sn2);

#endif /* __AIM_H__ */
Commit	Line	Data
bd71fa88	1	/*
	2	* Main libfaim header. Must be included in client for prototypes/macros.
	3	*
	4	*/
	5
	6	#ifndef __AIM_H__
	7	#define __AIM_H__
	8
	9	#include <faim/faimconfig.h>
	10	#include <faim/aim_cbtypes.h>
	11
	12	#include <stdio.h>
	13	#include <string.h>
	14	#include <fcntl.h>
	15	#include <sys/types.h>
	16	#include <stdlib.h>
	17	#include <stdarg.h>
	18	#include <errno.h>
	19
	20	#ifdef _WIN32
	21	#include <windows.h>
	22	#include <time.h>
	23	#include <io.h>
	24	#else
	25	#include <netdb.h>
	26	#include <sys/socket.h>
	27	#include <netinet/in.h>
	28	#include <sys/time.h>
	29	#include <unistd.h>
	30	#endif
	31
	32	/* Portability stuff (DMP) */
	33
	34	#ifdef _WIN32
	35	#define sleep Sleep
	36	#define strlen(x) (int)strlen(x) /* win32 has a unsigned size_t */
	37	#endif
	38
	39	#if defined(_WIN32) \|\| (defined(mach) && defined(__APPLE__))
	40	#define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */
	41	#endif
	42
	43	/*
	44	* Current Maximum Length for Screen Names (not including NULL)
	45	*/
	46	#define MAXSNLEN 16
	47
	48	/*
	49	* Standard size of an AIM authorization cookie
	50	*/
	51	#define AIM_COOKIELEN 0x100
	52
b8d0da45	53	#if debug > 0
	54	#define faimdprintf(l, x...) {if (l >= debug) printf(x); }
	55	#else
	56	#define faimdprintf(l, x...)
	57	#endif
	58
bd71fa88	59	/*
	60	* Login info. Passes information from the Authorization
	61	* stage of login to the service (BOS, etc) connection
	62	* phase.
	63	*
	64	*/
	65	struct aim_login_struct {
	66	char screen_name[MAXSNLEN+1];
	67	char *BOSIP;
	68	char cookie[AIM_COOKIELEN];
	69	char *email;
	70	u_short regstatus;
01b59e1e	71	char *errorurl;
01b59e1e	72	u_short errorcode;
bd71fa88	73	};
	74
	75	/*
	76	* Client info. Filled in by the client and passed
	77	* in to aim_login(). The information ends up
	78	* getting passed to OSCAR through the initial
	79	* login command.
	80	*
	81	* XXX: Should this be per-session? -mid
	82	*
	83	*/
	84	struct client_info_s {
	85	char clientstring[100]; /* arbitrary size */
	86	int major;
	87	int minor;
	88	int build;
	89	char country[3];
	90	char lang[3];
	91	};
	92
	93	#ifndef TRUE
	94	#define TRUE 1
	95	#define FALSE 0
	96	#endif
	97
	98	/*
	99	* These could be arbitrary, but its easier to use the actual AIM values
	100	*/
	101	#define AIM_CONN_TYPE_AUTH 0x0007
	102	#define AIM_CONN_TYPE_ADS 0x0005
	103	#define AIM_CONN_TYPE_BOS 0x0002
	104	#define AIM_CONN_TYPE_CHAT 0x000e
	105	#define AIM_CONN_TYPE_CHATNAV 0x000d
	106
	107	/*
	108	* Status values returned from aim_conn_new(). ORed together.
	109	*/
	110	#define AIM_CONN_STATUS_READY 0x0001
	111	#define AIM_CONN_STATUS_INTERNALERR 0x0002
	112	#define AIM_CONN_STATUS_RESOLVERR 0x0080
	113	#define AIM_CONN_STATUS_CONNERR 0x0040
	114
	115	struct aim_conn_t {
	116	int fd;
	117	int type;
	118	int seqnum;
	119	int status;
	120	void priv; / misc data the client may want to store */
	121	time_t lastactivity; /* time of last transmit */
	122	int forcedlatency;
	123	struct aim_rxcblist_t *handlerlist;
	124	};
	125
	126	/* struct for incoming commands */
	127	struct command_rx_struct {
	128	/* byte 1 assumed to always be 0x2a */
	129	char type; /* type code (byte 2) */
	130	u_int seqnum; /* sequence number (bytes 3 and 4) */
	131	u_int commandlen; /* total packet len - 6 (bytes 5 and 6) */
	132	u_char data; / packet data (from 7 byte on) */
	133	u_int lock; /* 0 = open, !0 = locked */
	134	u_int handled; /* 0 = new, !0 = been handled */
b8d0da45	135	u_int nofree; /* 0 = free data on purge, 1 = only unlink */
bd71fa88	136	struct aim_conn_t conn; / the connection it came in on... */
	137	struct command_rx_struct next; / ptr to next struct in list */
	138	};
	139
	140	/* struct for outgoing commands */
	141	struct command_tx_struct {
	142	/* byte 1 assumed to be 0x2a */
	143	char type; /* type/family code */
	144	u_int seqnum; /* seqnum dynamically assigned on tx */
	145	u_int commandlen; /* SNAC length */
	146	u_char data; / packet data */
	147	u_int lock; /* 0 = open, !0 = locked */
	148	u_int sent; /* 0 = pending, !0 = has been sent */
	149	struct aim_conn_t *conn;
	150	struct command_tx_struct next; / ptr to next struct in list */
	151	};
	152
	153
	154	/*
	155	* AIM Session: The main client-data interface.
	156	*
	157	*/
	158	struct aim_session_t {
	159
	160	/* ---- Client Accessible ------------------------ */
	161	/*
	162	* Login information. See definition above.
	163	*
	164	*/
	165	struct aim_login_struct logininfo;
	166
	167	/*
	168	* Pointer to anything the client wants to
	169	* explicitly associate with this session.
	170	*/
	171	void *aux_data;
	172
	173
	174	/* ---- Internal Use Only ------------------------ */
	175	/*
	176	* Connection information
	177	*/
	178	struct aim_conn_t conns[AIM_CONN_MAX];
	179
	180	/*
	181	* TX/RX queues
	182	*/
	183	struct command_tx_struct *queue_outgoing;
	184	struct command_rx_struct *queue_incoming;
	185
0c20631f	186	/*
	187	* This is a dreadful solution to the what-room-are-we-joining
	188	* problem. (There's no connection between the service
	189	* request and the resulting redirect.)
	190	*/
	191	char *pendingjoin;
	192
bd71fa88	193	/*
	194	* Outstanding snac handling
	195	*
	196	* XXX: Should these be per-connection? -mid
	197	**/
	198	struct aim_snac_t *outstanding_snacs;
	199	u_long snac_nextid;
	200	};
	201
	202
	203	/*
	204	* AIM User Info, Standard Form.
	205	*/
	206	struct aim_userinfo_s {
	207	char sn[MAXSNLEN+1];
	208	u_short warnlevel;
	209	u_short idletime;
	210	u_short class;
	211	u_long membersince;
	212	u_long onlinesince;
	213	u_long sessionlen;
5b79dc93	214	u_short capabilities;
bd71fa88	215	};
bd71fa88	216
0c20631f	217	#define AIM_CLASS_TRIAL 0x0001
	218	#define AIM_CLASS_UNKNOWN2 0x0002
	219	#define AIM_CLASS_AOL 0x0004
	220	#define AIM_CLASS_UNKNOWN4 0x0008
	221	#define AIM_CLASS_FREE 0x0010
	222	#define AIM_CLASS_AWAY 0x0020
	223	#define AIM_CLASS_UNKNOWN40 0x0040
	224	#define AIM_CLASS_UNKNOWN80 0x0080
	225
bd71fa88	226	/*
	227	* TLV handling
	228	*/
	229
	230	/* Generic TLV structure. */
	231	struct aim_tlv_t {
	232	u_short type;
	233	u_short length;
	234	u_char *value;
	235	};
	236
	237	/* List of above. */
	238	struct aim_tlvlist_t {
	239	struct aim_tlv_t *tlv;
	240	struct aim_tlvlist_t *next;
	241	};
	242
	243	/* TLV-handling functions */
	244	struct aim_tlvlist_t aim_readtlvchain(u_char buf, int maxlen);
	245	void aim_freetlvchain(struct aim_tlvlist_t **list);
	246	struct aim_tlv_t aim_grabtlv(u_char src);
	247	struct aim_tlv_t aim_grabtlvstr(u_char src);
	248	struct aim_tlv_t aim_gettlv(struct aim_tlvlist_t , u_short, int);
	249	char aim_gettlv_str(struct aim_tlvlist_t , u_short, int);
	250	int aim_puttlv (u_char dest, struct aim_tlv_t newtlv);
	251	struct aim_tlv_t *aim_createtlv(void);
	252	int aim_freetlv(struct aim_tlv_t **oldtlv);
	253	int aim_puttlv_16(u_char *, u_short, u_short);
01b59e1e	254	int aim_puttlv_32(u_char *, u_short, u_long);
01b59e1e	255	int aim_puttlv_str(u_char buf, u_short t, u_short l, u_char v);
0e2be272	256	int aim_writetlvchain(u_char buf, int buflen, struct aim_tlvlist_t *list);
0e2be272	257	int aim_addtlvtochain16(struct aim_tlvlist_t **list, unsigned short type, unsigned short val);
e6b05d80	258	int aim_addtlvtochain32(struct aim_tlvlist_t **list, unsigned short type, unsigned long val);
	259	int aim_addtlvtochain_str(struct aim_tlvlist_t *list, unsigned short type, char str, int len);
	260	int aim_counttlvchain(struct aim_tlvlist_t **list);
bd71fa88	261
	262	/*
	263	* Get command from connections / Dispatch commands
	264	* already in queue.
	265	*/
f1a5efe0	266	int aim_get_command(struct aim_session_t , struct aim_conn_t );
bd71fa88	267	int aim_rxdispatch(struct aim_session_t *);
	268
	269	int aim_logoff(struct aim_session_t *);
	270
	271
	272	typedef int (rxcallback_t)(struct aim_session_t , struct command_rx_struct *, ...);
	273	int aim_register_callbacks(rxcallback_t *);
	274
	275	u_long aim_genericreq_n(struct aim_session_t , struct aim_conn_t conn, u_short family, u_short subtype);
	276	u_long aim_genericreq_l(struct aim_session_t , struct aim_conn_t conn, u_short family, u_short subtype, u_long *);
	277	u_long aim_genericreq_s(struct aim_session_t , struct aim_conn_t conn, u_short family, u_short subtype, u_short *);
	278
	279	/* aim_login.c */
01b59e1e	280	int aim_sendconnack(struct aim_session_t sess, struct aim_conn_t conn);
01b59e1e	281	int aim_request_login (struct aim_session_t sess, struct aim_conn_t conn, char *sn);
bd71fa88	282	int aim_send_login (struct aim_session_t , struct aim_conn_t , char , char , struct client_info_s *);
bd71fa88	283	int aim_encode_password(const char , u_char );
e6b05d80	284	unsigned long aim_sendauthresp(struct aim_session_t *sess,
	285	struct aim_conn_t *conn,
	286	char sn, char bosip,
	287	char cookie, char email,
	288	int regstatus);
	289	int aim_gencookie(unsigned char *buf);
	290	int aim_sendserverready(struct aim_session_t sess, struct aim_conn_t conn);
	291	unsigned long aim_sendredirect(struct aim_session_t *sess,
	292	struct aim_conn_t *conn,
	293	unsigned short servid,
	294	char *ip,
	295	char *cookie);
b8d0da45	296	void aim_purge_rxqueue(struct aim_session_t *);
bd71fa88	297
	298
	299	int aim_parse_unknown(struct aim_session_t , struct command_rx_struct command, ...);
	300	int aim_parse_missed_im(struct aim_session_t , struct command_rx_struct , ...);
	301	int aim_parse_last_bad(struct aim_session_t , struct command_rx_struct , ...);
	302
5b79dc93	303	struct command_tx_struct aim_tx_new(int, struct aim_conn_t , int);
bd71fa88	304	int aim_tx_enqueue(struct aim_session_t , struct command_tx_struct );
	305	u_int aim_get_next_txseqnum(struct aim_conn_t *);
	306	int aim_tx_flushqueue(struct aim_session_t *);
	307	int aim_tx_printqueue(struct aim_session_t *);
b8d0da45	308	void aim_tx_purgequeue(struct aim_session_t *);
bd71fa88	309
	310	struct aim_rxcblist_t {
	311	u_short family;
	312	u_short type;
	313	rxcallback_t handler;
	314	u_short flags;
	315	struct aim_rxcblist_t *next;
	316	};
	317
	318	int aim_conn_setlatency(struct aim_conn_t *conn, int newval);
	319
	320	int aim_conn_addhandler(struct aim_session_t , struct aim_conn_t conn, u_short family, u_short type, rxcallback_t newhandler, u_short flags);
	321	rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type);
	322	int aim_clearhandlers(struct aim_conn_t *conn);
	323
	324	/*
	325	* Generic SNAC structure. Rarely if ever used.
	326	*/
	327	struct aim_snac_t {
	328	u_long id;
	329	u_short family;
	330	u_short type;
	331	u_short flags;
	332	void *data;
	333	time_t issuetime;
	334	struct aim_snac_t *next;
	335	};
	336	u_long aim_newsnac(struct aim_session_t , struct aim_snac_t newsnac);
	337	struct aim_snac_t aim_remsnac(struct aim_session_t , u_long id);
	338	int aim_cleansnacs(struct aim_session_t *, int maxage);
	339	int aim_putsnac(u_char *, int, int, int, u_long);
	340
	341
	342	void aim_connrst(struct aim_session_t *);
	343	struct aim_conn_t aim_conn_getnext(struct aim_session_t );
	344	void aim_conn_close(struct aim_conn_t *deadconn);
	345	struct aim_conn_t aim_getconn_type(struct aim_session_t , int type);
	346	struct aim_conn_t aim_newconn(struct aim_session_t , int type, char *dest);
	347	int aim_conngetmaxfd(struct aim_session_t *);
b8d0da45	348	struct aim_conn_t aim_select(struct aim_session_t , struct timeval , int );
bd71fa88	349	int aim_conn_isready(struct aim_conn_t *);
	350	int aim_conn_setstatus(struct aim_conn_t *, int);
	351	void aim_session_init(struct aim_session_t *);
	352
	353	/* aim_misc.c */
	354
	355	#define AIM_VISIBILITYCHANGE_PERMITADD 0x05
	356	#define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
	357	#define AIM_VISIBILITYCHANGE_DENYADD 0x07
	358	#define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08
	359
	360	u_long aim_bos_setidle(struct aim_session_t , struct aim_conn_t , u_long);
	361	u_long aim_bos_changevisibility(struct aim_session_t , struct aim_conn_t , int, char *);
	362	u_long aim_bos_setbuddylist(struct aim_session_t , struct aim_conn_t , char *);
5b79dc93	363	u_long aim_bos_setprofile(struct aim_session_t , struct aim_conn_t , char , char , unsigned int);
bd71fa88	364	u_long aim_bos_setgroupperm(struct aim_session_t , struct aim_conn_t , u_long);
	365	u_long aim_bos_clientready(struct aim_session_t , struct aim_conn_t );
	366	u_long aim_bos_reqrate(struct aim_session_t , struct aim_conn_t );
	367	u_long aim_bos_ackrateresp(struct aim_session_t , struct aim_conn_t );
	368	u_long aim_bos_setprivacyflags(struct aim_session_t , struct aim_conn_t , u_long);
	369	u_long aim_bos_reqpersonalinfo(struct aim_session_t , struct aim_conn_t );
	370	u_long aim_bos_reqservice(struct aim_session_t , struct aim_conn_t , u_short);
	371	u_long aim_bos_reqrights(struct aim_session_t , struct aim_conn_t );
	372	u_long aim_bos_reqbuddyrights(struct aim_session_t , struct aim_conn_t );
	373	u_long aim_bos_reqlocaterights(struct aim_session_t , struct aim_conn_t );
	374	u_long aim_bos_reqicbmparaminfo(struct aim_session_t , struct aim_conn_t );
0c20631f	375	u_long aim_setversions(struct aim_session_t sess, struct aim_conn_t conn);
bd71fa88	376
	377	/* aim_rxhandlers.c */
	378	int aim_rxdispatch(struct aim_session_t *);
	379	int aim_authparse(struct aim_session_t , struct command_rx_struct );
	380	int aim_handleredirect_middle(struct aim_session_t , struct command_rx_struct , ...);
	381	int aim_parse_unknown(struct aim_session_t , struct command_rx_struct , ...);
	382	int aim_parse_last_bad(struct aim_session_t , struct command_rx_struct , ...);
	383	int aim_parse_generalerrs(struct aim_session_t , struct command_rx_struct command, ...);
01b59e1e	384	int aim_parsemotd_middle(struct aim_session_t sess, struct command_rx_struct command, ...);
bd71fa88	385
	386	/* aim_im.c */
	387	#define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
	388	#define AIM_IMFLAGS_ACK 0x02 /* request a receipt notice */
	389
	390	u_long aim_send_im(struct aim_session_t , struct aim_conn_t , char , u_int, char );
	391	int aim_parse_incoming_im_middle(struct aim_session_t , struct command_rx_struct );
	392	u_long aim_seticbmparam(struct aim_session_t , struct aim_conn_t conn);
	393	int aim_parse_msgerror_middle(struct aim_session_t , struct command_rx_struct );
	394
	395	/* aim_info.c */
5b79dc93	396	#define AIM_CAPS_BUDDYICON 0x01
	397	#define AIM_CAPS_VOICE 0x02
	398	#define AIM_CAPS_IMIMAGE 0x04
	399	#define AIM_CAPS_CHAT 0x08
	400	#define AIM_CAPS_GETFILE 0x10
	401	#define AIM_CAPS_SENDFILE 0x20
	402	extern u_char aim_caps[6][16];
bd71fa88	403	u_long aim_getinfo(struct aim_session_t , struct aim_conn_t , const char *);
	404	int aim_extractuserinfo(u_char , struct aim_userinfo_s );
	405	int aim_parse_userinfo_middle(struct aim_session_t , struct command_rx_struct );
	406	int aim_parse_oncoming_middle(struct aim_session_t , struct command_rx_struct );
	407	int aim_parse_offgoing_middle(struct aim_session_t , struct command_rx_struct );
50443ea0	408	int aim_putuserinfo(u_char buf, int buflen, struct aim_userinfo_s info);
	409	int aim_sendbuddyoncoming(struct aim_session_t sess, struct aim_conn_t conn, struct aim_userinfo_s *info);
	410	int aim_sendbuddyoffgoing(struct aim_session_t sess, struct aim_conn_t conn, char *sn);
bd71fa88	411
f1a5efe0	412
bd71fa88	413	/* aim_auth.c */
	414	int aim_auth_sendcookie(struct aim_session_t , struct aim_conn_t , u_char *);
	415	u_long aim_auth_clientready(struct aim_session_t , struct aim_conn_t );
	416	u_long aim_auth_changepasswd(struct aim_session_t , struct aim_conn_t , char , char );
	417
	418	/* aim_buddylist.c */
	419	u_long aim_add_buddy(struct aim_session_t , struct aim_conn_t , char *);
	420	u_long aim_remove_buddy(struct aim_session_t , struct aim_conn_t , char *);
	421
	422	/* aim_search.c */
	423	u_long aim_usersearch_address(struct aim_session_t , struct aim_conn_t , char *);
	424	/* u_long aim_usersearch_name(struct aim_session_t , struct aim_conn_t , char ); /
	425
0c20631f	426
	427	struct aim_chat_roominfo {
	428	u_short exchange;
	429	char *name;
	430	u_short instance;
	431	};
	432	int aim_chat_readroominfo(u_char buf, struct aim_chat_roominfo outinfo);
	433	int aim_chat_parse_infoupdate(struct aim_session_t sess, struct command_rx_struct command);
	434	int aim_chat_parse_joined(struct aim_session_t sess, struct command_rx_struct command);
	435	int aim_chat_parse_leave(struct aim_session_t sess, struct command_rx_struct command);
	436	int aim_chat_parse_incoming(struct aim_session_t sess, struct command_rx_struct command);
	437	u_long aim_chat_send_im(struct aim_session_t sess, struct aim_conn_t conn, char *msg);
	438	u_long aim_chat_join(struct aim_session_t sess, struct aim_conn_t conn, u_short exchange, const char *roomname);
	439	u_long aim_chat_clientready(struct aim_session_t sess, struct aim_conn_t conn);
	440	int aim_chat_attachname(struct aim_conn_t conn, char roomname);
	441	char aim_chat_getname(struct aim_conn_t conn);
	442	struct aim_conn_t aim_chat_getconn(struct aim_session_t , char *name);
	443
	444	u_long aim_chatnav_reqrights(struct aim_session_t sess, struct aim_conn_t conn);
	445	u_long aim_chatnav_clientready(struct aim_session_t sess, struct aim_conn_t conn);
	446
	447	u_long aim_chat_invite(struct aim_session_t sess, struct aim_conn_t conn, char sn, char msg, u_short exchange, char *roomname, u_short instance);
	448
	449	struct aim_chat_exchangeinfo {
	450	u_short number;
	451	char *name;
	452	char *charset1;
	453	char *lang1;
	454	char *charset2;
	455	char *lang2;
	456	};
	457	int aim_chatnav_parse_info(struct aim_session_t sess, struct command_rx_struct command);
	458	u_long aim_chatnav_createroom(struct aim_session_t sess, struct aim_conn_t conn, char *name, u_short exchange);
	459	int aim_chat_leaveroom(struct aim_session_t sess, char name);
	460
bd71fa88	461	/* aim_util.c */
f1a5efe0	462	#ifdef AIMUTIL_USEMACROS
	463	/*
	464	* These are really ugly. You'd think this was LISP. I wish it was.
	465	*/
	466	#define aimutil_put8(buf, data) ((*(buf) = (u_char)(data)&0xff),1)
	467	#define aimutil_get8(buf) ((*(buf))&0xff)
	468	#define aimutil_put16(buf, data) ( \
	469	(*(buf) = (u_char)((data)>>8)&0xff), \
	470	(*((buf)+1) = (u_char)(data)&0xff), \
	471	2)
	472	#define aimutil_get16(buf) (((((buf))<<8)&0xff00) + ((((buf)+1)) & 0xff))
	473	#define aimutil_put32(buf, data) ( \
	474	(*((buf)) = (u_char)((data)>>24)&0xff), \
	475	(*((buf)+1) = (u_char)((data)>>16)&0xff), \
	476	(*((buf)+2) = (u_char)((data)>>8)&0xff), \
	477	(*((buf)+3) = (u_char)(data)&0xff), \
	478	4)
	479	#define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
	480	(((*((buf)+1))<<16)&0x00ff0000) + \
	481	(((*((buf)+2))<< 8)&0x0000ff00) + \
	482	(((*((buf)+3) )&0x000000ff)))
	483	#else
	484	#warning Not using aimutil macros. May have performance problems.
bd71fa88	485	int aimutil_put8(u_char *, u_char);
	486	u_char aimutil_get8(u_char *buf);
	487	int aimutil_put16(u_char *, u_short);
	488	u_short aimutil_get16(u_char *);
	489	int aimutil_put32(u_char *, u_long);
	490	u_long aimutil_get32(u_char *);
f1a5efe0	491	#endif
f1a5efe0	492
bd71fa88	493	int aimutil_putstr(u_char , const u_char , int);
	494	int aimutil_tokslen(char *toSearch, int index, char dl);
	495	int aimutil_itemcnt(char *toSearch, char dl);
	496	char aimutil_itemidx(char toSearch, int index, char dl);
	497
e6b05d80	498	int aim_snlen(const char *sn);
	499	int aim_sncmp(const char sn1, const char sn2);
	500
bd71fa88	501	#endif /* __AIM_H__ */
bd71fa88	502