annotate src/protocols/oscar/im.c @ 2231:8c4ff1a368bd

[gaim-migrate @ 2241] blue:~/gaim/app/src/protocols $ ./gtk icq: 0 irc: 0 jabber: 52 msn: 0 napster: 0 oscar: 7 toc: 17 yahoo: 0 zephyr: 1 committer: Tailor Script <[e-mail]>

/*
 *  aim_im.c
 *
 *  The routines for sending/receiving Instant Messages.
 *
 *  Note the term ICBM (Inter-Client Basic Message) which blankets
 *  all types of genericly routed through-server messages.  Within
 *  the ICBM types (family 4), a channel is defined.  Each channel
 *  represents a different type of message.  Channel 1 is used for
 *  what would commonly be called an "instant message".  Channel 2
 *  is used for negotiating "rendezvous".  These transactions end in
 *  something more complex happening, such as a chat invitation, or
 *  a file transfer.
 *
 *  In addition to the channel, every ICBM contains a cookie.  For
 *  standard IMs, these are only used for error messages.  However,
 *  the more complex rendezvous messages make suitably more complex
 *  use of this field.
 *
 */

#define FAIM_INTERNAL
#include <aim.h>

/*
 * Takes a msghdr (and a length) and returns a client type
 * code.  Note that this is *only a guess* and has a low likelihood
 * of actually being accurate.
 *
 * Its based on experimental data, with the help of Eric Warmenhoven
 * who seems to have collected a wide variety of different AIM clients.
 *
 *
 * Heres the current collection:
 *  0501 0003 0101 0101 01       AOL Mobile Communicator, WinAIM 1.0.414
 *  0501 0003 0101 0201 01       WinAIM 2.0.847, 2.1.1187, 3.0.1464, 
 *                                      4.3.2229, 4.4.2286
 *  0501 0004 0101 0102 0101     WinAIM 4.1.2010, libfaim (right here)
 *  0501 0001 0101 01            AOL v6.0, CompuServe 2000 v6.0, any
 *                                      TOC client
 */
faim_export unsigned short aim_fingerprintclient(unsigned char *msghdr, int len)
{
	static const struct {
		unsigned short clientid;
		int len;
		unsigned char data[10];
	} fingerprints[] = {
		/* AOL Mobile Communicator, WinAIM 1.0.414 */
		{ AIM_CLIENTTYPE_MC, 
		  9, {0x05, 0x01, 0x00, 0x03, 0x01, 0x01, 0x01, 0x01, 0x01}},

		/* WinAIM 2.0.847, 2.1.1187, 3.0.1464, 4.3.2229, 4.4.2286 */
		{ AIM_CLIENTTYPE_WINAIM, 
		  9, {0x05, 0x01, 0x00, 0x03, 0x01, 0x01, 0x02, 0x01, 0x01}},

		/* WinAIM 4.1.2010, libfaim */
		{ AIM_CLIENTTYPE_WINAIM41,
		 10, {0x05, 0x01, 0x00, 0x04, 0x01, 0x01, 0x01, 0x02, 0x01, 0x01}},

		/* AOL v6.0, CompuServe 2000 v6.0, any TOC client */
		{ AIM_CLIENTTYPE_AOL_TOC,
		  7, {0x05, 0x01, 0x00, 0x01, 0x01, 0x01, 0x01}},

		{ 0, 0}
	};
	int i;

	if (!msghdr || (len <= 0))
		return AIM_CLIENTTYPE_UNKNOWN;

	for (i = 0; fingerprints[i].len; i++) {
		if (fingerprints[i].len != len)
			continue;
		if (memcmp(fingerprints[i].data, msghdr, fingerprints[i].len) == 0)
			return fingerprints[i].clientid;
	}

	return AIM_CLIENTTYPE_UNKNOWN;
}

/* This should be endian-safe now... but who knows... */
faim_export unsigned short aim_iconsum(const unsigned char *buf, int buflen)
{
	unsigned long sum;
	int i;

	for (i = 0, sum = 0; i < buflen; i += 2)
		sum += (buf[i+1] << 8) + buf[i];

	sum = ((sum & 0xffff0000) >> 16) + (sum & 0x0000ffff);

	return sum & 0xffff;
}

/*
 * Send an ICBM (instant message).  
 *
 *
 * Possible flags:
 *   AIM_IMFLAGS_AWAY  -- Marks the message as an autoresponse
 *   AIM_IMFLAGS_ACK   -- Requests that the server send an ack
 *                        when the message is received (of type 0x0004/0x000c)
 *   AIM_IMFLAGS_UNICODE--Instead of ASCII7, the passed message is
 *                        made up of UNICODE duples.  If you set
 *                        this, you'd better be damn sure you know
 *                        what you're doing.
 *   AIM_IMFLAGS_ISO_8859_1 -- The message contains the ASCII8 subset
 *                        known as ISO-8859-1.  
 *
 * Generally, you should use the lowest encoding possible to send
 * your message.  If you only use basic punctuation and the generic
 * Latin alphabet, use ASCII7 (no flags).  If you happen to use non-ASCII7
 * characters, but they are all clearly defined in ISO-8859-1, then 
 * use that.  Keep in mind that not all characters in the PC ASCII8
 * character set are defined in the ISO standard. For those cases (most
 * notably when the (r) symbol is used), you must use the full UNICODE
 * encoding for your message.  In UNICODE mode, _all_ characters must
 * occupy 16bits, including ones that are not special.  (Remember that
 * the first 128 UNICODE symbols are equivelent to ASCII7, however they
 * must be prefixed with a zero high order byte.)
 *
 * I strongly discourage the use of UNICODE mode, mainly because none
 * of the clients I use can parse those messages (and besides that,
 * wchars are difficult and non-portable to handle in most UNIX environments).
 * If you really need to include special characters, use the HTML UNICODE 
 * entities.  These are of the form &#2026; where 2026 is the hex 
 * representation of the UNICODE index (in this case, UNICODE 
 * "Horizontal Ellipsis", or 133 in in ASCII8).
 *
 */
