source: protocols/msn/msn.h @ f8ec890

Last change on this file since f8ec890 was efbc154, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-04-16T09:58:22Z

Merge msn-keepalive, a nice hack (not yet documented) which sends keepalives
to switchboards with offline contacts. This is meant as a work-around for
the current lack of support for offline messaging.

  • Property mode set to 100644
File size: 6.1 KB
Line 
1  /********************************************************************\
2  * BitlBee -- An IRC to other IM-networks gateway                     *
3  *                                                                    *
4  * Copyright 2002-2004 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#define QRY_NAME "msmsgs@msnmsgr.com"
42#define QRY_CODE "Q1P7W2E4J9R8U3S5"
43
44#define MSN_SB_NEW         -24062002
45
46#define MSN_MESSAGE_HEADERS "MIME-Version: 1.0\r\n" \
47                            "Content-Type: text/plain; charset=UTF-8\r\n" \
48                            "User-Agent: BitlBee " BITLBEE_VERSION "\r\n" \
49                            "X-MMS-IM-Format: FN=MS%20Shell%20Dlg; EF=; CO=0; CS=0; PF=0\r\n" \
50                            "\r\n"
51
52#define MSN_TYPING_HEADERS "MIME-Version: 1.0\r\n" \
53                           "Content-Type: text/x-msmsgscontrol\r\n" \
54                           "TypingUser: %s\r\n" \
55                           "\r\n\r\n"
56
57#define SB_KEEPALIVE_HEADERS "MIME-Version: 1.0\r\n" \
58                             "Content-Type: text/x-ping\r\n" \
59                             "\r\n\r\n"
60
61#define PROFILE_URL "http://members.msn.com/"
62
63struct msn_data
64{
65        struct im_connection *ic;
66       
67        int fd;
68        struct msn_handler_data *handler;
69       
70        int trId;
71       
72        GSList *msgq;
73        GSList *switchboards;
74        int sb_failures;
75        time_t first_sb_failure;
76       
77        const struct msn_away_state *away_state;
78        int buddycount;
79        int groupcount;
80        char **grouplist;
81};
82
83struct msn_switchboard
84{
85        struct im_connection *ic;
86       
87        int fd;
88        gint inp;
89        struct msn_handler_data *handler;
90        gint keepalive;
91       
92        int trId;
93        int ready;
94       
95        int session;
96        char *key;
97       
98        GSList *msgq;
99        char *who;
100        struct groupchat *chat;
101};
102
103struct msn_away_state
104{
105        char code[4];
106        char name[16];
107};
108
109struct msn_status_code
110{
111        int number;
112        char *text;
113        int flags;
114};
115
116struct msn_message
117{
118        char *who;
119        char *text;
120};
121
122struct msn_handler_data
123{
124        int fd;
125        int rxlen;
126        char *rxq;
127       
128        int msglen;
129        char *cmd_text;
130       
131        gpointer data;
132       
133        int (*exec_command) ( gpointer data, char **cmd, int count );
134        int (*exec_message) ( gpointer data, char *msg, int msglen, char **cmd, int count );
135};
136
137/* Bitfield values for msn_status_code.flags */
138#define STATUS_FATAL            1
139#define STATUS_SB_FATAL         2
140#define STATUS_SB_IM_SPARE      4       /* Make one-to-one conversation switchboard available again, invite failed. */
141#define STATUS_SB_CHAT_SPARE    8       /* Same, but also for groupchats (not used yet). */
142
143extern int msn_chat_id;
144extern const struct msn_away_state msn_away_state_list[];
145extern const struct msn_status_code msn_status_code_list[];
146
147/* Keep a list of all the active connections. We need these lists because
148   "connected" callbacks might be called when the connection they belong too
149   is down already (for example, when an impatient user disabled the
150   connection), the callback should check whether it's still listed here
151   before doing *anything* else. */
152extern GSList *msn_connections;
153extern GSList *msn_switchboards;
154
155/* ns.c */
156gboolean msn_ns_connected( gpointer data, gint source, b_input_condition cond );
157
158/* msn_util.c */
159int msn_write( struct im_connection *ic, char *s, int len );
160int msn_logged_in( struct im_connection *ic );
161int msn_buddy_list_add( struct im_connection *ic, char *list, char *who, char *realname );
162int msn_buddy_list_remove( struct im_connection *ic, char *list, char *who );
163void msn_buddy_ask( struct im_connection *ic, char *handle, char *realname );
164char *msn_findheader( char *text, char *header, int len );
165char **msn_linesplit( char *line );
166int msn_handler( struct msn_handler_data *h );
167char *msn_http_encode( const char *input );
168void msn_msgq_purge( struct im_connection *ic, GSList **list );
169gboolean msn_set_display_name( struct im_connection *ic, const char *rawname );
170
171/* tables.c */
172const struct msn_away_state *msn_away_state_by_number( int number );
173const struct msn_away_state *msn_away_state_by_code( char *code );
174const struct msn_away_state *msn_away_state_by_name( char *name );
175const struct msn_status_code *msn_status_by_number( int number );
176
177/* sb.c */
178int msn_sb_write( struct msn_switchboard *sb, char *s, int len );
179struct msn_switchboard *msn_sb_create( struct im_connection *ic, char *host, int port, char *key, int session );
180struct msn_switchboard *msn_sb_by_handle( struct im_connection *ic, char *handle );
181struct msn_switchboard *msn_sb_by_chat( struct groupchat *c );
182struct msn_switchboard *msn_sb_spare( struct im_connection *ic );
183int msn_sb_sendmessage( struct msn_switchboard *sb, char *text );
184struct groupchat *msn_sb_to_chat( struct msn_switchboard *sb );
185void msn_sb_destroy( struct msn_switchboard *sb );
186gboolean msn_sb_connected( gpointer data, gint source, b_input_condition cond );
187int msn_sb_write_msg( struct im_connection *ic, struct msn_message *m );
188void msn_sb_start_keepalives( struct msn_switchboard *sb, gboolean initial );
189void msn_sb_stop_keepalives( struct msn_switchboard *sb );
190
191#endif //_MSN_H
Note: See TracBrowser for help on using the repository browser.