]> andersk Git - libfaim.git/blobdiff - faim/aim.h
- Mon Aug 28 03:11:15 GMT 2000
[libfaim.git] / faim / aim.h
index 82166283f039cb99b50e05817adbba82d341028e..6f5165e46ab9af60f5fbe77ad0357ca7530ca18d 100644 (file)
@@ -6,9 +6,17 @@
 #ifndef __AIM_H__
 #define __AIM_H__
 
+#define FAIM_VERSION_MAJOR 0
+#define FAIM_VERSION_MINOR 99
+#define FAIM_VERSION_MINORMINOR 0
+
 #include <faim/faimconfig.h>
 #include <faim/aim_cbtypes.h>
 
+#if !defined(FAIM_USEPTHREADS) && !defined(FAIM_USEFAKELOCKS)
+#error pthreads or fakelocks are currently required.
+#endif
+
 #include <stdio.h>
 #include <string.h>
 #include <fcntl.h>
 #include <unistd.h>
 #endif
 
+#ifdef FAIM_USEPTHREADS
+#include <pthread.h>
+#define faim_mutex_t pthread_mutex_t 
+#define faim_mutex_init(x) pthread_mutex_init(x, NULL)
+#define faim_mutex_lock(x) pthread_mutex_lock(x)
+#define faim_mutex_unlock(x) pthread_mutex_unlock(x)
+#define faim_mutex_destroy(x) pthread_mutex_destroy(x)
+#elif defined(FAIM_USEFAKELOCKS)
+/*
+ * For platforms without pthreads, we also assume
+ * we're not linking against a threaded app.  Which
+ * means we don't have to do real locking.  The 
+ * macros below do nothing really.  They're a joke.
+ * But they get it to compile.
+ */
+#define faim_mutex_t char
+#define faim_mutex_init(x) *x = 0
+#define faim_mutex_lock(x) *x = 1;
+#define faim_mutex_unlock(x) *x = 0;
+#define faim_mutex_destroy(x) *x = 0;
+#endif
+
 /* Portability stuff (DMP) */
 
 #ifdef _WIN32
 #define strlen(x) (int)strlen(x)  /* win32 has a unsigned size_t */
 #endif
 
-#if defined(_WIN32) || (defined(mach) && defined(__APPLE__)) 
-#define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */
-#endif 
+#if defined(mach) && defined(__APPLE__)
+#define gethostbyname(x) gethostbyname2(x, AF_INET) 
+#endif
+
+#if !defined(MSG_WAITALL)
+#warning FIX YOUR LIBC! MSG_WAITALL is required!
+#define MSG_WAITALL 0x100
+#endif
 
 /* 
  * Current Maximum Length for Screen Names (not including NULL) 
+ *
+ * Currently only names up to 16 characters can be registered
+ * however it is aparently legal for them to be larger.
  */
-#define MAXSNLEN 16
+#define MAXSNLEN 32
+
+/*
+ * Current Maximum Length for Instant Messages
+ *
+ * This was found basically by experiment, but not wholly
+ * accurate experiment.  It should not be regarded
+ * as completely correct.  But its a decent approximation.
+ *
+ * Note that although we can send this much, its impossible
+ * for WinAIM clients (up through the latest (4.0.1957)) to
+ * send any more than 1kb.  Amaze all your windows friends
+ * with utterly oversized instant messages!
+ *
+ * XXX: the real limit is the total SNAC size at 8192. Fix this.
+ * 
+ */
+#define MAXMSGLEN 7987
+
+/*
+ * Current Maximum Length for Chat Room Messages
+ *
+ * This is actually defined by the protocol to be
+ * dynamic, but I have yet to see due cause to 
+ * define it dynamically here.  Maybe later.
+ *
+ */
+#define MAXCHATMSGLEN 512
 
 /*
  * Standard size of an AIM authorization cookie
  */
 #define AIM_COOKIELEN            0x100
 
+#define AIM_MD5_STRING "AOL Instant Messenger (SM)"
+
 #if debug > 0
 #define faimdprintf(l, x...) {if (l >= debug) printf(x); }
 #else
@@ -88,6 +155,9 @@ struct client_info_s {
   int build;
   char country[3];
   char lang[3];
+  int major2;
+  int minor2;
+  long unknown;
 };
 
 #ifndef TRUE