faim_export int aim_send_im_ext(struct aim_session_t *sess, struct aim_conn_t *conn, struct aim_sendimext_args *args)
{
	int curbyte,i;
	struct command_tx_struct *newpacket;

	if (!sess || !conn || !args)
	       	return -EINVAL;

	if (!args->msg || (args->msglen <= 0))
		return -EINVAL;

	if (args->msglen >= MAXMSGLEN)
		return -E2BIG;

	if (!(newpacket = aim_tx_new(sess, conn, AIM_FRAMETYPE_OSCAR, 0x0002, args->msglen+512)))
		return -ENOMEM;

	newpacket->lock = 1; /* lock struct */

	curbyte  = 0;
	curbyte += aim_putsnac(newpacket->data+curbyte, 
				0x0004, 0x0006, 0x0000, sess->snac_nextid);

	/* 
	 * Generate a random message cookie 
	 *
	 * We could cache these like we do SNAC IDs.  (In fact, it 
	 * might be a good idea.)  In the message error functions, 
	 * the 8byte message cookie is returned as well as the 
	 * SNAC ID.
	 *
	 */
	for (i = 0; i < 8; i++) {
		curbyte += aimutil_put8(newpacket->data+curbyte, 
					(unsigned char) rand());
	}

	/*
	 * Channel ID
	 */
	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0001);

	/*
	 * Destination SN (prepended with byte length)
	 */
	curbyte += aimutil_put8(newpacket->data+curbyte, strlen(args->destsn));
	curbyte += aimutil_putstr(newpacket->data+curbyte, 
					args->destsn, strlen(args->destsn));

	/*
	 * metaTLV start.
	 */
	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0002);
	curbyte += aimutil_put16(newpacket->data+curbyte, args->msglen + 0x10);

	/*
	 * Flag data / ICBM Parameters?
	 *
	 * I don't know what these are...
	 *
	 */
	curbyte += aimutil_put8(newpacket->data+curbyte, 0x05);
	curbyte += aimutil_put8(newpacket->data+curbyte, 0x01);

	/* number of bytes to follow */
	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0004);
	curbyte += aimutil_put8(newpacket->data+curbyte, 0x01);
	curbyte += aimutil_put8(newpacket->data+curbyte, 0x01);
	curbyte += aimutil_put8(newpacket->data+curbyte, 0x01);
	curbyte += aimutil_put8(newpacket->data+curbyte, 0x02);

	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0101);

	/* 
	 * Message block length.
	 */
	curbyte += aimutil_put16(newpacket->data+curbyte, args->msglen + 0x04);

	/*
	 * Character set.
	 */
	if (args->flags & AIM_IMFLAGS_UNICODE)
		curbyte += aimutil_put16(newpacket->data+curbyte, 0x0002);
	else if (args->flags & AIM_IMFLAGS_ISO_8859_1)
		curbyte += aimutil_put16(newpacket->data+curbyte, 0x0003);
	else
		curbyte += aimutil_put16(newpacket->data+curbyte, 0x0000);

	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0000);

	/*
	 * Message.  Not terminated.
	 */
	curbyte += aimutil_putstr(newpacket->data+curbyte, 
					args->msg, args->msglen);

	/*
	 * Set the Request Acknowledge flag.  
	 */
	if (args->flags & AIM_IMFLAGS_ACK) {
		curbyte += aimutil_put16(newpacket->data+curbyte,0x0003);
		curbyte += aimutil_put16(newpacket->data+curbyte,0x0000);
	}
  
	/*
	 * Set the Autoresponse flag.
	 */
	if (args->flags & AIM_IMFLAGS_AWAY) {
		curbyte += aimutil_put16(newpacket->data+curbyte,0x0004);
		curbyte += aimutil_put16(newpacket->data+curbyte,0x0000);
	}

	/*
	 * Set the Buddy Icon Requested flag.
	 */
	if (args->flags & AIM_IMFLAGS_BUDDYREQ) {
		curbyte += aimutil_put16(newpacket->data+curbyte,0x0009);
		curbyte += aimutil_put16(newpacket->data+curbyte,0x0000);
	}

	/*
	 * Set the I HAVE A REALLY PURTY ICON flag (with timestamp).
	 */
	if (args->flags & AIM_IMFLAGS_HASICON) {
		curbyte += aimutil_put16(newpacket->data+curbyte, 0x0008);
		curbyte += aimutil_put16(newpacket->data+curbyte, 0x000c);
		curbyte += aimutil_put32(newpacket->data+curbyte, args->iconlen);
		curbyte += aimutil_put16(newpacket->data+curbyte, 0x0001);
		curbyte += aimutil_put16(newpacket->data+curbyte, args->iconsum);
		curbyte += aimutil_put32(newpacket->data+curbyte, args->iconstamp);
	}

	newpacket->commandlen = curbyte;
	newpacket->lock = 0;

	aim_tx_enqueue(sess, newpacket);

#if 1 /* XXX do this with autoconf or something... */
	aim_cachesnac(sess, 0x0004, 0x0006, 0x0000, args->destsn, strlen(args->destsn)+1);
	aim_cleansnacs(sess, 60); /* clean out all SNACs over 60sec old */
#endif

	return 0;
}

