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