@@ -104,6 +174,19 @@ struct client_info_s {
 #define AIM_CONN_TYPE_CHAT          0x000e
 #define AIM_CONN_TYPE_CHATNAV       0x000d
 
+/* they start getting arbitrary in rendezvous stuff =) */
+#define AIM_CONN_TYPE_RENDEZVOUS    0x0101 /* these do not speak OSCAR! */
+#define AIM_CONN_TYPE_RENDEZVOUS_OUT 0x0102 /* socket waiting for accept() */
+
+/*
+ * Subtypes, we need these for OFT stuff.
+ */
+#define AIM_CONN_SUBTYPE_OFT_DIRECTIM  0x0001
+#define AIM_CONN_SUBTYPE_OFT_GETFILE   0x0002
+#define AIM_CONN_SUBTYPE_OFT_SENDFILE  0x0003
+#define AIM_CONN_SUBTYPE_OFT_BUDDYICON 0x0004
+#define AIM_CONN_SUBTYPE_OFT_VOICE     0x0005
+
 /*
  * Status values returned from aim_conn_new().  ORed together.
  */
@@ -112,38 +195,65 @@ struct client_info_s {
 #define AIM_CONN_STATUS_RESOLVERR   0x0080
 #define AIM_CONN_STATUS_CONNERR     0x0040
 
+#define AIM_FRAMETYPE_OSCAR 0x0000
+#define AIM_FRAMETYPE_OFT 0x0001
+
 struct aim_conn_t {
   int fd;
-  int type;
+  unsigned short type;
+  unsigned short subtype;
   int seqnum;
   int status;
   void *priv; /* misc data the client may want to store */
   time_t lastactivity; /* time of last transmit */
   int forcedlatency; 
   struct aim_rxcblist_t *handlerlist;
+  faim_mutex_t active; /* lock around read/writes */
+  faim_mutex_t seqnum_lock; /* lock around ->seqnum changes */
+  struct aim_conn_t *next;
 };
 
 /* struct for incoming commands */
 struct command_rx_struct {
-                            /* byte 1 assumed to always be 0x2a */
-  char type;                /* type code (byte 2) */
-  u_int seqnum;             /* sequence number (bytes 3 and 4) */
-  u_int commandlen;         /* total packet len - 6 (bytes 5 and 6) */
-  u_char *data;             /* packet data (from 7 byte on) */
-  u_int lock;               /* 0 = open, !0 = locked */
-  u_int handled;            /* 0 = new, !0 = been handled */
-  u_int nofree;                    /* 0 = free data on purge, 1 = only unlink */
+  unsigned char hdrtype; /* defines which piece of the union to use */
+  union {
+    struct { 
+      char type;
+      unsigned short seqnum;     
+    } oscar;
+    struct {
+      unsigned short type;
+      unsigned char magic[4]; /* ODC2 OFT2 */
+      unsigned short hdr2len;
+      unsigned char *hdr2; /* rest of bloated header */
+    } oft;
+  } hdr;
+  unsigned short commandlen;         /* total payload length */
+  unsigned char *data;             /* packet data (from 7 byte on) */
+  unsigned char lock;               /* 0 = open, !0 = locked */
+  unsigned char handled;            /* 0 = new, !0 = been handled */
+  unsigned char nofree;                    /* 0 = free data on purge, 1 = only unlink */
   struct aim_conn_t *conn;  /* the connection it came in on... */
   struct command_rx_struct *next; /* ptr to next struct in list */
 };
 
 /* struct for outgoing commands */
 struct command_tx_struct {
-                            /* byte 1 assumed to be 0x2a */
-  char type;                /* type/family code */
-  u_int seqnum;             /* seqnum dynamically assigned on tx */
-  u_int commandlen;         /* SNAC length */
-  u_char *data;             /* packet data */
+  unsigned char hdrtype; /* defines which piece of the union to use */
+  union {
+    struct {
+      unsigned char type;
+      unsigned short seqnum;
+    } oscar;
+    struct {
+      unsigned short type;
+      unsigned char magic[4]; /* ODC2 OFT2 */
+      unsigned short hdr2len;
+      unsigned char *hdr2;
+    } oft;
+  } hdr;
+  u_int commandlen;         
+  u_char *data;      
   u_int lock;               /* 0 = open, !0 = locked */
   u_int sent;               /* 0 = pending, !0 = has been sent */
   struct aim_conn_t *conn; 
@@ -175,14 +285,20 @@ struct aim_session_t {
   /* 
    * Connection information
    */
-  struct aim_conn_t conns[AIM_CONN_MAX];
+  struct aim_conn_t *connlist;
+  faim_mutex_t connlistlock;
   
   /* 
    * TX/RX queues 
    */
-  struct command_tx_struct *queue_outgoing; 
+  struct command_tx_struct *queue_outgoing;   
   struct command_rx_struct *queue_incoming; 
   
+  /*
+   * Tx Enqueuing function
+   */
+  int (*tx_enqueue)(struct aim_session_t *, struct command_tx_struct *);
+
   /*
    * This is a dreadful solution to the what-room-are-we-joining
    * problem.  (There's no connection between the service
@@ -194,9 +310,12 @@ struct aim_session_t {
    * Outstanding snac handling 
    *
    * XXX: Should these be per-connection? -mid
-   **/
-  struct aim_snac_t *outstanding_snacs;
+   */
+  struct aim_snac_t *snac_hash[FAIM_SNAC_HASH_SIZE];
+  faim_mutex_t snac_hash_locks[FAIM_SNAC_HASH_SIZE];
   u_long snac_nextid;
+
+  struct aim_msgcookie_t *msgcookies;
 };
 
 
@@ -214,15 +333,17 @@ struct aim_userinfo_s {
   u_short capabilities;
 };
 
-#define AIM_CLASS_TRIAL        0x0001
-#define AIM_CLASS_UNKNOWN2     0x0002
+#define AIM_CLASS_TRIAL        0x0001 /* "damned transients" */
+#define AIM_CLASS_ADMINISTRATOR        0x0002
 #define AIM_CLASS_AOL          0x0004
-#define AIM_CLASS_UNKNOWN4     0x0008
+#define AIM_CLASS_OSCAR_PAY    0x0008
 #define AIM_CLASS_FREE                 0x0010
 #define AIM_CLASS_AWAY         0x0020
 #define AIM_CLASS_UNKNOWN40    0x0040
 #define AIM_CLASS_UNKNOWN80    0x0080
 
+#define AIM_CLASS_ALLUSERS      0x001f
+
 /*
  * TLV handling
  */
@@ -266,8 +387,11 @@ int aim_counttlvchain(struct aim_tlvlist_t **list);
 int aim_get_command(struct aim_session_t *, struct aim_conn_t *);
 int aim_rxdispatch(struct aim_session_t *);
 
+u_long aim_debugconn_sendconnect(struct aim_session_t *sess, struct aim_conn_t *conn);
+
 int aim_logoff(struct aim_session_t *);
 
+void aim_conn_kill(struct aim_session_t *sess, struct aim_conn_t **deadconn);
 
 typedef int (*rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...);
 int aim_register_callbacks(rxcallback_t *);
@@ -276,11 +400,12 @@ u_long aim_genericreq_n(struct aim_session_t *, struct aim_conn_t *conn, u_short
 u_long aim_genericreq_l(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_long *);
 u_long aim_genericreq_s(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_short *);
 
+struct aim_fileheader_t *aim_oft_getfh(char *hdr);
+
 /* aim_login.c */
 int aim_sendconnack(struct aim_session_t *sess, struct aim_conn_t *conn);
 int aim_request_login (struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);
-int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *);
-int aim_encode_password(const char *, u_char *);
+int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *, char *key);
 unsigned long aim_sendauthresp(struct aim_session_t *sess, 
                               struct aim_conn_t *conn, 
                               char *sn, char *bosip, 
@@ -288,20 +413,25 @@ unsigned long aim_sendauthresp(struct aim_session_t *sess,
                               int regstatus);
 int aim_gencookie(unsigned char *buf);
 int aim_sendserverready(struct aim_session_t *sess, struct aim_conn_t *conn);
+int aim_authkeyparse(struct aim_session_t *sess, struct command_rx_struct *command);
 unsigned long aim_sendredirect(struct aim_session_t *sess, 
                               struct aim_conn_t *conn, 
                               unsigned short servid, 
                               char *ip,
                               char *cookie);
 void aim_purge_rxqueue(struct aim_session_t *);
-
+void aim_rxqueue_cleanbyconn(struct aim_session_t *sess, struct aim_conn_t *conn);
 
 int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *command, ...);
 int aim_parse_missed_im(struct aim_session_t *, struct command_rx_struct *, ...);
 int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
+int aim_get_command_rendezvous(struct aim_session_t *sess, struct aim_conn_t *conn);
 
-struct command_tx_struct *aim_tx_new(int, struct aim_conn_t *, int);
-int aim_tx_enqueue(struct aim_session_t *, struct command_tx_struct *);
+struct command_tx_struct *aim_tx_new(unsigned short framing, int chan, struct aim_conn_t *conn, int datalen);
+int aim_tx_enqueue__queuebased(struct aim_session_t *, struct command_tx_struct *);
+int aim_tx_enqueue__immediate(struct aim_session_t *, struct command_tx_struct *);
+#define aim_tx_enqueue(x, y) ((*(x->tx_enqueue))(x, y))
+int aim_tx_sendframe(struct aim_session_t *sess, struct command_tx_struct *cur);
 u_int aim_get_next_txseqnum(struct aim_conn_t *);
 int aim_tx_flushqueue(struct aim_session_t *);
 int aim_tx_printqueue(struct aim_session_t *);
@@ -333,6 +463,7 @@ struct aim_snac_t {
   time_t issuetime;
   struct aim_snac_t *next;
 };
+void aim_initsnachash(struct aim_session_t *sess);
 u_long aim_newsnac(struct aim_session_t *, struct aim_snac_t *newsnac);
 struct aim_snac_t *aim_remsnac(struct aim_session_t *, u_long id);
 int aim_cleansnacs(struct aim_session_t *, int maxage);
@@ -357,6 +488,13 @@ void aim_session_init(struct aim_session_t *);
 #define AIM_VISIBILITYCHANGE_DENYADD      0x07
 #define AIM_VISIBILITYCHANGE_DENYREMOVE   0x08
 
+#define AIM_PRIVFLAGS_ALLOWIDLE           0x01
+#define AIM_PRIVFLAGS_ALLOWMEMBERSINCE    0x02
+
+#define AIM_WARN_ANON                     0x01
+
+int aim_send_warning(struct aim_session_t *sess, struct aim_conn_t *conn, char *destsn, int anon);
+u_long aim_bos_nop(struct aim_session_t *, struct aim_conn_t *);
 u_long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long);
 u_long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *);
 u_long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *);