/*
 * Simple wrapper for aim_send_im_ext() 
 *
 * You cannot use aim_send_im if you need the HASICON flag.  You must
 * use aim_send_im_ext directly for that.
 *
 * aim_send_im also cannot be used if you require UNICODE messages, because
 * that requires an explicit message length.  Use aim_send_im_ext().
 *
 */
faim_export int aim_send_im(struct aim_session_t *sess, struct aim_conn_t *conn, const char *destsn, unsigned short flags, const char *msg)
{
	struct aim_sendimext_args args;

	args.destsn = destsn;
	args.flags = flags;
	args.msg = msg;
	args.msglen = strlen(msg);

	return aim_send_im_ext(sess, conn, &args);
}

faim_export int aim_send_icon(struct aim_session_t *sess, struct aim_conn_t *conn, const char *sn, const unsigned char *icon, int iconlen, time_t stamp, unsigned short iconsum)
{
	struct command_tx_struct *np;
	int i, curbyte = 0;
	unsigned char ck[8];

	if (!sess || !conn || !sn || !icon || 
			(iconlen <= 0) || (iconlen >= MAXICONLEN))
	return -EINVAL;

	if (conn->type != AIM_CONN_TYPE_BOS)
		return -EINVAL;

	for (i = 0, curbyte = 0; i < 8; i++)
		curbyte += aimutil_put8(ck+curbyte, (u_char)rand());

	if (!(np = aim_tx_new(sess, conn, AIM_FRAMETYPE_OSCAR, 0x0002, 10+8+2+1+strlen(sn)+2+2+2+8+16+2+2+2+2+2+2+2+4+4+4+iconlen+strlen(AIM_ICONIDENT)+2+2)))
		return -ENOMEM;

	np->lock = 1;

	curbyte = aim_putsnac(np->data, 0x0004, 0x0006, 0x0000, sess->snac_nextid);

	/*
	 * Cookie
	 */
	memcpy(np->data+curbyte, ck, 8);
	curbyte += 8;

	/*
	 * Channel (2)
	 */
	curbyte += aimutil_put16(np->data+curbyte, 0x0002);

	/*
	 * Dest sn
	 */
	curbyte += aimutil_put8(np->data+curbyte, strlen(sn));
	curbyte += aimutil_putstr(np->data+curbyte, sn, strlen(sn));

	/*
	 * TLV t(0005)
	 */
	curbyte += aimutil_put16(np->data+curbyte, 0x0005);
	curbyte += aimutil_put16(np->data+curbyte, 2+8+16+6+4+4+iconlen+4+4+4+strlen(AIM_ICONIDENT));

	curbyte += aimutil_put16(np->data+curbyte, 0x0000);

	memcpy(np->data+curbyte, ck, 8);
	curbyte += 8;

	curbyte += aim_putcap(np->data+curbyte, 16, AIM_CAPS_BUDDYICON);

	/* TLV t(000a) */
	curbyte += aimutil_put16(np->data+curbyte, 0x000a);
	curbyte += aimutil_put16(np->data+curbyte, 0x0002);
	curbyte += aimutil_put16(np->data+curbyte, 0x0001);

	/* TLV t(000f) */
	curbyte += aimutil_put16(np->data+curbyte, 0x000f);
	curbyte += aimutil_put16(np->data+curbyte, 0x0000);

	/* TLV t(2711) */
	curbyte += aimutil_put16(np->data+curbyte, 0x2711);
	curbyte += aimutil_put16(np->data+curbyte, 4+4+4+iconlen+strlen(AIM_ICONIDENT));
	curbyte += aimutil_put16(np->data+curbyte, 0x0000);
	curbyte += aimutil_put16(np->data+curbyte, iconsum);
	curbyte += aimutil_put32(np->data+curbyte, iconlen);
	curbyte += aimutil_put32(np->data+curbyte, stamp);
	memcpy(np->data+curbyte, icon, iconlen);
	curbyte += iconlen;
	memcpy(np->data+curbyte, AIM_ICONIDENT, strlen(AIM_ICONIDENT));
	curbyte += strlen(AIM_ICONIDENT);

	/* TLV t(0003) */
	curbyte += aimutil_put16(np->data+curbyte, 0x0003);
	curbyte += aimutil_put16(np->data+curbyte, 0x0000);

	np->commandlen = curbyte;
	np->lock = 0;
	aim_tx_enqueue(sess, np);

	return 0;
}

static int outgoingim(struct aim_session_t *sess, aim_module_t *mod, struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned char *data, int datalen)
{
	unsigned int i, ret = 0;
	aim_rxcallback_t userfunc;
	unsigned char cookie[8];
	int channel;
	struct aim_tlvlist_t *tlvlist;
	char sn[MAXSNLEN];
	unsigned short icbmflags = 0;
	unsigned char flag1 = 0, flag2 = 0;
	unsigned char *msgblock = NULL, *msg = NULL;

	/* ICBM Cookie. */
	for (i = 0; i < 8; i++)
		cookie[i] = aimutil_get8(data+i);

	/* Channel ID */
	channel = aimutil_get16(data+i);
	i += 2;

	if (channel != 0x01) {
		faimdprintf(sess, 0, "icbm: ICBM recieved on unsupported channel.  Ignoring. (chan = %04x)\n", channel);
		return 1;
	}

	strncpy(sn, (char *) data+i+1, (int) *(data+i));
	i += 1 + (int) *(data+i);

	tlvlist = aim_readtlvchain(data+i, datalen-i);

	if (aim_gettlv(tlvlist, 0x0003, 1))
		icbmflags |= AIM_IMFLAGS_ACK;
	if (aim_gettlv(tlvlist, 0x0004, 1))
		icbmflags |= AIM_IMFLAGS_AWAY;

	if ((msgblock = (unsigned char *)aim_gettlv_str(tlvlist, 0x0002, 1))) {
		int j = 0;

		/* no, this really is correct.  I'm not high or anything either. */
		j += 2;
		j += 2 + aimutil_get16(msgblock+j);
		j += 2;

		j += 2; /* final block length */

		flag1 = aimutil_get16(msgblock);
		j += 2;
		flag2 = aimutil_get16(msgblock);
		j += 2;

		msg = msgblock+j;
	}

	if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
		ret = userfunc(sess, rx, channel, sn, msg, icbmflags, flag1, flag2);

	free(msgblock);
	aim_freetlvchain(&tlvlist);

	return ret;
}

