comparison: libpurple/protocols/myspace/myspace.h
libpurple/protocols/myspace/myspace.h
- branch
- soc.2007.msimprpl
- changeset 16333
- 0fdea8ad21cb
- child 16335
- 0c2b32acc27a
equal
deleted
inserted
replaced
| 16332:f0e987f024e0 | 16333:0fdea8ad21cb |
|---|---|
| 1 /* MySpaceIM Protocol Plugin, headr file | |
| 2 * | |
| 3 * \author Jeff Connelly | |
| 4 * | |
| 5 * Copyright (C) 2007, Jeff Connelly <jeff2@homing.pidgin.im> | |
| 6 * | |
| 7 * This program is free software; you can redistribute it and/or modify | |
| 8 * it under the terms of the GNU General Public License as published by | |
| 9 * the Free Software Foundation; either version 2 of the License, or | |
| 10 * (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, | |
| 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 15 * GNU General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU General Public License | |
| 18 * along with this program; if not, write to the Free Software | |
| 19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
| 20 */ | |
| 21 | |
| 22 /* Statuses */ | |
| 23 #define MSIM_STATUS_ONLINE "online" | |
| 24 #define MSIM_STATUS_AWAY "away" | |
| 25 #define MSIM_STATUS_OFFLINE "offline" | |
| 26 #define MSIM_STATUS_INVISIBLE "invisible" | |
| 27 | |
| 28 /* Build version of MySpaceIM to report to servers (1.0.xxx.0) */ | |
| 29 #define MSIM_CLIENT_VERSION 673 | |
| 30 | |
| 31 /* Server */ | |
| 32 #define MSIM_SERVER "im.myspace.akadns.net" | |
| 33 //#define MSIM_SERVER "localhost" | |
| 34 #define MSIM_PORT 1863 /* TODO: alternate ports and automatic */ | |
| 35 | |
| 36 /* Constants */ | |
| 37 #define HASH_SIZE 0x14 /**< Size of SHA-1 hash for login */ | |
| 38 #define NONCE_SIZE 0x20 /**< Half of decoded 'nc' field */ | |
| 39 #define MSIM_READ_BUF_SIZE 5*1024 /**< Receive buffer size */ | |
| 40 #define MSIM_FINAL_STRING "\\final\\" /**< Message end marker */ | |
| 41 | |
| 42 /* Messages */ | |
| 43 #define MSIM_BM_INSTANT 1 | |
| 44 #define MSIM_BM_STATUS 100 | |
| 45 #define MSIM_BM_ACTION 121 | |
| 46 /*#define MSIM_BM_UNKNOWN1 122*/ | |
| 47 | |
| 48 /* Random number in every MsimSession, to ensure it is valid. */ | |
| 49 #define MSIM_SESSION_STRUCT_MAGIC 0xe4a6752b | |
| 50 | |
| 51 /* Everything needed to keep track of a session. */ | |
| 52 typedef struct _MsimSession | |
| 53 { | |
| 54 guint magic; /**< MSIM_SESSION_STRUCT_MAGIC */ | |
| 55 PurpleAccount *account; | |
| 56 PurpleConnection *gc; | |
| 57 gchar *sesskey; /**< Session key text string from server */ | |
| 58 gchar *userid; /**< This user's numeric user ID */ | |
| 59 gint fd; /**< File descriptor to/from server */ | |
| 60 | |
| 61 GHashTable *user_lookup_cb; /**< Username -> userid lookup callback */ | |
| 62 GHashTable *user_lookup_cb_data; /**< Username -> userid lookup callback data */ | |
| 63 GHashTable *user_lookup_cache; /**< Cached information on users */ | |
| 64 | |
| 65 gchar *rxbuf; /**< Receive buffer */ | |
| 66 guint rxoff; /**< Receive buffer offset */ | |
| 67 /* TODO: rid, store here and increment instead of random. */ | |
| 68 } MsimSession; | |
| 69 | |
| 70 /* Check if an MsimSession is valid */ | |
| 71 #define MSIM_SESSION_VALID(s) (session != NULL && \ | |
| 72 session->magic == MSIM_SESSION_STRUCT_MAGIC) | |
| 73 | |
| 74 /* Callback function pointer type for when a user's information is received, | |
| 75 * initiated from a user lookup. */ | |
| 76 typedef void (*MSIM_USER_LOOKUP_CB)(MsimSession *session, GHashTable *userinfo, | |
| 77 gpointer data); | |
| 78 | |
| 79 /* Passed to MSIM_USER_LOOKUP_CB for msim_send_im_cb - called when | |
| 80 * user information is available, ready to send a message. */ | |
| 81 typedef struct _send_im_cb_struct | |
| 82 { | |
| 83 gchar *who; | |
| 84 gchar *message; | |
| 85 PurpleMessageFlags flags; | |
| 86 } send_im_cb_struct; | |
| 87 | |
| 88 | |
| 89 /* Functions */ | |
| 90 static void init_plugin(PurplePlugin *plugin); | |
| 91 static GList *msim_status_types(PurpleAccount *acct); | |
| 92 static const gchar *msim_list_icon(PurpleAccount *acct, PurpleBuddy *buddy); | |
| 93 | |
| 94 static GHashTable* msim_parse(gchar* msg); | |
| 95 static GHashTable *msim_parse_body(const gchar *body_str); | |
| 96 | |
| 97 static void print_hash_item(gpointer key, gpointer value, gpointer user_data); | |
| 98 static void msim_send(MsimSession *session, const gchar *msg); | |
| 99 | |
| 100 static void msim_login(PurpleAccount *acct); | |
| 101 static int msim_login_challenge(MsimSession *session, GHashTable *table); | |
| 102 static gchar* msim_compute_login_response(guchar nonce[2*NONCE_SIZE], | |
| 103 gchar* email, gchar* password); | |
| 104 | |
| 105 static int msim_send_im(PurpleConnection *gc, const char *who, | |
| 106 const char *message, PurpleMessageFlags flags); | |
| 107 static int msim_send_im_by_userid(MsimSession *session, const gchar *userid, | |
| 108 const gchar *message, PurpleMessageFlags flags); | |
| 109 static void msim_send_im_by_userid_cb(MsimSession *session, | |
| 110 GHashTable *userinfo, gpointer data); | |
| 111 static void msim_incoming_im_cb(MsimSession *session, GHashTable *userinfo, | |
| 112 gpointer data); | |
| 113 static int msim_incoming_im(MsimSession *session, GHashTable *table); | |
| 114 | |
| 115 static int msim_process_reply(MsimSession *session, GHashTable *table); | |
| 116 static int msim_process(PurpleConnection *gc, GHashTable *table); | |
| 117 | |
| 118 static int msim_error(MsimSession *session, GHashTable *table); | |
| 119 static void msim_status_cb(MsimSession *session, GHashTable *userinfo, | |
| 120 gpointer data); | |
| 121 static int msim_status(MsimSession *session, GHashTable *table); | |
| 122 static void msim_input_cb(gpointer gc_uncasted, gint source, | |
| 123 PurpleInputCondition cond); | |
| 124 static void msim_connect_cb(gpointer data, gint source, | |
| 125 const gchar *error_message); | |
| 126 | |
| 127 static MsimSession *msim_session_new(PurpleAccount *acct); | |
| 128 static void msim_session_destroy(MsimSession *session); | |
| 129 | |
| 130 static void msim_close(PurpleConnection *gc); | |
| 131 | |
| 132 static inline gboolean msim_is_userid(const gchar *user); | |
| 133 static inline gboolean msim_is_email(const gchar *user); | |
| 134 | |
| 135 static void msim_lookup_user(MsimSession *session, const gchar *user, | |
| 136 MSIM_USER_LOOKUP_CB cb, gpointer data); | |
| 137 | |
| 138 static char *msim_status_text(PurpleBuddy *buddy); | |
| 139 static void msim_tooltip_text(PurpleBuddy *buddy, | |
| 140 PurpleNotifyUserInfo *user_info, gboolean full); | |
| 141 |