@@ -374,6 +512,9 @@ u_long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *);
 u_long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *);
 u_long aim_setversions(struct aim_session_t *sess, struct aim_conn_t *conn);
 
+struct aim_fileheader_t *aim_getlisting(struct aim_session_t*);
+int aim_listenestablish(u_short);
+
 /* aim_rxhandlers.c */
 int aim_rxdispatch(struct aim_session_t *);
 int aim_authparse(struct aim_session_t *, struct command_rx_struct *);
@@ -382,15 +523,30 @@ int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *, ...);
 int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
 int aim_parse_generalerrs(struct aim_session_t *, struct command_rx_struct *command, ...);
 int aim_parsemotd_middle(struct aim_session_t *sess, struct command_rx_struct *command, ...);
+int aim_parse_ratechange_middle(struct aim_session_t *sess, struct command_rx_struct *command);
+int aim_parse_evilnotify_middle(struct aim_session_t *sess, struct command_rx_struct *command);
+int aim_parse_msgack_middle(struct aim_session_t *sess, struct command_rx_struct *command);
 
 /* aim_im.c */
+struct aim_directim_priv {
+  unsigned char cookie[8];
+  char sn[MAXSNLEN+1];
+  char ip[30];
+};
+
 #define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
 #define AIM_IMFLAGS_ACK  0x02 /* request a receipt notice */
 
 u_long aim_send_im(struct aim_session_t *, struct aim_conn_t *, char *, u_int, char *);
 int aim_parse_incoming_im_middle(struct aim_session_t *, struct command_rx_struct *);
