source: protocols/oscar/aim.h @ 6e9ae72

Last change on this file since 6e9ae72 was 6b96de6, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-11-15T23:00:32Z

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