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