diff libpurple/protocols/myspace/myspace.h @ 16405:8063f163f411

Add MySpaceIM header file and reorganize functions.

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libpurple/protocols/myspace/myspace.h	Sat Apr 28 21:19:40 2007 +0000
@@ -0,0 +1,141 @@
+/* MySpaceIM Protocol Plugin, headr file
+ *
+ * \author Jeff Connelly
+ *
+ * Copyright (C) 2007, Jeff Connelly <[e-mail]>
+ *
+ * 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
+ */
+
+/* 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 */
+	/* TODO: rid, store here and increment instead of random. */
+} 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 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 void msim_send(MsimSession *session, const gchar *msg);
+
+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);
+