Mercurial > pidgin
view libpurple/protocols/myspace/myspace.h @ 16723:3b5037a93807
Add initializers for reserved fields in plugin and prpl structures.
Change msim_send to msim_send_raw and add an empty msim_send for later.
author | Jeffrey Connelly <jaconnel@calpoly.edu> |
---|---|
date | Fri, 04 May 2007 04:49:01 +0000 |
parents | 1aa62f7368ca |
children | 58cd11fcd84f |
line wrap: on
line source
/* MySpaceIM Protocol Plugin, headr file * * \author Jeff Connelly * * Copyright (C) 2007, Jeff Connelly <jeff2@homing.pidgin.im> * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* Debugging options (1 to enable, 0 disable) */ #define MSIM_DEBUG_MSG 1 /* Low-level and rarely needed */ #define MSIM_DEBUG_PARSE 0 #define MSIM_DEBUG_LOGIN_CHALLENGE 0 #define MSIM_DEBUG_RXBUF 0 /* Statuses */ #define MSIM_STATUS_ONLINE "online" #define MSIM_STATUS_AWAY "away" #define MSIM_STATUS_OFFLINE "offline" #define MSIM_STATUS_INVISIBLE "invisible" /* Build version of MySpaceIM to report to servers (1.0.xxx.0) */ #define MSIM_CLIENT_VERSION 673 /* Server */ #define MSIM_SERVER "im.myspace.akadns.net" //#define MSIM_SERVER "localhost" #define MSIM_PORT 1863 /* TODO: alternate ports and automatic */ /* Constants */ #define HASH_SIZE 0x14 /**< Size of SHA-1 hash for login */ #define NONCE_SIZE 0x20 /**< Half of decoded 'nc' field */ #define MSIM_READ_BUF_SIZE 5*1024 /**< Receive buffer size */ #define MSIM_FINAL_STRING "\\final\\" /**< Message end marker */ /* Messages */ #define MSIM_BM_INSTANT 1 #define MSIM_BM_STATUS 100 #define MSIM_BM_ACTION 121 /*#define MSIM_BM_UNKNOWN1 122*/ /* Random number in every MsimSession, to ensure it is valid. */ #define MSIM_SESSION_STRUCT_MAGIC 0xe4a6752b /* Everything needed to keep track of a session. */ typedef struct _MsimSession { guint magic; /**< MSIM_SESSION_STRUCT_MAGIC */ PurpleAccount *account; PurpleConnection *gc; gchar *sesskey; /**< Session key text string from server */ gchar *userid; /**< This user's numeric user ID */ gint fd; /**< File descriptor to/from server */ GHashTable *user_lookup_cb; /**< Username -> userid lookup callback */ GHashTable *user_lookup_cb_data; /**< Username -> userid lookup callback data */ GHashTable *user_lookup_cache; /**< Cached information on users */ gchar *rxbuf; /**< Receive buffer */ guint rxoff; /**< Receive buffer offset */ guint next_rid; /**< Next request/response ID */ } MsimSession; /* Check if an MsimSession is valid */ #define MSIM_SESSION_VALID(s) (session != NULL && \ session->magic == MSIM_SESSION_STRUCT_MAGIC) /* Callback function pointer type for when a user's information is received, * initiated from a user lookup. */ typedef void (*MSIM_USER_LOOKUP_CB)(MsimSession *session, GHashTable *userinfo, gpointer data); /* Passed to MSIM_USER_LOOKUP_CB for msim_send_im_cb - called when * user information is available, ready to send a message. */ typedef struct _send_im_cb_struct { gchar *who; gchar *message; PurpleMessageFlags flags; } send_im_cb_struct; /* Functions */ static void init_plugin(PurplePlugin *plugin); static GList *msim_status_types(PurpleAccount *acct); static const gchar *msim_list_icon(PurpleAccount *acct, PurpleBuddy *buddy); static gchar *msim_unescape(const gchar *msg); static gchar *msim_escape(const gchar *msg); static gchar *str_replace(const gchar* str, const gchar *old, const gchar *new); static GHashTable* msim_parse(gchar* msg); static GHashTable *msim_parse_body(const gchar *body_str); static void print_hash_item(gpointer key, gpointer value, gpointer user_data); static gboolean msim_send_raw(MsimSession *session, const gchar *msg); static gboolean msim_send(MsimSession *session, ...); static void msim_login(PurpleAccount *acct); static int msim_login_challenge(MsimSession *session, GHashTable *table); static gchar* msim_compute_login_response(guchar nonce[2*NONCE_SIZE], gchar* email, gchar* password); static int msim_send_im(PurpleConnection *gc, const char *who, const char *message, PurpleMessageFlags flags); static int msim_send_im_by_userid(MsimSession *session, const gchar *userid, const gchar *message, PurpleMessageFlags flags); static void msim_send_im_by_userid_cb(MsimSession *session, GHashTable *userinfo, gpointer data); static void msim_incoming_im_cb(MsimSession *session, GHashTable *userinfo, gpointer data); static int msim_incoming_im(MsimSession *session, GHashTable *table); static int msim_process_reply(MsimSession *session, GHashTable *table); static int msim_process(PurpleConnection *gc, GHashTable *table); static int msim_error(MsimSession *session, GHashTable *table); static void msim_status_cb(MsimSession *session, GHashTable *userinfo, gpointer data); static int msim_status(MsimSession *session, GHashTable *table); static void msim_input_cb(gpointer gc_uncasted, gint source, PurpleInputCondition cond); static void msim_connect_cb(gpointer data, gint source, const gchar *error_message); static MsimSession *msim_session_new(PurpleAccount *acct); static void msim_session_destroy(MsimSession *session); static void msim_close(PurpleConnection *gc); static inline gboolean msim_is_userid(const gchar *user); static inline gboolean msim_is_email(const gchar *user); static void msim_lookup_user(MsimSession *session, const gchar *user, MSIM_USER_LOOKUP_CB cb, gpointer data); static char *msim_status_text(PurpleBuddy *buddy); static void msim_tooltip_text(PurpleBuddy *buddy, PurpleNotifyUserInfo *user_info, gboolean full);