/*
 * A multipart IM:
 *
 * 0004 0007 0000 8f08 d295 
 *      0031 6520 3b7b f9fd
 * 	0001 
 * 	06 XXXX XXXX XXXX
 * 	0000 
 * 	0004 
 * 		0001 0002 0004 
 * 		0010 0004 0000 01a3
 * 		0002 0004 3ab6 94fa
 * 		0003 0004 3b7b f85a
 * 	0002 003c 
 * 		0501 0001 01
 * 		0101 000a 0000 0000 3c48 544d 4c3e   ASCII part 
 * 		ISO-8859 part:
 * 		0101 0016 0003 0000 6c6b 7364 6a6b 6c6a 676c a56b 3b73 646a 6b6a
 * 		0101 000b 0000 0000 3c2f 4854 4d4c 3e   another ASCII part
 *
 */
static int incomingim_ch1(struct aim_session_t *sess, aim_module_t *mod,  struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned short channel, struct aim_userinfo_s *userinfo, unsigned char *data, int datalen, unsigned char *cookie)
{
	unsigned short type, length;
	aim_rxcallback_t userfunc;
	int i, ret = 0;
	struct aim_incomingim_ch1_args args;

	memset(&args, 0, sizeof(args));

	/*
	 * This used to be done using tlvchains.  For performance reasons,
	 * I've changed it to process the TLVs in-place.  This avoids lots
	 * of per-IM memory allocations.
	 */
	for (i = 0; i < datalen; ) {

		type = aimutil_get16(data+i);
		i += 2;
		      
		length = aimutil_get16(data+i);
		i += 2;

		if (type == 0x0002) { /* Message Block */
			unsigned short wastebits;
			unsigned char *msgblock;
			int j = 0, y = 0, z = 0;

			msgblock = data+i;
			      
			/*
			 * Extracting the message from the unknown cruft.
			 * 
			 * This is a bit messy, and I'm not really qualified,
			 * even as the author, to comment on it.  At least
			 * its not as bad as a while loop shooting into 
			 * infinity.
			 *
			 * "Do you believe in magic?"
			 *
			 */

			wastebits = aimutil_get8(msgblock+j++);
			wastebits = aimutil_get8(msgblock+j++);
			      
			y = aimutil_get16(msgblock+j);
			j += 2;
			for (z = 0; z < y; z++)
				wastebits = aimutil_get8(msgblock+j++);
			wastebits = aimutil_get8(msgblock+j++);
			wastebits = aimutil_get8(msgblock+j++);

			args.finlen = j;
			if (args.finlen > sizeof(args.fingerprint))
				args.finlen = sizeof(args.fingerprint);
			memcpy(args.fingerprint, msgblock, args.finlen);

			/* Message string length, including flag words. */
			args.msglen = aimutil_get16(msgblock+j);
			j += 2;

			/* Flag words. */
			args.flag1 = aimutil_get16(msgblock+j);
			if (args.flag1 == 0x0000)
				; /* ASCII */
			else if (args.flag1 == 0x0002)
				args.icbmflags |= AIM_IMFLAGS_UNICODE;
			else if (args.flag1 == 0x0003)
				args.icbmflags |= AIM_IMFLAGS_ISO_8859_1;
			else if (args.flag1 == 0xffff)
				; /* no encoding (yeep!) */
			j += 2;

			args.flag2 = aimutil_get16(msgblock+j);
			if (args.flag2 == 0x0000)
				; /* standard subencoding? */
			else if (args.flag2 == 0x000b)
				args.icbmflags |= AIM_IMFLAGS_SUBENC_MACINTOSH;
			else if (args.flag2 == 0xffff)
				; /* no subencoding */
			j += 2;
			
			if (	((args.flag1 != 0x0000) &&
				 (args.flag1 != 0x0002) &&
				 (args.flag1 != 0x0003) &&
				 (args.flag1 != 0xffff)) ||
				((args.flag2 != 0x0000) &&
				 (args.flag2 != 0x000b) &&
				 (args.flag2 != 0xffff))) {
				faimdprintf(sess, 0, "icbm: **warning: encoding flags are being used! {%04x, %04x}\n", args.flag1, args.flag2);
			}

			/* Message string. */
			args.msglen -= 4;
			if (args.icbmflags & AIM_IMFLAGS_UNICODE) {
				args.msg = malloc(args.msglen+2);
				memcpy(args.msg, msgblock+j, args.msglen);
				args.msg[args.msglen] = '\0'; /* wide NULL */
				args.msg[args.msglen+1] = '\0';
			} else {
				args.msg = malloc(args.msglen+1);
				memcpy(args.msg, msgblock+j, args.msglen);
				args.msg[args.msglen] = '\0';
			}

		} else if (type == 0x0003) { /* Server Ack Requested */

			args.icbmflags |= AIM_IMFLAGS_ACK;

		} else if (type == 0x0004) { /* Message is Auto Response */

			args.icbmflags |= AIM_IMFLAGS_AWAY;

		} else if ((type == 0x0008) && (length == 0x000c)) { /* I-HAVE-A-REALLY-PURTY-ICON Flag */

			args.iconchecksum = aimutil_get32(data+i);
			args.iconlength = aimutil_get32(data+i+4);
			args.iconstamp = aimutil_get32(data+i+8);
			args.icbmflags |= AIM_IMFLAGS_HASICON;

		} else if (type == 0x0009) {

			args.icbmflags |= AIM_IMFLAGS_BUDDYREQ;

		} else if (type == 0x0017) {

			args.extdatalen = length;
			args.extdata = data+i;

		} else {
			faimdprintf(sess, 0, "incomingim_ch1: unknown TLV 0x%04x (len %d)\n", type, length);
		}

		i += length;
	}


	if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
		ret = userfunc(sess, rx, channel, userinfo, &args);

	free(args.msg);

	return ret;
}

