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 #if !defined(FAIM_USEPTHREADS) && !defined(FAIM_USEFAKELOCKS) && !defined(FAIM_USENOPLOCKS)
  20 #error pthreads, fakelocks, or noplocks are currently required.
  21 #endif
  22
  23 #include <stdio.h>
  24 #include <string.h>
  25 #include <fcntl.h>
  26 #include <sys/types.h>
  27 #include <stdlib.h>
  28 #include <stdarg.h>
  29 #include <errno.h>
  30 #include <time.h>
  31
  32 #ifdef _WIN32
  33 #include <windows.h>
  34 #include <io.h>
  35 #else
  36 #include <sys/time.h>
  37 #include <unistd.h>
  38 #include <netinet/in.h>
  39 #include <sys/socket.h>
  40 #endif
  41
  42 #ifdef FAIM_USEPTHREADS
  43 #include <pthread.h>
  44 #define faim_mutex_t pthread_mutex_t
  45 #define faim_mutex_init(x) pthread_mutex_init(x, NULL)
  46 #define faim_mutex_lock(x) pthread_mutex_lock(x)
  47 #define faim_mutex_unlock(x) pthread_mutex_unlock(x)
  48 #define faim_mutex_destroy(x) pthread_mutex_destroy(x)
  49 #elif defined(FAIM_USEFAKELOCKS)
  50 /*
  51  * For platforms without pthreads, we also assume
  52  * we're not linking against a threaded app.  Which
  53  * means we don't have to do real locking.  The
  54  * macros below do nothing really.  They're a joke.
  55  * But they get it to compile.
  56  */
  57 #define faim_mutex_t char
  58 #define faim_mutex_init(x) *x = 0
  59 #define faim_mutex_lock(x) while(*x != 0) {/* spin */}; *x = 1;
  60 #define faim_mutex_unlock(x) while(*x != 0) {/* spin spin spin */}; *x = 0;
  61 #define faim_mutex_destroy(x) while(*x != 0) {/* spiiiinnn */}; *x = 0;
  62 #elif defined(FAIM_USENOPLOCKS)
  63 #define faim_mutex_t char
  64 #define faim_mutex_init(x)
  65 #define faim_mutex_lock(x)
  66 #define faim_mutex_unlock(x)
  67 #define faim_mutex_destroy(x)
  68 #endif
  69
  70 /* Portability stuff (DMP) */
  71
  72 #ifdef _WIN32
  73 #define sleep(x) Sleep((x)*1000)
  74 #define snprintf _snprintf /* I'm not sure whats wrong with Microsoft here */
  75 #define close(x) closesocket(x) /* no comment */
  76 #endif
  77
  78 #if defined(mach) && defined(__APPLE__)
  79 #define gethostbyname(x) gethostbyname2(x, AF_INET)
  80 #endif
  81
  82 #if defined(_WIN32) || defined(STRICT_ANSI)
  83 #define faim_shortfunc
  84 #else
  85 #define faim_shortfunc inline
  86 #endif
  87
  88 #if defined(_WIN32) && !defined(WIN32_STATIC)
  89 /*
  90  * For a win32 DLL, we define WIN32_INDLL if this file
  91  * is included while compiling the DLL. If its not
  92  * defined (its included in a client app), the symbols
  93  * will be imported instead of exported.
  94  */
  95 #ifdef WIN32_INDLL
  96 #define faim_export __declspec(dllexport)
  97 #else
  98 #define faim_export __declspec(dllimport)
  99 #endif /* WIN32_INDLL */
 100 #define faim_internal
 101 #else
 102 /*
 103  * Nothing normally needed for unix...
 104  */
 105 #define faim_export
 106 #define faim_internal
 107 #endif
 108
 109 /*
 110  * Current Maximum Length for Screen Names (not including NULL)
 111  *
 112  * Currently only names up to 16 characters can be registered
 113  * however it is aparently legal for them to be larger.
 114  */
 115 #define MAXSNLEN 32
 116
 117 /*
 118  * Current Maximum Length for Instant Messages
 119  *
 120  * This was found basically by experiment, but not wholly
 121  * accurate experiment.  It should not be regarded
 122  * as completely correct.  But its a decent approximation.
 123  *
 124  * Note that although we can send this much, its impossible
 125  * for WinAIM clients (up through the latest (4.0.1957)) to
 126  * send any more than 1kb.  Amaze all your windows friends
 127  * with utterly oversized instant messages!
 128  *
 129  * XXX: the real limit is the total SNAC size at 8192. Fix this.
 130  *
 131  */
 132 #define MAXMSGLEN 7987
 133
 134 /*
 135  * Maximum size of a Buddy Icon.
 136  */
 137 #define MAXICONLEN 7168
 138 #define AIM_ICONIDENT "AVT1picture.id"
 139
 140 /*
 141  * Current Maximum Length for Chat Room Messages
 142  *
 143  * This is actually defined by the protocol to be
 144  * dynamic, but I have yet to see due cause to
 145  * define it dynamically here.  Maybe later.
 146  *
 147  */
 148 #define MAXCHATMSGLEN 512
 149
 150 /*
 151  * Standard size of an AIM authorization cookie
 152  */
 153 #define AIM_COOKIELEN            0x100
 154
 155 #define AIM_MD5_STRING "AOL Instant Messenger (SM)"
 156
 157 /*
 158  * Client info.  Filled in by the client and passed
 159  * in to aim_login().  The information ends up
 160  * getting passed to OSCAR through the initial
 161  * login command.
 162  *
 163  * XXX: Should this be per-session? -mid
 164  *
 165  */
 166 struct client_info_s {
 167   char clientstring[100]; /* arbitrary size */
 168   int major;
 169   int minor;
 170   int build;
 171   char country[3];
 172   char lang[3];
 173   int major2;
 174   int minor2;
 175   long unknown;
 176 };
 177
 178 #define AIM_CLIENTINFO_KNOWNGOOD_3_5_1670 { \
 179   "AOL Instant Messenger (SM), version 3.5.1670/WIN32", \
 180   0x0003, \
 181   0x0005, \
 182   0x0686, \
 183   "us", \
 184   "en", \
 185   0x0004, \
 186   0x0000, \
 187   0x0000002a, \
 188 }
 189
 190 #define AIM_CLIENTINFO_KNOWNGOOD_4_1_2010 { \
 191   "AOL Instant Messenger (SM), version 4.1.2010/WIN32", \
 192   0x0004, \
 193   0x0001, \
 194   0x07da, \
 195   "us", \
 196   "en", \
 197   0x0004, \
 198   0x0000, \
 199   0x0000004b, \
 200 }
 201
 202 /*
 203  * I would make 4.1.2010 the default, but they seem to have found
 204  * an alternate way of breaking that one.
 205  *
 206  * 3.5.1670 should work fine, however, you will be subjected to the
 207  * memory test, which may require you to have a WinAIM binary laying
 208  * around. (see login.c::memrequest())
 209  */
 210 #define AIM_CLIENTINFO_KNOWNGOOD AIM_CLIENTINFO_KNOWNGOOD_3_5_1670
 211
 212 #ifndef TRUE
 213 #define TRUE 1
 214 #define FALSE 0
 215 #endif
 216
 217 /*
 218  * These could be arbitrary, but its easier to use the actual AIM values
 219  */
 220 #define AIM_CONN_TYPE_AUTH          0x0007
 221 #define AIM_CONN_TYPE_ADS           0x0005
 222 #define AIM_CONN_TYPE_BOS           0x0002
 223 #define AIM_CONN_TYPE_CHAT          0x000e
 224 #define AIM_CONN_TYPE_CHATNAV       0x000d
 225
 226 /* they start getting arbitrary in rendezvous stuff =) */
 227 #define AIM_CONN_TYPE_RENDEZVOUS    0x0101 /* these do not speak OSCAR! */
 228 #define AIM_CONN_TYPE_RENDEZVOUS_OUT 0x0102 /* socket waiting for accept() */
 229
 230 /*
 231  * Subtypes, we need these for OFT stuff.
 232  */
 233 #define AIM_CONN_SUBTYPE_OFT_DIRECTIM  0x0001
 234 #define AIM_CONN_SUBTYPE_OFT_GETFILE   0x0002
 235 #define AIM_CONN_SUBTYPE_OFT_SENDFILE  0x0003
 236 #define AIM_CONN_SUBTYPE_OFT_BUDDYICON 0x0004
 237 #define AIM_CONN_SUBTYPE_OFT_VOICE     0x0005
 238
 239 /*
 240  * Status values returned from aim_conn_new().  ORed together.
 241  */
 242 #define AIM_CONN_STATUS_READY       0x0001
 243 #define AIM_CONN_STATUS_INTERNALERR 0x0002
 244 #define AIM_CONN_STATUS_RESOLVERR   0x0040
 245 #define AIM_CONN_STATUS_CONNERR     0x0080
 246 #define AIM_CONN_STATUS_INPROGRESS  0x0100
 247
 248 #define AIM_FRAMETYPE_OSCAR 0x0000
 249 #define AIM_FRAMETYPE_OFT 0x0001
 250
 251 struct aim_conn_t {
 252   int fd;
 253   unsigned short type;
 254   unsigned short subtype;
 255   int seqnum;
 256   int status;
 257   void *priv; /* misc data the client may want to store */
 258   time_t lastactivity; /* time of last transmit */
 259   int forcedlatency;
 260   struct aim_rxcblist_t *handlerlist;
 261   faim_mutex_t active; /* lock around read/writes */
 262   faim_mutex_t seqnum_lock; /* lock around ->seqnum changes */
 263   void *sessv;
 264   struct aim_conn_t *next;
 265 };
 266
 267 /* struct for incoming commands */
 268 struct command_rx_struct {
 269   unsigned char hdrtype; /* defines which piece of the union to use */
 270   union {
 271     struct {
 272       char type;
 273       unsigned short seqnum;
 274     } oscar;
 275     struct {
 276       unsigned short type;
 277       unsigned char magic[4]; /* ODC2 OFT2 */
 278       unsigned short hdr2len;
 279       unsigned char *hdr2; /* rest of bloated header */
 280     } oft;
 281   } hdr;
 282   unsigned short commandlen;         /* total payload length */
 283   unsigned char *data;             /* packet data (from 7 byte on) */
 284   unsigned char lock;               /* 0 = open, !0 = locked */
 285   unsigned char handled;            /* 0 = new, !0 = been handled */
 286   unsigned char nofree;             /* 0 = free data on purge, 1 = only unlink */
 287   struct aim_conn_t *conn;  /* the connection it came in on... */
 288   struct command_rx_struct *next; /* ptr to next struct in list */
 289 };
 290
 291 /* struct for outgoing commands */
 292 struct command_tx_struct {
 293   unsigned char hdrtype; /* defines which piece of the union to use */
 294   union {
 295     struct {
 296       unsigned char type;
 297       unsigned short seqnum;
 298     } oscar;
 299     struct {
 300       unsigned short type;
 301       unsigned char magic[4]; /* ODC2 OFT2 */
 302       unsigned short hdr2len;
 303       unsigned char *hdr2;
 304     } oft;
 305   } hdr;
 306   u_int commandlen;
 307   u_char *data;
 308   u_int lock;               /* 0 = open, !0 = locked */
 309   u_int sent;               /* 0 = pending, !0 = has been sent */
 310   struct aim_conn_t *conn;
 311   struct command_tx_struct *next; /* ptr to next struct in list */
 312 };
 313
 314 /*
 315  * AIM Session: The main client-data interface.
 316  *
 317  */
 318 struct aim_session_t {
 319
 320   /* ---- Client Accessible ------------------------ */
 321   /*
 322    * Our screen name.
 323    *
 324    */
 325   char sn[MAXSNLEN+1];
 326
 327   /*
 328    * Pointer to anything the client wants to
 329    * explicitly associate with this session.
 330    *
 331    * This is for use in the callbacks mainly. In any
 332    * callback, you can access this with sess->aux_data.
 333    *
 334    */
 335   void *aux_data;
 336
 337   /* ---- Internal Use Only ------------------------ */
 338   /*
 339    * Connection information
 340    */
 341   struct aim_conn_t *connlist;
 342   faim_mutex_t connlistlock;
 343
 344   /*
 345    * TX/RX queues
 346    */
 347   struct command_tx_struct *queue_outgoing;
 348   struct command_rx_struct *queue_incoming;
 349
 350   /*
 351    * Tx Enqueuing function
 352    */
 353   int (*tx_enqueue)(struct aim_session_t *, struct command_tx_struct *);
 354
 355   /*
 356    * This is a dreadful solution to the what-room-are-we-joining
 357    * problem.  (There's no connection between the service
 358    * request and the resulting redirect.)
 359    */
 360   char *pendingjoin;
 361   unsigned short pendingjoinexchange;
 362
 363   /*
 364    * Outstanding snac handling
 365    *
 366    * XXX: Should these be per-connection? -mid
 367    */
 368   struct aim_snac_t *snac_hash[FAIM_SNAC_HASH_SIZE];
 369   faim_mutex_t snac_hash_locks[FAIM_SNAC_HASH_SIZE];
 370   unsigned long snac_nextid;
 371
 372   struct {
 373     char server[128];
 374     char username[128];
 375     char password[128];
 376   } socksproxy;
 377
 378   unsigned long flags;
 379
 380   int debug;
 381   void (*debugcb)(struct aim_session_t *sess, int level, const char *format, va_list va); /* same as faim_debugging_callback_t */
 382
 383   struct aim_msgcookie_t *msgcookies;
 384
 385   void *modlistv;
 386 };
 387
 388 /* Values for sess->flags */
 389 #define AIM_SESS_FLAGS_SNACLOGIN       0x00000001
 390 #define AIM_SESS_FLAGS_XORLOGIN        0x00000002
 391 #define AIM_SESS_FLAGS_NONBLOCKCONNECT 0x00000004
 392
 393 /*
 394  * AIM User Info, Standard Form.
 395  */
 396 struct aim_userinfo_s {
 397   char sn[MAXSNLEN+1];
 398   u_short warnlevel;
 399   u_short idletime;
 400   u_short flags;
 401   u_long membersince;
 402   u_long onlinesince;
 403   u_long sessionlen;
 404   u_short capabilities;
 405   struct {
 406     unsigned short status;
 407     unsigned int ipaddr;
 408     char crap[0x25]; /* until we figure it out... */
 409   } icqinfo;
 410 };
 411
 412 #define AIM_FLAG_UNCONFIRMED    0x0001 /* "damned transients" */
 413 #define AIM_FLAG_ADMINISTRATOR  0x0002
 414 #define AIM_FLAG_AOL            0x0004
 415 #define AIM_FLAG_OSCAR_PAY      0x0008
 416 #define AIM_FLAG_FREE           0x0010
 417 #define AIM_FLAG_AWAY           0x0020
 418 #define AIM_FLAG_UNKNOWN40      0x0040
 419 #define AIM_FLAG_UNKNOWN80      0x0080
 420
 421 #define AIM_FLAG_ALLUSERS       0x001f
 422
 423
 424 #if defined(FAIM_INTERNAL) || defined(FAIM_NEED_TLV)
 425 /*
 426  * TLV handling
 427  */
 428
 429 /* Generic TLV structure. */
 430 struct aim_tlv_t {
 431   u_short type;
 432   u_short length;
 433   u_char *value;
 434 };
 435
 436 /* List of above. */
 437 struct aim_tlvlist_t {
 438   struct aim_tlv_t *tlv;
 439   struct aim_tlvlist_t *next;
 440 };
 441
 442 /* TLV-handling functions */
 443 faim_internal struct aim_tlvlist_t *aim_readtlvchain(const unsigned char *buf, const int maxlen);
 444 faim_internal void aim_freetlvchain(struct aim_tlvlist_t **list);
 445 faim_internal struct aim_tlv_t *aim_grabtlv(const unsigned char *src);
 446 faim_internal struct aim_tlv_t *aim_grabtlvstr(const unsigned char *src);
 447 faim_internal struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *, const unsigned short, const int);
 448 faim_internal char *aim_gettlv_str(struct aim_tlvlist_t *, const unsigned short, const int);
 449 faim_internal unsigned char aim_gettlv8(struct aim_tlvlist_t *list, const unsigned short type, const int num);
 450 faim_internal unsigned short aim_gettlv16(struct aim_tlvlist_t *list, const unsigned short type, const int num);
 451 faim_internal unsigned long aim_gettlv32(struct aim_tlvlist_t *list, const unsigned short type, const int num);
 452 faim_internal int aim_puttlv (unsigned char *dest, struct aim_tlv_t *newtlv);
 453 faim_internal struct aim_tlv_t *aim_createtlv(void);
 454 faim_internal int aim_freetlv(struct aim_tlv_t **oldtlv);
 455 faim_internal int aim_puttlv_8(unsigned char *buf, const unsigned short t, const unsigned char  v);
 456 faim_internal int aim_puttlv_16(unsigned char *, const unsigned short, const unsigned short);
 457 faim_internal int aim_puttlv_32(unsigned char *, const unsigned short, const unsigned long);
 458 faim_internal int aim_puttlv_str(u_char *buf, const unsigned short t, const int l, const char *v);
 459 faim_internal int aim_writetlvchain(unsigned char *buf, const int buflen, struct aim_tlvlist_t **list);
 460 faim_internal int aim_addtlvtochain16(struct aim_tlvlist_t **list, const unsigned short type, const unsigned short val);
 461 faim_internal int aim_addtlvtochain32(struct aim_tlvlist_t **list, const unsigned short type, const unsigned long val);
 462 faim_internal int aim_addtlvtochain_str(struct aim_tlvlist_t **list, const unsigned short type, const char *str, const int len);
 463 faim_internal int aim_addtlvtochain_caps(struct aim_tlvlist_t **list, const unsigned short type, const unsigned short caps);
 464 faim_internal int aim_addtlvtochain_noval(struct aim_tlvlist_t **list, const unsigned short type);
 465 faim_internal int aim_counttlvchain(struct aim_tlvlist_t **list);
 466 #endif /* FAIM_INTERNAL */
 467
 468 /*
 469  * Get command from connections / Dispatch commands
 470  * already in queue.
 471  */
 472 faim_export int aim_get_command(struct aim_session_t *, struct aim_conn_t *);
 473 int aim_rxdispatch(struct aim_session_t *);
 474
 475 faim_export unsigned long aim_debugconn_sendconnect(struct aim_session_t *sess, struct aim_conn_t *conn);
 476
 477 faim_export int aim_logoff(struct aim_session_t *);
 478
 479 #if !defined(FAIM_INTERNAL) || defined(FAIM_INTERNAL_INSANE)
 480 /* the library should never call aim_conn_kill */
 481 faim_export void aim_conn_kill(struct aim_session_t *sess, struct aim_conn_t **deadconn);
 482 #endif
 483
 484 typedef int (*aim_rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...);
 485
 486 /* aim_login.c */
 487 faim_export int aim_sendconnack(struct aim_session_t *sess, struct aim_conn_t *conn);
 488 faim_export int aim_request_login (struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);
 489 faim_export int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *, char *key);
 490 faim_export int aim_encode_password_md5(const char *password, const char *key, unsigned char *digest);
 491 faim_export unsigned long aim_sendauthresp(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn, int errorcode, char *errorurl, char *bosip, char *cookie, char *email, int regstatus);
 492 faim_export int aim_gencookie(unsigned char *buf);
 493 faim_export int aim_sendserverready(struct aim_session_t *sess, struct aim_conn_t *conn);
 494 faim_export unsigned long aim_sendredirect(struct aim_session_t *sess, struct aim_conn_t *conn, unsigned short servid, char *ip, char *cookie);
 495 faim_export void aim_purge_rxqueue(struct aim_session_t *);
 496
 497 #define AIM_TX_QUEUED    0 /* default */
 498 #define AIM_TX_IMMEDIATE 1
 499 #define AIM_TX_USER      2
 500 faim_export int aim_tx_setenqueue(struct aim_session_t *sess, int what,  int (*func)(struct aim_session_t *, struct command_tx_struct *));
 501
 502 faim_export int aim_tx_flushqueue(struct aim_session_t *);
 503 faim_export void aim_tx_purgequeue(struct aim_session_t *);
 504
 505 struct aim_rxcblist_t {
 506   u_short family;
 507   u_short type;
 508   aim_rxcallback_t handler;
 509   u_short flags;
 510   struct aim_rxcblist_t *next;
 511 };
 512
 513 faim_export int aim_conn_setlatency(struct aim_conn_t *conn, int newval);
 514
 515 faim_export int aim_conn_addhandler(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short type, aim_rxcallback_t newhandler, u_short flags);
 516 faim_export int aim_clearhandlers(struct aim_conn_t *conn);
 517
 518 faim_export struct aim_session_t *aim_conn_getsess(struct aim_conn_t *conn);
 519 faim_export void aim_conn_close(struct aim_conn_t *deadconn);
 520 faim_export struct aim_conn_t *aim_newconn(struct aim_session_t *, int type, char *dest);
 521 faim_export int aim_conngetmaxfd(struct aim_session_t *);
 522 faim_export struct aim_conn_t *aim_select(struct aim_session_t *, struct timeval *, int *);
 523 faim_export int aim_conn_isready(struct aim_conn_t *);
 524 faim_export int aim_conn_setstatus(struct aim_conn_t *, int);
 525 faim_export int aim_conn_completeconnect(struct aim_session_t *sess, struct aim_conn_t *conn);
 526 faim_export int aim_conn_isconnecting(struct aim_conn_t *conn);
 527
 528 typedef void (*faim_debugging_callback_t)(struct aim_session_t *sess, int level, const char *format, va_list va);
 529 faim_export int aim_setdebuggingcb(struct aim_session_t *sess, faim_debugging_callback_t);
 530 faim_export void aim_session_init(struct aim_session_t *, unsigned long flags, int debuglevel);
 531 faim_export void aim_session_kill(struct aim_session_t *);
 532 faim_export void aim_setupproxy(struct aim_session_t *sess, char *server, char *username, char *password);
 533 faim_export struct aim_conn_t *aim_getconn_type(struct aim_session_t *, int type);
 534 faim_export struct aim_conn_t *aim_getconn_type_all(struct aim_session_t *, int type);
 535 faim_export struct aim_conn_t *aim_getconn_fd(struct 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_send_warning(struct aim_session_t *sess, struct aim_conn_t *conn, const char *destsn, unsigned long flags);
 550 faim_export unsigned long aim_bos_nop(struct aim_session_t *, struct aim_conn_t *);
 551 faim_export unsigned long aim_flap_nop(struct aim_session_t *sess, struct aim_conn_t *conn);
 552 faim_export unsigned long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long);
 553 faim_export unsigned long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *);
 554 faim_export unsigned long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *);
 555 faim_export unsigned long aim_bos_setprofile(struct aim_session_t *sess, struct aim_conn_t *conn, const char *profile, const char *awaymsg, unsigned short caps);
 556 faim_export unsigned long aim_bos_setgroupperm(struct aim_session_t *, struct aim_conn_t *, u_long);
 557 faim_export unsigned long aim_bos_clientready(struct aim_session_t *, struct aim_conn_t *);
 558 faim_export unsigned long aim_bos_reqrate(struct aim_session_t *, struct aim_conn_t *);
 559 faim_export unsigned long aim_bos_ackrateresp(struct aim_session_t *, struct aim_conn_t *);
 560 faim_export unsigned long aim_bos_setprivacyflags(struct aim_session_t *, struct aim_conn_t *, u_long);
 561 faim_export unsigned long aim_bos_reqpersonalinfo(struct aim_session_t *, struct aim_conn_t *);
 562 faim_export unsigned long aim_bos_reqservice(struct aim_session_t *, struct aim_conn_t *, u_short);
 563 faim_export unsigned long aim_bos_reqrights(struct aim_session_t *, struct aim_conn_t *);
 564 faim_export unsigned long aim_bos_reqbuddyrights(struct aim_session_t *, struct aim_conn_t *);
 565 faim_export unsigned long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *);
 566 faim_export unsigned long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *);
 567 faim_export unsigned long aim_addicbmparam(struct aim_session_t *sess,struct aim_conn_t *conn);
 568 faim_export unsigned long aim_setversions(struct aim_session_t *sess, struct aim_conn_t *conn);
 569 faim_export unsigned long aim_auth_setversions(struct aim_session_t *sess, struct aim_conn_t *conn);
 570 faim_export unsigned long aim_auth_reqconfirm(struct aim_session_t *sess, struct aim_conn_t *conn);
 571 faim_export unsigned long aim_auth_getinfo(struct aim_session_t *sess, struct aim_conn_t *conn, unsigned short info);
 572 faim_export unsigned long aim_auth_setemail(struct aim_session_t *sess, struct aim_conn_t *conn, char *newemail);
 573 faim_export unsigned long aim_setdirectoryinfo(struct aim_session_t *sess, struct aim_conn_t *conn, char *first, char *middle, char *last, char *maiden, char *nickname, char *street, char *city, char *state, char *zip, int country, unsigned short privacy);
 574 faim_export unsigned long aim_setuserinterests(struct aim_session_t *sess, struct aim_conn_t *conn, char *interest1, char *interest2, char *interest3, char *interest4, char *interest5, unsigned short privacy);
 575 faim_export unsigned long aim_icq_setstatus(struct aim_session_t *sess, struct aim_conn_t *conn, unsigned long status);
 576
 577 faim_export struct aim_fileheader_t *aim_getlisting(struct aim_session_t *sess, FILE *);
 578
 579 /* aim_rxhandlers.c */
 580 faim_export int aim_rxdispatch(struct aim_session_t *);
 581
 582 #define AIM_CLIENTTYPE_UNKNOWN  0x0000
 583 #define AIM_CLIENTTYPE_MC       0x0001
 584 #define AIM_CLIENTTYPE_WINAIM   0x0002
 585 #define AIM_CLIENTTYPE_WINAIM41 0x0003
 586 #define AIM_CLIENTTYPE_AOL_TOC  0x0004
 587 faim_export unsigned short aim_fingerprintclient(unsigned char *msghdr, int len);
 588
 589 #define AIM_RATE_CODE_CHANGE     0x0001
 590 #define AIM_RATE_CODE_WARNING    0x0002
 591 #define AIM_RATE_CODE_LIMIT      0x0003
 592 #define AIM_RATE_CODE_CLEARLIMIT 0x0004
 593 faim_export unsigned long aim_ads_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);
 594 faim_export unsigned long aim_ads_requestads(struct aim_session_t *sess, struct aim_conn_t *conn);
 595
 596 /* aim_im.c */
 597 struct aim_directim_priv {
 598   unsigned char cookie[8];
 599   char sn[MAXSNLEN+1];
 600   char ip[30];
 601 };
 602
 603 struct aim_fileheader_t {
 604 #if 0
 605   char  magic[4];            /* 0 */
 606   short hdrlen;           /* 4 */
 607   short hdrtype;             /* 6 */
 608 #endif
 609   char  bcookie[8];       /* 8 */
 610   short encrypt;          /* 16 */
 611   short compress;         /* 18 */
 612   short totfiles;         /* 20 */
 613   short filesleft;        /* 22 */
 614   short totparts;         /* 24 */
 615   short partsleft;        /* 26 */
 616   long  totsize;          /* 28 */
 617   long  size;             /* 32 */
 618   long  modtime;          /* 36 */
 619   long  checksum;         /* 40 */
 620   long  rfrcsum;          /* 44 */
 621   long  rfsize;           /* 48 */
 622   long  cretime;          /* 52 */
 623   long  rfcsum;           /* 56 */
 624   long  nrecvd;           /* 60 */
 625   long  recvcsum;         /* 64 */
 626   char  idstring[32];     /* 68 */
 627   char  flags;            /* 100 */
 628   char  lnameoffset;      /* 101 */
 629   char  lsizeoffset;      /* 102 */
 630   char  dummy[69];        /* 103 */
 631   char  macfileinfo[16];  /* 172 */
 632   short nencode;          /* 188 */
 633   short nlanguage;        /* 190 */
 634   char  name[64];         /* 192 */
 635                           /* 256 */
 636 };
 637
 638 struct aim_filetransfer_priv {
 639         char sn[MAXSNLEN];
 640         char cookie[8];
 641         char ip[30];
 642         int state;
 643         struct aim_fileheader_t fh;
 644 };
 645
 646 struct aim_chat_roominfo {
 647         unsigned short exchange;
 648         char *name;
 649         unsigned short instance;
 650 };
 651
 652 #define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
 653 #define AIM_IMFLAGS_ACK  0x02 /* request a receipt notice */
 654 #define AIM_IMFLAGS_UNICODE    0x04
 655 #define AIM_IMFLAGS_ISO_8859_1 0x08
 656 #define AIM_IMFLAGS_BUDDYREQ   0x10 /* buddy icon requested */
 657 #define AIM_IMFLAGS_HASICON    0x20 /* already has icon (timestamp included) */
 658 #define AIM_IMFLAGS_SUBENC_MACINTOSH    0x40 /* damn that Steve Jobs! */
 659
 660 struct aim_sendimext_args {
 661         const char *destsn;
 662         unsigned short flags;
 663         const char *msg;
 664         int msglen;
 665         int iconlen;
 666         time_t iconstamp;
 667         unsigned short iconsum;
 668 };
 669
 670 struct aim_incomingim_ch1_args {
 671         char *msg;
 672         int msglen;
 673         unsigned long icbmflags;
 674         unsigned short flag1;
 675         unsigned short flag2;
 676         int finlen;
 677         unsigned char fingerprint[10];
 678         time_t iconstamp;
 679         int extdatalen;
 680         unsigned char *extdata;
 681 };
 682
 683 struct aim_incomingim_ch2_args {
 684         unsigned short reqclass;
 685         unsigned short status;
 686         union {
 687                 struct {
 688                         unsigned int length;
 689                         time_t timestamp;
 690                         unsigned char *icon;
 691                 } icon;
 692                 struct {
 693                 } voice;
 694                 struct aim_directim_priv *directim;
 695                 struct {
 696                         char *msg;
 697                         char *encoding;
 698                         char *lang;
 699                 struct aim_chat_roominfo roominfo;
 700                 } chat;
 701                 struct {
 702                         char *ip;
 703                         unsigned char *cookie;
 704                 } getfile;
 705                 struct {
 706                 } sendfile;
 707         } info;
 708 };
 709
 710 faim_export int aim_send_im_ext(struct aim_session_t *sess, struct aim_conn_t *conn, struct aim_sendimext_args *args);
 711 faim_export int aim_send_im(struct aim_session_t *, struct aim_conn_t *, const char *destsn, unsigned short flags, const char *msg);
 712 faim_export int aim_send_icon(struct aim_session_t *sess, struct aim_conn_t *conn, const char *sn, const unsigned char *icon, int iconlen, time_t stamp, unsigned short iconsum);
 713 faim_export unsigned short aim_iconsum(const unsigned char *buf, int buflen);
 714 faim_export int aim_send_im_direct(struct aim_session_t *, struct aim_conn_t *, char *);
 715 faim_export struct aim_conn_t * aim_directim_initiate(struct aim_session_t *, struct aim_conn_t *, struct aim_directim_priv *, char *destsn);
 716 faim_export struct aim_conn_t *aim_directim_connect(struct aim_session_t *, struct aim_conn_t *, struct aim_directim_priv *);
 717 faim_export unsigned long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn);
 718
 719 faim_export struct aim_conn_t *aim_getfile_initiate(struct aim_session_t *sess, struct aim_conn_t *conn, char *destsn);
 720 faim_export int aim_oft_getfile_request(struct aim_session_t *sess, struct aim_conn_t *conn, const unsigned char *name, const int size);
 721 faim_export int aim_oft_getfile_ack(struct aim_session_t *sess, struct aim_conn_t *conn);
 722 faim_export int aim_oft_getfile_end(struct aim_session_t *sess, struct aim_conn_t *conn);
 723
 724 /* aim_info.c */
 725 #define AIM_CAPS_BUDDYICON      0x0001
 726 #define AIM_CAPS_VOICE          0x0002
 727 #define AIM_CAPS_IMIMAGE        0x0004
 728 #define AIM_CAPS_CHAT           0x0008
 729 #define AIM_CAPS_GETFILE        0x0010
 730 #define AIM_CAPS_SENDFILE       0x0020
 731 #define AIM_CAPS_GAMES          0x0040
 732 #define AIM_CAPS_SAVESTOCKS     0x0080
 733 #define AIM_CAPS_SENDBUDDYLIST  0x0100
 734 #define AIM_CAPS_GAMES2         0x0200
 735 #define AIM_CAPS_LAST           0x8000
 736
 737 faim_export int aim_0002_000b(struct aim_session_t *sess, struct aim_conn_t *conn, const char *sn);
 738
 739 #define AIM_SENDMEMBLOCK_FLAG_ISREQUEST  0
 740 #define AIM_SENDMEMBLOCK_FLAG_ISHASH     1
 741
 742 faim_export int aim_sendmemblock(struct aim_session_t *sess, struct aim_conn_t *conn, unsigned long offset, unsigned long len, const unsigned char *buf, unsigned char flag);
 743
 744 #define AIM_GETINFO_GENERALINFO 0x00001
 745 #define AIM_GETINFO_AWAYMESSAGE 0x00003
 746
 747 struct aim_msgcookie_t {
 748   unsigned char cookie[8];
 749   int type;
 750   void *data;
 751   time_t addtime;
 752   struct aim_msgcookie_t *next;
 753 };
 754
 755 struct aim_invite_priv {
 756   char *sn;
 757   char *roomname;
 758   int exchange;
 759   int instance;
 760 };
 761
 762 #define AIM_COOKIETYPE_UNKNOWN  0x00
 763 #define AIM_COOKIETYPE_ICBM     0x01
 764 #define AIM_COOKIETYPE_ADS      0x02
 765 #define AIM_COOKIETYPE_BOS      0x03
 766 #define AIM_COOKIETYPE_IM       0x04
 767 #define AIM_COOKIETYPE_CHAT     0x05
 768 #define AIM_COOKIETYPE_CHATNAV  0x06
 769 #define AIM_COOKIETYPE_INVITE   0x07
 770 /* we'll move OFT up a bit to give breathing room.  not like it really
 771  * matters. */
 772 #define AIM_COOKIETYPE_OFTIM    0x10
 773 #define AIM_COOKIETYPE_OFTGET   0x11
 774 #define AIM_COOKIETYPE_OFTSEND  0x12
 775 #define AIM_COOKIETYPE_OFTVOICE 0x13
 776 #define AIM_COOKIETYPE_OFTIMAGE 0x14
 777 #define AIM_COOKIETYPE_OFTICON  0x15
 778
 779 faim_export int aim_handlerendconnect(struct aim_session_t *sess, struct aim_conn_t *cur);
 780
 781 #define AIM_TRANSFER_DENY_NOTSUPPORTED 0x0000
 782 #define AIM_TRANSFER_DENY_DECLINE 0x0001
 783 #define AIM_TRANSFER_DENY_NOTACCEPTING 0x0002
 784 faim_export unsigned long aim_denytransfer(struct aim_session_t *sess, struct aim_conn_t *conn, char *sender, char *cookie, unsigned short code);
 785 faim_export struct aim_conn_t *aim_accepttransfer(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn, char *cookie, char *ip, unsigned short listingfiles, unsigned short listingtotsize, unsigned short listingsize, unsigned int listingchecksum, unsigned short rendid);
 786
 787 faim_export int aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *, unsigned short);
 788 faim_export int aim_sendbuddyoncoming(struct aim_session_t *sess, struct aim_conn_t *conn, struct aim_userinfo_s *info);
 789 faim_export int aim_sendbuddyoffgoing(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);
 790
 791
 792 /* aim_auth.c */
 793 faim_export int aim_auth_sendcookie(struct aim_session_t *, struct aim_conn_t *, u_char *);
 794 faim_export u_long aim_auth_clientready(struct aim_session_t *, struct aim_conn_t *);
 795 faim_export unsigned long aim_auth_changepasswd(struct aim_session_t *, struct aim_conn_t *, char *, char *);
 796
 797 /* aim_buddylist.c */
 798 faim_export unsigned long aim_add_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
 799 faim_export unsigned long aim_remove_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
 800
 801 /* aim_search.c */
 802 faim_export u_long aim_usersearch_address(struct aim_session_t *, struct aim_conn_t *, char *);
 803
 804 struct aim_chat_exchangeinfo {
 805   u_short number;
 806   char *name;
 807   char *charset1;
 808   char *lang1;
 809   char *charset2;
 810   char *lang2;
 811 };
 812
 813 #define AIM_CHATFLAGS_NOREFLECT 0x0001
 814 #define AIM_CHATFLAGS_AWAY      0x0002
 815 faim_export unsigned long aim_chat_send_im(struct aim_session_t *sess, struct aim_conn_t *conn, unsigned short flags, const char *msg, int msglen);
 816 faim_export unsigned long aim_chat_join(struct aim_session_t *sess, struct aim_conn_t *conn, u_short exchange, const char *roomname);
 817 faim_export unsigned long aim_chat_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);
 818 faim_export int aim_chat_attachname(struct aim_conn_t *conn, char *roomname);
 819 faim_export char *aim_chat_getname(struct aim_conn_t *conn);
 820 faim_export struct aim_conn_t *aim_chat_getconn(struct aim_session_t *, char *name);
 821
 822 faim_export unsigned long aim_chatnav_reqrights(struct aim_session_t *sess, struct aim_conn_t *conn);
 823 faim_export unsigned long aim_chatnav_clientready(struct aim_session_t *sess, struct aim_conn_t *conn);
 824
 825 faim_export unsigned long aim_chat_invite(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn, char *msg, u_short exchange, char *roomname, u_short instance);
 826
 827 faim_export u_long aim_chatnav_createroom(struct aim_session_t *sess, struct aim_conn_t *conn, char *name, u_short exchange);
 828 faim_export int aim_chat_leaveroom(struct aim_session_t *sess, char *name);
 829
 830 /* aim_util.c */
 831 #ifdef AIMUTIL_USEMACROS
 832 /*
 833  * These are really ugly.  You'd think this was LISP.  I wish it was.
 834  */
 835 #define aimutil_put8(buf, data) ((*(buf) = (u_char)(data)&0xff),1)
 836 #define aimutil_get8(buf) ((*(buf))&0xff)
 837 #define aimutil_put16(buf, data) ( \
 838                                   (*(buf) = (u_char)((data)>>8)&0xff), \
 839                                   (*((buf)+1) = (u_char)(data)&0xff),  \
 840                                   2)
 841 #define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
 842 #define aimutil_put32(buf, data) ( \
 843                                   (*((buf)) = (u_char)((data)>>24)&0xff), \
 844                                   (*((buf)+1) = (u_char)((data)>>16)&0xff), \
 845                                   (*((buf)+2) = (u_char)((data)>>8)&0xff), \
 846                                   (*((buf)+3) = (u_char)(data)&0xff), \
 847                                   4)
 848 #define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
 849                             (((*((buf)+1))<<16)&0x00ff0000) + \
 850                             (((*((buf)+2))<< 8)&0x0000ff00) + \
 851                             (((*((buf)+3)    )&0x000000ff)))
 852 #else
 853 #warning Not using aimutil macros.  May have performance problems.
 854 int aimutil_put8(u_char *, u_char);
 855 u_char aimutil_get8(u_char *buf);
 856 int aimutil_put16(u_char *, u_short);
 857 u_short aimutil_get16(u_char *);
 858 int aimutil_put32(u_char *, u_long);
 859 u_long aimutil_get32(u_char *);
 860 #endif
 861
 862 faim_export int aimutil_putstr(u_char *, const char *, int);
 863 faim_export int aimutil_tokslen(char *toSearch, int index, char dl);
 864 faim_export int aimutil_itemcnt(char *toSearch, char dl);
 865 faim_export char *aimutil_itemidx(char *toSearch, int index, char dl);
 866
 867 faim_export int aim_snlen(const char *sn);
 868 faim_export int aim_sncmp(const char *sn1, const char *sn2);
 869
 870 /* for libc's that dont have it */
 871 faim_export char *aim_strsep(char **pp, const char *delim);
 872
 873 /* aim_meta.c */
 874 faim_export char *aim_getbuilddate(void);
 875 faim_export char *aim_getbuildtime(void);
 876 faim_export int aim_getbuildstring(char *buf, int buflen);
 877
 878 #include <aim_internal.h>
 879
 880 #endif /* __AIM_H__ */
 881