Apply Mark's "libpurple_fix_aim_blocklist.diff".
[pidgin-git:pidgin-git.git] / libpurple / protocols / oscar / oscar.h
1 /*
2  * Purple's oscar protocol plugin
3  * This file is the legal property of its developers.
4  * Please see the AUTHORS file distributed alongside this file.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
19 */
20
21 /*
22  * Main libfaim header.  Must be included in client for prototypes/macros.
23  *
24  * "come on, i turned a chick lesbian; i think this is the hackish equivalent"
25  *                                                -- Josh Myer
26  *
27  */
28
29 #ifndef _OSCAR_H_
30 #define _OSCAR_H_
31
32 #include "circbuffer.h"
33 #include "debug.h"
34 #include "eventloop.h"
35 #include "internal.h"
36 #include "proxy.h"
37 #include "sslconn.h"
38
39 #include <stdio.h>
40 #include <string.h>
41 #include <fcntl.h>
42 #include <sys/types.h>
43 #include <stdlib.h>
44 #include <stdarg.h>
45 #include <errno.h>
46 #include <time.h>
47
48 #ifndef _WIN32
49 #include <sys/time.h>
50 #include <unistd.h>
51 #include <netdb.h>
52 #include <netinet/in.h>
53 #include <sys/socket.h>
54 #else
55 #include "libc_interface.h"
56 #endif
57
58 typedef struct _ByteStream         ByteStream;
59 typedef struct _ClientInfo         ClientInfo;
60 typedef struct _FlapConnection     FlapConnection;
61 typedef struct _FlapFrame          FlapFrame;
62 typedef struct _IcbmArgsCh2        IcbmArgsCh2;
63 typedef struct _IcbmCookie         IcbmCookie;
64 typedef struct _OscarData          OscarData;
65 typedef struct _QueuedSnac         QueuedSnac;
66
67 typedef guint32 aim_snacid_t;
68
69 #include "snactypes.h"
70
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75 #define FAIM_SNAC_HASH_SIZE 16
76
77 /*
78  * Current Maximum Length for Screen Names (not including NULL)
79  *
80  * Currently only names up to 16 characters can be registered
81  * however it is apparently legal for them to be larger.
82  */
83 #define MAXSNLEN 97
84
85 /*
86  * Current Maximum Length for Instant Messages
87  *
88  * This was found basically by experiment, but not wholly
89  * accurate experiment.  It should not be regarded
90  * as completely correct.  But its a decent approximation.
91  *
92  * Note that although we can send this much, its impossible
93  * for WinAIM clients (up through the latest (4.0.1957)) to
94  * send any more than 1kb.  Amaze all your windows friends
95  * with utterly oversized instant messages!
96  */
97 #define MAXMSGLEN 2544
98
99 /*
100  * Maximum size of a Buddy Icon.
101  */
102 #define MAXICONLEN 7168
103 #define AIM_ICONIDENT "AVT1picture.id"
104
105 /*
106  * Current Maximum Length for Chat Room Messages
107  *
108  * This is actually defined by the protocol to be
109  * dynamic, but I have yet to see due cause to
110  * define it dynamically here.  Maybe later.
111  *
112  */
113 #define MAXCHATMSGLEN 512
114
115 /*
116  * Found by trial and error.
117  */
118 #define MAXAVAILMSGLEN 251
119
120 /**
121  * Maximum length for the password of an ICQ account
122  */
123 #define MAXICQPASSLEN 8
124
125 #define AIM_MD5_STRING "AOL Instant Messenger (SM)"
126
127 /*
128  * Client info.  Filled in by the client and passed in to
129  * aim_send_login().  The information ends up getting passed to OSCAR
130  * through the initial login command.
131  *
132  */
133 struct _ClientInfo
134 {
135         const char *clientstring;
136         guint16 clientid;
137         guint16 major;
138         guint16 minor;
139         guint16 point;
140         guint16 build;
141         guint32 distrib;
142         const char *country; /* two-letter abbrev */
143         const char *lang; /* two-letter abbrev */
144 };
145
146 /* Needs to be checked */
147 #define CLIENTINFO_AIM_3_5_1670 { \
148         "AOL Instant Messenger (SM), version 3.5.1670/WIN32", \
149         0x0004, \
150         0x0003, 0x0005, \
151         0x0000, 0x0686, \
152         0x0000002a, \
153         "us", "en", \
154 }
155
156 /* Needs to be checked */
157 /* Latest winaim without ssi */
158 #define CLIENTINFO_AIM_4_1_2010 { \
159         "AOL Instant Messenger (SM), version 4.1.2010/WIN32", \
160         0x0004, \
161         0x0004, 0x0001, \
162         0x0000, 0x07da, \
163         0x0000004b, \
164         "us", "en", \
165 }
166
167 /* Needs to be checked */
168 #define CLIENTINFO_AIM_4_3_2188 { \
169         "AOL Instant Messenger (SM), version 4.3.2188/WIN32", \
170         0x0109, \
171         0x0400, 0x0003, \
172         0x0000, 0x088c, \
173         0x00000086, \
174         "us", "en", \
175 }
176
177 /* Needs to be checked */
178 #define CLIENTINFO_AIM_4_8_2540 { \
179         "AOL Instant Messenger (SM), version 4.8.2540/WIN32", \
180         0x0109, \
181         0x0004, 0x0008, \
182         0x0000, 0x09ec, \
183         0x000000af, \
184         "us", "en", \
185 }
186
187 /* Needs to be checked */
188 #define CLIENTINFO_AIM_5_0_2938 { \
189         "AOL Instant Messenger, version 5.0.2938/WIN32", \
190         0x0109, \
191         0x0005, 0x0000, \
192         0x0000, 0x0b7a, \
193         0x00000000, \
194         "us", "en", \
195 }
196
197 #define CLIENTINFO_AIM_5_1_3036 { \
198         "AOL Instant Messenger, version 5.1.3036/WIN32", \
199         0x0109, \
200         0x0005, 0x0001, \
201         0x0000, 0x0bdc, \
202         0x000000d2, \
203         "us", "en", \
204 }
205
206 #define CLIENTINFO_AIM_5_5_3415 { \
207         "AOL Instant Messenger, version 5.5.3415/WIN32", \
208         0x0109, \
209         0x0005, 0x0005, \
210         0x0000, 0x0057, \
211         0x000000ef, \
212         "us", "en", \
213 }
214
215 #define CLIENTINFO_AIM_5_9_3702 { \
216         "AOL Instant Messenger, version 5.9.3702/WIN32", \
217         0x0109, \
218         0x0005, 0x0009, \
219         0x0000, 0x0e76, \
220         0x00000111, \
221         "us", "en", \
222 }
223
224 #define CLIENTINFO_ICHAT_1_0 { \
225         "Apple iChat", \
226         0x311a, \
227         0x0001, 0x0000, \
228         0x0000, 0x003c, \
229         0x000000c6, \
230         "us", "en", \
231 }
232
233 /* Needs to be checked */
234 #define CLIENTINFO_ICQ_4_65_3281 { \
235         "ICQ Inc. - Product of ICQ (TM) 2000b.4.65.1.3281.85", \
236         0x010a, \
237         0x0004, 0x0041, \
238         0x0001, 0x0cd1, \
239         0x00000055, \
240         "us", "en", \
241 }
242
243 /* Needs to be checked */
244 #define CLIENTINFO_ICQ_5_34_3728 { \
245         "ICQ Inc. - Product of ICQ (TM).2002a.5.34.1.3728.85", \
246         0x010a, \
247         0x0005, 0x0022, \
248         0x0001, 0x0e8f, \
249         0x00000055, \
250         "us", "en", \
251 }
252
253 #define CLIENTINFO_ICQ_5_45_3777 { \
254         "ICQ Inc. - Product of ICQ (TM).2003a.5.45.1.3777.85", \
255         0x010a, \
256         0x0005, 0x002d, \
257         0x0001, 0x0ec1, \
258         0x00000055, \
259         "us", "en", \
260 }
261
262 #define CLIENTINFO_ICQ6_6_0_6059 { \
263         "ICQ Client", \
264         0x010a, \
265         0x0006, 0x0000, \
266         0x0000, 0x17ab, \
267         0x00007535, \
268         "us", "en", \
269 }
270
271 #define CLIENTINFO_ICQBASIC_14_3_1068 { \
272         "ICQBasic", \
273         0x010a, \
274         0x0014, 0x0003, \
275         0x0000, 0x042c, \
276         0x0000043d, \
277         "us", "en", \
278 }
279
280 #define CLIENTINFO_ICQBASIC_14_34_3000 { \
281         "ICQBasic", \
282         0x010a, \
283         0x0014, 0x0034, \
284         0x0000, 0x0bb8, \
285         0x0000043d, \
286         "us", "en", \
287 }
288
289 #define CLIENTINFO_ICQBASIC_14_34_3096 { \
290         "ICQBasic", \
291         0x010a, \
292         0x0014, 0x0034, \
293         0x0000, 0x0c18, \
294         0x0000043d, \
295         "us", "en", \
296 }
297
298 #define CLIENTINFO_NETSCAPE_7_0_1 { \
299         "Netscape 2000 an approved user of AOL Instant Messenger (SM)", \
300         0x1d0d, \
301         0x0007, 0x0000, \
302         0x0001, 0x0000, \
303         0x00000058, \
304         "us", "en", \
305 }
306
307 /*
308  * We need to use the major-minor-micro versions from the official
309  * AIM and ICQ programs here or AOL won't let us use certain features.
310  */
311
312 #define CLIENTINFO_PURPLE_AIM { \
313         "Purple/" VERSION, \
314         0x0109, \
315         0x0005, 0x0001, \
316         0x0000, 0x0bdc, \
317         0x000000d2, \
318         "us", "en", \
319 }
320
321 #define CLIENTINFO_PURPLE_ICQ { \
322         "Purple/" VERSION, \
323         0x010a, \
324         0x0014, 0x0034, \
325         0x0000, 0x0c18, \
326         0x0000043d, \
327         "us", "en", \
328 }
329
330 #define CLIENTINFO_AIM_KNOWNGOOD CLIENTINFO_AIM_5_1_3036
331 #define CLIENTINFO_ICQ_KNOWNGOOD CLIENTINFO_ICQBASIC_14_34_3096
332
333 typedef enum
334 {
335         OSCAR_DISCONNECT_DONE, /* not considered an error */
336         OSCAR_DISCONNECT_LOCAL_CLOSED, /* peer connections only, not considered an error */
337         OSCAR_DISCONNECT_REMOTE_CLOSED,
338         OSCAR_DISCONNECT_REMOTE_REFUSED, /* peer connections only */
339         OSCAR_DISCONNECT_LOST_CONNECTION,
340         OSCAR_DISCONNECT_INVALID_DATA,
341         OSCAR_DISCONNECT_COULD_NOT_CONNECT,
342         OSCAR_DISCONNECT_RETRYING /* peer connections only */
343 } OscarDisconnectReason;
344
345 typedef enum
346 {
347         OSCAR_CAPABILITY_BUDDYICON            = 0x00000001,
348         OSCAR_CAPABILITY_TALK                 = 0x00000002,
349         OSCAR_CAPABILITY_DIRECTIM             = 0x00000004,
350         OSCAR_CAPABILITY_CHAT                 = 0x00000008,
351         OSCAR_CAPABILITY_GETFILE              = 0x00000010,
352         OSCAR_CAPABILITY_SENDFILE             = 0x00000020,
353         OSCAR_CAPABILITY_GAMES                = 0x00000040,
354         OSCAR_CAPABILITY_ADDINS               = 0x00000080,
355         OSCAR_CAPABILITY_SENDBUDDYLIST        = 0x00000100,
356         OSCAR_CAPABILITY_GAMES2               = 0x00000200,
357         OSCAR_CAPABILITY_ICQ_DIRECT           = 0x00000400,
358         OSCAR_CAPABILITY_APINFO               = 0x00000800,
359         OSCAR_CAPABILITY_ICQRTF               = 0x00001000,
360         OSCAR_CAPABILITY_EMPTY                = 0x00002000,
361         OSCAR_CAPABILITY_ICQSERVERRELAY       = 0x00004000,
362         OSCAR_CAPABILITY_UNICODEOLD           = 0x00008000,
363         OSCAR_CAPABILITY_TRILLIANCRYPT        = 0x00010000,
364         OSCAR_CAPABILITY_UNICODE              = 0x00020000,
365         OSCAR_CAPABILITY_INTEROPERATE         = 0x00040000,
366         OSCAR_CAPABILITY_SHORTCAPS            = 0x00080000,
367         OSCAR_CAPABILITY_HIPTOP               = 0x00100000,
368         OSCAR_CAPABILITY_SECUREIM             = 0x00200000,
369         OSCAR_CAPABILITY_SMS                  = 0x00400000,
370         OSCAR_CAPABILITY_VIDEO                = 0x00800000,
371         OSCAR_CAPABILITY_ICHATAV              = 0x01000000,
372         OSCAR_CAPABILITY_LIVEVIDEO            = 0x02000000,
373         OSCAR_CAPABILITY_CAMERA               = 0x04000000,
374         OSCAR_CAPABILITY_ICHAT_SCREENSHARE    = 0x08000000,
375         OSCAR_CAPABILITY_TYPING               = 0x10000000,
376         OSCAR_CAPABILITY_GENERICUNKNOWN       = 0x20000000,
377         OSCAR_CAPABILITY_LAST                 = 0x40000000
378 } OscarCapability;
379
380 /*
381  * Byte Stream type. Sort of.
382  *
383  * Use of this type serves a couple purposes:
384  *   - Buffer/buflen pairs are passed all around everywhere. This turns
385  *     that into one value, as well as abstracting it slightly.
386  *   - Through the abstraction, it is possible to enable bounds checking
387  *     for robustness at the cost of performance.  But a clean failure on
388  *     weird packets is much better than a segfault.
389  *   - I like having variables named "bs".
390  *
391  * Don't touch the insides of this struct.  Or I'll have to kill you.
392  *
393  */
394 struct _ByteStream
395 {
396         guint8 *data;
397         guint32 len;
398         guint32 offset;
399 };
400
401 struct _QueuedSnac
402 {
403         guint16 family;
404         guint16 subtype;
405         FlapFrame *frame;
406 };
407
408 struct _FlapFrame
409 {
410         guint8 channel;
411         guint16 seqnum;
412         ByteStream data;        /* payload stream */
413 };
414
415 struct _FlapConnection
416 {
417         OscarData *od;              /**< Pointer to parent session. */
418         gboolean connected;
419         time_t lastactivity;             /**< Time of last transmit. */
420         guint destroy_timeout;
421         OscarDisconnectReason disconnect_reason;
422         gchar *error_message;
423         guint16 disconnect_code;
424
425         /* A few variables that are only used when connecting */
426         PurpleProxyConnectData *connect_data;
427         guint16 cookielen;
428         guint8 *cookie;
429         gpointer new_conn_data;
430         gchar *ssl_cert_cn;
431
432         int fd;
433         PurpleSslConnection *gsc;
434         guint8 header[6];
435         gssize header_received;
436         FlapFrame buffer_incoming;
437         PurpleCircBuffer *buffer_outgoing;
438         guint watcher_incoming;
439         guint watcher_outgoing;
440
441         guint16 type;
442         guint16 subtype;
443         guint16 seqnum_out; /**< The sequence number of most recently sent packet. */
444         guint16 seqnum_in; /**< The sequence number of most recently received packet. */
445         GSList *groups;
446         GSList *rateclasses; /* Contains nodes of struct rateclass. */
447
448         GQueue *queued_snacs; /**< Contains QueuedSnacs. */
449         GQueue *queued_lowpriority_snacs; /**< Contains QueuedSnacs to send only once queued_snacs is empty */
450         guint queued_timeout;
451
452         void *internal; /* internal conn-specific libfaim data */
453 };
454
455 struct _IcbmCookie
456 {
457         guchar cookie[8];
458         int type;
459         void *data;
460         time_t addtime;
461         struct _IcbmCookie *next;
462 };
463
464 #include "peer.h"
465
466 /*
467  * AIM Session: The main client-data interface.
468  *
469  */
470 struct _OscarData
471 {
472         gboolean iconconnecting;
473         gboolean set_icon;
474
475         GSList *create_rooms;
476
477         gboolean conf;
478         gboolean reqemail;
479         gboolean setemail;
480         char *email;
481         gboolean setnick;
482         char *newsn;
483         gboolean chpass;
484         char *oldp;
485         char *newp;
486
487         GSList *oscar_chats;
488         GHashTable *buddyinfo;
489         GSList *requesticon;
490
491         gboolean use_ssl;
492         gboolean icq;
493         guint getblisttimer;
494
495         struct {
496                 guint maxwatchers; /* max users who can watch you */
497                 guint maxbuddies; /* max users you can watch */
498                 guint maxgroups; /* max groups in server list */
499                 guint maxpermits; /* max users on permit list */
500                 guint maxdenies; /* max users on deny list */
501                 guint maxsiglen; /* max size (bytes) of profile */
502                 guint maxawaymsglen; /* max size (bytes) of posted away message */
503         } rights;
504
505         PurpleConnection *gc;
506
507         void *modlistv;
508
509         /*
510          * Outstanding snac handling
511          *
512          * TODO: Should these be per-connection? -mid
513          */
514         void *snac_hash[FAIM_SNAC_HASH_SIZE];
515         aim_snacid_t snacid_next;
516
517         /*
518          * TODO: Data specific to a certain family should go into a
519          *       hashtable and the core parts of libfaim shouldn't
520          *       need to know about them.
521          */
522
523         IcbmCookie *msgcookies;
524         struct aim_icq_info *icq_info;
525         struct aim_authresp_info *authinfo;
526         struct aim_emailinfo *emailinfo;
527
528         struct {
529                 struct aim_userinfo_s *userinfo;
530                 struct userinfo_node *requested;
531         } locate;
532
533         struct {
534                 gboolean have_rights;
535         } bos;
536
537         /* Server-stored information (ssi) */
538         struct {
539                 gboolean received_data;
540                 guint16 numitems;
541                 struct aim_ssi_item *official;
542                 struct aim_ssi_item *local;
543                 struct aim_ssi_tmp *pending;
544                 time_t timestamp;
545                 gboolean waiting_for_ack;
546                 gboolean in_transaction;
547         } ssi;
548
549         /** Contains pointers to handler functions for each family/subtype. */
550         GHashTable *handlerlist;
551
552         /** A linked list containing FlapConnections. */
553         GSList *oscar_connections;
554
555         /** A linked list containing PeerConnections. */
556         GSList *peer_connections;
557 };
558
559 /* Valid for calling aim_icq_setstatus() and for aim_userinfo_t->icqinfo.status */
560 #define AIM_ICQ_STATE_NORMAL            0x00000000
561 #define AIM_ICQ_STATE_AWAY              0x00000001
562 #define AIM_ICQ_STATE_DND               0x00000002
563 #define AIM_ICQ_STATE_OUT               0x00000004
564 #define AIM_ICQ_STATE_BUSY              0x00000010
565 #define AIM_ICQ_STATE_CHAT              0x00000020
566 #define AIM_ICQ_STATE_INVISIBLE         0x00000100
567 #define AIM_ICQ_STATE_WEBAWARE          0x00010000
568 #define AIM_ICQ_STATE_HIDEIP            0x00020000
569 #define AIM_ICQ_STATE_BIRTHDAY          0x00080000
570 #define AIM_ICQ_STATE_DIRECTDISABLED    0x00100000
571 #define AIM_ICQ_STATE_ICQHOMEPAGE       0x00200000
572 #define AIM_ICQ_STATE_DIRECTREQUIREAUTH 0x10000000
573 #define AIM_ICQ_STATE_DIRECTCONTACTLIST 0x20000000
574
575 typedef int (*aim_rxcallback_t)(OscarData *od, FlapConnection *conn, FlapFrame *frame, ...);
576
577
578 /* family_auth.c */
579 struct aim_clientrelease
580 {
581         char *name;
582         guint32 build;
583         char *url;
584         char *info;
585 };
586
587 struct aim_authresp_info
588 {
589         char *sn;
590         guint16 errorcode;
591         char *errorurl;
592         guint16 regstatus;
593         char *email;
594         char *bosip;
595         guint16 cookielen;
596         guint8 *cookie;
597         char *chpassurl;
598         struct aim_clientrelease latestrelease;
599         struct aim_clientrelease latestbeta;
600 };
601
602 /* Callback data for redirect. */
603 struct aim_redirect_data
604 {
605         guint16 group;
606         const char *ip;
607         guint16 cookielen;
608         const guint8 *cookie;
609         const char *ssl_cert_cn;
610         guint8 use_ssl;
611         struct { /* group == SNAC_FAMILY_CHAT */
612                 guint16 exchange;
613                 const char *room;
614                 guint16 instance;
615         } chat;
616 };
617
618 int aim_request_login(OscarData *od, FlapConnection *conn, const char *sn);
619 int aim_send_login(OscarData *od, FlapConnection *conn, const char *sn, const char *password, gboolean truncate_pass, ClientInfo *ci, const char *key, gboolean allow_multiple_logins);
620 /* 0x000b */ int aim_auth_securid_send(OscarData *od, const char *securid);
621
622 void oscar_data_addhandler(OscarData *od, guint16 family, guint16 subtype, aim_rxcallback_t newhandler, guint16 flags);
623 aim_rxcallback_t aim_callhandler(OscarData *od, guint16 family, guint16 subtype);
624
625 /* flap_connection.c */
626 FlapConnection *flap_connection_new(OscarData *, int type);
627 void flap_connection_close(OscarData *od, FlapConnection *conn);
628 void flap_connection_destroy(FlapConnection *conn, OscarDisconnectReason reason, const gchar *error_message);
629 void flap_connection_schedule_destroy(FlapConnection *conn, OscarDisconnectReason reason, const gchar *error_message);
630 FlapConnection *flap_connection_findbygroup(OscarData *od, guint16 group);
631 FlapConnection *flap_connection_getbytype(OscarData *, int type);
632 FlapConnection *flap_connection_getbytype_all(OscarData *, int type);
633 void flap_connection_recv_cb(gpointer data, gint source, PurpleInputCondition cond);
634 void flap_connection_recv_cb_ssl(gpointer data, PurpleSslConnection *gsc, PurpleInputCondition cond);
635
636 void flap_connection_send(FlapConnection *conn, FlapFrame *frame);
637 void flap_connection_send_version(OscarData *od, FlapConnection *conn);
638 void flap_connection_send_version_with_cookie(OscarData *od, FlapConnection *conn, guint16 length, const guint8 *chipsahoy);
639 void flap_connection_send_snac(OscarData *od, FlapConnection *conn, guint16 family, const guint16 subtype, guint16 flags, aim_snacid_t snacid, ByteStream *data);
640 void flap_connection_send_snac_with_priority(OscarData *od, FlapConnection *conn, guint16 family, const guint16 subtype, guint16 flags, aim_snacid_t snacid, ByteStream *data, gboolean high_priority);
641 void flap_connection_send_keepalive(OscarData *od, FlapConnection *conn);
642 FlapFrame *flap_frame_new(OscarData *od, guint16 channel, int datalen);
643
644 OscarData *oscar_data_new(void);
645 void oscar_data_destroy(OscarData *);
646
647 /* misc.c */
648 #define AIM_VISIBILITYCHANGE_PERMITADD    0x05
649 #define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
650 #define AIM_VISIBILITYCHANGE_DENYADD      0x07
651 #define AIM_VISIBILITYCHANGE_DENYREMOVE   0x08
652
653 #define AIM_PRIVFLAGS_ALLOWIDLE           0x01
654 #define AIM_PRIVFLAGS_ALLOWMEMBERSINCE    0x02
655
656 #define AIM_WARN_ANON                     0x01
657
658
659
660 /* 0x0001 - family_oservice.c */
661 /* 0x0002 */ void aim_srv_clientready(OscarData *od, FlapConnection *conn);
662 /* 0x0004 */ void aim_srv_requestnew(OscarData *od, guint16 serviceid);
663 /* 0x0006 */ void aim_srv_reqrates(OscarData *od, FlapConnection *conn);
664 /* 0x0008 */ void aim_srv_rates_addparam(OscarData *od, FlapConnection *conn);
665 /* 0x0009 */ void aim_srv_rates_delparam(OscarData *od, FlapConnection *conn);
666 /* 0x000c */ void aim_srv_sendpauseack(OscarData *od, FlapConnection *conn);
667 /* 0x000e */ void aim_srv_reqpersonalinfo(OscarData *od, FlapConnection *conn);
668 /* 0x0011 */ void aim_srv_setidle(OscarData *od, guint32 idletime);
669 /* 0x0014 */ void aim_srv_setprivacyflags(OscarData *od, FlapConnection *conn, guint32);
670 /* 0x0016 */ void aim_srv_nop(OscarData *od, FlapConnection *conn);
671 /* 0x0017 */ void aim_srv_setversions(OscarData *od, FlapConnection *conn);
672 /* 0x001e */ int aim_srv_setextrainfo(OscarData *od, gboolean seticqstatus, guint32 icqstatus, gboolean setavailmsg, const char *availmsg, const char *itmsurl);
673
674
675 void aim_bos_reqrights(OscarData *od, FlapConnection *conn);
676 int aim_bos_changevisibility(OscarData *od, FlapConnection *conn, int, const char *);
677 void aim_bos_setgroupperm(OscarData *od, FlapConnection *conn, guint32 mask);
678
679
680
681 #define AIM_CLIENTTYPE_UNKNOWN  0x0000
682 #define AIM_CLIENTTYPE_MC       0x0001
683 #define AIM_CLIENTTYPE_WINAIM   0x0002
684 #define AIM_CLIENTTYPE_WINAIM41 0x0003
685 #define AIM_CLIENTTYPE_AOL_TOC  0x0004
686 guint16 aim_im_fingerprint(const guint8 *msghdr, int len);
687
688 #define AIM_RATE_CODE_CHANGE     0x0001
689 #define AIM_RATE_CODE_WARNING    0x0002
690 #define AIM_RATE_CODE_LIMIT      0x0003
691 #define AIM_RATE_CODE_CLEARLIMIT 0x0004
692 void aim_ads_requestads(OscarData *od, FlapConnection *conn);
693
694
695
696 /* family_icbm.c */
697 #define AIM_OFT_SUBTYPE_SEND_FILE       0x0001
698 #define AIM_OFT_SUBTYPE_SEND_DIR        0x0002
699 #define AIM_OFT_SUBTYPE_GET_FILE        0x0011
700 #define AIM_OFT_SUBTYPE_GET_LIST        0x0012
701
702 #define AIM_TRANSFER_DENY_NOTSUPPORTED  0x0000
703 #define AIM_TRANSFER_DENY_DECLINE       0x0001
704 #define AIM_TRANSFER_DENY_NOTACCEPTING  0x0002
705
706 #define AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED       0x00000001
707 #define AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED    0x00000002
708 #define AIM_IMPARAM_FLAG_SUPPORT_OFFLINEMSGS    0x00000100
709
710 /* This is what the server will give you if you don't set them yourself. */
711 #define AIM_IMPARAM_DEFAULTS { \
712         0, \
713         AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
714         512, /* !! Note how small this is. */ \
715         (99.9)*10, (99.9)*10, \
716         1000 /* !! And how large this is. */ \
717 }
718
719 /* This is what most AIM versions use. */
720 #define AIM_IMPARAM_REASONABLE { \
721         0, \
722         AIM_IMPARAM_FLAG_CHANMSGS_ALLOWED | AIM_IMPARAM_FLAG_MISSEDCALLS_ENABLED, \
723         8000, \
724         (99.9)*10, (99.9)*10, \
725         0 \
726 }
727
728 struct aim_icbmparameters
729 {
730         guint16 maxchan;
731         guint32 flags; /* AIM_IMPARAM_FLAG_ */
732         guint16 maxmsglen; /* message size that you will accept */
733         guint16 maxsenderwarn; /* this and below are *10 (999=99.9%) */
734         guint16 maxrecverwarn;
735         guint32 minmsginterval; /* in milliseconds? */
736 };
737
738 /*
739  * TODO: Should probably combine this with struct chat_connection.
740  */
741 struct aim_chat_roominfo
742 {
743         guint16 exchange;
744         char *name;
745         guint8 namelen;
746         guint16 instance;
747 };
748
749 struct chat_connection
750 {
751         char *name;
752         char *show; /* AOL did something funny to us */
753         guint16 exchange;
754         guint16 instance;
755         FlapConnection *conn;
756         int id;
757         PurpleConnection *gc;
758         PurpleConversation *conv;
759         int maxlen;
760         int maxvis;
761 };
762
763 /*
764  * All this chat struct stuff should be in family_chat.c
765  */
766 void oscar_chat_destroy(struct chat_connection *cc);
767
768 #define AIM_IMFLAGS_AWAY                                0x0001 /* mark as an autoreply */
769 #define AIM_IMFLAGS_ACK                                 0x0002 /* request a receipt notice */
770 #define AIM_IMFLAGS_BUDDYREQ                    0x0010 /* buddy icon requested */
771 #define AIM_IMFLAGS_HASICON                             0x0020 /* already has icon */
772 #define AIM_IMFLAGS_SUBENC_MACINTOSH    0x0040 /* damn that Steve Jobs! */
773 #define AIM_IMFLAGS_CUSTOMFEATURES              0x0080 /* features field present */
774 #define AIM_IMFLAGS_EXTDATA                             0x0100
775 #define AIM_IMFLAGS_X                                   0x0200
776 #define AIM_IMFLAGS_MULTIPART                   0x0400 /* ->mpmsg section valid */
777 #define AIM_IMFLAGS_OFFLINE                             0x0800 /* send to offline user */
778 #define AIM_IMFLAGS_TYPINGNOT                   0x1000 /* typing notification */
779
780 #define AIM_CHARSET_ASCII               0x0000
781 #define AIM_CHARSET_UNICODE     0x0002 /* UTF-16BE */
782 #define AIM_CHARSET_CUSTOM      0x0003
783
784 /*
785  * Multipart message structures.
786  */
787 typedef struct aim_mpmsg_section_s
788 {
789         guint16 charset;
790         guint16 charsubset;
791         gchar *data;
792         guint16 datalen;
793         struct aim_mpmsg_section_s *next;
794 } aim_mpmsg_section_t;
795
796 typedef struct aim_mpmsg_s
797 {
798         unsigned int numparts;
799         aim_mpmsg_section_t *parts;
800 } aim_mpmsg_t;
801
802 int aim_mpmsg_init(OscarData *od, aim_mpmsg_t *mpm);
803 int aim_mpmsg_addraw(OscarData *od, aim_mpmsg_t *mpm, guint16 charset, guint16 charsubset, const gchar *data, guint16 datalen);
804 int aim_mpmsg_addascii(OscarData *od, aim_mpmsg_t *mpm, const char *ascii);
805 int aim_mpmsg_addunicode(OscarData *od, aim_mpmsg_t *mpm, const guint16 *unicode, guint16 unicodelen);
806 void aim_mpmsg_free(OscarData *od, aim_mpmsg_t *mpm);
807
808 /*
809  * Arguments to aim_send_im_ext().
810  *
811  * This is really complicated.  But immensely versatile.
812  *
813  */
814 struct aim_sendimext_args
815 {
816
817         /* These are _required_ */
818         const char *destsn;
819         guint32 flags; /* often 0 */
820
821         /* Only required if not using multipart messages */
822         const char *msg;
823         int msglen;
824
825         /* Required if ->msg is not provided */
826         aim_mpmsg_t *mpmsg;
827
828         /* Only used if AIM_IMFLAGS_HASICON is set */
829         guint32 iconlen;
830         time_t iconstamp;
831         guint32 iconsum;
832
833         /* Only used if AIM_IMFLAGS_CUSTOMFEATURES is set */
834         guint16 featureslen;
835         guint8 *features;
836
837         /* Only used if AIM_IMFLAGS_CUSTOMCHARSET is set and mpmsg not used */
838         guint16 charset;
839         guint16 charsubset;
840 };
841
842 /*
843  * Arguments to aim_send_rtfmsg().
844  */
845 struct aim_sendrtfmsg_args
846 {
847         const char *destsn;
848         guint32 fgcolor;
849         guint32 bgcolor;
850         const char *rtfmsg; /* must be in RTF */
851 };
852
853 /*
854  * This information is provided in the Incoming ICBM callback for
855  * Channel 1 ICBM's.
856  *
857  * Note that although CUSTOMFEATURES and CUSTOMCHARSET say they
858  * are optional, both are always set by the current libfaim code.
859  * That may or may not change in the future.  It is mainly for
860  * consistency with aim_sendimext_args.
861  *
862  * Multipart messages require some explanation. If you want to use them,
863  * I suggest you read all the comments in family_icbm.c.
864  *
865  */
866 struct aim_incomingim_ch1_args
867 {
868
869         /* Always provided */
870         aim_mpmsg_t mpmsg;
871         guint32 icbmflags; /* some flags apply only to ->msg, not all mpmsg */
872         time_t timestamp; /* Only set for offline messages */
873
874         /* Only provided if message has a human-readable section */
875         gchar *msg;
876         int msglen;
877
878         /* Only provided if AIM_IMFLAGS_HASICON is set */
879         time_t iconstamp;
880         guint32 iconlen;
881         guint16 iconsum;
882
883         /* Only provided if AIM_IMFLAGS_CUSTOMFEATURES is set */
884         guint8 *features;
885         guint8 featureslen;
886
887         /* Only provided if AIM_IMFLAGS_EXTDATA is set */
888         guint8 extdatalen;
889         guint8 *extdata;
890
891         /* Only used if AIM_IMFLAGS_CUSTOMCHARSET is set */
892         guint16 charset;
893         guint16 charsubset;
894 };
895
896 /* Valid values for channel 2 args->status */
897 #define AIM_RENDEZVOUS_PROPOSE   0x0000
898 #define AIM_RENDEZVOUS_CANCEL    0x0001
899 #define AIM_RENDEZVOUS_CONNECTED 0x0002
900
901 struct _IcbmArgsCh2
902 {
903         guint16 status;
904         guchar cookie[8];
905         int type; /* One of the OSCAR_CAPABILITY_ constants */
906         const char *proxyip;
907         const char *clientip;
908         const char *verifiedip;
909         guint16 port;
910         gboolean use_proxy;
911         guint16 errorcode;
912         const char *msg; /* invite message or file description */
913         guint16 msglen;
914         const char *encoding;
915         const char *language;
916         guint16 requestnumber;
917         union {
918                 struct {
919                         guint32 checksum;
920                         guint32 length;
921                         time_t timestamp;
922                         guint8 *icon;
923                 } icon;
924                 struct {
925                         struct aim_chat_roominfo roominfo;
926                 } chat;
927                 struct {
928                         guint16 msgtype;
929                         guint32 fgcolor;
930                         guint32 bgcolor;
931                         const char *rtfmsg;
932                 } rtfmsg;
933                 struct {
934                         guint16 subtype;
935                         guint16 totfiles;
936                         guint32 totsize;
937                         char *filename;
938                 } sendfile;
939         } info;
940         void *destructor; /* used internally only */
941 };
942
943 /* Valid values for channel 4 args->type */
944 #define AIM_ICQMSG_AUTHREQUEST  0x0006
945 #define AIM_ICQMSG_AUTHDENIED   0x0007
946 #define AIM_ICQMSG_AUTHGRANTED  0x0008
947
948 struct aim_incomingim_ch4_args
949 {
950         guint32 uin; /* Of the sender of the ICBM */
951         guint8 type;
952         guint8 flags;
953         gchar *msg; /* Reason for auth request, deny, or accept */
954         int msglen;
955 };
956
957 /* SNAC sending functions */
958 /* 0x0002 */ int aim_im_setparams(OscarData *od, struct aim_icbmparameters *params);
959 /* 0x0004 */ int aim_im_reqparams(OscarData *od);
960 /* 0x0006 */ int aim_im_sendch1_ext(OscarData *od, struct aim_sendimext_args *args);
961 /* 0x0006 */ int aim_im_sendch1(OscarData *, const char *destsn, guint16 flags, const char *msg);
962 /* 0x0006 */ int aim_im_sendch2_chatinvite(OscarData *od, const char *sn, const char *msg, guint16 exchange, const char *roomname, guint16 instance);
963 /* 0x0006 */ int aim_im_sendch2_icon(OscarData *od, const char *sn, const guint8 *icon, int iconlen, time_t stamp, guint16 iconsum);
964 /* 0x0006 */ int aim_im_sendch2_rtfmsg(OscarData *od, struct aim_sendrtfmsg_args *args);
965
966 /* 0x0006 */ void aim_im_sendch2_cancel(PeerConnection *peer_conn);
967 /* 0x0006 */ void aim_im_sendch2_connected(PeerConnection *peer_conn);
968 /* 0x0006 */ void aim_im_sendch2_odc_requestdirect(OscarData *od, guchar *cookie, const char *sn, const guint8 *ip, guint16 port, guint16 requestnumber);
969 /* 0x0006 */ void aim_im_sendch2_odc_requestproxy(OscarData *od, guchar *cookie, const char *sn, const guint8 *ip, guint16 pin, guint16 requestnumber);
970 /* 0x0006 */ void aim_im_sendch2_sendfile_requestdirect(OscarData *od, guchar *cookie, const char *sn, const guint8 *ip, guint16 port, guint16 requestnumber, const gchar *filename, guint32 size, guint16 numfiles);
971 /* 0x0006 */ void aim_im_sendch2_sendfile_requestproxy(OscarData *od, guchar *cookie, const char *sn, const guint8 *ip, guint16 pin, guint16 requestnumber, const gchar *filename, guint32 size, guint16 numfiles);
972
973 /* 0x0006 */ int aim_im_sendch2_geticqaway(OscarData *od, const char *sn, int type);
974 /* 0x0006 */ int aim_im_sendch4(OscarData *od, const char *sn, guint16 type, const char *message);
975 /* 0x0008 */ int aim_im_warn(OscarData *od, FlapConnection *conn, const char *destsn, guint32 flags);
976 /* 0x000b */ int aim_im_denytransfer(OscarData *od, const char *sn, const guchar *cookie, guint16 code);
977 /* 0x0010 */ int aim_im_reqofflinemsgs(OscarData *od);
978 /* 0x0014 */ int aim_im_sendmtn(OscarData *od, guint16 type1, const char *sn, guint16 type2);
979 void aim_icbm_makecookie(guchar* cookie);
980 gchar *oscar_encoding_extract(const char *encoding);
981 gchar *oscar_encoding_to_utf8(PurpleAccount *account, const char *encoding, const char *text, int textlen);
982 gchar *purple_plugin_oscar_decode_im_part(PurpleAccount *account, const char *sourcesn, guint16 charset, guint16 charsubset, const gchar *data, gsize datalen);
983
984
985 /* 0x0002 - family_locate.c */
986 /*
987  * AIM User Info, Standard Form.
988  */
989 #define AIM_FLAG_UNCONFIRMED     0x0001 /* "damned transients" */
990 #define AIM_FLAG_ADMINISTRATOR   0x0002
991 #define AIM_FLAG_AOL             0x0004
992 #define AIM_FLAG_OSCAR_PAY       0x0008
993 #define AIM_FLAG_FREE            0x0010
994 #define AIM_FLAG_AWAY            0x0020
995 #define AIM_FLAG_ICQ             0x0040
996 #define AIM_FLAG_WIRELESS        0x0080
997 #define AIM_FLAG_UNKNOWN100      0x0100
998 #define AIM_FLAG_UNKNOWN200      0x0200
999 #define AIM_FLAG_ACTIVEBUDDY     0x0400
1000 #define AIM_FLAG_UNKNOWN800      0x0800
1001 #define AIM_FLAG_ABINTERNAL      0x1000
1002 #define AIM_FLAG_ALLUSERS        0x001f
1003
1004 #define AIM_USERINFO_PRESENT_FLAGS        0x00000001
1005 #define AIM_USERINFO_PRESENT_MEMBERSINCE  0x00000002
1006 #define AIM_USERINFO_PRESENT_ONLINESINCE  0x00000004
1007 #define AIM_USERINFO_PRESENT_IDLE         0x00000008
1008 #define AIM_USERINFO_PRESENT_ICQEXTSTATUS 0x00000010
1009 #define AIM_USERINFO_PRESENT_ICQIPADDR    0x00000020
1010 #define AIM_USERINFO_PRESENT_ICQDATA      0x00000040
1011 #define AIM_USERINFO_PRESENT_CAPABILITIES 0x00000080
1012 #define AIM_USERINFO_PRESENT_SESSIONLEN   0x00000100
1013 #define AIM_USERINFO_PRESENT_CREATETIME   0x00000200
1014
1015 struct userinfo_node
1016 {
1017         char *sn;
1018         struct userinfo_node *next;
1019 };
1020
1021 typedef struct aim_userinfo_s
1022 {
1023         char *sn;
1024         guint16 warnlevel; /* evil percent * 10 (999 = 99.9%) */
1025         guint16 idletime; /* in seconds */
1026         guint16 flags;
1027         guint32 createtime; /* time_t */
1028         guint32 membersince; /* time_t */
1029         guint32 onlinesince; /* time_t */
1030         guint32 sessionlen;  /* in seconds */
1031         guint32 capabilities;
1032         struct {
1033                 guint32 status;
1034                 guint32 ipaddr;
1035                 guint8 crap[0x25]; /* until we figure it out... */
1036         } icqinfo;
1037         guint32 present;
1038
1039         guint8 iconcsumtype;
1040         guint16 iconcsumlen;
1041         guint8 *iconcsum;
1042
1043         char *info;
1044         char *info_encoding;
1045         guint16 info_len;
1046
1047         char *status;
1048         char *status_encoding;
1049         guint16 status_len;
1050
1051         char *itmsurl;
1052         char *itmsurl_encoding;
1053         guint16 itmsurl_len;
1054
1055         char *away;
1056         char *away_encoding;
1057         guint16 away_len;
1058
1059         struct aim_userinfo_s *next;
1060 } aim_userinfo_t;
1061
1062 #define AIM_SENDMEMBLOCK_FLAG_ISREQUEST  0
1063 #define AIM_SENDMEMBLOCK_FLAG_ISHASH     1
1064
1065 int aim_sendmemblock(OscarData *od, FlapConnection *conn, guint32 offset, guint32 len, const guint8 *buf, guint8 flag);
1066
1067 struct aim_invite_priv
1068 {
1069         char *sn;
1070         char *roomname;
1071         guint16 exchange;
1072         guint16 instance;
1073 };
1074
1075 #define AIM_COOKIETYPE_UNKNOWN  0x00
1076 #define AIM_COOKIETYPE_ICBM     0x01
1077 #define AIM_COOKIETYPE_ADS      0x02
1078 #define AIM_COOKIETYPE_BOS      0x03
1079 #define AIM_COOKIETYPE_IM       0x04
1080 #define AIM_COOKIETYPE_CHAT     0x05
1081 #define AIM_COOKIETYPE_CHATNAV  0x06
1082 #define AIM_COOKIETYPE_INVITE   0x07
1083 /* we'll move OFT up a bit to give breathing room.  not like it really
1084  * matters. */
1085 #define AIM_COOKIETYPE_OFTIM    0x10
1086 #define AIM_COOKIETYPE_OFTGET   0x11
1087 #define AIM_COOKIETYPE_OFTSEND  0x12
1088 #define AIM_COOKIETYPE_OFTVOICE 0x13
1089 #define AIM_COOKIETYPE_OFTIMAGE 0x14
1090 #define AIM_COOKIETYPE_OFTICON  0x15
1091
1092 aim_userinfo_t *aim_locate_finduserinfo(OscarData *od, const char *sn);
1093 void aim_locate_dorequest(OscarData *od);
1094
1095 /* 0x0002 */ int aim_locate_reqrights(OscarData *od);
1096 /* 0x0004 */ int aim_locate_setcaps(OscarData *od, guint32 caps);
1097 /* 0x0004 */ int aim_locate_setprofile(OscarData *od, const char *profile_encoding, const gchar *profile, const int profile_len, const char *awaymsg_encoding, const gchar *awaymsg, const int awaymsg_len);
1098 /* 0x0005 */ int aim_locate_getinfo(OscarData *od, const char *, guint16);
1099 /* 0x0009 */ int aim_locate_setdirinfo(OscarData *od, 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);
1100 /* 0x000b */ int aim_locate_000b(OscarData *od, const char *sn);
1101 /* 0x000f */ int aim_locate_setinterests(OscarData *od, const char *interest1, const char *interest2, const char *interest3, const char *interest4, const char *interest5, guint16 privacy);
1102 /* 0x0015 */ int aim_locate_getinfoshort(OscarData *od, const char *sn, guint32 flags);
1103
1104 void aim_locate_autofetch_away_message(OscarData *od, const char *sn);
1105 guint32 aim_locate_getcaps(OscarData *od, ByteStream *bs, int len);
1106 guint32 aim_locate_getcaps_short(OscarData *od, ByteStream *bs, int len);
1107 void aim_info_free(aim_userinfo_t *);
1108 int aim_info_extract(OscarData *od, ByteStream *bs, aim_userinfo_t *);
1109 int aim_putuserinfo(ByteStream *bs, aim_userinfo_t *info);
1110
1111
1112
1113 /* 0x0003 - family_buddy.c */
1114 /* 0x0002 */ void aim_buddylist_reqrights(OscarData *, FlapConnection *);
1115 /* 0x0004 */ int aim_buddylist_set(OscarData *, FlapConnection *, const char *);
1116 /* 0x0004 */ int aim_buddylist_addbuddy(OscarData *, FlapConnection *, const char *);
1117 /* 0x0005 */ int aim_buddylist_removebuddy(OscarData *, FlapConnection *, const char *);
1118
1119
1120
1121 /* 0x000a - family_userlookup.c */
1122 int aim_search_address(OscarData *, const char *);
1123
1124
1125
1126 /* 0x000d - family_chatnav.c */
1127 /* 0x000e - family_chat.c */
1128 /* These apply to exchanges as well. */
1129 #define AIM_CHATROOM_FLAG_EVILABLE 0x0001
1130 #define AIM_CHATROOM_FLAG_NAV_ONLY 0x0002
1131 #define AIM_CHATROOM_FLAG_INSTANCING_ALLOWED 0x0004
1132 #define AIM_CHATROOM_FLAG_OCCUPANT_PEEK_ALLOWED 0x0008
1133
1134 struct aim_chat_exchangeinfo
1135 {
1136         guint16 number;
1137         guint16 flags;
1138         char *name;
1139         char *charset1;
1140         char *lang1;
1141         char *charset2;
1142         char *lang2;
1143 };
1144
1145 #define AIM_CHATFLAGS_NOREFLECT 0x0001
1146 #define AIM_CHATFLAGS_AWAY      0x0002
1147 int aim_chat_send_im(OscarData *od, FlapConnection *conn, guint16 flags, const gchar *msg, int msglen, const char *encoding, const char *language);
1148 int aim_chat_join(OscarData *od, guint16 exchange, const char *roomname, guint16 instance);
1149 int aim_chat_attachname(FlapConnection *conn, guint16 exchange, const char *roomname, guint16 instance);
1150 char *aim_chat_getname(FlapConnection *conn);
1151 FlapConnection *aim_chat_getconn(OscarData *, const char *name);
1152
1153 void aim_chatnav_reqrights(OscarData *od, FlapConnection *conn);
1154
1155 int aim_chatnav_createroom(OscarData *od, FlapConnection *conn, const char *name, guint16 exchange);
1156 int aim_chat_leaveroom(OscarData *od, const char *name);
1157
1158
1159
1160 /* 0x000f - family_odir.c */
1161 struct aim_odir
1162 {
1163         char *first;
1164         char *last;
1165         char *middle;
1166         char *maiden;
1167         char *email;
1168         char *country;
1169         char *state;
1170         char *city;
1171         char *sn;
1172         char *interest;
1173         char *nick;
1174         char *zip;
1175         char *region;
1176         char *address;
1177         struct aim_odir *next;
1178 };
1179
1180 int aim_odir_email(OscarData *, const char *, const char *);
1181 int aim_odir_name(OscarData *, const char *, const char *, const char *, const char *, const char *, const char *, const char *, const char *, const char *, const char *, const char *);
1182 int aim_odir_interest(OscarData *, const char *, const char *);
1183
1184
1185
1186 /* 0x0010 - family_bart.c */
1187 int aim_bart_upload(OscarData *od, const guint8 *icon, guint16 iconlen);
1188 int aim_bart_request(OscarData *od, const char *sn, guint8 iconcsumtype, const guint8 *iconstr, guint16 iconstrlen);
1189
1190
1191
1192 /* 0x0013 - family_feedbag.c */
1193 #define AIM_SSI_TYPE_BUDDY              0x0000
1194 #define AIM_SSI_TYPE_GROUP              0x0001
1195 #define AIM_SSI_TYPE_PERMIT             0x0002
1196 #define AIM_SSI_TYPE_DENY               0x0003
1197 #define AIM_SSI_TYPE_PDINFO             0x0004
1198 #define AIM_SSI_TYPE_PRESENCEPREFS      0x0005
1199 #define AIM_SSI_TYPE_ICONINFO           0x0014
1200
1201 #define AIM_SSI_ACK_SUCCESS             0x0000
1202 #define AIM_SSI_ACK_ITEMNOTFOUND        0x0002
1203 #define AIM_SSI_ACK_IDNUMINUSE          0x000a
1204 #define AIM_SSI_ACK_ATMAX               0x000c
1205 #define AIM_SSI_ACK_INVALIDNAME         0x000d
1206 #define AIM_SSI_ACK_AUTHREQUIRED        0x000e
1207
1208 /* These flags are set in the 0x00c9 TLV of SSI teyp 0x0005 */
1209 #define AIM_SSI_PRESENCE_FLAG_SHOWIDLE        0x00000400
1210 #define AIM_SSI_PRESENCE_FLAG_NORECENTBUDDIES 0x00020000
1211
1212 struct aim_ssi_item
1213 {
1214         char *name;
1215         guint16 gid;
1216         guint16 bid;
1217         guint16 type;
1218         GSList *data;
1219         struct aim_ssi_item *next;
1220 };
1221
1222 struct aim_ssi_tmp
1223 {
1224         guint16 action;
1225         guint16 ack;
1226         char *name;
1227         struct aim_ssi_item *item;
1228         struct aim_ssi_tmp *next;
1229 };
1230
1231 /* These build the actual SNACs and queue them to be sent */
1232 /* 0x0002 */ int aim_ssi_reqrights(OscarData *od);
1233 /* 0x0004 */ int aim_ssi_reqdata(OscarData *od);
1234 /* 0x0005 */ int aim_ssi_reqifchanged(OscarData *od, time_t localstamp, guint16 localrev);
1235 /* 0x0007 */ int aim_ssi_enable(OscarData *od);
1236 /* 0x0011 */ int aim_ssi_modbegin(OscarData *od);
1237 /* 0x0012 */ int aim_ssi_modend(OscarData *od);
1238 /* 0x0014 */ int aim_ssi_sendauth(OscarData *od, char *sn, char *msg);
1239 /* 0x0018 */ int aim_ssi_sendauthrequest(OscarData *od, char *sn, const char *msg);
1240 /* 0x001a */ int aim_ssi_sendauthreply(OscarData *od, char *sn, guint8 reply, const char *msg);
1241
1242 /* Client functions for retrieving SSI data */
1243 struct aim_ssi_item *aim_ssi_itemlist_find(struct aim_ssi_item *list, guint16 gid, guint16 bid);
1244 struct aim_ssi_item *aim_ssi_itemlist_finditem(struct aim_ssi_item *list, const char *gn, const char *sn, guint16 type);
1245 struct aim_ssi_item *aim_ssi_itemlist_exists(struct aim_ssi_item *list, const char *sn);
1246 char *aim_ssi_itemlist_findparentname(struct aim_ssi_item *list, const char *sn);
1247 int aim_ssi_getpermdeny(struct aim_ssi_item *list);
1248 guint32 aim_ssi_getpresence(struct aim_ssi_item *list);
1249 char *aim_ssi_getalias(struct aim_ssi_item *list, const char *gn, const char *sn);
1250 char *aim_ssi_getcomment(struct aim_ssi_item *list, const char *gn, const char *sn);
1251 gboolean aim_ssi_waitingforauth(struct aim_ssi_item *list, const char *gn, const char *sn);
1252
1253 /* Client functions for changing SSI data */
1254 int aim_ssi_addbuddy(OscarData *od, const char *name, const char *group, GSList *tlvlist, const char *alias, const char *comment, const char *smsnum, gboolean needauth);
1255 int aim_ssi_addpermit(OscarData *od, const char *name);
1256 int aim_ssi_adddeny(OscarData *od, const char *name);
1257 int aim_ssi_delbuddy(OscarData *od, const char *name, const char *group);
1258 int aim_ssi_delgroup(OscarData *od, const char *group);
1259 int aim_ssi_delpermit(OscarData *od, const char *name);
1260 int aim_ssi_deldeny(OscarData *od, const char *name);
1261 int aim_ssi_movebuddy(OscarData *od, const char *oldgn, const char *newgn, const char *sn);
1262 int aim_ssi_aliasbuddy(OscarData *od, const char *gn, const char *sn, const char *alias);
1263 int aim_ssi_editcomment(OscarData *od, const char *gn, const char *sn, const char *alias);
1264 int aim_ssi_rename_group(OscarData *od, const char *oldgn, const char *newgn);
1265 int aim_ssi_cleanlist(OscarData *od);
1266 int aim_ssi_deletelist(OscarData *od);
1267 int aim_ssi_setpermdeny(OscarData *od, guint8 permdeny, guint32 vismask);
1268 int aim_ssi_setpresence(OscarData *od, guint32 presence);
1269 int aim_ssi_seticon(OscarData *od, const guint8 *iconsum, guint8 iconsumlen);
1270 int aim_ssi_delicon(OscarData *od);
1271
1272
1273
1274 /* 0x0015 - family_icq.c */
1275 #define AIM_ICQ_INFO_SIMPLE     0x001
1276 #define AIM_ICQ_INFO_SUMMARY    0x002
1277 #define AIM_ICQ_INFO_EMAIL      0x004
1278 #define AIM_ICQ_INFO_PERSONAL   0x008
1279 #define AIM_ICQ_INFO_ADDITIONAL 0x010
1280 #define AIM_ICQ_INFO_WORK       0x020
1281 #define AIM_ICQ_INFO_INTERESTS  0x040
1282 #define AIM_ICQ_INFO_ORGS       0x080
1283 #define AIM_ICQ_INFO_UNKNOWN    0x100
1284 #define AIM_ICQ_INFO_HAVEALL    0x1ff
1285
1286 #ifdef OLDSTYLE_ICQ_OFFLINEMSGS
1287 struct aim_icq_offlinemsg
1288 {
1289         guint32 sender;
1290         guint16 year;
1291         guint8 month, day, hour, minute;
1292         guint8 type;
1293         guint8 flags;
1294         char *msg;
1295         int msglen;
1296 };
1297 #endif /* OLDSTYLE_ICQ_OFFLINEMSGS */
1298
1299 struct aim_icq_info
1300 {
1301         guint16 reqid;
1302
1303         /* simple */
1304         guint32 uin;
1305
1306         /* general and "home" information (0x00c8) */
1307         char *nick;
1308         char *first;
1309         char *last;
1310         char *email;
1311         char *homecity;
1312         char *homestate;
1313         char *homephone;
1314         char *homefax;
1315         char *homeaddr;
1316         char *mobile;
1317         char *homezip;
1318         guint16 homecountry;
1319 /*      guint8 timezone;
1320         guint8 hideemail; */
1321
1322         /* personal (0x00dc) */
1323         guint8 age;
1324         guint8 unknown;
1325         guint8 gender;
1326         char *personalwebpage;
1327         guint16 birthyear;
1328         guint8 birthmonth;
1329         guint8 birthday;
1330         guint8 language1;
1331         guint8 language2;
1332         guint8 language3;
1333
1334         /* work (0x00d2) */
1335         char *workcity;
1336         char *workstate;
1337         char *workphone;
1338         char *workfax;
1339         char *workaddr;
1340         char *workzip;
1341         guint16 workcountry;
1342         char *workcompany;
1343         char *workdivision;
1344         char *workposition;
1345         char *workwebpage;
1346
1347         /* additional personal information (0x00e6) */
1348         char *info;
1349
1350         /* email (0x00eb) */
1351         guint16 numaddresses;
1352         char **email2;
1353
1354         /* we keep track of these in a linked list because we're 1337 */
1355         struct aim_icq_info *next;
1356
1357         /* status note info */
1358         guint8 icbm_cookie[8];
1359         char *status_note_title;
1360 };
1361
1362 #ifdef OLDSTYLE_ICQ_OFFLINEMSGS
1363 int aim_icq_reqofflinemsgs(OscarData *od);
1364 int aim_icq_ackofflinemsgs(OscarData *od);
1365 #endif
1366 int aim_icq_setsecurity(OscarData *od, gboolean auth_required, gboolean webaware);
1367 int aim_icq_changepasswd(OscarData *od, const char *passwd);
1368 int aim_icq_getsimpleinfo(OscarData *od, const char *uin);
1369 int aim_icq_getalias(OscarData *od, const char *uin);
1370 int aim_icq_getallinfo(OscarData *od, const char *uin);
1371 int aim_icq_sendsms(OscarData *od, const char *name, const char *msg, const char *alias);
1372
1373
1374 /* 0x0017 - family_auth.c */
1375 void aim_sendcookie(OscarData *, FlapConnection *, const guint16 length, const guint8 *);
1376 void aim_admin_changepasswd(OscarData *, FlapConnection *, const char *newpw, const char *curpw);
1377 void aim_admin_reqconfirm(OscarData *od, FlapConnection *conn);
1378 void aim_admin_getinfo(OscarData *od, FlapConnection *conn, guint16 info);
1379 void aim_admin_setemail(OscarData *od, FlapConnection *conn, const char *newemail);
1380 void aim_admin_setnick(OscarData *od, FlapConnection *conn, const char *newnick);
1381
1382
1383
1384 /* 0x0018 - family_alert.c */
1385 struct aim_emailinfo
1386 {
1387         guint8 *cookie16;
1388         guint8 *cookie8;
1389         char *url;
1390         guint16 nummsgs;
1391         guint8 unread;
1392         char *domain;
1393         guint16 flag;
1394         struct aim_emailinfo *next;
1395 };
1396
1397 int aim_email_sendcookies(OscarData *od);
1398 int aim_email_activate(OscarData *od);
1399
1400
1401
1402 /* tlv.c - TLV handling */
1403
1404 /* TLV structure */
1405 typedef struct aim_tlv_s
1406 {
1407         guint16 type;
1408         guint16 length;
1409         guint8 *value;
1410 } aim_tlv_t;
1411
1412 /* TLV handling functions */
1413 char *aim_tlv_getvalue_as_string(aim_tlv_t *tlv);
1414
1415 aim_tlv_t *aim_tlv_gettlv(GSList *list, const guint16 type, const int nth);
1416 int aim_tlv_getlength(GSList *list, const guint16 type, const int nth);
1417 char *aim_tlv_getstr(GSList *list, const guint16 type, const int nth);
1418 guint8 aim_tlv_get8(GSList *list, const guint16 type, const int nth);
1419 guint16 aim_tlv_get16(GSList *list, const guint16 type, const int nth);
1420 guint32 aim_tlv_get32(GSList *list, const guint16 type, const int nth);
1421
1422 /* TLV list handling functions */
1423 GSList *aim_tlvlist_read(ByteStream *bs);
1424 GSList *aim_tlvlist_readnum(ByteStream *bs, guint16 num);
1425 GSList *aim_tlvlist_readlen(ByteStream *bs, guint16 len);
1426 GSList *aim_tlvlist_copy(GSList *orig);
1427
1428 int aim_tlvlist_count(GSList *list);
1429 int aim_tlvlist_size(GSList *list);
1430 int aim_tlvlist_cmp(GSList *one, GSList *two);
1431 int aim_tlvlist_write(ByteStream *bs, GSList **list);
1432 void aim_tlvlist_free(GSList *list);
1433
1434 int aim_tlvlist_add_raw(GSList **list, const guint16 type, const guint16 length, const guint8 *value);
1435 int aim_tlvlist_add_noval(GSList **list, const guint16 type);
1436 int aim_tlvlist_add_8(GSList **list, const guint16 type, const guint8 value);
1437 int aim_tlvlist_add_16(GSList **list, const guint16 type, const guint16 value);
1438 int aim_tlvlist_add_32(GSList **list, const guint16 type, const guint32 value);
1439 int aim_tlvlist_add_str(GSList **list, const guint16 type, const char *value);
1440 int aim_tlvlist_add_caps(GSList **list, const guint16 type, const guint32 caps);
1441 int aim_tlvlist_add_userinfo(GSList **list, guint16 type, aim_userinfo_t *userinfo);
1442 int aim_tlvlist_add_chatroom(GSList **list, guint16 type, guint16 exchange, const char *roomname, guint16 instance);
1443 int aim_tlvlist_add_frozentlvlist(GSList **list, guint16 type, GSList **tl);
1444
1445 int aim_tlvlist_replace_raw(GSList **list, const guint16 type, const guint16 lenth, const guint8 *value);
1446 int aim_tlvlist_replace_str(GSList **list, const guint16 type, const char *str);
1447 int aim_tlvlist_replace_noval(GSList **list, const guint16 type);
1448 int aim_tlvlist_replace_8(GSList **list, const guint16 type, const guint8 value);
1449 int aim_tlvlist_replace_16(GSList **list, const guint16 type, const guint16 value);
1450 int aim_tlvlist_replace_32(GSList **list, const guint16 type, const guint32 value);
1451
1452 void aim_tlvlist_remove(GSList **list, const guint16 type);
1453
1454
1455
1456 /* util.c */
1457 /* These are really ugly.  You'd think this was LISP.  I wish it was. */
1458 #define aimutil_put8(buf, data) ((*(buf) = (guint8)(data)&0xff),1)
1459 #define aimutil_get8(buf) ((*(buf))&0xff)
1460 #define aimutil_put16(buf, data) ( \
1461                 (*(buf) = (guint8)((data)>>8)&0xff), \
1462                 (*((buf)+1) = (guint8)(data)&0xff),  \
1463                 2)
1464 #define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
1465 #define aimutil_put32(buf, data) ( \
1466                 (*((buf)) = (guint8)((data)>>24)&0xff), \
1467                 (*((buf)+1) = (guint8)((data)>>16)&0xff), \
1468                 (*((buf)+2) = (guint8)((data)>>8)&0xff), \
1469                 (*((buf)+3) = (guint8)(data)&0xff), \
1470                 4)
1471 #define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
1472                 (((*((buf)+1))<<16)&0x00ff0000) + \
1473                 (((*((buf)+2))<< 8)&0x0000ff00) + \
1474                 (((*((buf)+3)    )&0x000000ff)))
1475
1476 /* Little-endian versions (damn ICQ) */
1477 #define aimutil_putle8(buf, data) ( \
1478                 (*(buf) = (guint8)(data) & 0xff), \
1479                 1)
1480 #define aimutil_getle8(buf) ( \
1481                 (*(buf)) & 0xff \
1482                 )
1483 #define aimutil_putle16(buf, data) ( \
1484                 (*((buf)+0) = (guint8)((data) >> 0) & 0xff),  \
1485                 (*((buf)+1) = (guint8)((data) >> 8) & 0xff), \
1486                 2)
1487 #define aimutil_getle16(buf) ( \
1488                 (((*((buf)+0)) << 0) & 0x00ff) + \
1489                 (((*((buf)+1)) << 8) & 0xff00) \
1490                 )
1491 #define aimutil_putle32(buf, data) ( \
1492                 (*((buf)+0) = (guint8)((data) >>  0) & 0xff), \
1493                 (*((buf)+1) = (guint8)((data) >>  8) & 0xff), \
1494                 (*((buf)+2) = (guint8)((data) >> 16) & 0xff), \
1495                 (*((buf)+3) = (guint8)((data) >> 24) & 0xff), \
1496                 4)
1497 #define aimutil_getle32(buf) ( \
1498                 (((*((buf)+0)) <<  0) & 0x000000ff) + \
1499                 (((*((buf)+1)) <<  8) & 0x0000ff00) + \
1500                 (((*((buf)+2)) << 16) & 0x00ff0000) + \
1501                 (((*((buf)+3)) << 24) & 0xff000000))
1502
1503 guint16 aimutil_iconsum(const guint8 *buf, int buflen);
1504 int aimutil_tokslen(char *toSearch, int theindex, char dl);
1505 int aimutil_itemcnt(char *toSearch, char dl);
1506 char *aimutil_itemindex(char *toSearch, int theindex, char dl);
1507
1508 gboolean aim_snvalid(const char *sn);
1509 gboolean aim_snvalid_icq(const char *sn);
1510 gboolean aim_snvalid_sms(const char *sn);
1511 int aim_snlen(const char *sn);
1512 int aim_sncmp(const char *sn1, const char *sn2);
1513
1514
1515
1516
1517 typedef struct {
1518         guint16 family;
1519         guint16 subtype;
1520         guint16 flags;
1521         guint32 id;
1522 } aim_modsnac_t;
1523
1524 #define AIM_MODULENAME_MAXLEN 16
1525 #define AIM_MODFLAG_MULTIFAMILY 0x0001
1526 typedef struct aim_module_s
1527 {
1528         guint16 family;
1529         guint16 version;
1530         guint16 toolid;
1531         guint16 toolversion;
1532         guint16 flags;
1533         char name[AIM_MODULENAME_MAXLEN+1];
1534         int (*snachandler)(OscarData *od, FlapConnection *conn, struct aim_module_s *mod, FlapFrame *rx, aim_modsnac_t *snac, ByteStream *bs);
1535         void (*shutdown)(OscarData *od, struct aim_module_s *mod);
1536         void *priv;
1537         struct aim_module_s *next;
1538 } aim_module_t;
1539
1540 int aim__registermodule(OscarData *od, int (*modfirst)(OscarData *, aim_module_t *));
1541 void aim__shutdownmodules(OscarData *od);
1542 aim_module_t *aim__findmodulebygroup(OscarData *od, guint16 group);
1543 aim_module_t *aim__findmodule(OscarData *od, const char *name);
1544
1545 int admin_modfirst(OscarData *od, aim_module_t *mod);
1546 int buddylist_modfirst(OscarData *od, aim_module_t *mod);
1547 int bos_modfirst(OscarData *od, aim_module_t *mod);
1548 int search_modfirst(OscarData *od, aim_module_t *mod);
1549 int stats_modfirst(OscarData *od, aim_module_t *mod);
1550 int auth_modfirst(OscarData *od, aim_module_t *mod);
1551 int msg_modfirst(OscarData *od, aim_module_t *mod);
1552 int misc_modfirst(OscarData *od, aim_module_t *mod);
1553 int chatnav_modfirst(OscarData *od, aim_module_t *mod);
1554 int chat_modfirst(OscarData *od, aim_module_t *mod);
1555 int locate_modfirst(OscarData *od, aim_module_t *mod);
1556 int service_modfirst(OscarData *od, aim_module_t *mod);
1557 int invite_modfirst(OscarData *od, aim_module_t *mod);
1558 int translate_modfirst(OscarData *od, aim_module_t *mod);
1559 int popups_modfirst(OscarData *od, aim_module_t *mod);
1560 int adverts_modfirst(OscarData *od, aim_module_t *mod);
1561 int odir_modfirst(OscarData *od, aim_module_t *mod);
1562 int bart_modfirst(OscarData *od, aim_module_t *mod);
1563 int ssi_modfirst(OscarData *od, aim_module_t *mod);
1564 int icq_modfirst(OscarData *od, aim_module_t *mod);
1565 int email_modfirst(OscarData *od, aim_module_t *mod);
1566
1567 void aim_genericreq_n(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype);
1568 void aim_genericreq_n_snacid(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype);
1569 void aim_genericreq_l(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype, guint32 *);
1570 void aim_genericreq_s(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype, guint16 *);
1571
1572 /* bstream.c */
1573 int byte_stream_new(ByteStream *bs, guint32 len);
1574 int byte_stream_init(ByteStream *bs, guint8 *data, int len);
1575 void byte_stream_destroy(ByteStream *bs);
1576 int byte_stream_empty(ByteStream *bs);
1577 int byte_stream_curpos(ByteStream *bs);
1578 int byte_stream_setpos(ByteStream *bs, unsigned int off);
1579 void byte_stream_rewind(ByteStream *bs);
1580 int byte_stream_advance(ByteStream *bs, int n);
1581 guint8 byte_stream_get8(ByteStream *bs);
1582 guint16 byte_stream_get16(ByteStream *bs);
1583 guint32 byte_stream_get32(ByteStream *bs);
1584 guint8 byte_stream_getle8(ByteStream *bs);
1585 guint16 byte_stream_getle16(ByteStream *bs);
1586 guint32 byte_stream_getle32(ByteStream *bs);
1587 int byte_stream_getrawbuf(ByteStream *bs, guint8 *buf, int len);
1588 guint8 *byte_stream_getraw(ByteStream *bs, int len);
1589 char *byte_stream_getstr(ByteStream *bs, int len);
1590 int byte_stream_put8(ByteStream *bs, guint8 v);
1591 int byte_stream_put16(ByteStream *bs, guint16 v);
1592 int byte_stream_put32(ByteStream *bs, guint32 v);
1593 int byte_stream_putle8(ByteStream *bs, guint8 v);
1594 int byte_stream_putle16(ByteStream *bs, guint16 v);
1595 int byte_stream_putle32(ByteStream *bs, guint32 v);
1596 int byte_stream_putraw(ByteStream *bs, const guint8 *v, int len);
1597 int byte_stream_putstr(ByteStream *bs, const char *str);
1598 int byte_stream_putbs(ByteStream *bs, ByteStream *srcbs, int len);
1599 int byte_stream_putuid(ByteStream *bs, OscarData *od);
1600 int byte_stream_putcaps(ByteStream *bs, guint32 caps);
1601
1602 /*
1603  * Generic SNAC structure.  Rarely if ever used.
1604  */
1605 typedef struct aim_snac_s {
1606         aim_snacid_t id;
1607         guint16 family;
1608         guint16 type;
1609         guint16 flags;
1610         void *data;
1611         time_t issuetime;
1612         struct aim_snac_s *next;
1613 } aim_snac_t;
1614
1615 /* snac.c */
1616 void aim_initsnachash(OscarData *od);
1617 aim_snacid_t aim_newsnac(OscarData *, aim_snac_t *newsnac);
1618 aim_snacid_t aim_cachesnac(OscarData *od, const guint16 family, const guint16 type, const guint16 flags, const void *data, const int datalen);
1619 aim_snac_t *aim_remsnac(OscarData *, aim_snacid_t id);
1620 void aim_cleansnacs(OscarData *, int maxage);
1621 int aim_putsnac(ByteStream *, guint16 family, guint16 type, guint16 flags, aim_snacid_t id);
1622
1623 struct chatsnacinfo {
1624         guint16 exchange;
1625         char name[128];
1626         guint16 instance;
1627 };
1628
1629 struct rateclass {
1630         guint16 classid;
1631         guint32 windowsize;
1632         guint32 clear;
1633         guint32 alert;
1634         guint32 limit;
1635         guint32 disconnect;
1636         guint32 current;
1637         guint32 max;
1638         guint8 unknown[5]; /* only present in versions >= 3 */
1639         GHashTable *members; /* Key is family and subtype, value is TRUE. */
1640
1641         struct timeval last; /**< The time when we last sent a SNAC of this rate class. */
1642 };
1643
1644 int aim_cachecookie(OscarData *od, IcbmCookie *cookie);
1645 IcbmCookie *aim_uncachecookie(OscarData *od, guint8 *cookie, int type);
1646 IcbmCookie *aim_mkcookie(guint8 *, int, void *);
1647 IcbmCookie *aim_checkcookie(OscarData *, const unsigned char *, const int);
1648 int aim_freecookie(OscarData *od, IcbmCookie *cookie);
1649 int aim_msgcookie_gettype(int type);
1650 int aim_cookie_free(OscarData *od, IcbmCookie *cookie);
1651
1652 int aim_chat_readroominfo(ByteStream *bs, struct aim_chat_roominfo *outinfo);
1653
1654 void flap_connection_destroy_chat(OscarData *od, FlapConnection *conn);
1655
1656 #ifdef __cplusplus
1657 }
1658 #endif
1659
1660 #endif /* _OSCAR_H_ */