static int incomingim_ch2(struct aim_session_t *sess, aim_module_t *mod,  struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned short channel, struct aim_userinfo_s *userinfo, struct aim_tlvlist_t *tlvlist, unsigned char *cookie)
{
	aim_rxcallback_t userfunc;
	struct aim_tlv_t *block1;
	struct aim_tlvlist_t *list2;
	int ret = 0;
	struct aim_incomingim_ch2_args args;

	memset(&args, 0, sizeof(args));

	/*
	 * There's another block of TLVs embedded in the type 5 here. 
	 */
	if (!(block1 = aim_gettlv(tlvlist, 0x0005, 1)) || !block1->value) {
		faimdprintf(sess, 0, "no tlv 0x0005 in rendezvous transaction!\n");
		return 0;
	}

	/*
	 * First two bytes represent the status of the connection.
	 *
	 * 0 is a request, 2 is an accept
	 */ 
	args.status = aimutil_get16(block1->value+0);

	/*
	 * Next comes the cookie.  Should match the ICBM cookie.
	 */
	if (memcmp(block1->value+2, cookie, 8) != 0) 
		faimdprintf(sess, 0, "rend: warning cookies don't match!\n");

	/*
	 * The next 16bytes are a capability block so we can
	 * identify what type of rendezvous this is.
	 *
	 * Thanks to Eric Warmenhoven <[e-mail]> (of GAIM)
	 * for pointing some of this out to me.  In fact, a lot of 
	 * the client-to-client info comes from the work of the GAIM 
	 * developers. Thanks!
	 *
	 * Read off one capability string and we should have it ID'd.
	 * 
	 */
	if ((args.reqclass = aim_getcap(sess, block1->value+2+8, 0x10)) == 0x0000) {
		faimdprintf(sess, 0, "rend: no ID block\n");
		return 0;
	}

	/* 
	 * What follows may be TLVs or nothing, depending on the
	 * purpose of the message.
	 *
	 * Ack packets for instance have nothing more to them.
	 */
	list2 = aim_readtlvchain(block1->value+2+8+16, block1->length-2-8-16);

	if (!list2 || ((args.reqclass != AIM_CAPS_IMIMAGE) && !(aim_gettlv(list2, 0x2711, 1)))) {
		struct aim_msgcookie_t *cook;
		int type;

		type = aim_msgcookie_gettype(args.reqclass); /* XXX: fix this shitty code */

		if ((cook = aim_checkcookie(sess, cookie, type)) == NULL) {
			faimdprintf(sess, 0, "non-data rendezvous thats not in cache (type %d)\n", type);
		aim_freetlvchain(&list2);
		return 1;
		}

		if (cook->type == AIM_COOKIETYPE_OFTGET) {
			struct aim_filetransfer_priv *ft;

			if (cook->data) {
				int errorcode = -1; /* XXX shouldnt this be 0? */

				ft = (struct aim_filetransfer_priv *)cook->data;

				if (args.status != 0x0002) {

				  if (aim_gettlv(list2, 0x000b, 1))
					    errorcode = aim_gettlv16(list2, 0x000b, 1);

				  /* XXX this should make it up to the client, you know.. */
				  if (errorcode)
					faimdprintf(sess, 0, "transfer from %s (%s) for %s cancelled (error code %d)\n", ft->sn, ft->ip, ft->fh.name, errorcode);
				} /* args.status != 0x0002 */
				
			} else {
				faimdprintf(sess, 0, "no data attached to file transfer\n");
			} /* !cook->data */

		} else if (cook->type == AIM_CAPS_VOICE) {

			faimdprintf(sess, 0, "voice request cancelled\n");
		
		} else {
		
			faimdprintf(sess, 0, "unknown cookie cache type %d\n", cook->type);
		}

		aim_freetlvchain(&list2);

		return 1;
	}

	/*
	 * The rest of the handling depends on what type it is.
	 */
	if (args.reqclass & AIM_CAPS_BUDDYICON) {
		struct aim_tlv_t *miscinfo;
		int curpos = 0;

		miscinfo = aim_gettlv(list2, 0x2711, 1);

		args.info.icon.checksum = aimutil_get32(miscinfo->value+curpos);
		curpos += 4;
		args.info.icon.length = aimutil_get32(miscinfo->value+curpos);
		curpos += 4;
		args.info.icon.timestamp = aimutil_get32(miscinfo->value+curpos);
		curpos += 4;
		args.info.icon.icon = malloc(args.info.icon.length);
		memcpy(args.info.icon.icon, miscinfo->value+curpos, args.info.icon.length);

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
			ret = userfunc(sess, rx, channel, userinfo, &args);

		free(args.info.icon.icon);

	} else if (args.reqclass & AIM_CAPS_VOICE) {
		struct aim_msgcookie_t *cachedcook;

		faimdprintf(sess, 1, "rend: voice!\n");

		if(!(cachedcook = (struct aim_msgcookie_t*)calloc(1, sizeof(struct aim_msgcookie_t)))) {
			aim_freetlvchain(&list2);
			return 0;
		}

		memcpy(cachedcook->cookie, cookie, 8);
		cachedcook->type = AIM_COOKIETYPE_OFTVOICE;
		cachedcook->data = NULL;

		if (aim_cachecookie(sess, cachedcook) == -1)
			faimdprintf(sess, 0, "ERROR caching message cookie\n");

		/* XXX: implement all this */

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype))) 
			ret = userfunc(sess, rx, channel, userinfo, &args);

	} else if (args.reqclass & AIM_CAPS_IMIMAGE) {
		char ip[30];
		struct aim_directim_priv *priv;

		memset(ip, 0, sizeof(ip));

		if (aim_gettlv(list2, 0x0003, 1) && aim_gettlv(list2, 0x0005, 1)) {
			struct aim_tlv_t *iptlv, *porttlv;
			  
			iptlv = aim_gettlv(list2, 0x0003, 1);
			porttlv = aim_gettlv(list2, 0x0005, 1);

			snprintf(ip, 30, "%d.%d.%d.%d:%d", 
				aimutil_get8(iptlv->value+0),
				aimutil_get8(iptlv->value+1),
				aimutil_get8(iptlv->value+2),
				aimutil_get8(iptlv->value+3),
				4443 /*aimutil_get16(porttlv->value)*/);
		}

		faimdprintf(sess, 1, "rend: directIM request from %s (%s)\n",
				userinfo->sn, ip);

		/* 
		 * XXX: there are a couple of different request packets for
		 *          different things 
		 */

		args.info.directim = priv = (struct aim_directim_priv *)calloc(1, sizeof(struct aim_directim_priv)); /* XXX error */
		memcpy(priv->ip, ip, sizeof(priv->ip));
		memcpy(priv->sn, userinfo->sn, sizeof(priv->sn));
		memcpy(priv->cookie, cookie, sizeof(priv->cookie));

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
			ret = userfunc(sess, rx, channel, userinfo, &args);

	} else if (args.reqclass & AIM_CAPS_CHAT) {
		struct aim_tlv_t *miscinfo;

		miscinfo = aim_gettlv(list2, 0x2711, 1);
		aim_chat_readroominfo(miscinfo->value, &args.info.chat.roominfo);
			  
		if (aim_gettlv(list2, 0x000c, 1))
			args.info.chat.msg = aim_gettlv_str(list2, 0x000c, 1);
		
		if (aim_gettlv(list2, 0x000d, 1))
			args.info.chat.encoding = aim_gettlv_str(list2, 0x000d, 1);
		
		if (aim_gettlv(list2, 0x000e, 1))
			args.info.chat.lang = aim_gettlv_str(list2, 0x000e, 1);

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
			ret = userfunc(sess, rx, channel, userinfo, &args);

		free(args.info.chat.roominfo.name);
		free(args.info.chat.msg);
		free(args.info.chat.encoding);
		free(args.info.chat.lang);

	} else if (args.reqclass & AIM_CAPS_GETFILE) {
		char ip[30];
		struct aim_msgcookie_t *cachedcook;
		struct aim_tlv_t *miscinfo;
		struct aim_tlv_t *iptlv, *porttlv;

		memset(ip, 0, 30);

		if (!(cachedcook = calloc(1, sizeof(struct aim_msgcookie_t)))) {
			aim_freetlvchain(&list2);
			return 0;
		}

		if (!(miscinfo = aim_gettlv(list2, 0x2711, 1)) || 
			!(iptlv = aim_gettlv(list2, 0x0003, 1)) || 
			!(porttlv = aim_gettlv(list2, 0x0005, 1))) {
			
			faimdprintf(sess, 0, "rend: badly damaged file get request from %s...\n", userinfo->sn);
			aim_cookie_free(sess, cachedcook);
			aim_freetlvchain(&list2);
			
			return 0;
		}

		snprintf(ip, 30, "%d.%d.%d.%d:%d",
			aimutil_get8(iptlv->value+0),
			aimutil_get8(iptlv->value+1),
			aimutil_get8(iptlv->value+2),
			aimutil_get8(iptlv->value+3),
			aimutil_get16(porttlv->value));

		faimdprintf(sess, 0, "rend: file get request from %s (%s)\n", userinfo->sn, ip);

		args.info.getfile.ip = ip;
		args.info.getfile.cookie = cookie;

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
			ret = userfunc(sess, rx, channel, userinfo, &args);

	} else if (args.reqclass & AIM_CAPS_SENDFILE) {
#if 0 
		char ip[30];
		struct aim_msgcookie_t *cachedcook;
		struct aim_tlv_t *miscinfo;
		struct aim_tlv_t *iptlv, *porttlv;

		memset(ip, 0, 30);

		if (!(cachedcook = calloc(1, sizeof(struct aim_msgcookie_t)))) {
			aim_freetlvchain(&list2);
			return 0;
		}

		if (!(miscinfo = aim_gettlv(list2, 0x2711, 1)) || 
			!(iptlv = aim_gettlv(list2, 0x0003, 1)) || 
			!(porttlv = aim_gettlv(list2, 0x0005, 1))) {
		
			faimdprintf(sess, 0, "rend: badly damaged file get request from %s...\n", userinfo->sn);
			aim_cookie_free(sess, cachedcook);
			aim_freetlvchain(&list2);

			return 0;
		}

		snprintf(ip, 30, "%d.%d.%d.%d:%d",
			aimutil_get8(iptlv->value+0),
			aimutil_get8(iptlv->value+1),
			aimutil_get8(iptlv->value+2),
			aimutil_get8(iptlv->value+3),
			aimutil_get16(porttlv->value));

		if (aim_gettlv(list2, 0x000c, 1))
			desc = aim_gettlv_str(list2, 0x000c, 1);

		faimdprintf(sess, 0, "rend: file transfer request from %s: %s (%s)\n",
			userinfo->sn, desc, ip);

		memcpy(cachedcook->cookie, cookie, 8);

		ft = malloc(sizeof(struct aim_filetransfer_priv)); /* XXX */
		strncpy(ft->sn, userinfo.sn, sizeof(ft->sn));
		strncpy(ft->ip, ip, sizeof(ft->ip));
		strncpy(ft->fh.name, miscinfo->value+8, sizeof(ft->fh.name));
		cachedcook->type = AIM_COOKIETYPE_OFTSEND;
		cachedcook->data = ft;

		if (aim_cachecookie(sess, cachedcook) == -1)
			faimdprintf(sess, 0, "ERROR caching message cookie\n");

		aim_accepttransfer(sess, rx->conn, ft->sn, cookie, AIM_CAPS_SENDFILE);

		if (desc)
			free(desc);

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
			ret = userfunc(sess, rx, channel, userinfo, &args);

#endif	
	} else
		faimdprintf(sess, 0, "rend: unknown rendezvous 0x%04x\n", args.reqclass);

	aim_freetlvchain(&list2);

	return ret;
}

