2 * Main libfaim header. Must be included in client for prototypes/macros.
4 * "come on, i turned a chick lesbian; i think this is the hackish equivalent"
12 #define FAIM_VERSION_MAJOR 0
13 #define FAIM_VERSION_MINOR 99
14 #define FAIM_VERSION_MINORMINOR 1
16 #include <faimconfig.h>
17 #include <aim_cbtypes.h>
19 #if !defined(FAIM_USEPTHREADS) && !defined(FAIM_USEFAKELOCKS) && !defined(FAIM_USENOPLOCKS)
20 #error pthreads, fakelocks, or noplocks are currently required.
26 #include <sys/types.h>
38 #include <netinet/in.h>
39 #include <sys/socket.h>
42 /* XXX adjust these based on autoconf-detected platform */
43 typedef unsigned char fu8_t;
44 typedef unsigned short fu16_t;
45 typedef unsigned long fu32_t;
46 typedef fu32_t aim_snacid_t;
47 typedef fu16_t flap_seqnum_t;
49 #ifdef FAIM_USEPTHREADS
51 #define faim_mutex_t pthread_mutex_t
52 #define faim_mutex_init(x) pthread_mutex_init(x, NULL)
53 #define faim_mutex_lock(x) pthread_mutex_lock(x)
54 #define faim_mutex_unlock(x) pthread_mutex_unlock(x)
55 #define faim_mutex_destroy(x) pthread_mutex_destroy(x)
56 #elif defined(FAIM_USEFAKELOCKS)
58 * For platforms without pthreads, we also assume
59 * we're not linking against a threaded app. Which
60 * means we don't have to do real locking. The
61 * macros below do nothing really. They're a joke.
62 * But they get it to compile.
64 * XXX NOTE that locking hasn't really been tested in a long time,
65 * and most code written after dec2000 --is not thread safe--. You'll
66 * want to audit locking use before you use less-than-library level
70 #define faim_mutex_t fu8_t
71 #define faim_mutex_init(x) *x = 0
72 #define faim_mutex_lock(x) while(*x != 0) {/* spin */}; *x = 1;
73 #define faim_mutex_unlock(x) while(*x != 0) {/* spin spin spin */}; *x = 0;
74 #define faim_mutex_destroy(x) while(*x != 0) {/* spiiiinnn */}; *x = 0;
75 #elif defined(FAIM_USENOPLOCKS)
76 #define faim_mutex_t fu8_t
77 #define faim_mutex_init(x)
78 #define faim_mutex_lock(x)
79 #define faim_mutex_unlock(x)
80 #define faim_mutex_destroy(x)
83 /* Portability stuff (DMP) */
86 #define sleep(x) Sleep((x)*1000)
87 #define snprintf _snprintf /* I'm not sure whats wrong with Microsoft here */
88 #define close(x) closesocket(x) /* no comment */
91 #if defined(mach) && defined(__APPLE__)
92 #define gethostbyname(x) gethostbyname2(x, AF_INET)
95 #if defined(_WIN32) || defined(STRICT_ANSI)
96 #define faim_shortfunc
98 #define faim_shortfunc inline
101 #if defined(_WIN32) && !defined(WIN32_STATIC)
103 * For a win32 DLL, we define WIN32_INDLL if this file
104 * is included while compiling the DLL. If its not
105 * defined (its included in a client app), the symbols
106 * will be imported instead of exported.
109 #define faim_export __declspec(dllexport)
111 #define faim_export __declspec(dllimport)
112 #endif /* WIN32_INDLL */
113 #define faim_internal
116 * Nothing normally needed for unix...
119 #define faim_internal
123 * Current Maximum Length for Screen Names (not including NULL)
125 * Currently only names up to 16 characters can be registered
126 * however it is aparently legal for them to be larger.
131 * Current Maximum Length for Instant Messages
133 * This was found basically by experiment, but not wholly
134 * accurate experiment. It should not be regarded
135 * as completely correct. But its a decent approximation.
137 * Note that although we can send this much, its impossible
138 * for WinAIM clients (up through the latest (4.0.1957)) to
139 * send any more than 1kb. Amaze all your windows friends
140 * with utterly oversized instant messages!
142 * XXX: the real limit is the total SNAC size at 8192. Fix this.
145 #define MAXMSGLEN 7987
148 * Maximum size of a Buddy Icon.
150 #define MAXICONLEN 7168
151 #define AIM_ICONIDENT "AVT1picture.id"
154 * Current Maximum Length for Chat Room Messages
156 * This is actually defined by the protocol to be
157 * dynamic, but I have yet to see due cause to
158 * define it dynamically here. Maybe later.
161 #define MAXCHATMSGLEN 512
164 * Standard size of an AIM authorization cookie
166 #define AIM_COOKIELEN 0x100
168 #define AIM_MD5_STRING "AOL Instant Messenger (SM)"
171 * Client info. Filled in by the client and passed
172 * in to aim_login(). The information ends up
173 * getting passed to OSCAR through the initial
176 * XXX: Should this be per-session? -mid
179 struct client_info_s {
180 char clientstring[100]; /* arbitrary size */
191 #define AIM_CLIENTINFO_KNOWNGOOD_3_5_1670 { \
192 "AOL Instant Messenger (SM), version 3.5.1670/WIN32", \
203 #define AIM_CLIENTINFO_KNOWNGOOD_4_1_2010 { \
204 "AOL Instant Messenger (SM), version 4.1.2010/WIN32", \
216 * I would make 4.1.2010 the default, but they seem to have found
217 * an alternate way of breaking that one.
219 * 3.5.1670 should work fine, however, you will be subjected to the
220 * memory test, which may require you to have a WinAIM binary laying
221 * around. (see login.c::memrequest())
223 #define AIM_CLIENTINFO_KNOWNGOOD AIM_CLIENTINFO_KNOWNGOOD_3_5_1670
231 * These could be arbitrary, but its easier to use the actual AIM values
233 #define AIM_CONN_TYPE_AUTH 0x0007
234 #define AIM_CONN_TYPE_ADS 0x0005
235 #define AIM_CONN_TYPE_BOS 0x0002
236 #define AIM_CONN_TYPE_CHAT 0x000e
237 #define AIM_CONN_TYPE_CHATNAV 0x000d
239 /* they start getting arbitrary in rendezvous stuff =) */
240 #define AIM_CONN_TYPE_RENDEZVOUS 0x0101 /* these do not speak FLAP! */
241 #define AIM_CONN_TYPE_RENDEZVOUS_OUT 0x0102 /* socket waiting for accept() */
244 * Subtypes, we need these for OFT stuff.
246 #define AIM_CONN_SUBTYPE_OFT_DIRECTIM 0x0001
247 #define AIM_CONN_SUBTYPE_OFT_GETFILE 0x0002
248 #define AIM_CONN_SUBTYPE_OFT_SENDFILE 0x0003
249 #define AIM_CONN_SUBTYPE_OFT_BUDDYICON 0x0004
250 #define AIM_CONN_SUBTYPE_OFT_VOICE 0x0005
253 * Status values returned from aim_conn_new(). ORed together.
255 #define AIM_CONN_STATUS_READY 0x0001
256 #define AIM_CONN_STATUS_INTERNALERR 0x0002
257 #define AIM_CONN_STATUS_RESOLVERR 0x0040
258 #define AIM_CONN_STATUS_CONNERR 0x0080
259 #define AIM_CONN_STATUS_INPROGRESS 0x0100
261 #define AIM_FRAMETYPE_FLAP 0x0000
262 #define AIM_FRAMETYPE_OFT 0x0001
264 typedef struct aim_conn_s {
268 flap_seqnum_t seqnum;
270 void *priv; /* misc data the client may want to store */
271 void *internal; /* internal conn-specific libfaim data */
272 time_t lastactivity; /* time of last transmit */
275 faim_mutex_t active; /* lock around read/writes */
276 faim_mutex_t seqnum_lock; /* lock around ->seqnum changes */
277 void *sessv; /* pointer to parent session */
278 struct aim_conn_s *next;
282 * Byte Stream type. Sort of.
284 * Use of this type serves a couple purposes:
285 * - Buffer/buflen pairs are passed all around everywhere. This turns
286 * that into one value, as well as abstracting it slightly.
287 * - Through the abstraction, it is possible to enable bounds checking
288 * for robustness at the cost of performance. But a clean failure on
289 * weird packets is much better than a segfault.
290 * - I like having variables named "bs".
292 * Don't touch the insides of this struct. Or I'll have to kill you.
295 typedef struct aim_bstream_s {
301 typedef struct aim_frame_s {
302 fu8_t hdrtype; /* defines which piece of the union to use */
306 flap_seqnum_t seqnum;
310 fu8_t magic[4]; /* ODC2 OFT2 */
312 fu8_t *hdr2; /* rest of bloated header */
315 aim_bstream_t data; /* payload stream */
316 fu8_t handled; /* 0 = new, !0 = been handled */
317 fu8_t nofree; /* 0 = free data on purge, 1 = only unlink */
318 aim_conn_t *conn; /* the connection it came in on... */
319 struct aim_frame_s *next;
322 typedef struct aim_msgcookie_s {
323 unsigned char cookie[8];
327 struct aim_msgcookie_s *next;
331 * AIM Session: The main client-data interface.
334 typedef struct aim_session_s {
336 /* ---- Client Accessible ------------------------ */
338 /* Our screen name. */
342 * Pointer to anything the client wants to
343 * explicitly associate with this session.
345 * This is for use in the callbacks mainly. In any
346 * callback, you can access this with sess->aux_data.
351 /* ---- Internal Use Only ------------------------ */
353 /* Connection information */
354 aim_conn_t *connlist;
355 faim_mutex_t connlistlock;
358 * Transmit/receive queues.
360 * These are only used when you don't use your own lowlevel
361 * I/O. I don't suggest that you use libfaim's internal I/O.
362 * Its really bad and the API/event model is quirky at best.
365 aim_frame_t *queue_outgoing;
366 aim_frame_t *queue_incoming;
369 * Tx Enqueuing function.
371 * This is how you override the transmit direction of libfaim's
372 * internal I/O. This function will be called whenever it needs
376 int (*tx_enqueue)(struct aim_session_s *, aim_frame_t *);
379 * This is a dreadful solution to the what-room-are-we-joining
380 * problem. (There's no connection between the service
381 * request and the resulting redirect.)
384 fu16_t pendingjoinexchange;
387 * Outstanding snac handling
389 * XXX: Should these be per-connection? -mid
391 void *snac_hash[FAIM_SNAC_HASH_SIZE];
392 faim_mutex_t snac_hash_locks[FAIM_SNAC_HASH_SIZE];
393 aim_snacid_t snacid_next;
401 fu32_t flags; /* AIM_SESS_FLAGS_ */
404 void (*debugcb)(struct aim_session_s *sess, int level, const char *format, va_list va); /* same as faim_debugging_callback_t */
406 aim_msgcookie_t *msgcookies;
411 /* Values for sess->flags */
412 #define AIM_SESS_FLAGS_SNACLOGIN 0x00000001
413 #define AIM_SESS_FLAGS_XORLOGIN 0x00000002
414 #define AIM_SESS_FLAGS_NONBLOCKCONNECT 0x00000004
417 * AIM User Info, Standard Form.
419 struct aim_userinfo_s {
431 fu8_t crap[0x25]; /* until we figure it out... */
435 #define AIM_FLAG_UNCONFIRMED 0x0001 /* "damned transients" */
436 #define AIM_FLAG_ADMINISTRATOR 0x0002
437 #define AIM_FLAG_AOL 0x0004
438 #define AIM_FLAG_OSCAR_PAY 0x0008
439 #define AIM_FLAG_FREE 0x0010
440 #define AIM_FLAG_AWAY 0x0020
441 #define AIM_FLAG_UNKNOWN40 0x0040
442 #define AIM_FLAG_UNKNOWN80 0x0080
444 #define AIM_FLAG_ALLUSERS 0x001f
447 #if defined(FAIM_INTERNAL) || defined(FAIM_NEED_TLV)
452 /* Generic TLV structure. */
453 typedef struct aim_tlv_s {
460 typedef struct aim_tlvlist_s {
462 struct aim_tlvlist_s *next;
465 /* TLV-handling functions */
468 /* Very, very raw TLV handling. */
469 faim_internal int aim_puttlv_8(fu8_t *buf, const fu16_t t, const fu8_t v);
470 faim_internal int aim_puttlv_16(fu8_t *buf, const fu16_t t, const fu16_t v);
471 faim_internal int aim_puttlv_32(fu8_t *buf, const fu16_t t, const fu32_t v);
472 faim_internal int aim_puttlv_raw(fu8_t *buf, const fu16_t t, const fu16_t l, const fu8_t *v);
475 /* TLV list handling. */
476 faim_internal aim_tlvlist_t *aim_readtlvchain(aim_bstream_t *bs);
477 faim_internal void aim_freetlvchain(aim_tlvlist_t **list);
478 faim_internal aim_tlv_t *aim_gettlv(aim_tlvlist_t *, fu16_t t, const int n);
479 faim_internal char *aim_gettlv_str(aim_tlvlist_t *, const fu16_t t, const int n);
480 faim_internal fu8_t aim_gettlv8(aim_tlvlist_t *list, const fu16_t type, const int num);
481 faim_internal fu16_t aim_gettlv16(aim_tlvlist_t *list, const fu16_t t, const int n);
482 faim_internal fu32_t aim_gettlv32(aim_tlvlist_t *list, const fu16_t t, const int n);
483 faim_internal int aim_writetlvchain(aim_bstream_t *bs, aim_tlvlist_t **list);
484 faim_internal int aim_addtlvtochain16(aim_tlvlist_t **list, const fu16_t t, const fu16_t v);
485 faim_internal int aim_addtlvtochain32(aim_tlvlist_t **list, const fu16_t type, const fu32_t v);
486 faim_internal int aim_addtlvtochain_raw(aim_tlvlist_t **list, const fu16_t t, const fu16_t l, const fu8_t *v);
487 faim_internal int aim_addtlvtochain_caps(aim_tlvlist_t **list, const fu16_t t, const fu16_t caps);
488 faim_internal int aim_addtlvtochain_noval(aim_tlvlist_t **list, const fu16_t type);
489 faim_internal int aim_addtlvtochain_frozentlvlist(aim_tlvlist_t **list, fu16_t type, aim_tlvlist_t **tl);
490 faim_internal int aim_counttlvchain(aim_tlvlist_t **list);
491 faim_export int aim_sizetlvchain(aim_tlvlist_t **list);
492 #endif /* FAIM_INTERNAL */
495 * Get command from connections
497 * aim_get_commmand() is the libfaim lowlevel I/O in the receive direction.
498 * XXX Make this easily overridable.
501 faim_export int aim_get_command(aim_session_t *, aim_conn_t *);
504 * Dispatch commands that are in the rx queue.
506 faim_export void aim_rxdispatch(aim_session_t *);
508 faim_export int aim_debugconn_sendconnect(aim_session_t *sess, aim_conn_t *conn);
510 faim_export int aim_logoff(aim_session_t *);
512 #if !defined(FAIM_INTERNAL) || defined(FAIM_INTERNAL_INSANE)
513 /* the library should never call aim_conn_kill */
514 faim_export void aim_conn_kill(aim_session_t *sess, aim_conn_t **deadconn);
517 typedef int (*aim_rxcallback_t)(aim_session_t *, aim_frame_t *, ...);
520 faim_export int aim_sendflapver(aim_session_t *sess, aim_conn_t *conn);
521 faim_export int aim_request_login(aim_session_t *sess, aim_conn_t *conn, const char *sn);
522 faim_export int aim_send_login(aim_session_t *, aim_conn_t *, const char *, const char *, struct client_info_s *, const char *key);
523 faim_export int aim_encode_password_md5(const char *password, const char *key, unsigned char *digest);
524 faim_export int aim_sendauthresp(aim_session_t *sess, aim_conn_t *conn, const char *sn, int errorcode, const char *errorurl, const char *bosip, const char *cookie, const char *email, int regstatus);
525 faim_export int aim_gencookie(unsigned char *buf);
526 faim_export int aim_sendserverready(aim_session_t *sess, aim_conn_t *conn);
527 faim_export int aim_sendredirect(aim_session_t *sess, aim_conn_t *conn, fu16_t servid, const char *ip, const char *cookie);
528 faim_export void aim_purge_rxqueue(aim_session_t *);
530 #define AIM_TX_QUEUED 0 /* default */
531 #define AIM_TX_IMMEDIATE 1
532 #define AIM_TX_USER 2
533 faim_export int aim_tx_setenqueue(aim_session_t *sess, int what, int (*func)(aim_session_t *, aim_frame_t *));
535 faim_export int aim_tx_flushqueue(aim_session_t *);
536 faim_export void aim_tx_purgequeue(aim_session_t *);
538 faim_export int aim_conn_setlatency(aim_conn_t *conn, int newval);
540 faim_export int aim_conn_addhandler(aim_session_t *, aim_conn_t *conn, u_short family, u_short type, aim_rxcallback_t newhandler, u_short flags);
541 faim_export int aim_clearhandlers(aim_conn_t *conn);
543 faim_export aim_session_t *aim_conn_getsess(aim_conn_t *conn);
544 faim_export void aim_conn_close(aim_conn_t *deadconn);
545 faim_export aim_conn_t *aim_newconn(aim_session_t *, int type, const char *dest);
546 faim_export int aim_conngetmaxfd(aim_session_t *);
547 faim_export aim_conn_t *aim_select(aim_session_t *, struct timeval *, int *);
548 faim_export int aim_conn_isready(aim_conn_t *);
549 faim_export int aim_conn_setstatus(aim_conn_t *, int);
550 faim_export int aim_conn_completeconnect(aim_session_t *sess, aim_conn_t *conn);
551 faim_export int aim_conn_isconnecting(aim_conn_t *conn);
553 typedef void (*faim_debugging_callback_t)(aim_session_t *sess, int level, const char *format, va_list va);
554 faim_export int aim_setdebuggingcb(aim_session_t *sess, faim_debugging_callback_t);
555 faim_export void aim_session_init(aim_session_t *, unsigned long flags, int debuglevel);
556 faim_export void aim_session_kill(aim_session_t *);
557 faim_export void aim_setupproxy(aim_session_t *sess, const char *server, const char *username, const char *password);
558 faim_export aim_conn_t *aim_getconn_type(aim_session_t *, int type);
559 faim_export aim_conn_t *aim_getconn_type_all(aim_session_t *, int type);
560 faim_export aim_conn_t *aim_getconn_fd(aim_session_t *, int fd);
564 #define AIM_VISIBILITYCHANGE_PERMITADD 0x05
565 #define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
566 #define AIM_VISIBILITYCHANGE_DENYADD 0x07
567 #define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08
569 #define AIM_PRIVFLAGS_ALLOWIDLE 0x01
570 #define AIM_PRIVFLAGS_ALLOWMEMBERSINCE 0x02
572 #define AIM_WARN_ANON 0x01
574 faim_export int aim_send_warning(aim_session_t *sess, aim_conn_t *conn, const char *destsn, fu32_t flags);
575 faim_export int aim_bos_nop(aim_session_t *, aim_conn_t *);
576 faim_export int aim_flap_nop(aim_session_t *sess, aim_conn_t *conn);
577 faim_export int aim_bos_setidle(aim_session_t *, aim_conn_t *, fu32_t);
578 faim_export int aim_bos_changevisibility(aim_session_t *, aim_conn_t *, int, const char *);
579 faim_export int aim_bos_setbuddylist(aim_session_t *, aim_conn_t *, const char *);
580 faim_export int aim_bos_setprofile(aim_session_t *sess, aim_conn_t *conn, const char *profile, const char *awaymsg, fu16_t caps);
581 faim_export int aim_bos_setgroupperm(aim_session_t *, aim_conn_t *, fu32_t mask);
582 faim_export int aim_bos_clientready(aim_session_t *, aim_conn_t *);
583 faim_export int aim_bos_reqrate(aim_session_t *, aim_conn_t *);
584 faim_export int aim_bos_ackrateresp(aim_session_t *, aim_conn_t *);
585 faim_export int aim_bos_setprivacyflags(aim_session_t *, aim_conn_t *, fu32_t);
586 faim_export int aim_bos_reqpersonalinfo(aim_session_t *, aim_conn_t *);
587 faim_export int aim_bos_reqservice(aim_session_t *, aim_conn_t *, fu16_t);
588 faim_export int aim_bos_reqrights(aim_session_t *, aim_conn_t *);
589 faim_export int aim_bos_reqbuddyrights(aim_session_t *, aim_conn_t *);
590 faim_export int aim_bos_reqlocaterights(aim_session_t *, aim_conn_t *);
591 faim_export int aim_setversions(aim_session_t *sess, aim_conn_t *conn);
592 faim_export int aim_setdirectoryinfo(aim_session_t *sess, aim_conn_t *conn, const char *first, const char *middle, const char *last, const char *maiden, const char *nickname, const char *street, const char *city, const char *state, const char *zip, int country, fu16_t privacy);
593 faim_export int aim_setuserinterests(aim_session_t *sess, aim_conn_t *conn, const char *interest1, const char *interest2, const char *interest3, const char *interest4, const char *interest5, fu16_t privacy);
594 faim_export int aim_icq_setstatus(aim_session_t *sess, aim_conn_t *conn, fu32_t status);
596 faim_export struct aim_fileheader_t *aim_getlisting(aim_session_t *sess, FILE *);
598 #define AIM_CLIENTTYPE_UNKNOWN 0x0000
599 #define AIM_CLIENTTYPE_MC 0x0001
600 #define AIM_CLIENTTYPE_WINAIM 0x0002
601 #define AIM_CLIENTTYPE_WINAIM41 0x0003
602 #define AIM_CLIENTTYPE_AOL_TOC 0x0004
603 faim_export unsigned short aim_fingerprintclient(unsigned char *msghdr, int len);
605 #define AIM_RATE_CODE_CHANGE 0x0001
606 #define AIM_RATE_CODE_WARNING 0x0002
607 #define AIM_RATE_CODE_LIMIT 0x0003
608 #define AIM_RATE_CODE_CLEARLIMIT 0x0004
609 faim_export int aim_ads_clientready(aim_session_t *sess, aim_conn_t *conn);
610 faim_export int aim_ads_requestads(aim_session_t *sess, aim_conn_t *conn);
614 struct aim_fileheader_t {
616 char magic[4]; /* 0 */
617 short hdrlen; /* 4 */
618 short hdrtype; /* 6 */
620 char bcookie[8]; /* 8 */
621 short encrypt; /* 16 */
622 short compress; /* 18 */
623 short totfiles; /* 20 */
624 short filesleft; /* 22 */
625 short totparts; /* 24 */
626 short partsleft; /* 26 */
627 long totsize; /* 28 */
629 long modtime; /* 36 */
630 long checksum; /* 40 */
631 long rfrcsum; /* 44 */
632 long rfsize; /* 48 */
633 long cretime; /* 52 */
634 long rfcsum; /* 56 */
635 long nrecvd; /* 60 */
636 long recvcsum; /* 64 */
637 char idstring[32]; /* 68 */
638 char flags; /* 100 */
639 char lnameoffset; /* 101 */
640 char lsizeoffset; /* 102 */
641 char dummy[69]; /* 103 */
642 char macfileinfo[16]; /* 172 */
643 short nencode; /* 188 */
644 short nlanguage; /* 190 */
645 char name[64]; /* 192 */
649 struct aim_filetransfer_priv {
654 struct aim_fileheader_t fh;
657 struct aim_chat_roominfo {
658 unsigned short exchange;
660 unsigned short instance;
663 #define AIM_IMFLAGS_AWAY 0x0001 /* mark as an autoreply */
664 #define AIM_IMFLAGS_ACK 0x0002 /* request a receipt notice */
665 #define AIM_IMFLAGS_UNICODE 0x0004
666 #define AIM_IMFLAGS_ISO_8859_1 0x0008
667 #define AIM_IMFLAGS_BUDDYREQ 0x0010 /* buddy icon requested */
668 #define AIM_IMFLAGS_HASICON 0x0020 /* already has icon */
669 #define AIM_IMFLAGS_SUBENC_MACINTOSH 0x0040 /* damn that Steve Jobs! */
670 #define AIM_IMFLAGS_CUSTOMFEATURES 0x0080 /* features field present */
671 #define AIM_IMFLAGS_EXTDATA 0x0100
673 struct aim_sendimext_args {
675 /* These are _required_ */
681 /* Only used if AIM_IMFLAGS_HASICON is set */
686 /* Only used if AIM_IMFLAGS_CUSTOMFEATURES is set */
691 struct aim_incomingim_ch1_args {
693 /* Always provided */
700 /* Only provided if AIM_IMFLAGS_HASICON is set */
705 /* Only provided if AIM_IMFLAGS_CUSTOMFEATURES is set */
709 /* Only provided if AIM_IMFLAGS_EXTDATA is set */
714 struct aim_incomingim_ch2_args {
728 fu8_t ip[22]; /* xxx.xxx.xxx.xxx:xxxxx\0 */
734 struct aim_chat_roominfo roominfo;
738 unsigned char *cookie;
745 faim_export int aim_send_im_ext(aim_session_t *sess, aim_conn_t *conn, struct aim_sendimext_args *args);
746 faim_export int aim_send_im(aim_session_t *, aim_conn_t *, const char *destsn, unsigned short flags, const char *msg);
747 faim_export int aim_send_icon(aim_session_t *sess, aim_conn_t *conn, const char *sn, const fu8_t *icon, int iconlen, time_t stamp, fu32_t iconsum);
748 faim_export fu32_t aim_iconsum(const fu8_t *buf, int buflen);
749 faim_export int aim_send_im_direct(aim_session_t *, aim_conn_t *, const char *msg);
750 faim_export const char *aim_directim_getsn(aim_conn_t *conn);
751 faim_export aim_conn_t *aim_directim_initiate(aim_session_t *, aim_conn_t *, const char *destsn);
752 faim_export aim_conn_t *aim_directim_connect(aim_session_t *, const char *sn, const char *addr, const fu8_t *cookie);
754 faim_export aim_conn_t *aim_getfile_initiate(aim_session_t *sess, aim_conn_t *conn, const char *destsn);
755 faim_export int aim_oft_getfile_request(aim_session_t *sess, aim_conn_t *conn, const char *name, int size);
756 faim_export int aim_oft_getfile_ack(aim_session_t *sess, aim_conn_t *conn);
757 faim_export int aim_oft_getfile_end(aim_session_t *sess, aim_conn_t *conn);
760 #define AIM_CAPS_BUDDYICON 0x0001
761 #define AIM_CAPS_VOICE 0x0002
762 #define AIM_CAPS_IMIMAGE 0x0004
763 #define AIM_CAPS_CHAT 0x0008
764 #define AIM_CAPS_GETFILE 0x0010
765 #define AIM_CAPS_SENDFILE 0x0020
766 #define AIM_CAPS_GAMES 0x0040
767 #define AIM_CAPS_SAVESTOCKS 0x0080
768 #define AIM_CAPS_SENDBUDDYLIST 0x0100
769 #define AIM_CAPS_GAMES2 0x0200
770 #define AIM_CAPS_LAST 0x8000
772 faim_export int aim_0002_000b(aim_session_t *sess, aim_conn_t *conn, const char *sn);
774 #define AIM_SENDMEMBLOCK_FLAG_ISREQUEST 0
775 #define AIM_SENDMEMBLOCK_FLAG_ISHASH 1
777 faim_export int aim_sendmemblock(aim_session_t *sess, aim_conn_t *conn, unsigned long offset, unsigned long len, const unsigned char *buf, unsigned char flag);
779 #define AIM_GETINFO_GENERALINFO 0x00001
780 #define AIM_GETINFO_AWAYMESSAGE 0x00003
782 struct aim_invite_priv {
789 #define AIM_COOKIETYPE_UNKNOWN 0x00
790 #define AIM_COOKIETYPE_ICBM 0x01
791 #define AIM_COOKIETYPE_ADS 0x02
792 #define AIM_COOKIETYPE_BOS 0x03
793 #define AIM_COOKIETYPE_IM 0x04
794 #define AIM_COOKIETYPE_CHAT 0x05
795 #define AIM_COOKIETYPE_CHATNAV 0x06
796 #define AIM_COOKIETYPE_INVITE 0x07
797 /* we'll move OFT up a bit to give breathing room. not like it really
799 #define AIM_COOKIETYPE_OFTIM 0x10
800 #define AIM_COOKIETYPE_OFTGET 0x11
801 #define AIM_COOKIETYPE_OFTSEND 0x12
802 #define AIM_COOKIETYPE_OFTVOICE 0x13
803 #define AIM_COOKIETYPE_OFTIMAGE 0x14
804 #define AIM_COOKIETYPE_OFTICON 0x15
806 faim_export int aim_handlerendconnect(aim_session_t *sess, aim_conn_t *cur);
808 #define AIM_TRANSFER_DENY_NOTSUPPORTED 0x0000
809 #define AIM_TRANSFER_DENY_DECLINE 0x0001
810 #define AIM_TRANSFER_DENY_NOTACCEPTING 0x0002
811 faim_export int aim_denytransfer(aim_session_t *sess, aim_conn_t *conn, const char *sender, const char *cookie, unsigned short code);
812 faim_export aim_conn_t *aim_accepttransfer(aim_session_t *sess, aim_conn_t *conn, const char *sn, const fu8_t *cookie, const fu8_t *ip, fu16_t listingfiles, fu16_t listingtotsize, fu16_t listingsize, fu32_t listingchecksum, fu16_t rendid);
814 faim_export int aim_getinfo(aim_session_t *, aim_conn_t *, const char *, unsigned short);
815 faim_export int aim_sendbuddyoncoming(aim_session_t *sess, aim_conn_t *conn, struct aim_userinfo_s *info);
816 faim_export int aim_sendbuddyoffgoing(aim_session_t *sess, aim_conn_t *conn, const char *sn);
818 #define AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED 0x00000001
819 #define AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED 0x00000002
821 /* This is what the server will give you if you don't set them yourself. */
822 #define AIM_IMPARAM_DEFAULTS { \
824 AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
825 512, /* !! Note how small this is. */ \
826 (99.9)*10, (99.9)*10, \
830 /* This is what most AIM versions use. */
831 #define AIM_IMPARAM_REASONABLE { \
833 AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
835 (99.9)*10, (99.9)*10, \
840 struct aim_icbmparameters {
841 unsigned short maxchan;
842 unsigned long flags; /* AIM_IMPARAM_FLAG_ */
843 unsigned short maxmsglen; /* message size that you will accept */
844 unsigned short maxsenderwarn; /* this and below are *10 (999=99.9%) */
845 unsigned short maxrecverwarn;
846 unsigned long minmsginterval; /* in milliseconds? */
849 faim_export int aim_reqicbmparams(aim_session_t *sess, aim_conn_t *conn);
850 faim_export int aim_seticbmparam(aim_session_t *sess, aim_conn_t *conn, struct aim_icbmparameters *params);
854 faim_export int aim_auth_sendcookie(aim_session_t *, aim_conn_t *, const fu8_t *);
856 faim_export int aim_auth_clientready(aim_session_t *, aim_conn_t *);
857 faim_export int aim_auth_changepasswd(aim_session_t *, aim_conn_t *, const char *newpw, const char *curpw);
858 faim_export int aim_auth_setversions(aim_session_t *sess, aim_conn_t *conn);
859 faim_export int aim_auth_reqconfirm(aim_session_t *sess, aim_conn_t *conn);
860 faim_export int aim_auth_getinfo(aim_session_t *sess, aim_conn_t *conn, fu16_t info);
861 faim_export int aim_auth_setemail(aim_session_t *sess, aim_conn_t *conn, const char *newemail);
863 /* aim_buddylist.c */
864 faim_export int aim_add_buddy(aim_session_t *, aim_conn_t *, const char *);
865 faim_export int aim_remove_buddy(aim_session_t *, aim_conn_t *, const char *);
868 faim_export int aim_usersearch_address(aim_session_t *, aim_conn_t *, const char *);
870 struct aim_chat_exchangeinfo {
879 #define AIM_CHATFLAGS_NOREFLECT 0x0001
880 #define AIM_CHATFLAGS_AWAY 0x0002
881 faim_export int aim_chat_send_im(aim_session_t *sess, aim_conn_t *conn, fu16_t flags, const char *msg, int msglen);
882 faim_export int aim_chat_join(aim_session_t *sess, aim_conn_t *conn, fu16_t exchange, const char *roomname, fu16_t instance);
883 faim_export int aim_chat_clientready(aim_session_t *sess, aim_conn_t *conn);
884 faim_export int aim_chat_attachname(aim_conn_t *conn, const char *roomname);
885 faim_export char *aim_chat_getname(aim_conn_t *conn);
886 faim_export aim_conn_t *aim_chat_getconn(aim_session_t *, const char *name);
888 faim_export int aim_chatnav_reqrights(aim_session_t *sess, aim_conn_t *conn);
889 faim_export int aim_chatnav_clientready(aim_session_t *sess, aim_conn_t *conn);
891 faim_export int aim_chat_invite(aim_session_t *sess, aim_conn_t *conn, const char *sn, const char *msg, fu16_t exchange, const char *roomname, fu16_t instance);
893 faim_export int aim_chatnav_createroom(aim_session_t *sess, aim_conn_t *conn, const char *name, fu16_t exchange);
894 faim_export int aim_chat_leaveroom(aim_session_t *sess, const char *name);
898 * These are really ugly. You'd think this was LISP. I wish it was.
900 * XXX With the advent of bstream's, these should be removed to enforce
904 #define aimutil_put8(buf, data) ((*(buf) = (u_char)(data)&0xff),1)
905 #define aimutil_get8(buf) ((*(buf))&0xff)
906 #define aimutil_put16(buf, data) ( \
907 (*(buf) = (u_char)((data)>>8)&0xff), \
908 (*((buf)+1) = (u_char)(data)&0xff), \
910 #define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
911 #define aimutil_put32(buf, data) ( \
912 (*((buf)) = (u_char)((data)>>24)&0xff), \
913 (*((buf)+1) = (u_char)((data)>>16)&0xff), \
914 (*((buf)+2) = (u_char)((data)>>8)&0xff), \
915 (*((buf)+3) = (u_char)(data)&0xff), \
917 #define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
918 (((*((buf)+1))<<16)&0x00ff0000) + \
919 (((*((buf)+2))<< 8)&0x0000ff00) + \
920 (((*((buf)+3) )&0x000000ff)))
922 faim_export int aimutil_putstr(u_char *, const char *, int);
923 faim_export int aimutil_tokslen(char *toSearch, int index, char dl);
924 faim_export int aimutil_itemcnt(char *toSearch, char dl);
925 faim_export char *aimutil_itemidx(char *toSearch, int index, char dl);
927 faim_export int aim_snlen(const char *sn);
928 faim_export int aim_sncmp(const char *sn1, const char *sn2);
930 /* for libc's that dont have it */
931 faim_export char *aim_strsep(char **pp, const char *delim);
934 faim_export char *aim_getbuilddate(void);
935 faim_export char *aim_getbuildtime(void);
936 faim_export int aim_getbuildstring(char *buf, int buflen);
938 #include <aim_internal.h>
940 #endif /* __AIM_H__ */