+int aim_parse_outgoing_im_middle(struct aim_session_t *, struct command_rx_struct *);
 u_long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn);
 int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *);
+int aim_negchan_middle(struct aim_session_t *sess, struct command_rx_struct *command);
+
+struct aim_conn_t * aim_directim_initiate(struct aim_session_t *, struct aim_conn_t *, struct aim_directim_priv *, char *);
+int aim_send_im_direct(struct aim_session_t *, struct aim_conn_t *, char *);
+struct aim_conn_t *aim_directim_connect(struct aim_session_t *, struct aim_conn_t *, struct aim_directim_priv *);
 
 /* aim_info.c */
 #define AIM_CAPS_BUDDYICON 0x01
@@ -399,11 +555,96 @@ int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *
 #define AIM_CAPS_CHAT 0x08
 #define AIM_CAPS_GETFILE 0x10
 #define AIM_CAPS_SENDFILE 0x20
+
 extern u_char aim_caps[6][16];
+u_short aim_getcap(unsigned char *capblock, int buflen);
+int aim_putcap(unsigned char *capblock, int buflen, u_short caps);
 
 #define AIM_GETINFO_GENERALINFO 0x00001
 #define AIM_GETINFO_AWAYMESSAGE 0x00003
 
+struct aim_msgcookie_t {
+  unsigned char cookie[8];
+  int type;
+  void *data;
+  time_t addtime;
+  struct aim_msgcookie_t *next;
+};
+
+struct aim_fileheader_t {
+#if 0
+  char  magic[4];            /* 0 */
+  short hdrlen;           /* 4 */
+  short hdrtype;             /* 6 */
+#endif
+  char  bcookie[8];       /* 8 */
+  short encrypt;          /* 16 */
+  short compress;         /* 18 */
+  short totfiles;         /* 20 */
+  short filesleft;        /* 22 */
+  short totparts;         /* 24 */
+  short partsleft;        /* 26 */
+  long  totsize;          /* 28 */
+  long  size;             /* 32 */
+  long  modtime;          /* 36 */
+  long  checksum;         /* 40 */
+  long  rfrcsum;          /* 44 */
+  long  rfsize;           /* 48 */
+  long  cretime;          /* 52 */
+  long  rfcsum;           /* 56 */
+  long  nrecvd;           /* 60 */
+  long  recvcsum;         /* 64 */
+  char  idstring[32];     /* 68 */
+  char  flags;            /* 100 */
+  char  lnameoffset;      /* 101 */
+  char  lsizeoffset;      /* 102 */
+  char  dummy[69];        /* 103 */
+  char  macfileinfo[16];  /* 172 */
+  short nencode;          /* 188 */
+  short nlanguage;        /* 190 */
+  char  name[64];         /* 192 */
+                          /* 256 */
+};
+
+struct aim_filetransfer_priv {
+  char sn[MAXSNLEN];
+  char cookie[8];
+  char ip[30];
+  int state;
+  struct aim_fileheader_t fh;
+};
+
+#define AIM_COOKIETYPE_UNKNOWN  0x00
+#define AIM_COOKIETYPE_ICBM     0x01
+#define AIM_COOKIETYPE_ADS      0x02
+#define AIM_COOKIETYPE_BOS      0x03
+#define AIM_COOKIETYPE_IM       0x04
+#define AIM_COOKIETYPE_CHAT     0x05
+#define AIM_COOKIETYPE_CHATNAV  0x06
+/* we'll move OFT up a bit to give breathing room.  not like it really
+ * matters. */
+#define AIM_COOKIETYPE_OFTIM    0x10
+#define AIM_COOKIETYPE_OFTGET   0x11
+#define AIM_COOKIETYPE_OFTSEND  0x12
+#define AIM_COOKIETYPE_OFTVOICE 0x13
+#define AIM_COOKIETYPE_OFTIMAGE 0x14
+#define AIM_COOKIETYPE_OFTICON  0x15
+
+int aim_cachecookie(struct aim_session_t *sess, struct aim_msgcookie_t *cookie);
+int aim_purgecookies(struct aim_session_t *sess, int maxage);
+struct aim_msgcookie_t *aim_uncachecookie(struct aim_session_t *sess, char *cookie, int type);
+struct aim_msgcookie_t *aim_mkcookie(unsigned char *, int, void *);
+struct aim_msgcookie_t *aim_checkcookie(struct aim_session_t *, char *, int);
+int aim_getcookietype(int);
+
+int aim_handlerendconnect(struct aim_session_t *sess, struct aim_conn_t *cur);
+
+#define AIM_TRANSFER_DENY_NOTSUPPORTED 0x0000
+#define AIM_TRANSFER_DENY_DECLINE 0x0001
+#define AIM_TRANSFER_DENY_NOTACCEPTING 0x0002
+u_long aim_denytransfer(struct aim_session_t *sess, struct aim_conn_t *conn, char *sender, char *cookie, unsigned short code);
+u_long aim_accepttransfer(struct aim_session_t *sess, struct aim_conn_t *conn,struct aim_conn_t *oftconn, char *sender, char *cookie, unsigned short rendid);
+
 u_long aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *, unsigned short);
 int aim_extractuserinfo(u_char *, struct aim_userinfo_s *);
 int aim_parse_userinfo_middle(struct aim_session_t *, struct command_rx_struct *);
@@ -502,5 +743,10 @@ char *aimutil_itemidx(char *toSearch, int index, char dl);
 int aim_snlen(const char *sn);
 int aim_sncmp(const char *sn1, const char *sn2);
 
+/* aim_meta.c */
+char *aim_getbuilddate(void);
+char *aim_getbuildtime(void);
+char *aim_getbuildstring(void);
+
 #endif /* __AIM_H__ */
 
This page took 0.054706 seconds and 4 git commands to generate.