/*
 * It can easily be said that parsing ICBMs is THE single
 * most difficult thing to do in the in AIM protocol.  In
 * fact, I think I just did say that.
 *
 * Below is the best damned solution I've come up with
 * over the past sixteen months of battling with it. This
 * can parse both away and normal messages from every client
 * I have access to.  Its not fast, its not clean.  But it works.
 *
 */
static int incomingim(struct aim_session_t *sess, aim_module_t *mod, struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned char *data, int datalen)
{
	int i, ret = 0;
	unsigned char cookie[8];
	int channel;
	struct aim_userinfo_s userinfo;

	memset(&userinfo, 0x00, sizeof(struct aim_userinfo_s));

	/*
	 * Read ICBM Cookie.  And throw away.
	 */
	for (i = 0; i < 8; i++)
		cookie[i] = aimutil_get8(data+i);

	/*
	 * Channel ID.
	 *
	 * Channel 0x0001 is the message channel.  There are 
	 * other channels for things called "rendevous"
	 * which represent chat and some of the other new
	 * features of AIM2/3/3.5. 
	 *
	 * Channel 0x0002 is the Rendevous channel, which
	 * is where Chat Invitiations and various client-client
	 * connection negotiations come from.
	 * 
	 */
	channel = aimutil_get16(data+i);
	i += 2;

	/*
	 * Technically Channel 3 in chat could be done here too.
	 */
	if ((channel != 0x01) && (channel != 0x02)) {
		faimdprintf(sess, 0, "icbm: ICBM received on an unsupported channel.  Ignoring.\n (chan = %04x)", channel);
		return 1;
	}

	/*
	 * Extract the standard user info block.
	 *
	 * Note that although this contains TLVs that appear contiguous
	 * with the TLVs read below, they are two different pieces.  The
	 * userinfo block contains the number of TLVs that contain user
	 * information, the rest are not even though there is no seperation.
	 * aim_extractuserinfo() returns the number of bytes used by the
	 * userinfo tlvs, so you can start reading the rest of them right
	 * afterward.  
	 *
	 * That also means that TLV types can be duplicated between the
	 * userinfo block and the rest of the message, however there should
	 * never be two TLVs of the same type in one block.
	 * 
	 */
	i += aim_extractuserinfo(sess, data+i, &userinfo);

	/*
	 * From here on, its depends on what channel we're on.
	 *
	 * Technically all channels have a TLV list have this, however,
	 * for the common channel 1 case, in-place parsing is used for
	 * performance reasons (less memory allocation).
	 */
	if (channel == 1) {

		ret = incomingim_ch1(sess, mod, rx, snac, channel, &userinfo, data+i, datalen-i, cookie);

	} else if (channel == 0x0002) {
		struct aim_tlvlist_t *tlvlist;

		/*
		 * Read block of TLVs (not including the userinfo data).  All 
		 * further data is derived from what is parsed here.
		 */
		tlvlist = aim_readtlvchain(data+i, datalen-i);

		ret = incomingim_ch2(sess, mod, rx, snac, channel, &userinfo, tlvlist, cookie);

		/*
		 * Free up the TLV chain.
		 */
		aim_freetlvchain(&tlvlist);
	}

	return ret;
}

