faim/aim.h

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