source: protocols/msn/msn.h @ 04cd284

Last change on this file since 04cd284 was 27053b5, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-09-04T17:13:55Z

Finish re-authentication works. Should now work for OIMs as well.
  • Property mode set to 100644
File size: 7.9 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_flags_t;
85
86struct msn_handler_data
87{
88        int fd, inpa;
89        int rxlen;
90        char *rxq;
91       
92        int msglen;
93        char *cmd_text;
94       
95        /* Either ic or sb */
96        gpointer data;
97       
98        int (*exec_command) ( struct msn_handler_data *handler, char **cmd, int count );
99        int (*exec_message) ( struct msn_handler_data *handler, char *msg, int msglen, char **cmd, int count );
100};
101
102struct msn_data
103{
104        struct im_connection *ic;
105       
106        struct msn_handler_data ns[1];
107        msn_flags_t flags;
108       
109        int trId;
110        char *tokens[4];
111        char *lock_key, *pp_policy;
112       
113        GSList *msgq, *grpq, *soapq;
114        GSList *switchboards;
115        int sb_failures;
116        time_t first_sb_failure;
117       
118        const struct msn_away_state *away_state;
119        GSList *groups;
120       
121        /* Mostly used for sending the ADL command; since MSNP13 the client
122           is responsible for downloading the contact list and then sending
123           it to the MSNP server. */
124        GTree *domaintree;
125        int adl_todo;
126};
127
128struct msn_switchboard
129{
130        struct im_connection *ic;
131       
132        /* The following two are also in the handler. TODO: Clean up. */
133        int fd;
134        gint inp;
135        struct msn_handler_data *handler;
136        gint keepalive;
137       
138        int trId;
139        int ready;
140       
141        int session;
142        char *key;
143       
144        GSList *msgq;
145        char *who;
146        struct groupchat *chat;
147};
148
149struct msn_away_state
150{
151        char code[4];
152        char name[16];
153};
154
155struct msn_status_code
156{
157        int number;
158        char *text;
159        int flags;
160};
161
162struct msn_message
163{
164        char *who;
165        char *text;
166};
167
168struct msn_groupadd
169{
170        char *who;
171        char *group;
172};
173
174typedef enum
175{
176        MSN_BUDDY_FL = 1,   /* Warning: FL,AL,BL *must* be 1,2,4. */
177        MSN_BUDDY_AL = 2,
178        MSN_BUDDY_BL = 4,
179        MSN_BUDDY_RL = 8,
180        MSN_BUDDY_PL = 16,
181        MSN_BUDDY_ADL_SYNCED = 256,
182} msn_buddy_flags_t;
183
184struct msn_buddy_data
185{
186        char *cid;
187        msn_buddy_flags_t flags;
188};
189
190struct msn_group
191{
192        char *name;
193        char *id;
194};
195
196/* Bitfield values for msn_status_code.flags */
197#define STATUS_FATAL            1
198#define STATUS_SB_FATAL         2
199#define STATUS_SB_IM_SPARE      4       /* Make one-to-one conversation switchboard available again, invite failed. */
200#define STATUS_SB_CHAT_SPARE    8       /* Same, but also for groupchats (not used yet). */
201
202extern int msn_chat_id;
203extern const struct msn_away_state msn_away_state_list[];
204extern const struct msn_status_code msn_status_code_list[];
205
206/* Keep a list of all the active connections. We need these lists because
207   "connected" callbacks might be called when the connection they belong too
208   is down already (for example, when an impatient user disabled the
209   connection), the callback should check whether it's still listed here
210   before doing *anything* else. */
211extern GSList *msn_connections;
212extern GSList *msn_switchboards;
213
214/* ns.c */
215int msn_ns_write( struct im_connection *ic, int fd, const char *fmt, ... );
216gboolean msn_ns_connect( struct im_connection *ic, struct msn_handler_data *handler, const char *host, int port );
217void msn_ns_close( struct msn_handler_data *handler );
218void msn_auth_got_passport_token( struct im_connection *ic, const char *token, const char *error );
219void msn_auth_got_contact_list( struct im_connection *ic );
220int msn_ns_finish_login( struct im_connection *ic );
221
222/* msn_util.c */
223int msn_logged_in( struct im_connection *ic );
224int msn_buddy_list_add( struct im_connection *ic, msn_buddy_flags_t list, const char *who, const char *realname_, const char *group );
225int msn_buddy_list_remove( struct im_connection *ic, msn_buddy_flags_t list, const char *who, const char *group );
226void msn_buddy_ask( bee_user_t *bu );
227char *msn_findheader( char *text, char *header, int len );
228char **msn_linesplit( char *line );
229int msn_handler( struct msn_handler_data *h );
230void msn_msgq_purge( struct im_connection *ic, GSList **list );
231char *msn_p11_challenge( char *challenge );
232gint msn_domaintree_cmp( gconstpointer a_, gconstpointer b_ );
233struct msn_group *msn_group_by_name( struct im_connection *ic, const char *name );
234struct msn_group *msn_group_by_id( struct im_connection *ic, const char *id );
235int msn_ns_set_display_name( struct im_connection *ic, const char *value );
236
237/* tables.c */
238const struct msn_away_state *msn_away_state_by_number( int number );
239const struct msn_away_state *msn_away_state_by_code( char *code );
240const struct msn_away_state *msn_away_state_by_name( char *name );
241const struct msn_status_code *msn_status_by_number( int number );
242
243/* sb.c */
244int msn_sb_write( struct msn_switchboard *sb, const char *fmt, ... );
245struct msn_switchboard *msn_sb_create( struct im_connection *ic, char *host, int port, char *key, int session );
246struct msn_switchboard *msn_sb_by_handle( struct im_connection *ic, char *handle );
247struct msn_switchboard *msn_sb_by_chat( struct groupchat *c );
248struct msn_switchboard *msn_sb_spare( struct im_connection *ic );
249int msn_sb_sendmessage( struct msn_switchboard *sb, char *text );
250struct groupchat *msn_sb_to_chat( struct msn_switchboard *sb );
251void msn_sb_destroy( struct msn_switchboard *sb );
252gboolean msn_sb_connected( gpointer data, gint source, b_input_condition cond );
253int msn_sb_write_msg( struct im_connection *ic, struct msn_message *m );
254void msn_sb_start_keepalives( struct msn_switchboard *sb, gboolean initial );
255void msn_sb_stop_keepalives( struct msn_switchboard *sb );
256
257#endif //_MSN_H
Note: See TracBrowser for help on using the repository browser.