libpurple/protocols/oscar/oscar.h

   1 /*
   2  * Purple's oscar protocol plugin
   3  * This file is the legal property of its developers.
   4  * Please see the AUTHORS file distributed alongside this file.
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  19 */
  20
  21 /*
  22  * Main libfaim header.  Must be included in client for prototypes/macros.
  23  *
  24  * "come on, i turned a chick lesbian; i think this is the hackish equivalent"
  25  *                                                -- Josh Myer
  26  *
  27  */
  28
  29 #ifndef PURPLE_OSCAR_OSCAR_H
  30 #define PURPLE_OSCAR_OSCAR_H
  31
  32 #include "internal.h"
  33 #include "circularbuffer.h"
  34 #include "debug.h"
  35 #include "eventloop.h"
  36 #include "proxy.h"
  37 #include "sslconn.h"
  38
  39 #include <stdio.h>
  40 #include <string.h>
  41 #include <fcntl.h>
  42 #include <sys/types.h>
  43 #include <stdlib.h>
  44 #include <stdarg.h>
  45 #include <errno.h>
  46 #include <time.h>
  47
  48 #include <gmodule.h>
  49 #include <libsoup/soup.h>
  50
  51 #ifndef _WIN32
  52 #include <sys/time.h>
  53 #include <unistd.h>
  54 #include <netdb.h>
  55 #include <netinet/in.h>
  56 #include <sys/socket.h>
  57 #endif
  58
  59 #define OSCAR_TYPE_PROTOCOL             (oscar_protocol_get_type())
  60 #define OSCAR_PROTOCOL(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), OSCAR_TYPE_PROTOCOL, OscarProtocol))
  61 #define OSCAR_PROTOCOL_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), OSCAR_TYPE_PROTOCOL, OscarProtocolClass))
  62 #define OSCAR_IS_PROTOCOL(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), OSCAR_TYPE_PROTOCOL))
  63 #define OSCAR_IS_PROTOCOL_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), OSCAR_TYPE_PROTOCOL))
  64 #define OSCAR_PROTOCOL_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), OSCAR_TYPE_PROTOCOL, OscarProtocolClass))
  65
  66 typedef struct _ByteStream         ByteStream;
  67 typedef struct _ClientInfo         ClientInfo;
  68 typedef struct _FlapConnection     FlapConnection;
  69 typedef struct _FlapFrame          FlapFrame;
  70 typedef struct _IcbmArgsCh2        IcbmArgsCh2;
  71 typedef struct _IcbmCookie         IcbmCookie;
  72 typedef struct _OscarData          OscarData;
  73 typedef struct _QueuedSnac         QueuedSnac;
  74
  75 typedef guint32 aim_snacid_t;
  76
  77 #include "snactypes.h"
  78
  79 G_BEGIN_DECLS
  80
  81 #define FAIM_SNAC_HASH_SIZE 16
  82
  83 /*
  84  * Current Maximum Length for usernames (not including NULL)
  85  *
  86  * Currently only names up to 16 characters can be registered
  87  * however it is apparently legal for them to be larger.
  88  */
  89 #define MAXSNLEN 97
  90
  91 /*
  92  * Current Maximum Length for Instant Messages
  93  *
  94  * This was found basically by experiment, but not wholly
  95  * accurate experiment.  It should not be regarded
  96  * as completely correct.  But its a decent approximation.
  97  *
  98  * Note that although we can send this much, its impossible
  99  * for WinAIM clients (up through the latest (4.0.1957)) to
 100  * send any more than 1kb.  Amaze all your windows friends
 101  * with utterly oversized instant messages!
 102  */
 103 #define MAXMSGLEN 2544
 104
 105 /*
 106  * Maximum size of a Buddy Icon.
 107  */
 108 #define MAXICONLEN 7168
 109 #define AIM_ICONIDENT "AVT1picture.id"
 110
 111 /*
 112  * Found by trial and error.
 113  */
 114 #define MAXAVAILMSGLEN 251
 115
 116 /**
 117  * Maximum length for the password of an ICQ account
 118  */
 119 #define MAXICQPASSLEN 16
 120
 121 #define AIM_MD5_STRING "AOL Instant Messenger (SM)"
 122
 123 #define OSCAR_CONNECT_STEPS 6
 124
 125 /*
 126  * Client info.  Filled in by the client and passed in to
 127  * aim_send_login().  The information ends up getting passed to OSCAR
 128  * through the initial login command.
 129  *
 130  */
 131 struct _ClientInfo
 132 {
 133         const char *clientstring;
 134         guint16 clientid;
 135         guint16 major;
 136         guint16 minor;
 137         guint16 point;
 138         guint16 build;
 139         guint32 distrib;
 140         const char *country; /* two-letter abbrev */
 141         const char *lang; /* two-letter abbrev */
 142 };
 143
 144 /*
 145  * We need to use the major-minor-micro versions from the official
 146  * AIM and ICQ programs here or AOL won't let us use certain features.
 147  *
 148  * 0x00000611 is the distid given to us by AOL for use as the default
 149  * libpurple distid.
 150  */
 151 #define CLIENTINFO_PURPLE_AIM { \
 152         NULL, \
 153         0x0109, \
 154         0x0005, 0x0001, \
 155         0x0000, 0x0bdc, \
 156         0x00000611, \
 157         "us", "en", \
 158 }
 159
 160 #define CLIENTINFO_PURPLE_ICQ { \
 161         NULL, \
 162         0x010a, \
 163         0x0014, 0x0034, \
 164         0x0000, 0x0c18, \
 165         0x00000611, \
 166         "us", "en", \
 167 }
 168
 169 typedef enum
 170 {
 171         OSCAR_DISCONNECT_DONE, /* not considered an error */
 172         OSCAR_DISCONNECT_LOCAL_CLOSED, /* peer connections only, not considered an error */
 173         OSCAR_DISCONNECT_REMOTE_CLOSED,
 174         OSCAR_DISCONNECT_REMOTE_REFUSED, /* peer connections only */
 175         OSCAR_DISCONNECT_LOST_CONNECTION,
 176         OSCAR_DISCONNECT_INVALID_DATA,
 177         OSCAR_DISCONNECT_COULD_NOT_CONNECT,
 178         OSCAR_DISCONNECT_RETRYING /* peer connections only */
 179 } OscarDisconnectReason;
 180
 181 #define OSCAR_CAPABILITY_BUDDYICON             0x0000000000000001LL
 182 #define OSCAR_CAPABILITY_TALK                  0x0000000000000002LL
 183 #define OSCAR_CAPABILITY_DIRECTIM              0x0000000000000004LL
 184 #define OSCAR_CAPABILITY_CHAT                  0x0000000000000008LL
 185 #define OSCAR_CAPABILITY_GETFILE               0x0000000000000010LL
 186 #define OSCAR_CAPABILITY_SENDFILE              0x0000000000000020LL
 187 #define OSCAR_CAPABILITY_GAMES                 0x0000000000000040LL
 188 #define OSCAR_CAPABILITY_ADDINS                0x0000000000000080LL
 189 #define OSCAR_CAPABILITY_SENDBUDDYLIST         0x0000000000000100LL
 190 #define OSCAR_CAPABILITY_GAMES2                0x0000000000000200LL
 191 #define OSCAR_CAPABILITY_ICQ_DIRECT            0x0000000000000400LL
 192 #define OSCAR_CAPABILITY_APINFO                0x0000000000000800LL
 193 #define OSCAR_CAPABILITY_ICQRTF                0x0000000000001000LL
 194 #define OSCAR_CAPABILITY_EMPTY                 0x0000000000002000LL
 195 #define OSCAR_CAPABILITY_ICQSERVERRELAY        0x0000000000004000LL
 196 #define OSCAR_CAPABILITY_UNICODEOLD            0x0000000000008000LL
 197 #define OSCAR_CAPABILITY_TRILLIANCRYPT         0x0000000000010000LL
 198 #define OSCAR_CAPABILITY_UNICODE               0x0000000000020000LL
 199 #define OSCAR_CAPABILITY_INTEROPERATE          0x0000000000040000LL
 200 #define OSCAR_CAPABILITY_SHORTCAPS             0x0000000000080000LL
 201 #define OSCAR_CAPABILITY_HIPTOP                0x0000000000100000LL
 202 #define OSCAR_CAPABILITY_SECUREIM              0x0000000000200000LL
 203 #define OSCAR_CAPABILITY_SMS                   0x0000000000400000LL
 204 #define OSCAR_CAPABILITY_VIDEO                 0x0000000000800000LL
 205 #define OSCAR_CAPABILITY_ICHATAV               0x0000000001000000LL
 206 #define OSCAR_CAPABILITY_LIVEVIDEO             0x0000000002000000LL
 207 #define OSCAR_CAPABILITY_CAMERA                0x0000000004000000LL
 208 #define OSCAR_CAPABILITY_ICHAT_SCREENSHARE     0x0000000008000000LL
 209 #define OSCAR_CAPABILITY_TYPING                0x0000000010000000LL
 210 #define OSCAR_CAPABILITY_NEWCAPS               0x0000000020000000LL
 211 #define OSCAR_CAPABILITY_XTRAZ                 0x0000000040000000LL
 212 #define OSCAR_CAPABILITY_GENERICUNKNOWN        0x0000000080000000LL
 213 #define OSCAR_CAPABILITY_HTML_MSGS             0x0000000100000000LL
 214 #define OSCAR_CAPABILITY_LAST                  0x0000000200000000LL
 215
 216 #define OSCAR_STATUS_ID_INVISIBLE   "invisible"
 217 #define OSCAR_STATUS_ID_OFFLINE     "offline"
 218 #define OSCAR_STATUS_ID_AVAILABLE   "available"
 219 #define OSCAR_STATUS_ID_AWAY        "away"
 220 #define OSCAR_STATUS_ID_DND         "dnd"
 221 #define OSCAR_STATUS_ID_NA          "na"
 222 #define OSCAR_STATUS_ID_OCCUPIED    "occupied"
 223 #define OSCAR_STATUS_ID_FREE4CHAT   "free4chat"
 224 #define OSCAR_STATUS_ID_CUSTOM      "custom"
 225 #define OSCAR_STATUS_ID_MOBILE      "mobile"
 226 #define OSCAR_STATUS_ID_EVIL        "evil"
 227 #define OSCAR_STATUS_ID_DEPRESSION       "depression"
 228 #define OSCAR_STATUS_ID_ATHOME      "athome"
 229 #define OSCAR_STATUS_ID_ATWORK      "atwork"
 230 #define OSCAR_STATUS_ID_LUNCH       "lunch"
 231
 232 typedef struct
 233 {
 234         PurpleProtocol parent;
 235 } OscarProtocol;
 236
 237 typedef struct
 238 {
 239         PurpleProtocolClass parent_class;
 240 } OscarProtocolClass;
 241
 242 /**
 243  * Returns the GType for the OscarProtocol object.
 244  */
 245 G_MODULE_EXPORT GType oscar_protocol_get_type(void);
 246
 247 /*
 248  * Byte Stream type. Sort of.
 249  *
 250  * Use of this type serves a couple purposes:
 251  *   - Buffer/buflen pairs are passed all around everywhere. This turns
 252  *     that into one value, as well as abstracting it slightly.
 253  *   - Through the abstraction, it is possible to enable bounds checking
 254  *     for robustness at the cost of performance.  But a clean failure on
 255  *     weird packets is much better than a segfault.
 256  *   - I like having variables named "bs".
 257  *
 258  * Don't touch the insides of this struct.  Or I'll have to kill you.
 259  *
 260  */
 261 struct _ByteStream
 262 {
 263         guint8 *data;
 264         size_t len;
 265         size_t offset;
 266 };
 267
 268 struct _QueuedSnac
 269 {
 270         guint16 family;
 271         guint16 subtype;
 272         FlapFrame *frame;
 273 };
 274
 275 struct _FlapFrame
 276 {
 277         guint8 channel;
 278         guint16 seqnum;
 279         ByteStream data;        /* payload stream */
 280 };
 281
 282 struct _FlapConnection
 283 {
 284         OscarData *od;              /**< Pointer to parent session. */
 285         gboolean connected;
 286         time_t lastactivity;             /**< Time of last transmit. */
 287         guint destroy_timeout;
 288         OscarDisconnectReason disconnect_reason;
 289         gchar *error_message;
 290         guint16 disconnect_code;
 291
 292         /* A few variables that are only used when connecting */
 293         PurpleProxyConnectData *connect_data;
 294         guint16 cookielen;
 295         guint8 *cookie;
 296         gpointer new_conn_data;
 297
 298         int fd;
 299         PurpleSslConnection *gsc;
 300         guint8 header[6];
 301         gssize header_received;
 302         FlapFrame buffer_incoming;
 303         PurpleCircularBuffer *buffer_outgoing;
 304         guint watcher_incoming;
 305         guint watcher_outgoing;
 306
 307         guint16 type;
 308         guint16 subtype;
 309         guint16 seqnum_out; /**< The sequence number of most recently sent packet. */
 310         guint16 seqnum_in; /**< The sequence number of most recently received packet. */
 311         GSList *groups;
 312         GSList *rateclasses; /* Contains nodes of struct rateclass. */
 313         struct rateclass *default_rateclass;
 314         GHashTable *rateclass_members; /* Key is family and subtype, value is pointer to the rateclass struct to use. */
 315
 316         GQueue *queued_snacs; /**< Contains QueuedSnacs. */
 317         GQueue *queued_lowpriority_snacs; /**< Contains QueuedSnacs to send only once queued_snacs is empty */
 318         guint queued_timeout;
 319
 320         void *internal; /* internal conn-specific libfaim data */
 321 };
 322
 323 struct _IcbmCookie
 324 {
 325         guchar cookie[8];
 326         int type;
 327         void *data;
 328         time_t addtime;
 329         struct _IcbmCookie *next;
 330 };
 331
 332 #include "peer.h"
 333
 334 struct aim_ssi_itemlist {
 335         struct aim_ssi_item *data;
 336         GHashTable *idx_gid_bid;
 337         GHashTable *idx_all_named_items;
 338 };
 339
 340 /**
 341  * The main client-data interface.
 342  */
 343 struct _OscarData
 344 {
 345         /* Only used when connecting with clientLogin or Kerberos. */
 346         SoupSession *http_conns;
 347
 348         gboolean iconconnecting;
 349         gboolean set_icon;
 350
 351         GSList *create_rooms;
 352
 353         gboolean conf;
 354         gboolean reqemail;
 355         gboolean setemail;
 356         char *email;
 357         gboolean setnick;
 358         char *newformatting;
 359         gboolean chpass;
 360         char *oldp;
 361         char *newp;
 362
 363         GSList *oscar_chats;
 364         GHashTable *buddyinfo;
 365         GSList *requesticon;
 366
 367         gboolean use_ssl;
 368         gboolean icq;
 369         guint getblisttimer;
 370
 371         struct {
 372                 guint maxwatchers; /* max users who can watch you */
 373                 guint maxbuddies; /* max users you can watch */
 374                 guint maxgroups; /* max groups in server list */
 375                 guint maxpermits; /* max users on permit list */
 376                 guint maxdenies; /* max users on deny list */
 377                 guint maxsiglen; /* max size (bytes) of profile */
 378                 guint maxawaymsglen; /* max size (bytes) of posted away message */
 379         } rights;
 380
 381         PurpleConnection *gc;
 382
 383         void *modlistv;
 384
 385         /*
 386          * Outstanding snac handling
 387          *
 388          * TODO: Should these be per-connection? -mid
 389          */
 390         void *snac_hash[FAIM_SNAC_HASH_SIZE];
 391         aim_snacid_t snacid_next;
 392
 393         /*
 394          * TODO: Data specific to a certain family should go into a
 395          *       hashtable and the core parts of libfaim shouldn't
 396          *       need to know about them.
 397          */
 398
 399         IcbmCookie *msgcookies;
 400         GSList *icq_info;
 401
 402         /** Only used when connecting with the old-style BUCP login. */
 403         struct aim_authresp_info *authinfo;
 404         struct aim_emailinfo *emailinfo;
 405
 406         struct {
 407                 struct aim_userinfo_s *userinfo;
 408         } locate;
 409
 410         struct {
 411                 gboolean have_rights;
 412         } bos;
 413
 414         /* Server-stored information (ssi) */
 415         struct {
 416                 gboolean received_data;
 417                 guint16 numitems;
 418                 struct aim_ssi_itemlist official;
 419                 struct aim_ssi_itemlist local;
 420                 struct aim_ssi_tmp *pending;
 421                 time_t timestamp;
 422                 gboolean waiting_for_ack;
 423                 gboolean in_transaction;
 424         } ssi;
 425
 426         /** Contains pointers to handler functions for each family/subtype. */
 427         GHashTable *handlerlist;
 428
 429         /** A linked list containing FlapConnections. */
 430         GSList *oscar_connections;
 431         guint16 default_port;
 432
 433         /** A linked list containing PeerConnections. */
 434         GSList *peer_connections;
 435 };
 436
 437 /* Valid for calling aim_icq_setstatus() and for aim_userinfo_t->icqinfo.status */
 438 #define AIM_ICQ_STATE_NORMAL            0x00000000
 439 #define AIM_ICQ_STATE_AWAY              0x00000001
 440 #define AIM_ICQ_STATE_DND               0x00000002
 441 #define AIM_ICQ_STATE_OUT               0x00000004
 442 #define AIM_ICQ_STATE_BUSY              0x00000010
 443 #define AIM_ICQ_STATE_CHAT              0x00000020
 444 #define AIM_ICQ_STATE_INVISIBLE         0x00000100
 445 #define AIM_ICQ_STATE_EVIL              0x00003000
 446 #define AIM_ICQ_STATE_DEPRESSION        0x00004000
 447 #define AIM_ICQ_STATE_ATHOME            0x00005000
 448 #define AIM_ICQ_STATE_ATWORK            0x00006000
 449 #define AIM_ICQ_STATE_LUNCH             0x00002001
 450 #define AIM_ICQ_STATE_EVIL              0x00003000
 451 #define AIM_ICQ_STATE_WEBAWARE          0x00010000
 452 #define AIM_ICQ_STATE_HIDEIP            0x00020000
 453 #define AIM_ICQ_STATE_BIRTHDAY          0x00080000
 454 #define AIM_ICQ_STATE_ICQHOMEPAGE       0x00200000
 455 #define AIM_ICQ_STATE_DIRECTREQUIREAUTH 0x10000000
 456
 457 /**
 458  * Only used when connecting with the old-style BUCP login.
 459  */
 460 struct aim_clientrelease
 461 {
 462         char *name;
 463         guint32 build;
 464         char *url;
 465         char *info;
 466 };
 467
 468 /**
 469  * Only used when connecting with the old-style BUCP login.
 470  */
 471 struct aim_authresp_info
 472 {
 473         char *bn;
 474         guint16 errorcode;
 475         char *errorurl;
 476         guint16 regstatus;
 477         char *email;
 478         char *bosip;
 479         guint16 cookielen;
 480         guint8 *cookie;
 481         char *chpassurl;
 482         struct aim_clientrelease latestrelease;
 483         struct aim_clientrelease latestbeta;
 484 };
 485
 486 /* Callback data for redirect. */
 487 struct aim_redirect_data
 488 {
 489         guint16 group;
 490         const char *ip;
 491         guint16 cookielen;
 492         const guint8 *cookie;
 493         const char *ssl_cert_cn;
 494         guint8 use_ssl;
 495         struct { /* group == SNAC_FAMILY_CHAT */
 496                 guint16 exchange;
 497                 const char *room;
 498                 guint16 instance;
 499         } chat;
 500 };
 501
 502 int oscar_connect_to_bos(PurpleConnection *gc, OscarData *od, const char *host, guint16 port, guint8 *cookie, guint16 cookielen, const char *tls_certname);
 503
 504 /* family_auth.c */
 505
 506 /**
 507  * Only used when connecting with the old-style BUCP login.
 508  */
 509 int aim_request_login(OscarData *od, FlapConnection *conn, const char *bn);
 510
 511 /**
 512  * Only used when connecting with the old-style BUCP login.
 513  */
 514 int aim_send_login(OscarData *od, FlapConnection *conn, const char *bn, const char *password, gboolean truncate_pass, ClientInfo *ci, const char *key, gboolean allow_multiple_logins);
 515
 516 /**
 517  * Only used when connecting with the old-style BUCP login.
 518  */
 519 /* 0x000b */ int aim_auth_securid_send(OscarData *od, const char *securid);
 520
 521 /**
 522  * Only used when connecting with clientLogin.
 523  */
 524 void send_client_login(OscarData *od, const char *username);
 525
 526 /**
 527  * Only used when connecting with kerberos login.
 528  */
 529 void send_kerberos_login(OscarData *od, const char *username);
 530
 531
 532 /* flap_connection.c */
 533 FlapConnection *flap_connection_new(OscarData *, int type);
 534 void flap_connection_close(OscarData *od, FlapConnection *conn);
 535 void flap_connection_destroy(FlapConnection *conn, OscarDisconnectReason reason, const gchar *error_message);
 536 void flap_connection_schedule_destroy(FlapConnection *conn, OscarDisconnectReason reason, const gchar *error_message);
 537 FlapConnection *flap_connection_findbygroup(OscarData *od, guint16 group);
 538 FlapConnection *flap_connection_getbytype(OscarData *, int type);
 539 FlapConnection *flap_connection_getbytype_all(OscarData *, int type);
 540 void flap_connection_recv_cb(gpointer data, gint source, PurpleInputCondition cond);
 541 void flap_connection_recv_cb_ssl(gpointer data, PurpleSslConnection *gsc, PurpleInputCondition cond);
 542
 543 void flap_connection_send(FlapConnection *conn, FlapFrame *frame);
 544 void flap_connection_send_version(OscarData *od, FlapConnection *conn);
 545 void flap_connection_send_version_with_cookie(OscarData *od, FlapConnection *conn, guint16 length, const guint8 *chipsahoy);
 546 void flap_connection_send_version_with_cookie_and_clientinfo(OscarData *od, FlapConnection *conn, guint16 length, const guint8 *chipsahoy, ClientInfo *ci, gboolean allow_multiple_login);
 547 void flap_connection_send_snac(OscarData *od, FlapConnection *conn, guint16 family, const guint16 subtype, aim_snacid_t snacid, ByteStream *data);
 548 void flap_connection_send_snac_with_priority(OscarData *od, FlapConnection *conn, guint16 family, const guint16 subtype, aim_snacid_t snacid, ByteStream *data, gboolean high_priority);
 549 void flap_connection_send_keepalive(OscarData *od, FlapConnection *conn);
 550 FlapFrame *flap_frame_new(OscarData *od, guint16 channel, int datalen);
 551
 552 /* oscar_data.c */
 553 typedef int (*aim_rxcallback_t)(OscarData *od, FlapConnection *conn, FlapFrame *frame, ...);
 554
 555 OscarData *oscar_data_new(void);
 556 void oscar_data_destroy(OscarData *);
 557 void oscar_data_addhandler(OscarData *od, guint16 family, guint16 subtype, aim_rxcallback_t newhandler, guint16 flags);
 558 aim_rxcallback_t aim_callhandler(OscarData *od, guint16 family, guint16 subtype);
 559
 560 /* 0x0001 - family_oservice.c */
 561 /* 0x0002 */ void aim_srv_clientready(OscarData *od, FlapConnection *conn);
 562 /* 0x0004 */ void aim_srv_requestnew(OscarData *od, guint16 serviceid);
 563 /* 0x0006 */ void aim_srv_reqrates(OscarData *od, FlapConnection *conn);
 564 /* 0x0008 */ void aim_srv_rates_addparam(OscarData *od, FlapConnection *conn);
 565 /* 0x000e */ void aim_srv_reqpersonalinfo(OscarData *od, FlapConnection *conn);
 566 /* 0x0011 */ void aim_srv_setidle(OscarData *od, guint32 idletime);
 567 /* 0x0017 */ void aim_srv_setversions(OscarData *od, FlapConnection *conn);
 568 /* 0x001e */ int aim_srv_setextrainfo(OscarData *od, gboolean seticqstatus, guint32 icqstatus, gboolean setstatusmsg, const char *statusmsg, const char *itmsurl);
 569 void aim_srv_set_dc_info(OscarData *od);
 570
 571
 572 void aim_bos_reqrights(OscarData *od, FlapConnection *conn);
 573
 574 #define AIM_RATE_CODE_LIMIT      0x0003
 575
 576 /* family_icbm.c */
 577 #define AIM_OFT_SUBTYPE_SEND_DIR        0x0002
 578
 579 #define AIM_TRANSFER_DENY_DECLINE       0x0001
 580
 581 #define AIM_IMPARAM_FLAG_CHANNEL_MSGS_ALLOWED   0x00000001
 582 #define AIM_IMPARAM_FLAG_MISSED_CALLS_ENABLED   0x00000002
 583 #define AIM_IMPARAM_FLAG_EVENTS_ALLOWED         0x00000008
 584 #define AIM_IMPARAM_FLAG_SMS_SUPPORTED          0x00000010
 585 #define AIM_IMPARAM_FLAG_OFFLINE_MSGS_ALLOWED   0x00000100
 586
 587 /**
 588  * This flag tells the server that we always send HTML in messages
 589  * sent from an ICQ account to an ICQ account.  (If this flag is
 590  * not sent then plaintext is sent ICQ<-->ICQ (HTML is sent in all
 591  * other cases)).
 592  *
 593  * If we send an HTML message to an old client that doesn't support
 594  * HTML messages, then the oscar servers will merrily strip the HTML
 595  * for us.
 596  *
 597  * All incoming IMs are treated as HTML.
 598  */
 599 #define AIM_IMPARAM_FLAG_USE_HTML_FOR_ICQ       0x00000400
 600
 601 struct aim_icbmparameters
 602 {
 603         guint16 maxchan;
 604         guint32 flags; /* AIM_IMPARAM_FLAG_ */
 605         guint16 maxmsglen; /* message size that you will accept */
 606         guint16 maxsenderwarn; /* this and below are *10 (999=99.9%) */
 607         guint16 maxrecverwarn;
 608         guint32 minmsginterval; /* in milliseconds? */
 609 };
 610
 611 /*
 612  * TODO: Should probably combine this with struct chat_connection.
 613  */
 614 struct aim_chat_roominfo
 615 {
 616         guint16 exchange;
 617         char *name;
 618         guint8 namelen;
 619         guint16 instance;
 620 };
 621
 622 struct chat_connection
 623 {
 624         char *name;
 625         char *show; /* AOL did something funny to us */
 626         guint16 exchange;
 627         guint16 instance;
 628         FlapConnection *conn;
 629         int id;
 630         PurpleConnection *gc;
 631         PurpleChatConversation *conv;
 632         guint16 maxlen;
 633         guint16 maxvis;
 634 };
 635
 636 /*
 637  * All this chat struct stuff should be in family_chat.c
 638  */
 639 void oscar_chat_destroy(struct chat_connection *cc);
 640
 641 #define AIM_IMFLAGS_AWAY                                0x0001 /* mark as an autoreply */
 642 #define AIM_IMFLAGS_ACK                                 0x0002 /* request a receipt notice */
 643 #define AIM_IMFLAGS_BUDDYREQ                    0x0010 /* buddy icon requested */
 644 #define AIM_IMFLAGS_HASICON                             0x0020 /* already has icon */
 645 #define AIM_IMFLAGS_SUBENC_MACINTOSH    0x0040 /* damn that Steve Jobs! */
 646 #define AIM_IMFLAGS_CUSTOMFEATURES              0x0080 /* features field present */
 647 #define AIM_IMFLAGS_OFFLINE                             0x0800 /* send to offline user */
 648 #define AIM_IMFLAGS_TYPINGNOT                   0x1000 /* typing notification */
 649
 650 #define AIM_CHARSET_ASCII   0x0000 /* ISO 646 */
 651 #define AIM_CHARSET_UNICODE 0x0002 /* ISO 10646 (UTF-16/UCS-2BE) */
 652 #define AIM_CHARSET_LATIN_1 0x0003 /* ISO 8859-1 */
 653
 654 /*
 655  * Arguments to aim_send_im_ext().
 656  *
 657  * This is really complicated.  But immensely versatile.
 658  *
 659  */
 660 struct aim_sendimext_args
 661 {
 662         /* These are _required_ */
 663         const char *destbn;
 664         guint32 flags; /* often 0 */
 665
 666         const char *msg;
 667         gsize msglen;
 668
 669         /* Only used if AIM_IMFLAGS_HASICON is set */
 670         guint32 iconlen;
 671         time_t iconstamp;
 672         guint32 iconsum;
 673
 674         guint16 featureslen;
 675         guint8 *features;
 676
 677         guint16 charset;
 678 };
 679
 680 /*
 681  * This information is provided in the Incoming ICBM callback for
 682  * Channel 1 ICBM's.
 683  */
 684 struct aim_incomingim_ch1_args
 685 {
 686         guint32 icbmflags; /* some flags apply only to ->msg, not all mpmsg */
 687         time_t timestamp; /* Only set for offline messages */
 688
 689         gchar *msg;
 690
 691         /* Only provided if AIM_IMFLAGS_HASICON is set */
 692         time_t iconstamp;
 693         guint32 iconlen;
 694         guint16 iconsum;
 695 };
 696
 697 /* Valid values for channel 2 args->status */
 698 #define AIM_RENDEZVOUS_PROPOSE   0x0000
 699 #define AIM_RENDEZVOUS_CANCEL    0x0001
 700 #define AIM_RENDEZVOUS_CONNECTED 0x0002
 701
 702 struct _IcbmArgsCh2
 703 {
 704         guint16 status;
 705         guchar cookie[8];
 706         guint64 type; /* One of the OSCAR_CAPABILITY_ constants */
 707         const char *proxyip;
 708         const char *clientip;
 709         const char *verifiedip;
 710         guint16 port;
 711         gboolean use_proxy;
 712         guint16 errorcode;
 713         const char *msg; /* invite message or file description */
 714         guint16 msglen;
 715         const char *encoding;
 716         const char *language;
 717         guint16 requestnumber;
 718         union {
 719                 struct {
 720                         guint32 checksum;
 721                         guint32 length;
 722                         time_t timestamp;
 723                         guint8 *icon;
 724                 } icon;
 725                 struct {
 726                         struct aim_chat_roominfo roominfo;
 727                 } chat;
 728                 struct {
 729                         guint8 msgtype;
 730                         const char *msg;
 731                 } rtfmsg;
 732                 struct {
 733                         guint16 subtype;
 734                         guint16 totfiles;
 735                         guint32 totsize;
 736                         char *filename;
 737                 } sendfile;
 738         } info;
 739         void *destructor; /* used internally only */
 740 };
 741
 742 struct aim_incomingim_ch4_args
 743 {
 744         guint32 uin; /* Of the sender of the ICBM */
 745         guint8 type;
 746         guint8 flags;
 747         gchar *msg; /* Reason for auth request, deny, or accept */
 748         int msglen;
 749 };
 750
 751 /* SNAC sending functions */
 752 /* 0x0002 */ int aim_im_setparams(OscarData *od, struct aim_icbmparameters *params);
 753 /* 0x0004 */ int aim_im_reqparams(OscarData *od);
 754 /* 0x0006 */ int aim_im_sendch1_ext(OscarData *od, struct aim_sendimext_args *args);
 755 /* 0x0006 */ int aim_im_sendch1(OscarData *, const char *destbn, guint16 flags, const char *msg);
 756 /* 0x0006 */ int aim_im_sendch2_chatinvite(OscarData *od, const char *bn, const char *msg, guint16 exchange, const char *roomname, guint16 instance);
 757 /* 0x0006 */ int aim_im_sendch2_icon(OscarData *od, const char *bn, const guint8 *icon, int iconlen, time_t stamp, guint16 iconsum);
 758
 759 /* 0x0006 */ void aim_im_sendch2_cancel(PeerConnection *peer_conn);
 760 /* 0x0006 */ void aim_im_sendch2_connected(PeerConnection *peer_conn);
 761 /* 0x0006 */ void aim_im_sendch2_odc_requestdirect(OscarData *od, guchar *cookie, const char *bn, const guint8 *ip, guint16 port, guint16 requestnumber);
 762 /* 0x0006 */ void aim_im_sendch2_odc_requestproxy(OscarData *od, guchar *cookie, const char *bn, const guint8 *ip, guint16 pin, guint16 requestnumber);
 763 /* 0x0006 */ void aim_im_sendch2_sendfile_requestdirect(OscarData *od, guchar *cookie, const char *bn, const guint8 *ip, guint16 port, guint16 requestnumber, const gchar *filename, guint32 size, guint16 numfiles);
 764 /* 0x0006 */ void aim_im_sendch2_sendfile_requestproxy(OscarData *od, guchar *cookie, const char *bn, const guint8 *ip, guint16 pin, guint16 requestnumber, const gchar *filename, guint32 size, guint16 numfiles);
 765
 766 /* 0x000b */ int aim_im_denytransfer(OscarData *od, const char *bn, const guchar *cookie, guint16 code);
 767 /* 0x0010 */ int aim_im_reqofflinemsgs(OscarData *od);
 768 /* 0x0014 */ int aim_im_sendmtn(OscarData *od, guint16 type1, const char *bn, guint16 type2);
 769 /* 0x000b */ int icq_relay_xstatus (OscarData *od, const char *sn, const guchar* cookie);
 770 void aim_icbm_makecookie(guchar* cookie);
 771 void aim_im_send_icq_confirmation(OscarData *od, const char *bn, const guchar *cookie);
 772
 773 /* 0x0002 - family_locate.c */
 774 /*
 775  * AIM User Info, Standard Form.
 776  */
 777 #define AIM_FLAG_ADMINISTRATOR   0x0002
 778 #define AIM_FLAG_AOL             0x0004
 779 #define AIM_FLAG_AWAY            0x0020
 780 #define AIM_FLAG_WIRELESS        0x0080
 781 #define AIM_FLAG_ICQ             0x0040
 782 #define AIM_FLAG_ACTIVEBUDDY     0x0400
 783
 784 #define AIM_USERINFO_PRESENT_FLAGS        0x00000001
 785 #define AIM_USERINFO_PRESENT_MEMBERSINCE  0x00000002
 786 #define AIM_USERINFO_PRESENT_ONLINESINCE  0x00000004
 787 #define AIM_USERINFO_PRESENT_IDLE         0x00000008
 788 #define AIM_USERINFO_PRESENT_ICQEXTSTATUS 0x00000010
 789 #define AIM_USERINFO_PRESENT_ICQIPADDR    0x00000020
 790 #define AIM_USERINFO_PRESENT_ICQDATA      0x00000040
 791 #define AIM_USERINFO_PRESENT_CAPABILITIES 0x00000080
 792 #define AIM_USERINFO_PRESENT_SESSIONLEN   0x00000100
 793 #define AIM_USERINFO_PRESENT_CREATETIME   0x00000200
 794
 795 struct userinfo_node
 796 {
 797         char *bn;
 798         struct userinfo_node *next;
 799 };
 800
 801 typedef struct aim_userinfo_s
 802 {
 803         char *bn;
 804         guint16 warnlevel; /* evil percent * 10 (999 = 99.9%) */
 805         guint16 idletime; /* in seconds */
 806         guint16 flags;
 807         guint32 createtime; /* time_t */
 808         guint32 membersince; /* time_t */
 809         guint32 onlinesince; /* time_t */
 810         guint32 sessionlen;  /* in seconds */
 811         guint64 capabilities;
 812         struct {
 813                 guint32 status;
 814                 guint32 ipaddr;
 815                 guint8 crap[0x25]; /* until we figure it out... */
 816         } icqinfo;
 817         guint32 present;
 818
 819         guint8 iconcsumtype;
 820         guint16 iconcsumlen;
 821         guint8 *iconcsum;
 822
 823         char *info;
 824         char *info_encoding;
 825         guint16 info_len;
 826
 827         char *status;
 828         char *status_encoding;
 829         guint16 status_len;
 830
 831         char *itmsurl;
 832         char *itmsurl_encoding;
 833         guint16 itmsurl_len;
 834
 835         char *away;
 836         char *away_encoding;
 837         guint16 away_len;
 838
 839         struct aim_userinfo_s *next;
 840 } aim_userinfo_t;
 841
 842 struct aim_invite_priv
 843 {
 844         char *bn;
 845         char *roomname;
 846         guint16 exchange;
 847         guint16 instance;
 848 };
 849
 850 #define AIM_COOKIETYPE_CHAT     0x01
 851 #define AIM_COOKIETYPE_INVITE   0x02
 852
 853 aim_userinfo_t *aim_locate_finduserinfo(OscarData *od, const char *bn);
 854 void aim_locate_dorequest(OscarData *od);
 855
 856 /* 0x0002 */ int aim_locate_reqrights(OscarData *od);
 857 /* 0x0004 */ int aim_locate_setcaps(OscarData *od, guint64 caps);
 858 /* 0x0004 */ int aim_locate_setprofile(OscarData *od, const char *profile_encoding, const gchar *profile, const int profile_len, const char *awaymsg_encoding, const gchar *awaymsg, const int awaymsg_len);
 859 /* 0x0015 */ int aim_locate_getinfoshort(OscarData *od, const char *bn, guint32 flags);
 860
 861 guint64 aim_locate_getcaps(OscarData *od, ByteStream *bs, int len);
 862 guint64 aim_locate_getcaps_short(OscarData *od, ByteStream *bs, int len);
 863 void aim_info_free(aim_userinfo_t *);
 864 int aim_info_extract(OscarData *od, ByteStream *bs, aim_userinfo_t *);
 865 int aim_putuserinfo(ByteStream *bs, aim_userinfo_t *info);
 866 PurpleMood* icq_get_purple_moods(PurpleAccount *account);
 867 const char* icq_get_custom_icon_description(const char *mood);
 868 guint8* icq_get_custom_icon_data(const char *mood);
 869 int icq_im_xstatus_request(OscarData *od, const char *sn);
 870
 871 /* 0x0003 - family_buddy.c */
 872 /* 0x0002 */ void aim_buddylist_reqrights(OscarData *, FlapConnection *);
 873
 874
 875 /* 0x000a - family_userlookup.c */
 876 int aim_search_address(OscarData *, const char *);
 877
 878 struct aim_chat_exchangeinfo
 879 {
 880         guint16 number;
 881         guint16 flags;
 882         char *name;
 883         char *charset1;
 884         char *lang1;
 885         char *charset2;
 886         char *lang2;
 887 };
 888
 889 #define AIM_CHATFLAGS_NOREFLECT 0x0001
 890 #define AIM_CHATFLAGS_AWAY      0x0002
 891 int aim_chat_send_im(OscarData *od, FlapConnection *conn, guint16 flags, const gchar *msg, int msglen, const char *encoding, const char *language);
 892 int aim_chat_join(OscarData *od, guint16 exchange, const char *roomname, guint16 instance);
 893
 894 void aim_chatnav_reqrights(OscarData *od, FlapConnection *conn);
 895
 896 int aim_chatnav_createroom(OscarData *od, FlapConnection *conn, const char *name, guint16 exchange);
 897
 898
 899 /* 0x0010 - family_bart.c */
 900 int aim_bart_upload(OscarData *od, const guint8 *icon, guint16 iconlen);
 901 int aim_bart_request(OscarData *od, const char *bn, guint8 iconcsumtype, const guint8 *iconstr, guint16 iconstrlen);
 902
 903
 904
 905 /* 0x0013 - family_feedbag.c */
 906 #define AIM_SSI_TYPE_BUDDY              0x0000
 907 #define AIM_SSI_TYPE_GROUP              0x0001
 908 #define AIM_SSI_TYPE_PERMIT             0x0002
 909 #define AIM_SSI_TYPE_DENY               0x0003
 910 #define AIM_SSI_TYPE_PDINFO             0x0004
 911 #define AIM_SSI_TYPE_PRESENCEPREFS      0x0005
 912 #define AIM_SSI_TYPE_ICQDENY            0x000e
 913 #define AIM_SSI_TYPE_ICONINFO           0x0014
 914
 915 /* These flags are set in the 0x00c9 TLV of SSI type 0x0005 */
 916 #define AIM_SSI_PRESENCE_FLAG_SHOWIDLE        0x00000400
 917 #define AIM_SSI_PRESENCE_FLAG_NORECENTBUDDIES 0x00020000
 918
 919 struct aim_ssi_item
 920 {
 921         char *name;
 922         guint16 gid;
 923         guint16 bid;
 924         guint16 type;
 925         GSList *data;
 926         struct aim_ssi_item *next;
 927 };
 928
 929 struct aim_ssi_tmp
 930 {
 931         guint16 action;
 932         guint16 ack;
 933         char *name;
 934         struct aim_ssi_item *item;
 935         struct aim_ssi_tmp *next;
 936 };
 937
 938 /* These build the actual SNACs and queue them to be sent */
 939 /* 0x0002 */ int aim_ssi_reqrights(OscarData *od);
 940 /* 0x0004 */ int aim_ssi_reqdata(OscarData *od);
 941 /* 0x0007 */ int aim_ssi_enable(OscarData *od);
 942 /* 0x0011 */ int aim_ssi_modbegin(OscarData *od);
 943 /* 0x0012 */ int aim_ssi_modend(OscarData *od);
 944 /* 0x0018 */ int aim_ssi_sendauthrequest(OscarData *od, const char *bn, const char *msg);
 945 /* 0x001a */ int aim_ssi_sendauthreply(OscarData *od, const char *bn, guint8 reply, const char *msg);
 946
 947 /* Client functions for retrieving SSI data */
 948 struct aim_ssi_item *aim_ssi_itemlist_find(struct aim_ssi_itemlist *list, guint16 gid, guint16 bid);
 949 struct aim_ssi_item *aim_ssi_itemlist_finditem(struct aim_ssi_itemlist *list, const char *gn, const char *bn, guint16 type);
 950 struct aim_ssi_item *aim_ssi_itemlist_exists(struct aim_ssi_itemlist *list, const char *bn);
 951 char *aim_ssi_itemlist_findparentname(struct aim_ssi_itemlist *list, const char *bn);
 952 int aim_ssi_getpermdeny(struct aim_ssi_itemlist *list);
 953 guint32 aim_ssi_getpresence(struct aim_ssi_itemlist *list);
 954 char *aim_ssi_getalias(struct aim_ssi_itemlist *list, const char *gn, const char *bn);
 955 char *aim_ssi_getalias_from_item(struct aim_ssi_item *item);
 956 char *aim_ssi_getcomment(struct aim_ssi_itemlist *list, const char *gn, const char *bn);
 957 gboolean aim_ssi_waitingforauth(struct aim_ssi_itemlist *list, const char *gn, const char *bn);
 958
 959 /* Client functions for changing SSI data */
 960 int aim_ssi_addbuddy(OscarData *od, const char *name, const char *group, GSList *tlvlist, const char *alias, const char *comment, const char *smsnum, gboolean needauth);
 961 int aim_ssi_delbuddy(OscarData *od, const char *name, const char *group);
 962 int aim_ssi_delgroup(OscarData *od, const char *group);
 963 int aim_ssi_movebuddy(OscarData *od, const char *oldgn, const char *newgn, const char *bn);
 964 int aim_ssi_aliasbuddy(OscarData *od, const char *gn, const char *bn, const char *alias);
 965 int aim_ssi_editcomment(OscarData *od, const char *gn, const char *bn, const char *alias);
 966 int aim_ssi_rename_group(OscarData *od, const char *oldgn, const char *newgn);
 967 int aim_ssi_deletelist(OscarData *od);
 968 int aim_ssi_setpermdeny(OscarData *od, guint8 permdeny);
 969 int aim_ssi_setpresence(OscarData *od, guint32 presence);
 970 int aim_ssi_seticon(OscarData *od, const guint8 *iconsum, guint8 iconsumlen);
 971 int aim_ssi_delicon(OscarData *od);
 972 int aim_ssi_add_to_private_list(OscarData *od, const char* name, guint16 list_type);
 973 int aim_ssi_del_from_private_list(OscarData* od, const char* name, guint16 list_type);
 974
 975 guint16 aim_ssi_getdenyentrytype(OscarData* od);
 976
 977 struct aim_icq_info
 978 {
 979         guint16 reqid;
 980
 981         /* simple */
 982         guint32 uin;
 983
 984         /* general and "home" information (0x00c8) */
 985         char *nick;
 986         char *first;
 987         char *last;
 988         char *email;
 989         char *homecity;
 990         char *homestate;
 991         char *homephone;
 992         char *homefax;
 993         char *homeaddr;
 994         char *mobile;
 995         char *homezip;
 996         guint16 homecountry;
 997 /*      guint8 timezone;
 998         guint8 hideemail; */
 999
1000         /* personal (0x00dc) */
1001         guint8 age;
1002         guint8 unknown;
1003         guint8 gender;
1004         char *personalwebpage;
1005         guint16 birthyear;
1006         guint8 birthmonth;
1007         guint8 birthday;
1008         guint8 language1;
1009         guint8 language2;
1010         guint8 language3;
1011
1012         /* work (0x00d2) */
1013         char *workcity;
1014         char *workstate;
1015         char *workphone;
1016         char *workfax;
1017         char *workaddr;
1018         char *workzip;
1019         guint16 workcountry;
1020         char *workcompany;
1021         char *workdivision;
1022         char *workposition;
1023         char *workwebpage;
1024
1025         /* additional personal information (0x00e6) */
1026         char *info;
1027
1028         /* email (0x00eb) */
1029         guint16 numaddresses;
1030         char **email2;
1031
1032         /* status note info */
1033         guint8 icbm_cookie[8];
1034         char *status_note_title;
1035
1036         gboolean for_auth_request;
1037         char *auth_request_reason;
1038 };
1039
1040 int aim_icq_setsecurity(OscarData *od, gboolean auth_required, gboolean webaware);
1041 int aim_icq_changepasswd(OscarData *od, const char *passwd);
1042 int aim_icq_getalias(OscarData *od, const char *uin, gboolean for_auth_request, char *auth_request_reason);
1043 int aim_icq_getallinfo(OscarData *od, const char *uin);
1044 int aim_icq_sendsms(OscarData *od, const char *name, const char *msg, const char *alias);
1045
1046
1047 /* 0x0017 - family_auth.c */
1048 void aim_sendcookie(OscarData *, FlapConnection *, const guint16 length, const guint8 *);
1049 void aim_admin_changepasswd(OscarData *, FlapConnection *, const char *newpw, const char *curpw);
1050 void aim_admin_reqconfirm(OscarData *od, FlapConnection *conn);
1051 void aim_admin_getinfo(OscarData *od, FlapConnection *conn, guint16 info);
1052 void aim_admin_setemail(OscarData *od, FlapConnection *conn, const char *newemail);
1053 void aim_admin_setnick(OscarData *od, FlapConnection *conn, const char *newnick);
1054
1055
1056
1057 /* 0x0018 - family_alert.c */
1058 struct aim_emailinfo
1059 {
1060         guint8 *cookie16;
1061         guint8 *cookie8;
1062         char *url;
1063         guint16 nummsgs;
1064         guint8 unread;
1065         char *domain;
1066         guint16 flag;
1067         struct aim_emailinfo *next;
1068 };
1069
1070 int aim_email_sendcookies(OscarData *od);
1071 int aim_email_activate(OscarData *od);
1072
1073
1074
1075 /* tlv.c - TLV handling */
1076
1077 /* TLV structure */
1078 typedef struct aim_tlv_s
1079 {
1080         guint16 type;
1081         guint16 length;
1082         guint8 *value;
1083 } aim_tlv_t;
1084
1085 /* TLV handling functions */
1086 char *aim_tlv_getvalue_as_string(aim_tlv_t *tlv);
1087
1088 aim_tlv_t *aim_tlv_gettlv(GSList *list, const guint16 type, const int nth);
1089 int aim_tlv_getlength(GSList *list, const guint16 type, const int nth);
1090 char *aim_tlv_getstr(GSList *list, const guint16 type, const int nth);
1091 guint8 aim_tlv_get8(GSList *list, const guint16 type, const int nth);
1092 guint16 aim_tlv_get16(GSList *list, const guint16 type, const int nth);
1093 guint32 aim_tlv_get32(GSList *list, const guint16 type, const int nth);
1094
1095 /* TLV list handling functions */
1096 GSList *aim_tlvlist_read(ByteStream *bs);
1097 GSList *aim_tlvlist_readnum(ByteStream *bs, guint16 num);
1098 GSList *aim_tlvlist_readlen(ByteStream *bs, guint16 len);
1099 GSList *aim_tlvlist_copy(GSList *orig);
1100
1101 int aim_tlvlist_count(GSList *list);
1102 size_t aim_tlvlist_size(GSList *list);
1103 int aim_tlvlist_cmp(GSList *one, GSList *two);
1104 int aim_tlvlist_write(ByteStream *bs, GSList **list);
1105 void aim_tlvlist_free(GSList *list);
1106
1107 int aim_tlvlist_add_raw(GSList **list, const guint16 type, const guint16 length, const guint8 *value);
1108 int aim_tlvlist_add_noval(GSList **list, const guint16 type);
1109 int aim_tlvlist_add_8(GSList **list, const guint16 type, const guint8 value);
1110 int aim_tlvlist_add_16(GSList **list, const guint16 type, const guint16 value);
1111 int aim_tlvlist_add_32(GSList **list, const guint16 type, const guint32 value);
1112 int aim_tlvlist_add_str(GSList **list, const guint16 type, const char *value);
1113 int aim_tlvlist_add_caps(GSList **list, const guint16 type, const guint64 caps, const char *mood);
1114 int aim_tlvlist_add_userinfo(GSList **list, guint16 type, aim_userinfo_t *userinfo);
1115 int aim_tlvlist_add_chatroom(GSList **list, guint16 type, guint16 exchange, const char *roomname, guint16 instance);
1116 int aim_tlvlist_add_frozentlvlist(GSList **list, guint16 type, GSList **tl);
1117
1118 int aim_tlvlist_replace_raw(GSList **list, const guint16 type, const guint16 lenth, const guint8 *value);
1119 int aim_tlvlist_replace_str(GSList **list, const guint16 type, const char *str);
1120 int aim_tlvlist_replace_noval(GSList **list, const guint16 type);
1121 int aim_tlvlist_replace_8(GSList **list, const guint16 type, const guint8 value);
1122 int aim_tlvlist_replace_16(GSList **list, const guint16 type, const guint16 value);
1123 int aim_tlvlist_replace_32(GSList **list, const guint16 type, const guint32 value);
1124
1125 void aim_tlvlist_remove(GSList **list, const guint16 type);
1126
1127
1128
1129 /* util.c */
1130 /* These are really ugly.  You'd think this was LISP.  I wish it was. */
1131 #define aimutil_put8(buf, data) ((*(buf) = (guint8)(data)&0xff),1)
1132 #define aimutil_get8(buf) ((*(buf))&0xff)
1133 #define aimutil_put16(buf, data) ( \
1134                 (*(buf) = (guint8)((data)>>8)&0xff), \
1135                 (*((buf)+1) = (guint8)(data)&0xff),  \
1136                 2)
1137 #define aimutil_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
1138 #define aimutil_put32(buf, data) ( \
1139                 (*((buf)) = (guint8)((data)>>24)&0xff), \
1140                 (*((buf)+1) = (guint8)((data)>>16)&0xff), \
1141                 (*((buf)+2) = (guint8)((data)>>8)&0xff), \
1142                 (*((buf)+3) = (guint8)(data)&0xff), \
1143                 4)
1144 #define aimutil_get32(buf) ((((*(buf))<<24)&0xff000000) + \
1145                 (((*((buf)+1))<<16)&0x00ff0000) + \
1146                 (((*((buf)+2))<< 8)&0x0000ff00) + \
1147                 (((*((buf)+3)    )&0x000000ff)))
1148
1149 /* Little-endian versions (damn ICQ) */
1150 #define aimutil_putle8(buf, data) ( \
1151                 (*(buf) = (guint8)(data) & 0xff), \
1152                 1)
1153 #define aimutil_getle8(buf) ( \
1154                 (*(buf)) & 0xff \
1155                 )
1156 #define aimutil_putle16(buf, data) ( \
1157                 (*((buf)+0) = (guint8)((data) >> 0) & 0xff),  \
1158                 (*((buf)+1) = (guint8)((data) >> 8) & 0xff), \
1159                 2)
1160 #define aimutil_getle16(buf) ( \
1161                 (((*((buf)+0)) << 0) & 0x00ff) + \
1162                 (((*((buf)+1)) << 8) & 0xff00) \
1163                 )
1164 #define aimutil_putle32(buf, data) ( \
1165                 (*((buf)+0) = (guint8)((data) >>  0) & 0xff), \
1166                 (*((buf)+1) = (guint8)((data) >>  8) & 0xff), \
1167                 (*((buf)+2) = (guint8)((data) >> 16) & 0xff), \
1168                 (*((buf)+3) = (guint8)((data) >> 24) & 0xff), \
1169                 4)
1170 #define aimutil_getle32(buf) ( \
1171                 (((*((buf)+0)) <<  0) & 0x000000ff) + \
1172                 (((*((buf)+1)) <<  8) & 0x0000ff00) + \
1173                 (((*((buf)+2)) << 16) & 0x00ff0000) + \
1174                 (((*((buf)+3)) << 24) & 0xff000000))
1175
1176 const char *oscar_get_msgerr_reason(size_t reason);
1177 int oscar_get_ui_info_int(const char *str, int default_value);
1178 const char *oscar_get_ui_info_string(const char *str, const char *default_value);
1179 gchar *oscar_get_clientstring(void);
1180
1181 guint16 aimutil_iconsum(const guint8 *buf, int buflen);
1182
1183 gboolean oscar_util_valid_name(const char *bn);
1184 gboolean oscar_util_valid_name_icq(const char *bn);
1185 gboolean oscar_util_valid_name_sms(const char *bn);
1186 int oscar_util_name_compare(const char *bn1, const char *bn2);
1187 gchar *oscar_util_format_string(const char *str, const char *name);
1188 gchar *oscar_format_buddies(GSList *buddies, const gchar *no_buddies_message);
1189
1190 typedef struct {
1191         guint16 family;
1192         guint16 subtype;
1193         guint16 flags;
1194         guint32 id;
1195 } aim_modsnac_t;
1196
1197 #define AIM_MODULENAME_MAXLEN 16
1198 #define AIM_MODFLAG_MULTIFAMILY 0x0001
1199 typedef struct aim_module_s
1200 {
1201         guint16 family;
1202         guint16 version;
1203         guint16 toolid;
1204         guint16 toolversion;
1205         guint16 flags;
1206         char name[AIM_MODULENAME_MAXLEN+1];
1207         int (*snachandler)(OscarData *od, FlapConnection *conn, struct aim_module_s *mod, FlapFrame *rx, aim_modsnac_t *snac, ByteStream *bs);
1208         void (*shutdown)(OscarData *od, struct aim_module_s *mod);
1209         void *priv;
1210         struct aim_module_s *next;
1211 } aim_module_t;
1212
1213 int aim__registermodule(OscarData *od, int (*modfirst)(OscarData *, aim_module_t *));
1214 void aim__shutdownmodules(OscarData *od);
1215 aim_module_t *aim__findmodulebygroup(OscarData *od, guint16 group);
1216 aim_module_t *aim__findmodule(OscarData *od, const char *name);
1217
1218 int admin_modfirst(OscarData *od, aim_module_t *mod);
1219 int buddylist_modfirst(OscarData *od, aim_module_t *mod);
1220 int bos_modfirst(OscarData *od, aim_module_t *mod);
1221 int search_modfirst(OscarData *od, aim_module_t *mod);
1222 int stats_modfirst(OscarData *od, aim_module_t *mod);
1223 int auth_modfirst(OscarData *od, aim_module_t *mod);
1224 int msg_modfirst(OscarData *od, aim_module_t *mod);
1225 int misc_modfirst(OscarData *od, aim_module_t *mod);
1226 int chatnav_modfirst(OscarData *od, aim_module_t *mod);
1227 int chat_modfirst(OscarData *od, aim_module_t *mod);
1228 int locate_modfirst(OscarData *od, aim_module_t *mod);
1229 int service_modfirst(OscarData *od, aim_module_t *mod);
1230 int popups_modfirst(OscarData *od, aim_module_t *mod);
1231 int bart_modfirst(OscarData *od, aim_module_t *mod);
1232 int ssi_modfirst(OscarData *od, aim_module_t *mod);
1233 int icq_modfirst(OscarData *od, aim_module_t *mod);
1234 int email_modfirst(OscarData *od, aim_module_t *mod);
1235
1236 void aim_genericreq_n(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype);
1237 void aim_genericreq_n_snacid(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype);
1238 void aim_genericreq_l(OscarData *od, FlapConnection *conn, guint16 family, guint16 subtype, guint32 *);
1239
1240 /* bstream.c */
1241 int byte_stream_new(ByteStream *bs, size_t len);
1242 int byte_stream_init(ByteStream *bs, guint8 *data, size_t len);
1243 void byte_stream_destroy(ByteStream *bs);
1244 size_t byte_stream_bytes_left(ByteStream *bs);
1245 int byte_stream_curpos(ByteStream *bs);
1246 int byte_stream_setpos(ByteStream *bs, size_t off);
1247 void byte_stream_rewind(ByteStream *bs);
1248 int byte_stream_advance(ByteStream *bs, int n);
1249 guint8 byte_stream_get8(ByteStream *bs);
1250 guint16 byte_stream_get16(ByteStream *bs);
1251 guint32 byte_stream_get32(ByteStream *bs);
1252 guint8 byte_stream_getle8(ByteStream *bs);
1253 guint16 byte_stream_getle16(ByteStream *bs);
1254 guint32 byte_stream_getle32(ByteStream *bs);
1255 int byte_stream_getrawbuf(ByteStream *bs, guint8 *buf, size_t len);
1256 guint8 *byte_stream_getraw(ByteStream *bs, size_t len);
1257 char *byte_stream_getstr(ByteStream *bs, size_t len);
1258 int byte_stream_put8(ByteStream *bs, guint8 v);
1259 int byte_stream_put16(ByteStream *bs, guint16 v);
1260 int byte_stream_put32(ByteStream *bs, guint32 v);
1261 int byte_stream_putle8(ByteStream *bs, guint8 v);
1262 int byte_stream_putle16(ByteStream *bs, guint16 v);
1263 int byte_stream_putle32(ByteStream *bs, guint32 v);
1264 int byte_stream_putraw(ByteStream *bs, const guint8 *v, size_t len);
1265 int byte_stream_putstr(ByteStream *bs, const char *str);
1266 int byte_stream_putbs(ByteStream *bs, ByteStream *srcbs, size_t len);
1267 int byte_stream_putuid(ByteStream *bs, OscarData *od);
1268 int byte_stream_putcaps(ByteStream *bs, guint64 caps);
1269
1270 /**
1271  * Inserts a BART asset block into the given byte stream.  The flags
1272  * and length are set appropriately based on the value of data.
1273  */
1274 void byte_stream_put_bart_asset(ByteStream *bs, guint16 type, ByteStream *data);
1275
1276 /**
1277  * A helper function that calls byte_stream_put_bart_asset with the
1278  * appropriate data ByteStream given the datastr.
1279  */
1280 void byte_stream_put_bart_asset_str(ByteStream *bs, guint16 type, const char *datastr);
1281
1282 /*
1283  * Generic SNAC structure.  Rarely if ever used.
1284  */
1285 typedef struct aim_snac_s {
1286         aim_snacid_t id;
1287         guint16 family;
1288         guint16 type;
1289         guint16 flags;
1290         void *data;
1291         time_t issuetime;
1292         struct aim_snac_s *next;
1293 } aim_snac_t;
1294
1295 /* snac.c */
1296 void aim_initsnachash(OscarData *od);
1297 aim_snacid_t aim_newsnac(OscarData *, aim_snac_t *newsnac);
1298 aim_snacid_t aim_cachesnac(OscarData *od, const guint16 family, const guint16 type, const guint16 flags, const void *data, const int datalen);
1299 aim_snac_t *aim_remsnac(OscarData *, aim_snacid_t id);
1300 void aim_cleansnacs(OscarData *, int maxage);
1301 int aim_putsnac(ByteStream *, guint16 family, guint16 type, aim_snacid_t id);
1302
1303 struct chatsnacinfo {
1304         guint16 exchange;
1305         char name[128];
1306         guint16 instance;
1307 };
1308
1309 struct rateclass {
1310         guint16 classid;
1311         guint32 windowsize;
1312         guint32 clear;
1313         guint32 alert;
1314         guint32 limit;
1315         guint32 disconnect;
1316         guint32 current;
1317         guint32 max;
1318         guint8 dropping_snacs;
1319
1320         struct timeval last; /**< The time when we last sent a SNAC of this rate class. */
1321 };
1322
1323 int aim_cachecookie(OscarData *od, IcbmCookie *cookie);
1324 IcbmCookie *aim_uncachecookie(OscarData *od, guint8 *cookie, int type);
1325 IcbmCookie *aim_mkcookie(guint8 *, int, void *);
1326 IcbmCookie *aim_checkcookie(OscarData *, const unsigned char *, const int);
1327 int aim_freecookie(OscarData *od, IcbmCookie *cookie);
1328 int aim_cookie_free(OscarData *od, IcbmCookie *cookie);
1329
1330 int aim_chat_readroominfo(ByteStream *bs, struct aim_chat_roominfo *outinfo);
1331
1332 void flap_connection_destroy_chat(OscarData *od, FlapConnection *conn);
1333
1334 /* userinfo.c - displaying user information */
1335
1336 void oscar_user_info_append_status(PurpleConnection *gc, PurpleNotifyUserInfo *user_info, PurpleBuddy *b, aim_userinfo_t *userinfo, gboolean use_html_status);
1337 void oscar_user_info_append_extra_info(PurpleConnection *gc, PurpleNotifyUserInfo *user_info, PurpleBuddy *b, aim_userinfo_t *userinfo);
1338 void oscar_user_info_display_error(OscarData *od, guint16 error_reason, char *buddy);
1339 void oscar_user_info_display_icq(OscarData *od, struct aim_icq_info *info);
1340 void oscar_user_info_display_aim(OscarData *od, aim_userinfo_t *userinfo);
1341
1342 /* authorization.c - OSCAR authorization requests */
1343 void oscar_auth_sendrequest(PurpleConnection *gc, const char *name, const char *msg);
1344 void oscar_auth_sendrequest_menu(PurpleBlistNode *node, gpointer ignored);
1345 void oscar_auth_recvrequest(PurpleConnection *gc, gchar *name, gchar *nick, gchar *reason);
1346
1347 void oscar_set_aim_permdeny(PurpleConnection *gc);
1348
1349 struct buddyinfo
1350 {
1351         gboolean typingnot;
1352         guint32 ipaddr;
1353
1354         unsigned long ico_me_len;
1355         unsigned long ico_me_csum;
1356         time_t ico_me_time;
1357         gboolean ico_informed;
1358
1359         unsigned long ico_len;
1360         unsigned long ico_csum;
1361         time_t ico_time;
1362         gboolean ico_need;
1363         gboolean ico_sent;
1364 };
1365
1366 struct name_data
1367 {
1368         PurpleConnection *gc;
1369         gchar *name;
1370         gchar *nick;
1371 };
1372
1373 void oscar_free_name_data(struct name_data *data);
1374
1375 void oscar_init_account_options(PurpleProtocol *protocol, gboolean is_icq);
1376
1377 G_END_DECLS
1378
1379 #endif /* PURPLE_OSCAR_OSCAR_H */