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