source: protocols/msn/msn.h @ ed0589c

Last change on this file since ed0589c was ed0589c, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-11-13T13:01:40Z

Fixed issue with logging in to unverified MSN accounts.
  • Property mode set to 100644
File size: 8.0 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2010 Wilmer van der Gaast and others                *
5  \********************************************************************/
6
7/* MSN module                                                           */
8
9/*
10  This program is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14
15  This program is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  GNU General Public License for more details.
19
20  You should have received a copy of the GNU General Public License with
21  the Debian GNU/Linux distribution in /usr/share/common-licenses/GPL;
22  if not, write to the Free Software Foundation, Inc., 59 Temple Place,
23  Suite 330, Boston, MA  02111-1307  USA
24*/
25
26#ifndef _MSN_H
27#define _MSN_H
28
29/* Some hackish magicstrings to make special-purpose messages/switchboards.
30 */
31#define TYPING_NOTIFICATION_MESSAGE "\r\r\rBEWARE, ME R TYPINK MESSAGE!!!!\r\r\r"
32#define GROUPCHAT_SWITCHBOARD_MESSAGE "\r\r\rME WANT TALK TO MANY PEOPLE\r\r\r"
33#define SB_KEEPALIVE_MESSAGE "\r\r\rDONT HANG UP ON ME!\r\r\r"
34
35#ifdef DEBUG_MSN
36#define debug( text... ) imcb_log( ic, text );
37#else
38#define debug( text... )
39#endif
40
41/* This should be MSN Messenger 7.0.0813
42#define MSNP11_PROD_KEY "CFHUR$52U_{VIX5T"
43#define MSNP11_PROD_ID  "PROD0101{0RM?UBW"
44*/
45
46#define MSN_NS_HOST "messenger.hotmail.com"
47#define MSN_NS_PORT 1863
48
49/* Some other version.
50#define MSNP11_PROD_KEY "O4BG@C7BWLYQX?5G"
51#define MSNP11_PROD_ID  "PROD01065C%ZFN6F"
52*/
53
54#define MSNP11_PROD_KEY "ILTXC!4IXB5FB*PX"
55#define MSNP11_PROD_ID  "PROD0119GSJUC$18"
56#define MSNP_VER        "MSNP15"
57#define MSNP_BUILD      "8.5.1288"
58
59#define MSN_SB_NEW         -24062002
60
61#define MSN_MESSAGE_HEADERS "MIME-Version: 1.0\r\n" \
62                            "Content-Type: text/plain; charset=UTF-8\r\n" \
63                            "User-Agent: BitlBee " BITLBEE_VERSION "\r\n" \
64                            "X-MMS-IM-Format: FN=MS%20Shell%20Dlg; EF=; CO=0; CS=0; PF=0\r\n" \
65                            "\r\n"
66
67#define MSN_TYPING_HEADERS "MIME-Version: 1.0\r\n" \
68                           "Content-Type: text/x-msmsgscontrol\r\n" \
69                           "TypingUser: %s\r\n" \
70                           "\r\n\r\n"
71
72#define SB_KEEPALIVE_HEADERS "MIME-Version: 1.0\r\n" \
73                             "Content-Type: text/x-ping\r\n" \
74                             "\r\n\r\n"
75
76#define PROFILE_URL "http://members.msn.com/"
77
78typedef enum
79{
80        MSN_GOT_PROFILE = 1,
81        MSN_GOT_PROFILE_DN = 2,
82        MSN_DONE_ADL = 4,
83        MSN_REAUTHING = 8,
84        MSN_EMAIL_UNVERIFIED = 16,
85} msn_flags_t;
86
87struct msn_handler_data
88{
89        int fd, inpa;
90        int rxlen;
91        char *rxq;
92       
93        int msglen;
94        char *cmd_text;
95       
96        /* Either ic or sb */
97        gpointer data;
98       
99        int (*exec_command) ( struct msn_handler_data *handler, char **cmd, int count );
100        int (*exec_message) ( struct msn_handler_data *handler, char *msg, int msglen, char **cmd, int count );
101};
102
103struct msn_data
104{
105        struct im_connection *ic;
106       
107        struct msn_handler_data ns[1];
108        msn_flags_t flags;
109       
110        int trId;
111        char *tokens[4];
112        char *lock_key, *pp_policy;
113       
114        GSList *msgq, *grpq, *soapq;
115        GSList *switchboards;
116        int sb_failures;
117        time_t first_sb_failure;
118       
119        const struct msn_away_state *away_state;
120        GSList *groups;
121       
122        /* Mostly used for sending the ADL command; since MSNP13 the client
123           is responsible for downloading the contact list and then sending
124           it to the MSNP server. */
125        GTree *domaintree;
126        int adl_todo;
127};
128
129struct msn_switchboard
130{
131        struct im_connection *ic;
132       
133        /* The following two are also in the handler. TODO: Clean up. */
134        int fd;
135        gint inp;
136        struct msn_handler_data *handler;
137        gint keepalive;
138       
139        int trId;
140        int ready;
141       
142        int session;
143        char *key;
144       
145        GSList *msgq;
146        char *who;
147        struct groupchat *chat;
148};
149
150struct msn_away_state
151{
152        char code[4];
153        char name[16];
154};
155
156struct msn_status_code
157{
158        int number;
159        char *text;
160        int flags;
161};
162
163struct msn_message
164{
165        char *who;
166        char *text;
167};
168
169struct msn_groupadd
170{
171        char *who;
172        char *group;
173};
174
175typedef enum
176{
177        MSN_BUDDY_FL = 1,   /* Warning: FL,AL,BL *must* be 1,2,4. */
178        MSN_BUDDY_AL = 2,
179        MSN_BUDDY_BL = 4,
180        MSN_BUDDY_RL = 8,
181        MSN_BUDDY_PL = 16,
182        MSN_BUDDY_ADL_SYNCED = 256,
183} msn_buddy_flags_t;
184
185struct msn_buddy_data
186{
187        char *cid;
188        msn_buddy_flags_t flags;
189};
190
191struct msn_group
192{
193        char *name;
194        char *id;
195};
196
197/* Bitfield values for msn_status_code.flags */
198#define STATUS_FATAL            1
199#define STATUS_SB_FATAL         2
200#define STATUS_SB_IM_SPARE      4       /* Make one-to-one conversation switchboard available again, invite failed. */
201#define STATUS_SB_CHAT_SPARE    8       /* Same, but also for groupchats (not used yet). */
202
203extern int msn_chat_id;
204extern const struct msn_away_state msn_away_state_list[];
205extern const struct msn_status_code msn_status_code_list[];
206
207/* Keep a list of all the active connections. We need these lists because
208   "connected" callbacks might be called when the connection they belong too
209   is down already (for example, when an impatient user disabled the
210   connection), the callback should check whether it's still listed here
211   before doing *anything* else. */
212extern GSList *msn_connections;
213extern GSList *msn_switchboards;
214
215/* ns.c */
216int msn_ns_write( struct im_connection *ic, int fd, const char *fmt, ... );
217gboolean msn_ns_connect( struct im_connection *ic, struct msn_handler_data *handler, const char *host, int port );
218void msn_ns_close( struct msn_handler_data *handler );
219void msn_auth_got_passport_token( struct im_connection *ic, const char *token, const char *error );
220void msn_auth_got_contact_list( struct im_connection *ic );
221int msn_ns_finish_login( struct im_connection *ic );
222
223/* msn_util.c */
224int msn_logged_in( struct im_connection *ic );
225int msn_buddy_list_add( struct im_connection *ic, msn_buddy_flags_t list, const char *who, const char *realname_, const char *group );
226int msn_buddy_list_remove( struct im_connection *ic, msn_buddy_flags_t list, const char *who, const char *group );
227void msn_buddy_ask( bee_user_t *bu );
228char *msn_findheader( char *text, char *header, int len );
229char **msn_linesplit( char *line );
230int msn_handler( struct msn_handler_data *h );
231void msn_msgq_purge( struct im_connection *ic, GSList **list );
232char *msn_p11_challenge( char *challenge );
233gint msn_domaintree_cmp( gconstpointer a_, gconstpointer b_ );
234struct msn_group *msn_group_by_name( struct im_connection *ic, const char *name );
235struct msn_group *msn_group_by_id( struct im_connection *ic, const char *id );
236int msn_ns_set_display_name( struct im_connection *ic, const char *value );
237
238/* tables.c */
239const struct msn_away_state *msn_away_state_by_number( int number );
240const struct msn_away_state *msn_away_state_by_code( char *code );
241const struct msn_away_state *msn_away_state_by_name( char *name );
242const struct msn_status_code *msn_status_by_number( int number );
243
244/* sb.c */
245int msn_sb_write( struct msn_switchboard *sb, const char *fmt, ... );
246struct msn_switchboard *msn_sb_create( struct im_connection *ic, char *host, int port, char *key, int session );
247struct msn_switchboard *msn_sb_by_handle( struct im_connection *ic, char *handle );
248struct msn_switchboard *msn_sb_by_chat( struct groupchat *c );
249struct msn_switchboard *msn_sb_spare( struct im_connection *ic );
250int msn_sb_sendmessage( struct msn_switchboard *sb, char *text );
251struct groupchat *msn_sb_to_chat( struct msn_switchboard *sb );
252void msn_sb_destroy( struct msn_switchboard *sb );
253gboolean msn_sb_connected( gpointer data, gint source, b_input_condition cond );
254int msn_sb_write_msg( struct im_connection *ic, struct msn_message *m );
255void msn_sb_start_keepalives( struct msn_switchboard *sb, gboolean initial );
256void msn_sb_stop_keepalives( struct msn_switchboard *sb );
257
258#endif //_MSN_H
Note: See TracBrowser for help on using the repository browser.