source: protocols/oscar/aim.h @ ea85a0b

Last change on this file since ea85a0b was b7d3cc34, checked in by Wilmer van der Gaast <wilmer@…>, at 2005-11-06T18:23:18Z

Initial repository (0.99 release tree)
  • Property mode set to 100644
File size: 29.2 KB
Line 
1/*
2 * Main libfaim header.  Must be included in client for prototypes/macros.
3 *
4 * "come on, i turned a chick lesbian; i think this is the hackish equivalent"
5 *                                                -- Josh Meyer
6 *
7 */
8
9#ifndef __AIM_H__
10#define __AIM_H__
11
12#include <stdio.h>
13#include <string.h>
14#include <fcntl.h>
15#include <sys/types.h>
16#include <stdlib.h>
17#include <stdarg.h>
18#include <errno.h>
19#include <time.h>
20#include <gmodule.h>
21
22#include "bitlbee.h"
23
24/* XXX adjust these based on autoconf-detected platform */
25typedef guint32 aim_snacid_t;
26typedef guint16 flap_seqnum_t;
27
28/* Portability stuff (DMP) */
29
30#if defined(mach) && defined(__APPLE__)
31#define gethostbyname(x) gethostbyname2(x, AF_INET)
32#endif
33
34/*
35 * Current Maximum Length for Screen Names (not including NULL)
36 *
37 * Currently only names up to 16 characters can be registered
38 * however it is aparently legal for them to be larger.
39 */
40#define MAXSNLEN 32
41
42/*
43 * Current Maximum Length for Instant Messages
44 *
45 * This was found basically by experiment, but not wholly
46 * accurate experiment.  It should not be regarded
47 * as completely correct.  But its a decent approximation.
48 *
49 * Note that although we can send this much, its impossible
50 * for WinAIM clients (up through the latest (4.0.1957)) to
51 * send any more than 1kb.  Amaze all your windows friends
52 * with utterly oversized instant messages!
53 *
54 * XXX: the real limit is the total SNAC size at 8192. Fix this.
55 *
56 */
57#define MAXMSGLEN 7987
58
59/*
60 * Maximum size of a Buddy Icon.
61 */
62#define MAXICONLEN 7168
63#define AIM_ICONIDENT "AVT1picture.id"
64
65/*
66 * Current Maximum Length for Chat Room Messages
67 *
68 * This is actually defined by the protocol to be
69 * dynamic, but I have yet to see due cause to
70 * define it dynamically here.  Maybe later.
71 *
72 */
73#define MAXCHATMSGLEN 512
74
75/*
76 * Standard size of an AIM authorization cookie
77 */
78#define AIM_COOKIELEN            0x100
79
80#define AIM_MD5_STRING "AOL Instant Messenger (SM)"
81
82/*
83 * Default Authorizer server name and TCP port for the OSCAR farm. 
84 *
85 * You shouldn't need to change this unless you're writing
86 * your own server.
87 *
88 * Note that only one server is needed to start the whole
89 * AIM process.  The later server addresses come from
90 * the authorizer service.
91 *
92 * This is only here for convenience.  Its still up to
93 * the client to connect to it.
94 *
95 */
96#define AIM_DEFAULT_LOGIN_SERVER "login.oscar.aol.com"
97#define AIM_LOGIN_PORT 5190
98
99/*
100 * Size of the SNAC caching hash.
101 *
102 * Default: 16
103 *
104 */
105#define AIM_SNAC_HASH_SIZE 16
106
107/*
108 * Client info.  Filled in by the client and passed in to
109 * aim_send_login().  The information ends up getting passed to OSCAR
110 * through the initial login command.
111 *
112 */
113struct client_info_s {
114        const char *clientstring;
115        guint16 clientid;
116        int major;
117        int minor;
118        int point;
119        int build;
120        const char *country; /* two-letter abbrev */
121        const char *lang; /* two-letter abbrev */
122};
123
124#define AIM_CLIENTINFO_KNOWNGOOD_3_5_1670 { \
125        "AOL Instant Messenger (SM), version 3.5.1670/WIN32", \
126        0x0004, \
127        0x0003, \
128        0x0005, \
129        0x0000, \
130        0x0686, \
131        "us", \
132        "en", \
133}
134
135#define AIM_CLIENTINFO_KNOWNGOOD_4_1_2010 { \
136          "AOL Instant Messenger (SM), version 4.1.2010/WIN32", \
137          0x0004, \
138          0x0004, \
139          0x0001, \
140          0x0000, \
141          0x07da, \
142          "us", \
143          "en", \
144}
145
146/*
147 * I would make 4.1.2010 the default, but they seem to have found
148 * an alternate way of breaking that one.
149 *
150 * 3.5.1670 should work fine, however, you will be subjected to the
151 * memory test, which may require you to have a WinAIM binary laying
152 * around. (see login.c::memrequest())
153 */
154#define AIM_CLIENTINFO_KNOWNGOOD AIM_CLIENTINFO_KNOWNGOOD_3_5_1670
155
156#ifndef TRUE
157#define TRUE 1
158#define FALSE 0
159#endif
160
161/*
162 * These could be arbitrary, but its easier to use the actual AIM values
163 */
164#define AIM_CONN_TYPE_AUTH          0x0007
165#define AIM_CONN_TYPE_ADS           0x0005
166#define AIM_CONN_TYPE_BOS           0x0002
167#define AIM_CONN_TYPE_CHAT          0x000e
168#define AIM_CONN_TYPE_CHATNAV       0x000d
169
170/* they start getting arbitrary in rendezvous stuff =) */
171#define AIM_CONN_TYPE_RENDEZVOUS    0x0101 /* these do not speak FLAP! */
172#define AIM_CONN_TYPE_RENDEZVOUS_OUT 0x0102 /* socket waiting for accept() */
173
174/*
175 * Subtypes, we need these for OFT stuff.
176 */
177#define AIM_CONN_SUBTYPE_OFT_DIRECTIM  0x0001
178#define AIM_CONN_SUBTYPE_OFT_GETFILE   0x0002
179#define AIM_CONN_SUBTYPE_OFT_SENDFILE  0x0003
180#define AIM_CONN_SUBTYPE_OFT_BUDDYICON 0x0004
181#define AIM_CONN_SUBTYPE_OFT_VOICE     0x0005
182
183/*
184 * Status values returned from aim_conn_new().  ORed together.
185 */
186#define AIM_CONN_STATUS_READY       0x0001
187#define AIM_CONN_STATUS_INTERNALERR 0x0002
188#define AIM_CONN_STATUS_RESOLVERR   0x0040
189#define AIM_CONN_STATUS_CONNERR     0x0080
190#define AIM_CONN_STATUS_INPROGRESS  0x0100
191
192#define AIM_FRAMETYPE_FLAP 0x0000
193#define AIM_FRAMETYPE_OFT  0x0001
194
195/*
196 * message type flags
197 */
198#define AIM_MTYPE_PLAIN     0x01
199#define AIM_MTYPE_CHAT      0x02
200#define AIM_MTYPE_FILEREQ   0x03
201#define AIM_MTYPE_URL       0x04
202#define AIM_MTYPE_AUTHREQ   0x06
203#define AIM_MTYPE_AUTHDENY  0x07
204#define AIM_MTYPE_AUTHOK    0x08
205#define AIM_MTYPE_SERVER    0x09
206#define AIM_MTYPE_ADDED     0x0C
207#define AIM_MTYPE_WWP       0x0D
208#define AIM_MTYPE_EEXPRESS  0x0E
209#define AIM_MTYPE_CONTACTS  0x13
210#define AIM_MTYPE_PLUGIN    0x1A
211#define AIM_MTYPE_AUTOAWAY      0xE8
212#define AIM_MTYPE_AUTOBUSY      0xE9
213#define AIM_MTYPE_AUTONA        0xEA
214#define AIM_MTYPE_AUTODND       0xEB
215#define AIM_MTYPE_AUTOFFC       0xEC
216
217typedef struct aim_conn_s {
218        int fd;
219        guint16 type;
220        guint16 subtype;
221        flap_seqnum_t seqnum;
222        guint32 status;
223        void *priv; /* misc data the client may want to store */
224        void *internal; /* internal conn-specific libfaim data */
225        time_t lastactivity; /* time of last transmit */
226        int forcedlatency; 
227        void *handlerlist;
228        void *sessv; /* pointer to parent session */
229        void *inside; /* only accessible from inside libfaim */
230        struct aim_conn_s *next;
231} aim_conn_t;
232
233/*
234 * Byte Stream type. Sort of.
235 *
236 * Use of this type serves a couple purposes:
237 *   - Buffer/buflen pairs are passed all around everywhere. This turns
238 *     that into one value, as well as abstracting it slightly.
239 *   - Through the abstraction, it is possible to enable bounds checking
240 *     for robustness at the cost of performance.  But a clean failure on
241 *     weird packets is much better than a segfault.
242 *   - I like having variables named "bs".
243 *
244 * Don't touch the insides of this struct.  Or I'll have to kill you.
245 *
246 */
247typedef struct aim_bstream_s {
248        guint8 *data;
249        guint32 len;
250        guint32 offset;
251} aim_bstream_t;
252
253typedef struct aim_frame_s {
254        guint8 hdrtype; /* defines which piece of the union to use */
255        union {
256                struct { 
257                        guint8 type;
258                        flap_seqnum_t seqnum;     
259                } flap;
260                struct {
261                        guint16 type;
262                        guint8 magic[4]; /* ODC2 OFT2 */
263                        guint16 hdr2len;
264                        guint8 *hdr2; /* rest of bloated header */
265                } oft;
266        } hdr;
267        aim_bstream_t data;     /* payload stream */
268        guint8 handled;         /* 0 = new, !0 = been handled */
269        guint8 nofree;          /* 0 = free data on purge, 1 = only unlink */
270        aim_conn_t *conn;  /* the connection it came in on... */
271        struct aim_frame_s *next;
272} aim_frame_t;
273
274typedef struct aim_msgcookie_s {
275        unsigned char cookie[8];
276        int type;
277        void *data;
278        time_t addtime;
279        struct aim_msgcookie_s *next;
280} aim_msgcookie_t;
281
282/*
283 * AIM Session: The main client-data interface. 
284 *
285 */
286typedef struct aim_session_s {
287
288        /* ---- Client Accessible ------------------------ */
289
290        /* Our screen name. */
291        char sn[MAXSNLEN+1];
292
293        /*
294         * Pointer to anything the client wants to
295         * explicitly associate with this session.
296         *
297         * This is for use in the callbacks mainly. In any
298         * callback, you can access this with sess->aux_data.
299         *
300         */
301        void *aux_data;
302
303        /* ---- Internal Use Only ------------------------ */
304
305        /* Server-stored information (ssi) */
306        struct {
307                int received_data;
308                guint16 revision;
309                struct aim_ssi_item *items;
310                time_t timestamp;
311                int waiting_for_ack;
312                aim_frame_t *holding_queue;
313        } ssi;
314
315        /* Connection information */
316        aim_conn_t *connlist;
317
318        /*
319         * Transmit/receive queues.
320         *
321         * These are only used when you don't use your own lowlevel
322         * I/O.  I don't suggest that you use libfaim's internal I/O.
323         * Its really bad and the API/event model is quirky at best.
324         * 
325         */
326        aim_frame_t *queue_outgoing;   
327        aim_frame_t *queue_incoming; 
328
329        /*
330         * Tx Enqueuing function.
331         *
332         * This is how you override the transmit direction of libfaim's
333         * internal I/O.  This function will be called whenever it needs
334         * to send something.
335         *
336         */
337        int (*tx_enqueue)(struct aim_session_s *, aim_frame_t *);
338
339        /*
340         * Outstanding snac handling
341         *
342         * XXX: Should these be per-connection? -mid
343         */
344        void *snac_hash[AIM_SNAC_HASH_SIZE];
345        aim_snacid_t snacid_next;
346
347        struct aim_icq_info *icq_info;
348        struct aim_oft_info *oft_info;
349        struct aim_authresp_info *authinfo;
350        struct aim_emailinfo *emailinfo;
351
352        struct {
353                struct aim_userinfo_s *userinfo;
354                struct userinfo_node *torequest;
355                struct userinfo_node *requested;
356                int waiting_for_response;
357        } locate;
358
359        guint32 flags; /* AIM_SESS_FLAGS_ */
360
361        aim_msgcookie_t *msgcookies;
362
363        void *modlistv;
364
365        guint8 aim_icq_state;  /* ICQ representation of away state */
366} aim_session_t;
367
368/* Values for sess->flags */
369#define AIM_SESS_FLAGS_SNACLOGIN         0x00000001
370#define AIM_SESS_FLAGS_XORLOGIN          0x00000002
371#define AIM_SESS_FLAGS_NONBLOCKCONNECT   0x00000004
372#define AIM_SESS_FLAGS_DONTTIMEOUTONICBM 0x00000008
373
374/* Valid for calling aim_icq_setstatus() and for aim_userinfo_t->icqinfo.status */
375#define AIM_ICQ_STATE_NORMAL    0x00000000
376#define AIM_ICQ_STATE_AWAY      0x00000001
377#define AIM_ICQ_STATE_DND       0x00000002
378#define AIM_ICQ_STATE_OUT       0x00000004
379#define AIM_ICQ_STATE_BUSY      0x00000010
380#define AIM_ICQ_STATE_CHAT      0x00000020
381#define AIM_ICQ_STATE_INVISIBLE 0x00000100
382#define AIM_ICQ_STATE_WEBAWARE  0x00010000
383#define AIM_ICQ_STATE_HIDEIP            0x00020000
384#define AIM_ICQ_STATE_BIRTHDAY          0x00080000
385#define AIM_ICQ_STATE_DIRECTDISABLED    0x00100000
386#define AIM_ICQ_STATE_ICQHOMEPAGE       0x00200000
387#define AIM_ICQ_STATE_DIRECTREQUIREAUTH 0x10000000
388#define AIM_ICQ_STATE_DIRECTCONTACTLIST 0x20000000
389
390/*
391 * AIM User Info, Standard Form.
392 */
393typedef struct {
394        char sn[MAXSNLEN+1];
395        guint16 warnlevel;
396        guint16 idletime;
397        guint16 flags;
398        guint32 membersince;
399        guint32 onlinesince;
400        guint32 sessionlen; 
401        guint32 capabilities;
402        struct {
403                guint32 status;
404                guint32 ipaddr;
405                guint8 crap[0x25]; /* until we figure it out... */
406        } icqinfo;
407        guint32 present;
408} aim_userinfo_t;
409
410#define AIM_USERINFO_PRESENT_FLAGS        0x00000001
411#define AIM_USERINFO_PRESENT_MEMBERSINCE  0x00000002
412#define AIM_USERINFO_PRESENT_ONLINESINCE  0x00000004
413#define AIM_USERINFO_PRESENT_IDLE         0x00000008
414#define AIM_USERINFO_PRESENT_ICQEXTSTATUS 0x00000010
415#define AIM_USERINFO_PRESENT_ICQIPADDR    0x00000020
416#define AIM_USERINFO_PRESENT_ICQDATA      0x00000040
417#define AIM_USERINFO_PRESENT_CAPABILITIES 0x00000080
418#define AIM_USERINFO_PRESENT_SESSIONLEN   0x00000100
419
420const char *aim_userinfo_sn(aim_userinfo_t *ui);
421guint16 aim_userinfo_flags(aim_userinfo_t *ui);
422guint16 aim_userinfo_idle(aim_userinfo_t *ui);
423float aim_userinfo_warnlevel(aim_userinfo_t *ui);
424time_t aim_userinfo_membersince(aim_userinfo_t *ui);
425time_t aim_userinfo_onlinesince(aim_userinfo_t *ui);
426guint32 aim_userinfo_sessionlen(aim_userinfo_t *ui);
427int aim_userinfo_hascap(aim_userinfo_t *ui, guint32 cap);
428
429#define AIM_FLAG_UNCONFIRMED    0x0001 /* "damned transients" */
430#define AIM_FLAG_ADMINISTRATOR  0x0002
431#define AIM_FLAG_AOL            0x0004
432#define AIM_FLAG_OSCAR_PAY      0x0008
433#define AIM_FLAG_FREE           0x0010
434#define AIM_FLAG_AWAY           0x0020
435#define AIM_FLAG_ICQ            0x0040
436#define AIM_FLAG_WIRELESS       0x0080
437#define AIM_FLAG_UNKNOWN100     0x0100
438#define AIM_FLAG_UNKNOWN200     0x0200
439#define AIM_FLAG_ACTIVEBUDDY    0x0400
440#define AIM_FLAG_UNKNOWN800     0x0800
441#define AIM_FLAG_ABINTERNAL     0x1000
442
443#define AIM_FLAG_ALLUSERS       0x001f
444
445/*
446 * TLV handling
447 */
448
449/* Generic TLV structure. */
450typedef struct aim_tlv_s {
451        guint16 type;
452        guint16 length;
453        guint8 *value;
454} aim_tlv_t;
455
456/* List of above. */
457typedef struct aim_tlvlist_s {
458        aim_tlv_t *tlv;
459        struct aim_tlvlist_s *next;
460} aim_tlvlist_t;
461
462/* TLV-handling functions */
463
464#if 0
465/* Very, very raw TLV handling. */
466int aim_puttlv_8(guint8 *buf, const guint16 t, const guint8 v);
467int aim_puttlv_16(guint8 *buf, const guint16 t, const guint16 v);
468int aim_puttlv_32(guint8 *buf, const guint16 t, const guint32 v);
469int aim_puttlv_raw(guint8 *buf, const guint16 t, const guint16 l, const guint8 *v);
470#endif
471
472/* TLV list handling. */
473aim_tlvlist_t *aim_readtlvchain(aim_bstream_t *bs);
474void aim_freetlvchain(aim_tlvlist_t **list);
475aim_tlv_t *aim_gettlv(aim_tlvlist_t *list, guint16 t, const int n);
476char *aim_gettlv_str(aim_tlvlist_t *list, const guint16 t, const int n);
477guint8 aim_gettlv8(aim_tlvlist_t *list, const guint16 type, const int num);
478guint16 aim_gettlv16(aim_tlvlist_t *list, const guint16 t, const int n);
479guint32 aim_gettlv32(aim_tlvlist_t *list, const guint16 t, const int n);
480int aim_writetlvchain(aim_bstream_t *bs, aim_tlvlist_t **list);
481int aim_addtlvtochain8(aim_tlvlist_t **list, const guint16 t, const guint8 v);
482int aim_addtlvtochain16(aim_tlvlist_t **list, const guint16 t, const guint16 v);
483int aim_addtlvtochain32(aim_tlvlist_t **list, const guint16 type, const guint32 v);
484int aim_addtlvtochain_availmsg(aim_tlvlist_t **list, const guint16 type, const char *msg);
485int aim_addtlvtochain_raw(aim_tlvlist_t **list, const guint16 t, const guint16 l, const guint8 *v);
486int aim_addtlvtochain_caps(aim_tlvlist_t **list, const guint16 t, const guint32 caps);
487int aim_addtlvtochain_noval(aim_tlvlist_t **list, const guint16 type);
488int aim_addtlvtochain_userinfo(aim_tlvlist_t **list, guint16 type, aim_userinfo_t *ui);
489int aim_addtlvtochain_frozentlvlist(aim_tlvlist_t **list, guint16 type, aim_tlvlist_t **tl);
490int aim_counttlvchain(aim_tlvlist_t **list);
491int aim_sizetlvchain(aim_tlvlist_t **list);
492
493
494/*
495 * Get command from connections
496 *
497 * aim_get_commmand() is the libfaim lowlevel I/O in the receive direction.
498 * XXX Make this easily overridable.
499 *
500 */
501int aim_get_command(aim_session_t *, aim_conn_t *);
502
503/*
504 * Dispatch commands that are in the rx queue.
505 */
506void aim_rxdispatch(aim_session_t *);
507
508int aim_debugconn_sendconnect(aim_session_t *sess, aim_conn_t *conn);
509
510typedef int (*aim_rxcallback_t)(aim_session_t *, aim_frame_t *, ...);
511
512struct aim_clientrelease {
513        char *name;
514        guint32 build;
515        char *url;
516        char *info;
517};
518
519struct aim_authresp_info {
520        char *sn;
521        guint16 errorcode;
522        char *errorurl;
523        guint16 regstatus;
524        char *email;
525        char *bosip;
526        guint8 *cookie;
527        struct aim_clientrelease latestrelease;
528        struct aim_clientrelease latestbeta;
529};
530
531/* Callback data for redirect. */
532struct aim_redirect_data {
533        guint16 group;
534        const char *ip;
535        const guint8 *cookie;
536        struct { /* group == AIM_CONN_TYPE_CHAT */
537                guint16 exchange;
538                const char *room;
539                guint16 instance;
540        } chat;
541};
542
543int aim_clientready(aim_session_t *sess, aim_conn_t *conn);
544int aim_sendflapver(aim_session_t *sess, aim_conn_t *conn);
545int aim_request_login(aim_session_t *sess, aim_conn_t *conn, const char *sn);
546int aim_send_login(aim_session_t *, aim_conn_t *, const char *, const char *, struct client_info_s *, const char *key);
547int aim_encode_password_md5(const char *password, const char *key, unsigned char *digest);
548void aim_purge_rxqueue(aim_session_t *);
549
550#define AIM_TX_QUEUED    0 /* default */
551#define AIM_TX_IMMEDIATE 1
552#define AIM_TX_USER      2
553int aim_tx_setenqueue(aim_session_t *sess, int what, int (*func)(aim_session_t *, aim_frame_t *));
554
555int aim_tx_flushqueue(aim_session_t *);
556void aim_tx_purgequeue(aim_session_t *);
557
558int aim_conn_setlatency(aim_conn_t *conn, int newval);
559
560void aim_conn_kill(aim_session_t *sess, aim_conn_t **deadconn);
561
562int aim_conn_addhandler(aim_session_t *, aim_conn_t *conn, u_short family, u_short type, aim_rxcallback_t newhandler, u_short flags);
563int aim_clearhandlers(aim_conn_t *conn);
564
565aim_conn_t *aim_conn_findbygroup(aim_session_t *sess, guint16 group);
566aim_session_t *aim_conn_getsess(aim_conn_t *conn);
567void aim_conn_close(aim_conn_t *deadconn);
568aim_conn_t *aim_newconn(aim_session_t *, int type, const char *dest);
569int aim_conngetmaxfd(aim_session_t *);
570aim_conn_t *aim_select(aim_session_t *, struct timeval *, int *);
571int aim_conn_isready(aim_conn_t *);
572int aim_conn_setstatus(aim_conn_t *, int);
573int aim_conn_completeconnect(aim_session_t *sess, aim_conn_t *conn);
574int aim_conn_isconnecting(aim_conn_t *conn);
575
576typedef void (*faim_debugging_callback_t)(aim_session_t *sess, int level, const char *format, va_list va);
577int aim_setdebuggingcb(aim_session_t *sess, faim_debugging_callback_t);
578void aim_session_init(aim_session_t *, guint32 flags, int debuglevel);
579void aim_session_kill(aim_session_t *);
580void aim_setupproxy(aim_session_t *sess, const char *server, const char *username, const char *password);
581aim_conn_t *aim_getconn_type(aim_session_t *, int type);
582aim_conn_t *aim_getconn_type_all(aim_session_t *, int type);
583aim_conn_t *aim_getconn_fd(aim_session_t *, int fd);
584
585/* aim_misc.c */
586
587
588struct aim_chat_roominfo {
589        unsigned short exchange;
590        char *name;
591        unsigned short instance;
592};
593
594
595#define AIM_VISIBILITYCHANGE_PERMITADD    0x05
596#define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
597#define AIM_VISIBILITYCHANGE_DENYADD      0x07
598#define AIM_VISIBILITYCHANGE_DENYREMOVE   0x08
599
600#define AIM_PRIVFLAGS_ALLOWIDLE           0x01
601#define AIM_PRIVFLAGS_ALLOWMEMBERSINCE    0x02
602
603#define AIM_WARN_ANON                     0x01
604
605int aim_sendpauseack(aim_session_t *sess, aim_conn_t *conn);
606int aim_send_warning(aim_session_t *sess, aim_conn_t *conn, const char *destsn, guint32 flags);
607int aim_nop(aim_session_t *, aim_conn_t *);
608int aim_flap_nop(aim_session_t *sess, aim_conn_t *conn);
609int aim_bos_setidle(aim_session_t *, aim_conn_t *, guint32);
610int aim_bos_changevisibility(aim_session_t *, aim_conn_t *, int, const char *);
611int aim_bos_setbuddylist(aim_session_t *, aim_conn_t *, const char *);
612int aim_bos_setprofile(aim_session_t *sess, aim_conn_t *conn, const char *profile, const char *awaymsg, guint32 caps);
613int aim_bos_setgroupperm(aim_session_t *, aim_conn_t *, guint32 mask);
614int aim_bos_setprivacyflags(aim_session_t *, aim_conn_t *, guint32);
615int aim_reqpersonalinfo(aim_session_t *, aim_conn_t *);
616int aim_reqservice(aim_session_t *, aim_conn_t *, guint16);
617int aim_bos_reqrights(aim_session_t *, aim_conn_t *);
618int aim_bos_reqbuddyrights(aim_session_t *, aim_conn_t *);
619int aim_bos_reqlocaterights(aim_session_t *, aim_conn_t *);
620int 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, guint16 privacy);
621int 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, guint16 privacy);
622int aim_setextstatus(aim_session_t *sess, aim_conn_t *conn, guint32 status);
623
624struct aim_fileheader_t *aim_getlisting(aim_session_t *sess, FILE *);
625
626#define AIM_CLIENTTYPE_UNKNOWN  0x0000
627#define AIM_CLIENTTYPE_MC       0x0001
628#define AIM_CLIENTTYPE_WINAIM   0x0002
629#define AIM_CLIENTTYPE_WINAIM41 0x0003
630#define AIM_CLIENTTYPE_AOL_TOC  0x0004
631unsigned short aim_fingerprintclient(unsigned char *msghdr, int len);
632
633#define AIM_RATE_CODE_CHANGE     0x0001
634#define AIM_RATE_CODE_WARNING    0x0002
635#define AIM_RATE_CODE_LIMIT      0x0003
636#define AIM_RATE_CODE_CLEARLIMIT 0x0004
637int aim_ads_requestads(aim_session_t *sess, aim_conn_t *conn);
638
639/* aim_im.c */
640
641aim_conn_t *aim_sendfile_initiate(aim_session_t *, const char *destsn, const char *filename, guint16 numfiles, guint32 totsize);
642
643aim_conn_t *aim_getfile_initiate(aim_session_t *sess, aim_conn_t *conn, const char *destsn);
644int aim_oft_getfile_request(aim_session_t *sess, aim_conn_t *conn, const char *name, int size);
645int aim_oft_getfile_ack(aim_session_t *sess, aim_conn_t *conn);
646int aim_oft_getfile_end(aim_session_t *sess, aim_conn_t *conn);
647
648#define AIM_SENDMEMBLOCK_FLAG_ISREQUEST  0
649#define AIM_SENDMEMBLOCK_FLAG_ISHASH     1
650
651int aim_sendmemblock(aim_session_t *sess, aim_conn_t *conn, guint32 offset, guint32 len, const guint8 *buf, guint8 flag);
652
653#define AIM_GETINFO_GENERALINFO 0x00001
654#define AIM_GETINFO_AWAYMESSAGE 0x00003
655#define AIM_GETINFO_CAPABILITIES 0x0004
656
657struct aim_invite_priv {
658        char *sn;
659        char *roomname;
660        guint16 exchange;
661        guint16 instance;
662};
663
664#define AIM_COOKIETYPE_UNKNOWN  0x00
665#define AIM_COOKIETYPE_ICBM     0x01
666#define AIM_COOKIETYPE_ADS      0x02
667#define AIM_COOKIETYPE_BOS      0x03
668#define AIM_COOKIETYPE_IM       0x04
669#define AIM_COOKIETYPE_CHAT     0x05
670#define AIM_COOKIETYPE_CHATNAV  0x06
671#define AIM_COOKIETYPE_INVITE   0x07
672/* we'll move OFT up a bit to give breathing room.  not like it really
673 * matters. */
674#define AIM_COOKIETYPE_OFTIM    0x10
675#define AIM_COOKIETYPE_OFTGET   0x11
676#define AIM_COOKIETYPE_OFTSEND  0x12
677#define AIM_COOKIETYPE_OFTVOICE 0x13
678#define AIM_COOKIETYPE_OFTIMAGE 0x14
679#define AIM_COOKIETYPE_OFTICON  0x15
680
681int aim_handlerendconnect(aim_session_t *sess, aim_conn_t *cur);
682
683#define AIM_TRANSFER_DENY_NOTSUPPORTED 0x0000
684#define AIM_TRANSFER_DENY_DECLINE 0x0001
685#define AIM_TRANSFER_DENY_NOTACCEPTING 0x0002
686int aim_denytransfer(aim_session_t *sess, const char *sender, const guint8 *cookie, unsigned short code);
687aim_conn_t *aim_accepttransfer(aim_session_t *sess, aim_conn_t *conn, const char *sn, const guint8 *cookie, const guint8 *ip, guint16 listingfiles, guint16 listingtotsize, guint16 listingsize, guint32 listingchecksum, guint16 rendid);
688
689int aim_getinfo(aim_session_t *, aim_conn_t *, const char *, unsigned short);
690int aim_sendbuddyoncoming(aim_session_t *sess, aim_conn_t *conn, aim_userinfo_t *info);
691int aim_sendbuddyoffgoing(aim_session_t *sess, aim_conn_t *conn, const char *sn);
692
693#define AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED       0x00000001
694#define AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED    0x00000002
695
696/* This is what the server will give you if you don't set them yourself. */
697#define AIM_IMPARAM_DEFAULTS { \
698        0, \
699        AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
700        512, /* !! Note how small this is. */ \
701        (99.9)*10, (99.9)*10, \
702        1000 /* !! And how large this is. */ \
703}
704
705/* This is what most AIM versions use. */
706#define AIM_IMPARAM_REASONABLE { \
707        0, \
708        AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
709        8000, \
710        (99.9)*10, (99.9)*10, \
711        0 \
712}
713
714
715struct aim_icbmparameters {
716        guint16 maxchan;
717        guint32 flags; /* AIM_IMPARAM_FLAG_ */
718        guint16 maxmsglen; /* message size that you will accept */
719        guint16 maxsenderwarn; /* this and below are *10 (999=99.9%) */
720        guint16 maxrecverwarn;
721        guint32 minmsginterval; /* in milliseconds? */
722};
723
724int aim_reqicbmparams(aim_session_t *sess);
725int aim_seticbmparam(aim_session_t *sess, struct aim_icbmparameters *params);
726
727/* auth.c */
728int aim_sendcookie(aim_session_t *, aim_conn_t *, const guint8 *);
729
730int aim_admin_changepasswd(aim_session_t *, aim_conn_t *, const char *newpw, const char *curpw);
731int aim_admin_reqconfirm(aim_session_t *sess, aim_conn_t *conn);
732int aim_admin_getinfo(aim_session_t *sess, aim_conn_t *conn, guint16 info);
733int aim_admin_setemail(aim_session_t *sess, aim_conn_t *conn, const char *newemail);
734int aim_admin_setnick(aim_session_t *sess, aim_conn_t *conn, const char *newnick);
735
736/* These apply to exchanges as well. */
737#define AIM_CHATROOM_FLAG_EVILABLE 0x0001
738#define AIM_CHATROOM_FLAG_NAV_ONLY 0x0002
739#define AIM_CHATROOM_FLAG_INSTANCING_ALLOWED 0x0004
740#define AIM_CHATROOM_FLAG_OCCUPANT_PEEK_ALLOWED 0x0008
741
742struct aim_chat_exchangeinfo {
743        guint16 number;
744        guint16 flags;
745        char *name;
746        char *charset1;
747        char *lang1;
748        char *charset2;
749        char *lang2;
750};
751
752#define AIM_CHATFLAGS_NOREFLECT 0x0001
753#define AIM_CHATFLAGS_AWAY      0x0002
754int aim_chat_send_im(aim_session_t *sess, aim_conn_t *conn, guint16 flags, const char *msg, int msglen);
755int aim_chat_join(aim_session_t *sess, aim_conn_t *conn, guint16 exchange, const char *roomname, guint16 instance);
756int aim_chat_attachname(aim_conn_t *conn, guint16 exchange, const char *roomname, guint16 instance);
757char *aim_chat_getname(aim_conn_t *conn);
758aim_conn_t *aim_chat_getconn(aim_session_t *, const char *name);
759
760int aim_chatnav_reqrights(aim_session_t *sess, aim_conn_t *conn);
761
762int aim_chat_invite(aim_session_t *sess, aim_conn_t *conn, const char *sn, const char *msg, guint16 exchange, const char *roomname, guint16 instance);
763
764int aim_chatnav_createroom(aim_session_t *sess, aim_conn_t *conn, const char *name, guint16 exchange);
765int aim_chat_leaveroom(aim_session_t *sess, const char *name);
766
767/* aim_util.c */
768/*
769 * These are really ugly.  You'd think this was LISP.  I wish it was.
770 *
771 * XXX With the advent of bstream's, these should be removed to enforce
772 * their use.
773 *
774 */
775#define aimutil_put8(buf, data) ((*(buf) = (u_char)(data)&0xff),1)
776#define aimutil_get8(buf) ((*(buf))&0xff)
777#define aimutil_put16(buf, data) ( \
778                (*(buf) = (u_char)((data)>>8)&0xff), \
779                (*((buf)+1) = (u_char)(data)&0xff),  \
780                2)
781#define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
782#define aimutil_put32(buf, data) ( \
783                (*((buf)) = (u_char)((data)>>24)&0xff), \
784                (*((buf)+1) = (u_char)((data)>>16)&0xff), \
785                (*((buf)+2) = (u_char)((data)>>8)&0xff), \
786                (*((buf)+3) = (u_char)(data)&0xff), \
787                4)
788#define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
789                (((*((buf)+1))<<16)&0x00ff0000) + \
790                (((*((buf)+2))<< 8)&0x0000ff00) + \
791                (((*((buf)+3)    )&0x000000ff)))
792
793/* Little-endian versions (damn ICQ) */
794#define aimutil_putle8(buf, data) ( \
795                (*(buf) = (unsigned char)(data) & 0xff), \
796                1)
797#define aimutil_getle8(buf) ( \
798                (*(buf)) & 0xff \
799                )
800#define aimutil_putle16(buf, data) ( \
801                (*((buf)+0) = (unsigned char)((data) >> 0) & 0xff),  \
802                (*((buf)+1) = (unsigned char)((data) >> 8) & 0xff), \
803                2)
804#define aimutil_getle16(buf) ( \
805                (((*((buf)+0)) << 0) & 0x00ff) + \
806                (((*((buf)+1)) << 8) & 0xff00) \
807                )
808#define aimutil_putle32(buf, data) ( \
809                (*((buf)+0) = (unsigned char)((data) >>  0) & 0xff), \
810                (*((buf)+1) = (unsigned char)((data) >>  8) & 0xff), \
811                (*((buf)+2) = (unsigned char)((data) >> 16) & 0xff), \
812                (*((buf)+3) = (unsigned char)((data) >> 24) & 0xff), \
813                4)
814#define aimutil_getle32(buf) ( \
815                (((*((buf)+0)) <<  0) & 0x000000ff) + \
816                (((*((buf)+1)) <<  8) & 0x0000ff00) + \
817                (((*((buf)+2)) << 16) & 0x00ff0000) + \
818                (((*((buf)+3)) << 24) & 0xff000000))
819
820
821int aimutil_putstr(u_char *, const char *, int);
822int aimutil_tokslen(char *toSearch, int index, char dl);
823int aimutil_itemcnt(char *toSearch, char dl);
824char *aimutil_itemidx(char *toSearch, int index, char dl);
825int aim_sncmp(const char *a, const char *b);
826
827#include <aim_internal.h>
828
829/*
830 * SNAC Families.
831 */
832#define AIM_CB_FAM_ACK 0x0000
833#define AIM_CB_FAM_GEN 0x0001
834#define AIM_CB_FAM_SPECIAL 0xffff /* Internal libfaim use */
835
836/*
837 * SNAC Family: Ack.
838 *
839 * Not really a family, but treating it as one really
840 * helps it fit into the libfaim callback structure better.
841 *
842 */
843#define AIM_CB_ACK_ACK 0x0001
844
845/*
846 * SNAC Family: General.
847 */ 
848#define AIM_CB_GEN_ERROR 0x0001
849#define AIM_CB_GEN_CLIENTREADY 0x0002
850#define AIM_CB_GEN_SERVERREADY 0x0003
851#define AIM_CB_GEN_SERVICEREQ 0x0004
852#define AIM_CB_GEN_REDIRECT 0x0005
853#define AIM_CB_GEN_RATEINFOREQ 0x0006
854#define AIM_CB_GEN_RATEINFO 0x0007
855#define AIM_CB_GEN_RATEINFOACK 0x0008
856#define AIM_CB_GEN_RATECHANGE 0x000a
857#define AIM_CB_GEN_SERVERPAUSE 0x000b
858#define AIM_CB_GEN_SERVERRESUME 0x000d
859#define AIM_CB_GEN_REQSELFINFO 0x000e
860#define AIM_CB_GEN_SELFINFO 0x000f
861#define AIM_CB_GEN_EVIL 0x0010
862#define AIM_CB_GEN_SETIDLE 0x0011
863#define AIM_CB_GEN_MIGRATIONREQ 0x0012
864#define AIM_CB_GEN_MOTD 0x0013
865#define AIM_CB_GEN_SETPRIVFLAGS 0x0014
866#define AIM_CB_GEN_WELLKNOWNURL 0x0015
867#define AIM_CB_GEN_NOP 0x0016
868#define AIM_CB_GEN_DEFAULT 0xffff
869
870/*
871 * SNAC Family: Advertisement Services
872 */ 
873#define AIM_CB_ADS_ERROR 0x0001
874#define AIM_CB_ADS_DEFAULT 0xffff
875
876/*
877 * OFT Services
878 *
879 * See non-SNAC note below.
880 */
881#define AIM_CB_OFT_DIRECTIMCONNECTREQ 0x0001/* connect request -- actually an OSCAR CAP*/
882#define AIM_CB_OFT_DIRECTIMINCOMING 0x0002
883#define AIM_CB_OFT_DIRECTIMDISCONNECT 0x0003
884#define AIM_CB_OFT_DIRECTIMTYPING 0x0004
885#define AIM_CB_OFT_DIRECTIMINITIATE 0x0005
886
887#define AIM_CB_OFT_GETFILECONNECTREQ 0x0006 /* connect request -- actually an OSCAR CAP*/
888#define AIM_CB_OFT_GETFILELISTINGREQ 0x0007 /* OFT listing.txt request */
889#define AIM_CB_OFT_GETFILEFILEREQ 0x0008    /* received file request */
890#define AIM_CB_OFT_GETFILEFILESEND 0x0009   /* received file request confirm -- send data */
891#define AIM_CB_OFT_GETFILECOMPLETE 0x000a   /* received file send complete*/
892#define AIM_CB_OFT_GETFILEINITIATE 0x000b   /* request for file get acknowledge */
893#define AIM_CB_OFT_GETFILEDISCONNECT 0x000c   /* OFT connection disconnected.*/
894#define AIM_CB_OFT_GETFILELISTING 0x000d   /* OFT listing.txt received.*/
895#define AIM_CB_OFT_GETFILERECEIVE 0x000e   /* OFT file incoming.*/
896#define AIM_CB_OFT_GETFILELISTINGRXCONFIRM 0x000f
897#define AIM_CB_OFT_GETFILESTATE4 0x0010
898
899#define AIM_CB_OFT_SENDFILEDISCONNECT 0x0020   /* OFT connection disconnected.*/
900
901
902
903/*
904 * SNAC Family: Internal Messages
905 *
906 * This isn't truely a SNAC family either, but using
907 * these, we can integrated non-SNAC services into
908 * the SNAC-centered libfaim callback structure.
909 *
910 */ 
911#define AIM_CB_SPECIAL_AUTHSUCCESS 0x0001
912#define AIM_CB_SPECIAL_AUTHOTHER 0x0002
913#define AIM_CB_SPECIAL_CONNERR 0x0003
914#define AIM_CB_SPECIAL_CONNCOMPLETE 0x0004
915#define AIM_CB_SPECIAL_FLAPVER 0x0005
916#define AIM_CB_SPECIAL_CONNINITDONE 0x0006
917#define AIM_CB_SPECIAL_IMAGETRANSFER 0x007
918#define AIM_CB_SPECIAL_UNKNOWN 0xffff
919#define AIM_CB_SPECIAL_DEFAULT AIM_CB_SPECIAL_UNKNOWN
920
921#endif /* __AIM_H__ */
Note: See TracBrowser for help on using the repository browser.