/*
 * Possible codes:
 *    AIM_TRANSFER_DENY_NOTSUPPORTED -- "client does not support"
 *    AIM_TRANSFER_DENY_DECLINE -- "client has declined transfer"
 *    AIM_TRANSFER_DENY_NOTACCEPTING -- "client is not accepting transfers"
 * 
 */
faim_export int aim_denytransfer(struct aim_session_t *sess,
					struct aim_conn_t *conn, 
					const char *sender,
					const char *cookie, 
					unsigned short code)
{
	struct command_tx_struct *newpacket;
	int curbyte, i;

	if (!(newpacket = aim_tx_new(sess, conn, AIM_FRAMETYPE_OSCAR, 0x0002, 10+8+2+1+strlen(sender)+6)))
		return -ENOMEM;

	newpacket->lock = 1;

	curbyte = aim_putsnac(newpacket->data, 0x0004, 0x000b, 0x0000, sess->snac_nextid++);
	for (i = 0; i < 8; i++)
		curbyte += aimutil_put8(newpacket->data+curbyte, cookie[i]);
	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0002);
	curbyte += aimutil_put8(newpacket->data+curbyte, strlen(sender));
	curbyte += aimutil_putstr(newpacket->data+curbyte, sender, strlen(sender));
	curbyte += aim_puttlv_16(newpacket->data+curbyte, 0x0003, code);

	newpacket->lock = 0;
	aim_tx_enqueue(sess, newpacket);

	return 0;
}

