]> andersk Git - libfaim.git/blame - include/aim.h
andersk / libfaim.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
- Wed Sep 19 18:50:34 PDT 2001
[libfaim.git] / include / aim.h
CommitLineData
bd71fa88 1/*
2 * Main libfaim header. Must be included in client for prototypes/macros.
3 *
fd0b7da6 4 * "come on, i turned a chick lesbian; i think this is the hackish equivalent"
5 * -- Josh Meyer
6 *
bd71fa88 7 */
8
9#ifndef __AIM_H__
10#define __AIM_H__
11
0cc57340 12#define FAIM_VERSION_MAJOR 0
13#define FAIM_VERSION_MINOR 99
37ee990e 14#define FAIM_VERSION_MINORMINOR 1
0cc57340 15
dd60ff8b 16#include <faimconfig.h>
17#include <aim_cbtypes.h>
bd71fa88 18
19#include <stdio.h>
20#include <string.h>
21#include <fcntl.h>
22#include <sys/types.h>
23#include <stdlib.h>
24#include <stdarg.h>
25#include <errno.h>
646c6b52 26#include <time.h>
bd71fa88 27
7392c79f 28#ifdef _WIN32
29#include <windows.h>
7392c79f 30#include <io.h>
31#else
7392c79f 32#include <sys/time.h>
33#include <unistd.h>
a15d82b1 34#include <netinet/in.h>
37ee990e 35#include <sys/socket.h>
7392c79f 36#endif
37
d410cf58 38/* XXX adjust these based on autoconf-detected platform */
39typedef unsigned char fu8_t;
40typedef unsigned short fu16_t;
41typedef unsigned long fu32_t;
42typedef fu32_t aim_snacid_t;
43typedef fu16_t flap_seqnum_t;
44
bd71fa88 45/* Portability stuff (DMP) */
46
47#ifdef _WIN32
6b9df03c 48#define sleep(x) Sleep((x)*1000)
5ac21963 49#define snprintf _snprintf /* I'm not sure whats wrong with Microsoft here */
5aab5195 50#define close(x) closesocket(x) /* no comment */
bd71fa88 51#endif
52
040457cc 53#if defined(mach) && defined(__APPLE__)
54#define gethostbyname(x) gethostbyname2(x, AF_INET)
55#endif
bd71fa88 56
78b3fb13 57#if defined(_WIN32) || defined(STRICT_ANSI)
58#define faim_shortfunc
59#else
60#define faim_shortfunc inline
61#endif
62
5ac21963 63#if defined(_WIN32) && !defined(WIN32_STATIC)
78b3fb13 64/*
65 * For a win32 DLL, we define WIN32_INDLL if this file
66 * is included while compiling the DLL. If its not
67 * defined (its included in a client app), the symbols
68 * will be imported instead of exported.
69 */
70#ifdef WIN32_INDLL
71#define faim_export __declspec(dllexport)
72#else
73#define faim_export __declspec(dllimport)
74#endif /* WIN32_INDLL */
75#define faim_internal
76#else
77/*
78 * Nothing normally needed for unix...
79 */
80#define faim_export
81#define faim_internal
81d7797e 82#endif
83
bd71fa88 84/*
85 * Current Maximum Length for Screen Names (not including NULL)
68ac63c2 86 *
87 * Currently only names up to 16 characters can be registered
88 * however it is aparently legal for them to be larger.
bd71fa88 89 */
68ac63c2 90#define MAXSNLEN 32
bd71fa88 91
91931247 92/*
93 * Current Maximum Length for Instant Messages
94 *
95 * This was found basically by experiment, but not wholly
96 * accurate experiment. It should not be regarded
97 * as completely correct. But its a decent approximation.
98 *
99 * Note that although we can send this much, its impossible
100 * for WinAIM clients (up through the latest (4.0.1957)) to
101 * send any more than 1kb. Amaze all your windows friends
5e02cf44 102 * with utterly oversized instant messages!
98c88242 103 *
104 * XXX: the real limit is the total SNAC size at 8192. Fix this.
91931247 105 *
106 */
b69540e3 107#define MAXMSGLEN 7987
91931247 108
7b91722d 109/*
110 * Maximum size of a Buddy Icon.
111 */
112#define MAXICONLEN 7168
113#define AIM_ICONIDENT "AVT1picture.id"
114
91931247 115/*
116 * Current Maximum Length for Chat Room Messages
117 *
118 * This is actually defined by the protocol to be
119 * dynamic, but I have yet to see due cause to
120 * define it dynamically here. Maybe later.
121 *
122 */
123#define MAXCHATMSGLEN 512
124
bd71fa88 125/*
126 * Standard size of an AIM authorization cookie
127 */
128#define AIM_COOKIELEN 0x100
129
b5bc2a8c 130#define AIM_MD5_STRING "AOL Instant Messenger (SM)"
131
bd71fa88 132/*
133 * Client info. Filled in by the client and passed
134 * in to aim_login(). The information ends up
135 * getting passed to OSCAR through the initial
136 * login command.
137 *
138 * XXX: Should this be per-session? -mid
139 *
140 */
141struct client_info_s {
d410cf58 142 char clientstring[100]; /* arbitrary size */
143 int major;
144 int minor;
145 int build;
146 char country[3];
147 char lang[3];
148 int major2;
149 int minor2;
150 long unknown;
bd71fa88 151};
152
b1eac25a 153#define AIM_CLIENTINFO_KNOWNGOOD_3_5_1670 { \
d410cf58 154 "AOL Instant Messenger (SM), version 3.5.1670/WIN32", \
155 0x0003, \
156 0x0005, \
157 0x0686, \
158 "us", \
159 "en", \
160 0x0004, \
161 0x0000, \
162 0x0000002a, \
154b4093 163}
164
b1eac25a 165#define AIM_CLIENTINFO_KNOWNGOOD_4_1_2010 { \
d410cf58 166 "AOL Instant Messenger (SM), version 4.1.2010/WIN32", \
167 0x0004, \
168 0x0001, \
169 0x07da, \
170 "us", \
171 "en", \
172 0x0004, \
173 0x0000, \
174 0x0000004b, \
b1eac25a 175}
176
177/*
178 * I would make 4.1.2010 the default, but they seem to have found
179 * an alternate way of breaking that one.
180 *
181 * 3.5.1670 should work fine, however, you will be subjected to the
182 * memory test, which may require you to have a WinAIM binary laying
183 * around. (see login.c::memrequest())
184 */
185#define AIM_CLIENTINFO_KNOWNGOOD AIM_CLIENTINFO_KNOWNGOOD_3_5_1670
186
bd71fa88 187#ifndef TRUE
188#define TRUE 1
189#define FALSE 0
190#endif
191
192/*
193 * These could be arbitrary, but its easier to use the actual AIM values
194 */
195#define AIM_CONN_TYPE_AUTH 0x0007
196#define AIM_CONN_TYPE_ADS 0x0005
197#define AIM_CONN_TYPE_BOS 0x0002
198#define AIM_CONN_TYPE_CHAT 0x000e
199#define AIM_CONN_TYPE_CHATNAV 0x000d
7392c79f 200
201/* they start getting arbitrary in rendezvous stuff =) */
d410cf58 202#define AIM_CONN_TYPE_RENDEZVOUS 0x0101 /* these do not speak FLAP! */
7392c79f 203#define AIM_CONN_TYPE_RENDEZVOUS_OUT 0x0102 /* socket waiting for accept() */
204
205/*
206 * Subtypes, we need these for OFT stuff.
207 */
208#define AIM_CONN_SUBTYPE_OFT_DIRECTIM 0x0001
209#define AIM_CONN_SUBTYPE_OFT_GETFILE 0x0002
210#define AIM_CONN_SUBTYPE_OFT_SENDFILE 0x0003
211#define AIM_CONN_SUBTYPE_OFT_BUDDYICON 0x0004
212#define AIM_CONN_SUBTYPE_OFT_VOICE 0x0005
bd71fa88 213
214/*
215 * Status values returned from aim_conn_new(). ORed together.
216 */
217#define AIM_CONN_STATUS_READY 0x0001
218#define AIM_CONN_STATUS_INTERNALERR 0x0002
22517493 219#define AIM_CONN_STATUS_RESOLVERR 0x0040
220#define AIM_CONN_STATUS_CONNERR 0x0080
221#define AIM_CONN_STATUS_INPROGRESS 0x0100
bd71fa88 222
d410cf58 223#define AIM_FRAMETYPE_FLAP 0x0000
224#define AIM_FRAMETYPE_OFT 0x0001
225
226typedef struct aim_conn_s {
227 int fd;
228 fu16_t type;
229 fu16_t subtype;
230 flap_seqnum_t seqnum;
231 fu32_t status;
232 void *priv; /* misc data the client may want to store */
c5f5b7f1 233 void *internal; /* internal conn-specific libfaim data */
d410cf58 234 time_t lastactivity; /* time of last transmit */
235 int forcedlatency;
236 void *handlerlist;
d410cf58 237 void *sessv; /* pointer to parent session */
031c2fb3 238 void *inside; /* only accessible from inside libfaim */
d410cf58 239 struct aim_conn_s *next;
240} aim_conn_t;
bd71fa88 241
d410cf58 242/*
243 * Byte Stream type. Sort of.
244 *
245 * Use of this type serves a couple purposes:
246 * - Buffer/buflen pairs are passed all around everywhere. This turns
247 * that into one value, as well as abstracting it slightly.
248 * - Through the abstraction, it is possible to enable bounds checking
249 * for robustness at the cost of performance. But a clean failure on
250 * weird packets is much better than a segfault.
251 * - I like having variables named "bs".
252 *
253 * Don't touch the insides of this struct. Or I'll have to kill you.
254 *
255 */
256typedef struct aim_bstream_s {
257 fu8_t *data;
258 fu16_t len;
259 fu16_t offset;
260} aim_bstream_t;
261
262typedef struct aim_frame_s {
263 fu8_t hdrtype; /* defines which piece of the union to use */
264 union {
265 struct {
266 fu8_t type;
267 flap_seqnum_t seqnum;
268 } flap;
269 struct {
270 fu16_t type;
271 fu8_t magic[4]; /* ODC2 OFT2 */
272 fu16_t hdr2len;
273 fu8_t *hdr2; /* rest of bloated header */
274 } oft;
275 } hdr;
276 aim_bstream_t data; /* payload stream */
277 fu8_t handled; /* 0 = new, !0 = been handled */
278 fu8_t nofree; /* 0 = free data on purge, 1 = only unlink */
279 aim_conn_t *conn; /* the connection it came in on... */
280 struct aim_frame_s *next;
281} aim_frame_t;
282
283typedef struct aim_msgcookie_s {
284 unsigned char cookie[8];
285 int type;
286 void *data;
287 time_t addtime;
288 struct aim_msgcookie_s *next;
289} aim_msgcookie_t;
bd71fa88 290
bd71fa88 291/*
292 * AIM Session: The main client-data interface.
293 *
294 */
d410cf58 295typedef struct aim_session_s {
296
297 /* ---- Client Accessible ------------------------ */
298
299 /* Our screen name. */
300 char sn[MAXSNLEN+1];
301
302 /*
303 * Pointer to anything the client wants to
304 * explicitly associate with this session.
305 *
306 * This is for use in the callbacks mainly. In any
307 * callback, you can access this with sess->aux_data.
308 *
309 */
310 void *aux_data;
311
312 /* ---- Internal Use Only ------------------------ */
313
314 /* Connection information */
315 aim_conn_t *connlist;
d410cf58 316
317 /*
318 * Transmit/receive queues.
319 *
320 * These are only used when you don't use your own lowlevel
321 * I/O. I don't suggest that you use libfaim's internal I/O.
322 * Its really bad and the API/event model is quirky at best.
323 *
324 */
325 aim_frame_t *queue_outgoing;
326 aim_frame_t *queue_incoming;
327
328 /*
329 * Tx Enqueuing function.
330 *
331 * This is how you override the transmit direction of libfaim's
332 * internal I/O. This function will be called whenever it needs
333 * to send something.
334 *
335 */
336 int (*tx_enqueue)(struct aim_session_s *, aim_frame_t *);
337
338 /*
339 * This is a dreadful solution to the what-room-are-we-joining
340 * problem. (There's no connection between the service
341 * request and the resulting redirect.)
342 */
343 char *pendingjoin;
344 fu16_t pendingjoinexchange;
345
346 /*
347 * Outstanding snac handling
348 *
349 * XXX: Should these be per-connection? -mid
350 */
351 void *snac_hash[FAIM_SNAC_HASH_SIZE];
d410cf58 352 aim_snacid_t snacid_next;
353
354 struct {
355 char server[128];
356 char username[128];
357 char password[128];
358 } socksproxy;
359
360 fu32_t flags; /* AIM_SESS_FLAGS_ */
361
362 int debug;
363 void (*debugcb)(struct aim_session_s *sess, int level, const char *format, va_list va); /* same as faim_debugging_callback_t */
364
365 aim_msgcookie_t *msgcookies;
366
367 void *modlistv;
368} aim_session_t;
bd71fa88 369
22517493 370/* Values for sess->flags */
371#define AIM_SESS_FLAGS_SNACLOGIN 0x00000001
372#define AIM_SESS_FLAGS_XORLOGIN 0x00000002
373#define AIM_SESS_FLAGS_NONBLOCKCONNECT 0x00000004
bd71fa88 374
375/*
376 * AIM User Info, Standard Form.
377 */
378struct aim_userinfo_s {
d410cf58 379 char sn[MAXSNLEN+1];
380 fu16_t warnlevel;
381 fu16_t idletime;
382 fu16_t flags;
383 fu32_t membersince;
384 fu32_t onlinesince;
385 fu32_t sessionlen;
386 fu16_t capabilities;
387 struct {
388 fu16_t status;
389 fu32_t ipaddr;
390 fu8_t crap[0x25]; /* until we figure it out... */
391 } icqinfo;
bd71fa88 392};
393
a15d82b1 394#define AIM_FLAG_UNCONFIRMED 0x0001 /* "damned transients" */
395#define AIM_FLAG_ADMINISTRATOR 0x0002
396#define AIM_FLAG_AOL 0x0004
397#define AIM_FLAG_OSCAR_PAY 0x0008
398#define AIM_FLAG_FREE 0x0010
399#define AIM_FLAG_AWAY 0x0020
400#define AIM_FLAG_UNKNOWN40 0x0040
401#define AIM_FLAG_UNKNOWN80 0x0080
25aaf30e 402#define AIM_FLAG_UNKNOWN100 0x0100
403#define AIM_FLAG_UNKNOWN200 0x0200
404#define AIM_FLAG_ACTIVEBUDDY 0x0400
405#define AIM_FLAG_UNKNOWN800 0x0800
0c20631f 406
a15d82b1 407#define AIM_FLAG_ALLUSERS 0x001f
98c88242 408
37ee990e 409
24fbfcf3 410#if defined(FAIM_INTERNAL) || defined(FAIM_NEED_TLV)
bd71fa88 411/*
412 * TLV handling
413 */
414
415/* Generic TLV structure. */
d410cf58 416typedef struct aim_tlv_s {
417 fu16_t type;
418 fu16_t length;
419 fu8_t *value;
420} aim_tlv_t;
bd71fa88 421
422/* List of above. */
d410cf58 423typedef struct aim_tlvlist_s {
424 aim_tlv_t *tlv;
425 struct aim_tlvlist_s *next;
426} aim_tlvlist_t;
bd71fa88 427
428/* TLV-handling functions */
d410cf58 429
430#if 0
431/* Very, very raw TLV handling. */
432faim_internal int aim_puttlv_8(fu8_t *buf, const fu16_t t, const fu8_t v);
433faim_internal int aim_puttlv_16(fu8_t *buf, const fu16_t t, const fu16_t v);
434faim_internal int aim_puttlv_32(fu8_t *buf, const fu16_t t, const fu32_t v);
435faim_internal int aim_puttlv_raw(fu8_t *buf, const fu16_t t, const fu16_t l, const fu8_t *v);
436#endif
437
438/* TLV list handling. */
439faim_internal aim_tlvlist_t *aim_readtlvchain(aim_bstream_t *bs);
440faim_internal void aim_freetlvchain(aim_tlvlist_t **list);
441faim_internal aim_tlv_t *aim_gettlv(aim_tlvlist_t *, fu16_t t, const int n);
442faim_internal char *aim_gettlv_str(aim_tlvlist_t *, const fu16_t t, const int n);
443faim_internal fu8_t aim_gettlv8(aim_tlvlist_t *list, const fu16_t type, const int num);
444faim_internal fu16_t aim_gettlv16(aim_tlvlist_t *list, const fu16_t t, const int n);
445faim_internal fu32_t aim_gettlv32(aim_tlvlist_t *list, const fu16_t t, const int n);
446faim_internal int aim_writetlvchain(aim_bstream_t *bs, aim_tlvlist_t **list);
447faim_internal int aim_addtlvtochain16(aim_tlvlist_t **list, const fu16_t t, const fu16_t v);
448faim_internal int aim_addtlvtochain32(aim_tlvlist_t **list, const fu16_t type, const fu32_t v);
449faim_internal int aim_addtlvtochain_raw(aim_tlvlist_t **list, const fu16_t t, const fu16_t l, const fu8_t *v);
450faim_internal int aim_addtlvtochain_caps(aim_tlvlist_t **list, const fu16_t t, const fu16_t caps);
451faim_internal int aim_addtlvtochain_noval(aim_tlvlist_t **list, const fu16_t type);
603fdcaa 452faim_internal int aim_addtlvtochain_userinfo(aim_tlvlist_t **list, fu16_t type, struct aim_userinfo_s *ui);
d410cf58 453faim_internal int aim_addtlvtochain_frozentlvlist(aim_tlvlist_t **list, fu16_t type, aim_tlvlist_t **tl);
454faim_internal int aim_counttlvchain(aim_tlvlist_t **list);
603fdcaa 455faim_internal int aim_sizetlvchain(aim_tlvlist_t **list);
37ee990e 456#endif /* FAIM_INTERNAL */
bd71fa88 457
458/*
d410cf58 459 * Get command from connections
460 *
461 * aim_get_commmand() is the libfaim lowlevel I/O in the receive direction.
462 * XXX Make this easily overridable.
463 *
464 */
465faim_export int aim_get_command(aim_session_t *, aim_conn_t *);
466
467/*
468 * Dispatch commands that are in the rx queue.
bd71fa88 469 */
d410cf58 470faim_export void aim_rxdispatch(aim_session_t *);
7392c79f 471
d410cf58 472faim_export int aim_debugconn_sendconnect(aim_session_t *sess, aim_conn_t *conn);
7392c79f 473
d410cf58 474faim_export int aim_logoff(aim_session_t *);
bd71fa88 475
50038c74 476#if !defined(FAIM_INTERNAL) || defined(FAIM_INTERNAL_INSANE)
646c6b52 477/* the library should never call aim_conn_kill */
d410cf58 478faim_export void aim_conn_kill(aim_session_t *sess, aim_conn_t **deadconn);
50038c74 479#endif
bd71fa88 480
d410cf58 481typedef int (*aim_rxcallback_t)(aim_session_t *, aim_frame_t *, ...);
bd71fa88 482
bd71fa88 483/* aim_login.c */
d410cf58 484faim_export int aim_sendflapver(aim_session_t *sess, aim_conn_t *conn);
485faim_export int aim_request_login(aim_session_t *sess, aim_conn_t *conn, const char *sn);
486faim_export int aim_send_login(aim_session_t *, aim_conn_t *, const char *, const char *, struct client_info_s *, const char *key);
9f1a4013 487faim_export int aim_encode_password_md5(const char *password, const char *key, unsigned char *digest);
d410cf58 488faim_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);
78b3fb13 489faim_export int aim_gencookie(unsigned char *buf);
d410cf58 490faim_export int aim_sendserverready(aim_session_t *sess, aim_conn_t *conn);
491faim_export int aim_sendredirect(aim_session_t *sess, aim_conn_t *conn, fu16_t servid, const char *ip, const char *cookie);
492faim_export void aim_purge_rxqueue(aim_session_t *);
37ee990e 493
b8c79ca7 494#define AIM_TX_QUEUED 0 /* default */
495#define AIM_TX_IMMEDIATE 1
496#define AIM_TX_USER 2
d410cf58 497faim_export int aim_tx_setenqueue(aim_session_t *sess, int what, int (*func)(aim_session_t *, aim_frame_t *));
498
499faim_export int aim_tx_flushqueue(aim_session_t *);
500faim_export void aim_tx_purgequeue(aim_session_t *);
501
502faim_export int aim_conn_setlatency(aim_conn_t *conn, int newval);
503
504faim_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);
505faim_export int aim_clearhandlers(aim_conn_t *conn);
506
031c2fb3 507faim_export aim_conn_t *aim_conn_findbygroup(aim_session_t *sess, fu16_t group);
d410cf58 508faim_export aim_session_t *aim_conn_getsess(aim_conn_t *conn);
509faim_export void aim_conn_close(aim_conn_t *deadconn);
510faim_export aim_conn_t *aim_newconn(aim_session_t *, int type, const char *dest);
511faim_export int aim_conngetmaxfd(aim_session_t *);
512faim_export aim_conn_t *aim_select(aim_session_t *, struct timeval *, int *);
513faim_export int aim_conn_isready(aim_conn_t *);
514faim_export int aim_conn_setstatus(aim_conn_t *, int);
515faim_export int aim_conn_completeconnect(aim_session_t *sess, aim_conn_t *conn);
516faim_export int aim_conn_isconnecting(aim_conn_t *conn);
517
518typedef void (*faim_debugging_callback_t)(aim_session_t *sess, int level, const char *format, va_list va);
519faim_export int aim_setdebuggingcb(aim_session_t *sess, faim_debugging_callback_t);
520faim_export void aim_session_init(aim_session_t *, unsigned long flags, int debuglevel);
521faim_export void aim_session_kill(aim_session_t *);
522faim_export void aim_setupproxy(aim_session_t *sess, const char *server, const char *username, const char *password);
523faim_export aim_conn_t *aim_getconn_type(aim_session_t *, int type);
524faim_export aim_conn_t *aim_getconn_type_all(aim_session_t *, int type);
525faim_export aim_conn_t *aim_getconn_fd(aim_session_t *, int fd);
bd71fa88 526
527/* aim_misc.c */
528
529#define AIM_VISIBILITYCHANGE_PERMITADD 0x05
530#define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
531#define AIM_VISIBILITYCHANGE_DENYADD 0x07
532#define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08
533
98c88242 534#define AIM_PRIVFLAGS_ALLOWIDLE 0x01
535#define AIM_PRIVFLAGS_ALLOWMEMBERSINCE 0x02
536
537#define AIM_WARN_ANON 0x01
538
031c2fb3 539faim_export int aim_sendpauseack(aim_session_t *sess, aim_conn_t *conn);
d410cf58 540faim_export int aim_send_warning(aim_session_t *sess, aim_conn_t *conn, const char *destsn, fu32_t flags);
541faim_export int aim_bos_nop(aim_session_t *, aim_conn_t *);
542faim_export int aim_flap_nop(aim_session_t *sess, aim_conn_t *conn);
543faim_export int aim_bos_setidle(aim_session_t *, aim_conn_t *, fu32_t);
544faim_export int aim_bos_changevisibility(aim_session_t *, aim_conn_t *, int, const char *);
545faim_export int aim_bos_setbuddylist(aim_session_t *, aim_conn_t *, const char *);
546faim_export int aim_bos_setprofile(aim_session_t *sess, aim_conn_t *conn, const char *profile, const char *awaymsg, fu16_t caps);
547faim_export int aim_bos_setgroupperm(aim_session_t *, aim_conn_t *, fu32_t mask);
548faim_export int aim_bos_clientready(aim_session_t *, aim_conn_t *);
549faim_export int aim_bos_reqrate(aim_session_t *, aim_conn_t *);
550faim_export int aim_bos_ackrateresp(aim_session_t *, aim_conn_t *);
551faim_export int aim_bos_setprivacyflags(aim_session_t *, aim_conn_t *, fu32_t);
552faim_export int aim_bos_reqpersonalinfo(aim_session_t *, aim_conn_t *);
553faim_export int aim_bos_reqservice(aim_session_t *, aim_conn_t *, fu16_t);
554faim_export int aim_bos_reqrights(aim_session_t *, aim_conn_t *);
555faim_export int aim_bos_reqbuddyrights(aim_session_t *, aim_conn_t *);
556faim_export int aim_bos_reqlocaterights(aim_session_t *, aim_conn_t *);
557faim_export int aim_setversions(aim_session_t *sess, aim_conn_t *conn);
558faim_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);
559faim_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);
560faim_export int aim_icq_setstatus(aim_session_t *sess, aim_conn_t *conn, fu32_t status);
561
562faim_export struct aim_fileheader_t *aim_getlisting(aim_session_t *sess, FILE *);
37ee990e 563
9d83220c 564#define AIM_CLIENTTYPE_UNKNOWN 0x0000
565#define AIM_CLIENTTYPE_MC 0x0001
566#define AIM_CLIENTTYPE_WINAIM 0x0002
567#define AIM_CLIENTTYPE_WINAIM41 0x0003
568#define AIM_CLIENTTYPE_AOL_TOC 0x0004
569faim_export unsigned short aim_fingerprintclient(unsigned char *msghdr, int len);
570
275a2ff8 571#define AIM_RATE_CODE_CHANGE 0x0001
572#define AIM_RATE_CODE_WARNING 0x0002
573#define AIM_RATE_CODE_LIMIT 0x0003
574#define AIM_RATE_CODE_CLEARLIMIT 0x0004
d410cf58 575faim_export int aim_ads_clientready(aim_session_t *sess, aim_conn_t *conn);
576faim_export int aim_ads_requestads(aim_session_t *sess, aim_conn_t *conn);
37ee990e 577
bd71fa88 578/* aim_im.c */
7392c79f 579
7392c79f 580struct aim_fileheader_t {
581#if 0
d410cf58 582 char magic[4]; /* 0 */
583 short hdrlen; /* 4 */
584 short hdrtype; /* 6 */
7392c79f 585#endif
d410cf58 586 char bcookie[8]; /* 8 */
587 short encrypt; /* 16 */
588 short compress; /* 18 */
589 short totfiles; /* 20 */
590 short filesleft; /* 22 */
591 short totparts; /* 24 */
592 short partsleft; /* 26 */
593 long totsize; /* 28 */
594 long size; /* 32 */
595 long modtime; /* 36 */
596 long checksum; /* 40 */
597 long rfrcsum; /* 44 */
598 long rfsize; /* 48 */
599 long cretime; /* 52 */
600 long rfcsum; /* 56 */
601 long nrecvd; /* 60 */
602 long recvcsum; /* 64 */
603 char idstring[32]; /* 68 */
604 char flags; /* 100 */
605 char lnameoffset; /* 101 */
606 char lsizeoffset; /* 102 */
607 char dummy[69]; /* 103 */
608 char macfileinfo[16]; /* 172 */
609 short nencode; /* 188 */
610 short nlanguage; /* 190 */
611 char name[64]; /* 192 */
612 /* 256 */
7392c79f 613};
614
615struct aim_filetransfer_priv {
1dcd23dd 616 char sn[MAXSNLEN];
617 char cookie[8];
618 char ip[30];
619 int state;
620 struct aim_fileheader_t fh;
040457cc 621};
7392c79f 622
7b91722d 623struct aim_chat_roominfo {
1dcd23dd 624 unsigned short exchange;
625 char *name;
626 unsigned short instance;
7b91722d 627};
37ee990e 628
84e0ca17 629#define AIM_IMFLAGS_AWAY 0x0001 /* mark as an autoreply */
630#define AIM_IMFLAGS_ACK 0x0002 /* request a receipt notice */
631#define AIM_IMFLAGS_UNICODE 0x0004
632#define AIM_IMFLAGS_ISO_8859_1 0x0008
633#define AIM_IMFLAGS_BUDDYREQ 0x0010 /* buddy icon requested */
634#define AIM_IMFLAGS_HASICON 0x0020 /* already has icon */
635#define AIM_IMFLAGS_SUBENC_MACINTOSH 0x0040 /* damn that Steve Jobs! */
636#define AIM_IMFLAGS_CUSTOMFEATURES 0x0080 /* features field present */
637#define AIM_IMFLAGS_EXTDATA 0x0100
603fdcaa 638#define AIM_IMFLAGS_CUSTOMCHARSET 0x0200 /* charset fields set */
639#define AIM_IMFLAGS_MULTIPART 0x0400 /* ->mpmsg section valid */
7b91722d 640
603fdcaa 641/*
642 * Multipart message structures.
643 */
644typedef struct aim_mpmsg_section_s {
645 fu16_t charset;
646 fu16_t charsubset;
647 fu8_t *data;
648 fu16_t datalen;
649 struct aim_mpmsg_section_s *next;
650} aim_mpmsg_section_t;
651
652typedef struct aim_mpmsg_s {
653 int numparts;
654 aim_mpmsg_section_t *parts;
655} aim_mpmsg_t;
656
657faim_export int aim_mpmsg_init(aim_session_t *sess, aim_mpmsg_t *mpm);
658faim_export int aim_mpmsg_addraw(aim_session_t *sess, aim_mpmsg_t *mpm, fu16_t charset, fu16_t charsubset, const fu8_t *data, fu16_t datalen);
659faim_export int aim_mpmsg_addascii(aim_session_t *sess, aim_mpmsg_t *mpm, const char *ascii);
660faim_export int aim_mpmsg_addunicode(aim_session_t *sess, aim_mpmsg_t *mpm, const fu16_t *unicode, fu16_t unicodelen);
661faim_export void aim_mpmsg_free(aim_session_t *sess, aim_mpmsg_t *mpm);
662
663/*
664 * Arguments to aim_send_im_ext().
665 *
666 * This is really complicated. But immensely versatile.
667 *
668 */
7b91722d 669struct aim_sendimext_args {
84e0ca17 670
671 /* These are _required_ */
1dcd23dd 672 const char *destsn;
603fdcaa 673 fu32_t flags; /* often 0 */
674
675 /* Only required if not using multipart messages */
1dcd23dd 676 const char *msg;
677 int msglen;
84e0ca17 678
603fdcaa 679 /* Required if ->msg is not provided */
680 aim_mpmsg_t *mpmsg;
681
84e0ca17 682 /* Only used if AIM_IMFLAGS_HASICON is set */
683 fu32_t iconlen;
1dcd23dd 684 time_t iconstamp;
84e0ca17 685 fu32_t iconsum;
686
687 /* Only used if AIM_IMFLAGS_CUSTOMFEATURES is set */
688 fu8_t *features;
689 fu8_t featureslen;
603fdcaa 690
691 /* Only used if AIM_IMFLAGS_CUSTOMCHARSET is set and mpmsg not used */
692 fu16_t charset;
693 fu16_t charsubset;
7b91722d 694};
695
603fdcaa 696/*
697 * This information is provided in the Incoming ICBM callback for
698 * Channel 1 ICBM's.
699 *
700 * Note that although CUSTOMFEATURES and CUSTOMCHARSET say they
701 * are optional, both are always set by the current libfaim code.
702 * That may or may not change in the future. It is mainly for
703 * consistency with aim_sendimext_args.
704 *
705 * Multipart messages require some explanation. If you want to use them,
706 * I suggest you read all the comments in im.c.
707 *
708 */
7b91722d 709struct aim_incomingim_ch1_args {
84e0ca17 710
711 /* Always provided */
603fdcaa 712 aim_mpmsg_t mpmsg;
713 fu32_t icbmflags; /* some flags apply only to ->msg, not all mpmsg */
714
715 /* Only provided if message has a human-readable section */
1dcd23dd 716 char *msg;
717 int msglen;
84e0ca17 718
719 /* Only provided if AIM_IMFLAGS_HASICON is set */
1dcd23dd 720 time_t iconstamp;
84e0ca17 721 fu32_t iconlen;
722 fu32_t iconsum;
723
724 /* Only provided if AIM_IMFLAGS_CUSTOMFEATURES is set */
725 fu8_t *features;
726 fu8_t featureslen;
727
728 /* Only provided if AIM_IMFLAGS_EXTDATA is set */
729 fu8_t extdatalen;
730 fu8_t *extdata;
603fdcaa 731
732 /* Only used if AIM_IMFLAGS_CUSTOMCHARSET is set */
733 fu16_t charset;
734 fu16_t charsubset;
7b91722d 735};
37ee990e 736
7b91722d 737struct aim_incomingim_ch2_args {
c5f5b7f1 738 fu8_t cookie[8];
739 fu16_t reqclass;
740 fu16_t status;
1dcd23dd 741 union {
742 struct {
e1b8c575 743 fu32_t checksum;
744 fu32_t length;
1dcd23dd 745 time_t timestamp;
e1b8c575 746 fu8_t *icon;
1dcd23dd 747 } icon;
748 struct {
749 } voice;
c5f5b7f1 750 struct {
751 fu8_t ip[22]; /* xxx.xxx.xxx.xxx:xxxxx\0 */
752 } imimage;
1dcd23dd 753 struct {
754 char *msg;
755 char *encoding;
756 char *lang;
757 struct aim_chat_roominfo roominfo;
758 } chat;
759 struct {
760 char *ip;
761 unsigned char *cookie;
762 } getfile;
763 struct {
764 } sendfile;
765 } info;
7b91722d 766};
767
d410cf58 768faim_export int aim_send_im_ext(aim_session_t *sess, aim_conn_t *conn, struct aim_sendimext_args *args);
769faim_export int aim_send_im(aim_session_t *, aim_conn_t *, const char *destsn, unsigned short flags, const char *msg);
e1b8c575 770faim_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);
771faim_export fu32_t aim_iconsum(const fu8_t *buf, int buflen);
d410cf58 772faim_export int aim_send_im_direct(aim_session_t *, aim_conn_t *, const char *msg);
c5f5b7f1 773faim_export const char *aim_directim_getsn(aim_conn_t *conn);
774faim_export aim_conn_t *aim_directim_initiate(aim_session_t *, aim_conn_t *, const char *destsn);
775faim_export aim_conn_t *aim_directim_connect(aim_session_t *, const char *sn, const char *addr, const fu8_t *cookie);
37ee990e 776
d410cf58 777faim_export aim_conn_t *aim_getfile_initiate(aim_session_t *sess, aim_conn_t *conn, const char *destsn);
778faim_export int aim_oft_getfile_request(aim_session_t *sess, aim_conn_t *conn, const char *name, int size);
779faim_export int aim_oft_getfile_ack(aim_session_t *sess, aim_conn_t *conn);
780faim_export int aim_oft_getfile_end(aim_session_t *sess, aim_conn_t *conn);
37ee990e 781
782/* aim_info.c */
f7bb124a 783#define AIM_CAPS_BUDDYICON 0x0001
784#define AIM_CAPS_VOICE 0x0002
785#define AIM_CAPS_IMIMAGE 0x0004
786#define AIM_CAPS_CHAT 0x0008
787#define AIM_CAPS_GETFILE 0x0010
788#define AIM_CAPS_SENDFILE 0x0020
789#define AIM_CAPS_GAMES 0x0040
790#define AIM_CAPS_SAVESTOCKS 0x0080
791#define AIM_CAPS_SENDBUDDYLIST 0x0100
792#define AIM_CAPS_GAMES2 0x0200
793#define AIM_CAPS_LAST 0x8000
37ee990e 794
d410cf58 795faim_export int aim_0002_000b(aim_session_t *sess, aim_conn_t *conn, const char *sn);
d2698e03 796
797#define AIM_SENDMEMBLOCK_FLAG_ISREQUEST 0
798#define AIM_SENDMEMBLOCK_FLAG_ISHASH 1
799
d410cf58 800faim_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);
e80a0fa9 801
37ee990e 802#define AIM_GETINFO_GENERALINFO 0x00001
803#define AIM_GETINFO_AWAYMESSAGE 0x00003
804
37ee990e 805struct aim_invite_priv {
d410cf58 806 char *sn;
807 char *roomname;
808 fu16_t exchange;
809 fu16_t instance;
37ee990e 810};
811
7392c79f 812#define AIM_COOKIETYPE_UNKNOWN 0x00
813#define AIM_COOKIETYPE_ICBM 0x01
814#define AIM_COOKIETYPE_ADS 0x02
815#define AIM_COOKIETYPE_BOS 0x03
816#define AIM_COOKIETYPE_IM 0x04
817#define AIM_COOKIETYPE_CHAT 0x05
818#define AIM_COOKIETYPE_CHATNAV 0x06
37ee990e 819#define AIM_COOKIETYPE_INVITE 0x07
7392c79f 820/* we'll move OFT up a bit to give breathing room. not like it really
821 * matters. */
822#define AIM_COOKIETYPE_OFTIM 0x10
823#define AIM_COOKIETYPE_OFTGET 0x11
824#define AIM_COOKIETYPE_OFTSEND 0x12
825#define AIM_COOKIETYPE_OFTVOICE 0x13
826#define AIM_COOKIETYPE_OFTIMAGE 0x14
827#define AIM_COOKIETYPE_OFTICON 0x15
828
d410cf58 829faim_export int aim_handlerendconnect(aim_session_t *sess, aim_conn_t *cur);
040457cc 830
831#define AIM_TRANSFER_DENY_NOTSUPPORTED 0x0000
832#define AIM_TRANSFER_DENY_DECLINE 0x0001
833#define AIM_TRANSFER_DENY_NOTACCEPTING 0x0002
d410cf58 834faim_export int aim_denytransfer(aim_session_t *sess, aim_conn_t *conn, const char *sender, const char *cookie, unsigned short code);
835faim_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);
78b3fb13 836
d410cf58 837faim_export int aim_getinfo(aim_session_t *, aim_conn_t *, const char *, unsigned short);
838faim_export int aim_sendbuddyoncoming(aim_session_t *sess, aim_conn_t *conn, struct aim_userinfo_s *info);
839faim_export int aim_sendbuddyoffgoing(aim_session_t *sess, aim_conn_t *conn, const char *sn);
37ee990e 840
355229fe 841#define AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED 0x00000001
842#define AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED 0x00000002
843
844/* This is what the server will give you if you don't set them yourself. */
845#define AIM_IMPARAM_DEFAULTS { \
846 0, \
847 AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
848 512, /* !! Note how small this is. */ \
849 (99.9)*10, (99.9)*10, \
850 1000 \
851}
852
853/* This is what most AIM versions use. */
854#define AIM_IMPARAM_REASONABLE { \
855 0, \
856 AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
857 8000, \
858 (99.9)*10, (99.9)*10, \
859 0 \
860}
861
862
863struct aim_icbmparameters {
864 unsigned short maxchan;
865 unsigned long flags; /* AIM_IMPARAM_FLAG_ */
866 unsigned short maxmsglen; /* message size that you will accept */
867 unsigned short maxsenderwarn; /* this and below are *10 (999=99.9%) */
868 unsigned short maxrecverwarn;
869 unsigned long minmsginterval; /* in milliseconds? */
870};
871
d410cf58 872faim_export int aim_reqicbmparams(aim_session_t *sess, aim_conn_t *conn);
873faim_export int aim_seticbmparam(aim_session_t *sess, aim_conn_t *conn, struct aim_icbmparameters *params);
355229fe 874
f1a5efe0 875
d410cf58 876/* auth.c */
877faim_export int aim_auth_sendcookie(aim_session_t *, aim_conn_t *, const fu8_t *);
878
879faim_export int aim_auth_clientready(aim_session_t *, aim_conn_t *);
880faim_export int aim_auth_changepasswd(aim_session_t *, aim_conn_t *, const char *newpw, const char *curpw);
881faim_export int aim_auth_setversions(aim_session_t *sess, aim_conn_t *conn);
882faim_export int aim_auth_reqconfirm(aim_session_t *sess, aim_conn_t *conn);
883faim_export int aim_auth_getinfo(aim_session_t *sess, aim_conn_t *conn, fu16_t info);
884faim_export int aim_auth_setemail(aim_session_t *sess, aim_conn_t *conn, const char *newemail);
bd71fa88 885
886/* aim_buddylist.c */
d410cf58 887faim_export int aim_add_buddy(aim_session_t *, aim_conn_t *, const char *);
888faim_export int aim_remove_buddy(aim_session_t *, aim_conn_t *, const char *);
37ee990e 889
bd71fa88 890/* aim_search.c */
d410cf58 891faim_export int aim_usersearch_address(aim_session_t *, aim_conn_t *, const char *);
bd71fa88 892
37ee990e 893struct aim_chat_exchangeinfo {
d410cf58 894 fu16_t number;
895 char *name;
896 char *charset1;
897 char *lang1;
898 char *charset2;
899 char *lang2;
37ee990e 900};
901
a2244dd9 902#define AIM_CHATFLAGS_NOREFLECT 0x0001
903#define AIM_CHATFLAGS_AWAY 0x0002
d410cf58 904faim_export int aim_chat_send_im(aim_session_t *sess, aim_conn_t *conn, fu16_t flags, const char *msg, int msglen);
905faim_export int aim_chat_join(aim_session_t *sess, aim_conn_t *conn, fu16_t exchange, const char *roomname, fu16_t instance);
906faim_export int aim_chat_clientready(aim_session_t *sess, aim_conn_t *conn);
907faim_export int aim_chat_attachname(aim_conn_t *conn, const char *roomname);
908faim_export char *aim_chat_getname(aim_conn_t *conn);
909faim_export aim_conn_t *aim_chat_getconn(aim_session_t *, const char *name);
78b3fb13 910
d410cf58 911faim_export int aim_chatnav_reqrights(aim_session_t *sess, aim_conn_t *conn);
912faim_export int aim_chatnav_clientready(aim_session_t *sess, aim_conn_t *conn);
78b3fb13 913
d410cf58 914faim_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);
0c20631f 915
d410cf58 916faim_export int aim_chatnav_createroom(aim_session_t *sess, aim_conn_t *conn, const char *name, fu16_t exchange);
917faim_export int aim_chat_leaveroom(aim_session_t *sess, const char *name);
0c20631f 918
bd71fa88 919/* aim_util.c */
f1a5efe0 920/*
921 * These are really ugly. You'd think this was LISP. I wish it was.
d410cf58 922 *
923 * XXX With the advent of bstream's, these should be removed to enforce
924 * their use.
925 *
f1a5efe0 926 */
927#define aimutil_put8(buf, data) ((*(buf) = (u_char)(data)&0xff),1)
928#define aimutil_get8(buf) ((*(buf))&0xff)
929#define aimutil_put16(buf, data) ( \
d410cf58 930 (*(buf) = (u_char)((data)>>8)&0xff), \
931 (*((buf)+1) = (u_char)(data)&0xff), \
932 2)
f1a5efe0 933#define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
934#define aimutil_put32(buf, data) ( \
d410cf58 935 (*((buf)) = (u_char)((data)>>24)&0xff), \
936 (*((buf)+1) = (u_char)((data)>>16)&0xff), \
937 (*((buf)+2) = (u_char)((data)>>8)&0xff), \
938 (*((buf)+3) = (u_char)(data)&0xff), \
939 4)
f1a5efe0 940#define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
d410cf58 941 (((*((buf)+1))<<16)&0x00ff0000) + \
942 (((*((buf)+2))<< 8)&0x0000ff00) + \
943 (((*((buf)+3) )&0x000000ff)))
f1a5efe0 944
78b3fb13 945faim_export int aimutil_putstr(u_char *, const char *, int);
946faim_export int aimutil_tokslen(char *toSearch, int index, char dl);
947faim_export int aimutil_itemcnt(char *toSearch, char dl);
948faim_export char *aimutil_itemidx(char *toSearch, int index, char dl);
bd71fa88 949
78b3fb13 950faim_export int aim_snlen(const char *sn);
951faim_export int aim_sncmp(const char *sn1, const char *sn2);
e6b05d80 952
a3619f23 953/* for libc's that dont have it */
78b3fb13 954faim_export char *aim_strsep(char **pp, const char *delim);
a3619f23 955
0cc57340 956/* aim_meta.c */
78b3fb13 957faim_export char *aim_getbuilddate(void);
958faim_export char *aim_getbuildtime(void);
00ef5271 959faim_export int aim_getbuildstring(char *buf, int buflen);
37ee990e 960
9e8c4225 961#include <aim_internal.h>
0cc57340 962
bd71fa88 963#endif /* __AIM_H__ */
964
git-cvsimport mirror of libfaim
This page took 0.343072 seconds and 5 git commands to generate.