aim.h

   1 #ifndef __AIM_H__
   2 #define __AIM_H__
   3
   4 #include <faimconfig.h>
   5
   6 #include <stdio.h>
   7 #include <string.h>
   8 #include <fcntl.h>
   9 #include <sys/types.h>
  10 #include <stdlib.h>
  11 #include <stdarg.h>
  12 #include <errno.h>
  13
  14 #ifdef _WIN32
  15 #include <windows.h>
  16 #include <time.h>
  17 #include <io.h>
  18 #else
  19 #include <netdb.h>
  20 #include <sys/socket.h>
  21 #include <netinet/in.h>
  22 #include <sys/time.h>
  23 #include <unistd.h>
  24 #endif
  25
  26 /* Portability stuff (DMP) */
  27
  28 #ifdef _WIN32
  29 #define sleep Sleep
  30 #define strlen(x) (int)strlen(x)  /* win32 has a unsigned size_t */
  31 #endif
  32
  33 #if defined(_WIN32) || (defined(mach) && defined(__APPLE__))
  34 #define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */
  35 #endif
  36
  37 /*
  38  * Login Error codes
  39  */
  40 #define AIM_CONNECT_ERROR       -0x1
  41 #define AIM_SIGNON_TOO_SOON     -0x4
  42 #define AIM_SERVICE_FULL        -0x6f
  43
  44 /* Current Maximum Length for Screen Names (not including NULL) */
  45 #define MAXSNLEN 16
  46
  47 struct login_phase1_struct {
  48   char *screen_name;
  49   char *BOSIP;
  50   char *cookie;
  51   char *email;
  52   u_short regstatus;
  53 };
  54
  55 extern struct login_phase1_struct aim_logininfo;
  56
  57 struct client_info_s {
  58   char clientstring[100]; /* arbitrary number */
  59   int major;
  60   int minor;
  61   int build;
  62   char country[3];
  63   char lang[3];
  64 };
  65
  66 struct connection_info_struct {
  67   u_int local_seq_num_origin; /* our first seq num */
  68   int local_command_count;
  69
  70   u_int remote_seq_num_origin; /* oscar's first seqnum */
  71   int remote_command_count; /* command_count + seq_num_origin = cur_seq_num */
  72
  73   char *sn; /* our screen name */
  74
  75   int fd;                   /* socket descriptor */
  76 };
  77
  78 #ifndef TRUE
  79 #define TRUE 1
  80 #define FALSE 0
  81 #endif
  82
  83 #define AIM_CONN_MAX 5
  84 /* these could be arbitrary, but its easier to use the actual AIM values */
  85 #define AIM_CONN_TYPE_AUTH 0x0007
  86 #define AIM_CONN_TYPE_ADS 0x0005
  87 #define AIM_CONN_TYPE_BOS 2
  88 #define AIM_CONN_TYPE_CHAT 0x000e
  89 #define AIM_CONN_TYPE_CHATNAV 0x000d
  90
  91 #define AIM_CONN_STATUS_READY 0x0001
  92 #define AIM_CONN_STATUS_INTERNALERR 0x0002
  93 #define AIM_CONN_STATUS_RESOLVERR 0x80
  94 #define AIM_CONN_STATUS_CONNERR 0x40
  95
  96
  97 struct aim_conn_t {
  98   int fd;
  99   int type;
 100   int seqnum;
 101   int status;
 102   time_t lastactivity; /* time of last transmit */
 103   int forcedlatency;
 104   struct aim_rxcblist_t *handlerlist;
 105 };
 106 struct aim_conn_t aim_conns[AIM_CONN_MAX];
 107
 108
 109 /* struct for incoming commands */
 110 struct command_rx_struct {
 111                             /* byte 1 assumed to always be 0x2a */
 112   char type;                /* type code (byte 2) */
 113   u_int seqnum;             /* sequence number (bytes 3 and 4) */
 114   u_int commandlen;         /* total packet len - 6 (bytes 5 and 6) */
 115   u_char *data;             /* packet data (from 7 byte on) */
 116   u_int lock;               /* 0 = open, !0 = locked */
 117   u_int handled;            /* 0 = new, !0 = been handled */
 118   struct aim_conn_t *conn;  /* the connection it came in on... */
 119   struct command_rx_struct *next; /* ptr to next struct in list */
 120 };
 121
 122 /* struct for outgoing commands */
 123 struct command_tx_struct {
 124                             /* byte 1 assumed to be 0x2a */
 125   char type;                /* type/family code */
 126   u_int seqnum;             /* seqnum dynamically assigned on tx */
 127   u_int commandlen;         /* SNAC length */
 128   u_char *data;             /* packet data */
 129   u_int lock;               /* 0 = open, !0 = locked */
 130   u_int sent;               /* 0 = pending, !0 = has been sent */
 131   struct aim_conn_t *conn;
 132   struct command_tx_struct *next; /* ptr to next struct in list */
 133 };
 134
 135 /*
 136  * AIM User Info, Standard Form.
 137  */
 138 struct aim_userinfo_s {
 139   char sn[MAXSNLEN+1];
 140   u_short warnlevel;
 141   u_short idletime;
 142   u_short class;
 143   u_long membersince;
 144   u_long onlinesince;
 145   u_long sessionlen;
 146 };
 147
 148 /* TLV-related tidbits */
 149 struct aim_tlv_t {
 150   u_short type;
 151   u_short length;
 152   u_char *value;
 153 };
 154
 155 struct aim_tlvlist_t {
 156   struct aim_tlv_t *tlv;
 157   struct aim_tlvlist_t *next;
 158 };
 159 struct aim_tlvlist_t *aim_readtlvchain(u_char *buf, int maxlen);
 160 void aim_freetlvchain(struct aim_tlvlist_t **list);
 161 struct aim_tlv_t *aim_grabtlv(u_char *src);
 162 struct aim_tlv_t *aim_grabtlvstr(u_char *src);
 163 int aim_puttlv (u_char *dest, struct aim_tlv_t *newtlv);
 164 struct aim_tlv_t *aim_createtlv(void);
 165 int aim_freetlv(struct aim_tlv_t **oldtlv);
 166 int aim_puttlv_16(u_char *, u_short, u_short);
 167
 168 /* some prototypes... */
 169
 170 /*   implicitly or explicitly called */
 171 int aim_get_command(void);
 172 int aim_rxdispatch(void);
 173 int aim_logoff(void);
 174
 175 typedef int (*rxcallback_t)(struct command_rx_struct *, ...);
 176 int aim_register_callbacks(rxcallback_t *);
 177
 178 u_long aim_genericreq_n(struct aim_conn_t *conn, u_short family, u_short subtype);
 179 u_long aim_genericreq_l(struct aim_conn_t *conn, u_short family, u_short subtype, u_long *);
 180 u_long aim_genericreq_s(struct aim_conn_t *conn, u_short family, u_short subtype, u_short *);
 181
 182 /* aim_login.c */
 183 int aim_send_login (struct aim_conn_t *, char *, char *, struct client_info_s *);
 184 int aim_encode_password(const char *, char *);
 185
 186
 187 struct command_rx_struct *aim_purge_rxqueue(struct command_rx_struct *queue);
 188
 189
 190 int aim_parse_unknown(struct command_rx_struct *command, ...);
 191 int aim_parse_missed_im(struct command_rx_struct *, ...);
 192 int aim_parse_last_bad(struct command_rx_struct *, ...);
 193
 194 int aim_tx_enqueue(struct command_tx_struct *);
 195 u_int aim_get_next_txseqnum(struct aim_conn_t *);
 196 int aim_tx_flushqueue(void);
 197 int aim_tx_printqueue(void);
 198 int aim_tx_purgequeue(void);
 199
 200 /* queue (linked list) pointers */
 201 extern struct command_tx_struct *aim_queue_outgoing; /* incoming commands */
 202 extern struct command_rx_struct *aim_queue_incoming; /* outgoing commands */
 203
 204 /* The default callback handler array */
 205 extern rxcallback_t aim_callbacks[];
 206
 207 struct aim_rxcblist_t {
 208   u_short family;
 209   u_short type;
 210   rxcallback_t handler;
 211   u_short flags;
 212   struct aim_rxcblist_t *next;
 213 };
 214
 215 int aim_conn_setlatency(struct aim_conn_t *conn, int newval);
 216
 217 int aim_conn_addhandler(struct aim_conn_t *conn, u_short family, u_short type, rxcallback_t newhandler, u_short flags);
 218 rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type);
 219 int aim_clearhandlers(struct aim_conn_t *conn);
 220
 221 extern struct aim_snac_t *aim_outstanding_snacs;
 222 extern u_long aim_snac_nextid;
 223
 224 #define AIM_CB_FAM_ACK 0x0000
 225 #define AIM_CB_FAM_GEN 0x0001
 226 #define AIM_CB_FAM_LOC 0x0002
 227 #define AIM_CB_FAM_BUD 0x0003
 228 #define AIM_CB_FAM_MSG 0x0004
 229 #define AIM_CB_FAM_ADS 0x0005
 230 #define AIM_CB_FAM_INV 0x0006
 231 #define AIM_CB_FAM_ADM 0x0007
 232 #define AIM_CB_FAM_POP 0x0008
 233 #define AIM_CB_FAM_BOS 0x0009
 234 #define AIM_CB_FAM_LOK 0x000a
 235 #define AIM_CB_FAM_STS 0x000b
 236 #define AIM_CB_FAM_TRN 0x000c
 237 #define AIM_CB_FAM_CTN 0x000d /* ChatNav */
 238 #define AIM_CB_FAM_CHT 0x000e /* Chat */
 239 #define AIM_CB_FAM_SPECIAL 0xffff /* Internal libfaim use */
 240
 241 #define AIM_CB_ACK_ACK 0x0001
 242
 243 #define AIM_CB_GEN_ERROR 0x0001
 244 #define AIM_CB_GEN_CLIENTREADY 0x0002
 245 #define AIM_CB_GEN_SERVERREADY 0x0003
 246 #define AIM_CB_GEN_SERVICEREQ 0x0004
 247 #define AIM_CB_GEN_REDIRECT 0x0005
 248 #define AIM_CB_GEN_RATEINFOREQ 0x0006
 249 #define AIM_CB_GEN_RATEINFO 0x0007
 250 #define AIM_CB_GEN_RATEINFOACK 0x0008
 251 #define AIM_CB_GEN_RATECHANGE 0x000a
 252 #define AIM_CB_GEN_SERVERPAUSE 0x000b
 253 #define AIM_CB_GEN_SERVERRESUME 0x000d
 254 #define AIM_CB_GEN_REQSELFINFO 0x000e
 255 #define AIM_CB_GEN_SELFINFO 0x000f
 256 #define AIM_CB_GEN_EVIL 0x0010
 257 #define AIM_CB_GEN_SETIDLE 0x0011
 258 #define AIM_CB_GEN_MIGRATIONREQ 0x0012
 259 #define AIM_CB_GEN_MOTD 0x0013
 260 #define AIM_CB_GEN_SETPRIVFLAGS 0x0014
 261 #define AIM_CB_GEN_WELLKNOWNURL 0x0015
 262 #define AIM_CB_GEN_NOP 0x0016
 263 #define AIM_CB_GEN_DEFAULT 0xffff
 264
 265 #define AIM_CB_LOC_ERROR 0x0001
 266 #define AIM_CB_LOC_REQRIGHTS 0x0002
 267 #define AIM_CB_LOC_RIGHTSINFO 0x0003
 268 #define AIM_CB_LOC_SETUSERINFO 0x0004
 269 #define AIM_CB_LOC_REQUSERINFO 0x0005
 270 #define AIM_CB_LOC_USERINFO 0x0006
 271 #define AIM_CB_LOC_WATCHERSUBREQ 0x0007
 272 #define AIM_CB_LOC_WATCHERNOT 0x0008
 273 #define AIM_CB_LOC_DEFAULT 0xffff
 274
 275 #define AIM_CB_BUD_ERROR 0x0001
 276 #define AIM_CB_BUD_REQRIGHTS 0x0002
 277 #define AIM_CB_BUD_RIGHTSINFO 0x0003
 278 #define AIM_CB_BUD_ADDBUDDY 0x0004
 279 #define AIM_CB_BUD_REMBUDDY 0x0005
 280 #define AIM_CB_BUD_REJECT 0x000a
 281 #define AIM_CB_BUD_ONCOMING 0x000b
 282 #define AIM_CB_BUD_OFFGOING 0x000c
 283 #define AIM_CB_BUD_DEFAULT 0xffff
 284
 285 #define AIM_CB_MSG_ERROR 0x0001
 286 #define AIM_CB_MSG_PARAMINFO 0x0005
 287 #define AIM_CB_MSG_INCOMING 0x0007
 288 #define AIM_CB_MSG_EVIL 0x0009
 289 #define AIM_CB_MSG_MISSEDCALL 0x000a
 290 #define AIM_CB_MSG_CLIENTERROR 0x000b
 291 #define AIM_CB_MSG_ACK 0x000c
 292 #define AIM_CB_MSG_DEFAULT 0xffff
 293
 294 #define AIM_CB_ADS_ERROR 0x0001
 295 #define AIM_CB_ADS_DEFAULT 0xffff
 296
 297 #define AIM_CB_INV_ERROR 0x0001
 298 #define AIM_CB_INV_DEFAULT 0xffff
 299
 300 #define AIM_CB_ADM_ERROR 0x0001
 301 #define AIM_CB_ADM_INFOCHANGE_REPLY 0x0005
 302 #define AIM_CB_ADM_DEFAULT 0xffff
 303
 304 #define AIM_CB_POP_ERROR 0x0001
 305 #define AIM_CB_POP_DEFAULT 0xffff
 306
 307 #define AIM_CB_BOS_ERROR 0x0001
 308 #define AIM_CB_BOS_DEFAULT 0xffff
 309
 310 #define AIM_CB_LOK_ERROR 0x0001
 311 #define AIM_CB_LOK_DEFAULT 0xffff
 312
 313 #define AIM_CB_STS_ERROR 0x0001
 314 #define AIM_CB_STS_SETREPORTINTERVAL 0x0002
 315 #define AIM_CB_STS_REPORTACK 0x0004
 316 #define AIM_CB_STS_DEFAULT 0xffff
 317
 318 #define AIM_CB_TRN_ERROR 0x0001
 319 #define AIM_CB_TRN_DEFAULT 0xffff
 320
 321 #define AIM_CB_CTN_ERROR 0x0001
 322 #define AIM_CB_CTN_DEFAULT 0xffff
 323
 324 #define AIM_CB_CHT_ERROR 0x0001
 325 #define AIM_CB_CHT_DEFAULT 0xffff
 326
 327 #define AIM_CB_SPECIAL_AUTHSUCCESS 0x0001
 328 #define AIM_CB_SPECIAL_AUTHOTHER 0x0002
 329 #define AIM_CB_SPECIAL_UNKNOWN 0xffff
 330 #define AIM_CB_SPECIAL_DEFAULT AIM_CB_SPECIAL_UNKNOWN
 331
 332 #if 0
 333 #define AIM_CB_INCOMING_IM 0
 334 #define AIM_CB_ONCOMING_BUDDY 1
 335 #define AIM_CB_OFFGOING_BUDDY 2
 336 #define AIM_CB_MISSED_IM 3
 337 #define AIM_CB_MISSED_CALL 4
 338 #define AIM_CB_LOGIN_P4_C1 5
 339 #define AIM_CB_LOGIN_P4_C2 6
 340 #define AIM_CB_LOGIN_P2_1 7
 341 #define AIM_CB_LOGIN_P2_2 8
 342 #define AIM_CB_LOGIN_P3_B 9
 343 #define AIM_CB_LOGIN_P3D_A 10
 344 #define AIM_CB_LOGIN_P3D_B 11
 345 #define AIM_CB_LOGIN_P3D_C 12
 346 #define AIM_CB_LOGIN_P3D_D 13
 347 #define AIM_CB_LOGIN_P3D_E 14
 348 #define AIM_CB_LOGIN_P3D_F 15
 349 #define AIM_CB_RATECHANGE 16
 350 #define AIM_CB_USERERROR 17
 351 #define AIM_CB_UNKNOWN 18
 352 #define AIM_CB_USERINFO 19
 353 #define AIM_CB_SEARCH_ADDRESS 20
 354 #define AIM_CB_SEARCH_NAME 21
 355 #define AIM_CB_SEARCH_FAIL 22
 356
 357 #define AIM_CB_AUTH_ERROR 23
 358 #define AIM_CB_AUTH_SUCCESS 24
 359 #define AIM_CB_AUTH_SVRREADY 25
 360
 361 #define AIM_CB_AUTH_OTHER 26
 362 #define AIM_CB_AUTH_INFOCHNG_REPLY 27
 363 #define AIM_CB_CHATNAV_SVRREADY 28
 364 #endif
 365
 366 int Read(int, u_char *, int);
 367
 368 struct aim_snac_t {
 369   u_long id;
 370   u_short family;
 371   u_short type;
 372   u_short flags;
 373   void *data;
 374   time_t issuetime;
 375   struct aim_snac_t *next;
 376 };
 377 u_long aim_newsnac(struct aim_snac_t *newsnac);
 378 struct aim_snac_t *aim_remsnac(u_long id);
 379 int aim_cleansnacs(int maxage);
 380 int aim_putsnac(u_char *, int, int, int, u_long);
 381
 382 void aim_connrst(void);
 383 struct aim_conn_t *aim_conn_getnext(void);
 384 void aim_conn_close(struct aim_conn_t *deadconn);
 385 struct aim_conn_t *aim_getconn_type(int type);
 386 struct aim_conn_t *aim_newconn(int type, char *dest);
 387 int aim_conngetmaxfd(void);
 388 struct aim_conn_t *aim_select(struct timeval *);
 389 int aim_conn_isready(struct aim_conn_t *);
 390 int aim_conn_setstatus(struct aim_conn_t *, int);
 391
 392 /* aim_misc.c */
 393
 394 #define AIM_VISIBILITYCHANGE_PERMITADD 0x05
 395 #define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
 396 #define AIM_VISIBILITYCHANGE_DENYADD 0x07
 397 #define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08
 398
 399 u_long aim_bos_setidle(struct aim_conn_t *, u_long);
 400 u_long aim_bos_changevisibility(struct aim_conn_t *, int, char *);
 401 u_long aim_bos_setbuddylist(struct aim_conn_t *, char *);
 402 u_long aim_bos_setprofile(struct aim_conn_t *, char *);
 403 u_long aim_bos_setgroupperm(struct aim_conn_t *, u_long);
 404 u_long aim_bos_clientready(struct aim_conn_t *);
 405 u_long aim_bos_reqrate(struct aim_conn_t *);
 406 u_long aim_bos_ackrateresp(struct aim_conn_t *);
 407 u_long aim_bos_setprivacyflags(struct aim_conn_t *, u_long);
 408 u_long aim_bos_reqpersonalinfo(struct aim_conn_t *);
 409 u_long aim_bos_reqservice(struct aim_conn_t *, u_short);
 410 u_long aim_bos_reqrights(struct aim_conn_t *);
 411 u_long aim_bos_reqbuddyrights(struct aim_conn_t *);
 412 u_long aim_bos_reqlocaterights(struct aim_conn_t *);
 413 u_long aim_bos_reqicbmparaminfo(struct aim_conn_t *);
 414
 415 /* aim_rxhandlers.c */
 416 int aim_register_callbacks(rxcallback_t *);
 417 int aim_rxdispatch(void);
 418 int aim_authparse(struct command_rx_struct *);
 419 int aim_handleredirect_middle(struct command_rx_struct *, ...);
 420 int aim_parse_unknown(struct command_rx_struct *, ...);
 421 int aim_parse_missed_im(struct command_rx_struct *, ...);
 422 int aim_parse_last_bad(struct command_rx_struct *, ...);
 423 int aim_parse_generalerrs(struct command_rx_struct *command, ...);
 424
 425 /* aim_im.c */
 426 #define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
 427 #define AIM_IMFLAGS_ACK 0x02 /* request a receipt notice */
 428 u_long aim_send_im(struct aim_conn_t *, char *, int, char *);
 429 int aim_parse_incoming_im_middle(struct command_rx_struct *);
 430 u_long aim_seticbmparam(struct aim_conn_t *conn);
 431
 432 /* aim_info.c */
 433 u_long aim_getinfo(struct aim_conn_t *, const char *);
 434 int aim_extractuserinfo(u_char *, struct aim_userinfo_s *);
 435 int aim_parse_userinfo_middle(struct command_rx_struct *);
 436 int aim_parse_oncoming_middle(struct command_rx_struct *);
 437
 438 /* aim_auth.c */
 439 int aim_auth_sendcookie(struct aim_conn_t *, char *);
 440 u_long aim_auth_clientready(struct aim_conn_t *);
 441 u_long aim_auth_changepasswd(struct aim_conn_t *, char *, char *);
 442
 443 /* aim_buddylist.c */
 444 u_long aim_add_buddy(struct aim_conn_t *, char *);
 445 u_long aim_remove_buddy(struct aim_conn_t *, char *);
 446
 447 /* aim_search.c */
 448 u_long aim_usersearch_address(struct aim_conn_t *, char *);
 449 /* u_long aim_usersearch_name(struct aim_conn_t *, char *); */
 450
 451 /* aim_util.c */
 452 int aimutil_put8(u_char *, u_char);
 453 u_char aimutil_get8(u_char *buf);
 454 int aimutil_put16(u_char *, u_short);
 455 u_short aimutil_get16(u_char *);
 456 int aimutil_put32(u_char *, u_long);
 457 u_long aimutil_get32(u_char *);
 458 int aimutil_putstr(u_char *, const u_char *, int);
 459 int aimutil_tokslen(char *toSearch, int index, char dl);
 460 int aimutil_itemcnt(char *toSearch, char dl);
 461 char *aimutil_itemidx(char *toSearch, int index, char dl);
 462
 463 struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *list, u_short type, int nth);
 464 char *aim_gettlv_str(struct aim_tlvlist_t *list, u_short type, int nth);
 465
 466 #endif /* __AIM_H__ */
 467