include/aim.h

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