/*
 * aim_reqicbmparaminfo()
 *
 * Request ICBM parameter information.
 *
 */
faim_export unsigned long aim_reqicbmparams(struct aim_session_t *sess, struct aim_conn_t *conn)
{
	return aim_genericreq_n(sess, conn, 0x0004, 0x0004);
}

/*
 *
 */
faim_export unsigned long aim_seticbmparam(struct aim_session_t *sess, struct aim_conn_t *conn, struct aim_icbmparameters *params)
{
	struct command_tx_struct *newpacket;
	int curbyte;

	if (!sess || !conn || !params)
		return -EINVAL;

	if (!(newpacket = aim_tx_new(sess, conn, AIM_FRAMETYPE_OSCAR, 0x0002, 10+16)))
		return -ENOMEM;

	newpacket->lock = 1;

	curbyte = aim_putsnac(newpacket->data, 0x0004, 0x0002, 0x0000, sess->snac_nextid++);

	/* This is read-only (in Parameter Reply). Must be set to zero here. */
	curbyte += aimutil_put16(newpacket->data+curbyte, 0x0000);

	/* These are all read-write */
	curbyte += aimutil_put32(newpacket->data+curbyte, params->flags); 
	curbyte += aimutil_put16(newpacket->data+curbyte, params->maxmsglen);
	curbyte += aimutil_put16(newpacket->data+curbyte, params->maxsenderwarn); 
	curbyte += aimutil_put16(newpacket->data+curbyte, params->maxrecverwarn); 
	curbyte += aimutil_put32(newpacket->data+curbyte, params->minmsginterval);

	newpacket->lock = 0;
	aim_tx_enqueue(sess, newpacket);

	return 0;
}

static int paraminfo(struct aim_session_t *sess, aim_module_t *mod, struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned char *data, int datalen)
{
	struct aim_icbmparameters params;
	aim_rxcallback_t userfunc;
	int i = 0;

	params.maxchan = aimutil_get16(data+i);
	i += 2;

	params.flags = aimutil_get32(data+i);
	i += 4;

	params.maxmsglen = aimutil_get16(data+i);
	i += 2;

	params.maxsenderwarn = aimutil_get16(data+i);
	i += 2;

	params.maxrecverwarn = aimutil_get16(data+i);
	i += 2;

	params.minmsginterval = aimutil_get32(data+i);
	i += 4;

	if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
		return userfunc(sess, rx, &params);

	return 0;
}

static int missedcall(struct aim_session_t *sess, aim_module_t *mod, struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned char *data, int datalen)
{
	int i, ret = 0;
	aim_rxcallback_t userfunc;
	unsigned short channel, nummissed, reason;
	struct aim_userinfo_s userinfo;
	
	for (i = 0; i < datalen; ) {

		/* Channel ID. */
		channel = aimutil_get16(data+i);
		i += 2;

		/* Extract the standard user info block. */
		i += aim_extractuserinfo(sess, data+i, &userinfo);

		nummissed = aimutil_get16(data+i);
		i += 2;

		reason = aimutil_get16(data+i);
		i += 2;

		if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
			 ret = userfunc(sess, rx, channel, &userinfo, nummissed, reason);
	}

	return ret;
}

static int msgack(struct aim_session_t *sess, aim_module_t *mod, struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned char *data, int datalen)
{
	aim_rxcallback_t userfunc;
	char sn[MAXSNLEN];
	unsigned char ck[8];
	unsigned short type;
	int i = 0;
	unsigned char snlen;

	memcpy(ck, data, 8);
	i += 8;

	type = aimutil_get16(data+i);
	i += 2;

	snlen = aimutil_get8(data+i);
	i++;

	memset(sn, 0, sizeof(sn));
	strncpy(sn, (char *)data+i, snlen);

	if ((userfunc = aim_callhandler(sess, rx->conn, snac->family, snac->subtype)))
		return userfunc(sess, rx, type, sn);

	return 0;
}

static int snachandler(struct aim_session_t *sess, aim_module_t *mod, struct command_rx_struct *rx, aim_modsnac_t *snac, unsigned char *data, int datalen)
{

	if (snac->subtype == 0x0005)
		return paraminfo(sess, mod, rx, snac, data, datalen);
	else if (snac->subtype == 0x0006)
		return outgoingim(sess, mod, rx, snac, data, datalen);
	else if (snac->subtype == 0x0007)
		return incomingim(sess, mod, rx, snac, data, datalen);
	else if (snac->subtype == 0x000a)
		return missedcall(sess, mod, rx, snac, data, datalen);
	else if (snac->subtype == 0x000c)
		return msgack(sess, mod, rx, snac, data, datalen);

	return 0;
}

faim_internal int msg_modfirst(struct aim_session_t *sess, aim_module_t *mod)
{

	mod->family = 0x0004;
	mod->version = 0x0000;
	mod->flags = 0;
	strncpy(mod->name, "messaging", sizeof(mod->name));
	mod->snachandler = snachandler;

	return 0;
}