source: protocols/jabber/jabber.h @ 1174899

Last change on this file since 1174899 was 4a5d885, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-07-26T11:58:38Z

Working OAuth2 support. Needs some more debugging (error handling is not
great and imc_logout() gets (rightfully) confused when jabber_data is empty).
  • Property mode set to 100644
File size: 14.5 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Jabber module - Main file                                                *
5*                                                                           *
6*  Copyright 2006 Wilmer van der Gaast <wilmer@gaast.net>                   *
7*                                                                           *
8*  This program is free software; you can redistribute it and/or modify     *
9*  it under the terms of the GNU General Public License as published by     *
10*  the Free Software Foundation; either version 2 of the License, or        *
11*  (at your option) any later version.                                      *
12*                                                                           *
13*  This program is distributed in the hope that it will be useful,          *
14*  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
15*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
16*  GNU General Public License for more details.                             *
17*                                                                           *
18*  You should have received a copy of the GNU General Public License along  *
19*  with this program; if not, write to the Free Software Foundation, Inc.,  *
20*  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.              *
21*                                                                           *
22\***************************************************************************/
23
24#ifndef _JABBER_H
25#define _JABBER_H
26
27#include <glib.h>
28
29#include "bitlbee.h"
30#include "md5.h"
31#include "xmltree.h"
32
33extern GSList *jabber_connections;
34
35typedef enum
36{
37        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
38                                           and want to do auth. */
39        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
40        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
41                                           SASL or TLS). */
42        JFLAG_WANT_SESSION = 8,         /* Set if the server wants a <session/> tag
43                                           before we continue. */
44        JFLAG_WANT_BIND = 16,           /* ... for <bind> tag. */
45        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
46                                           activates all XEP-85 related code. */
47        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
48        JFLAG_STARTTLS_DONE = 128,      /* If a plaintext session was converted to TLS. */
49} jabber_flags_t;
50
51typedef enum
52{
53        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
54                                           sure it gets sent only once. */
55        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
56                                           XEP85 (typing notification shite). */
57        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
58                                           groupchat state info too. */
59        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
60                                           have a real JID. */
61        JBFLAG_HIDE_SUBJECT = 16,       /* Hide the subject field since we probably
62                                           showed it already. */
63} jabber_buddy_flags_t;
64
65/* Stores a streamhost's (a.k.a. proxy) data */
66typedef struct
67{
68        char *jid;
69        char *host;
70        char port[6];
71} jabber_streamhost_t;
72
73typedef enum
74{
75        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
76                                           we can detect echoes/backlogs. */
77} jabber_chat_flags_t;
78
79struct jabber_data
80{
81        struct im_connection *ic;
82       
83        int fd;
84        void *ssl;
85        char *txq;
86        int tx_len;
87        int r_inpa, w_inpa;
88       
89        struct xt_parser *xt;
90        jabber_flags_t flags;
91       
92        char *username;         /* USERNAME@server */
93        char *server;           /* username@SERVER -=> server/domain, not hostname */
94       
95        char *oauth2_access_token;
96       
97        /* After changing one of these two (or the priority setting), call
98           presence_send_update() to inform the server about the changes. */
99        const struct jabber_away_state *away_state;
100        char *away_message;
101       
102        md5_state_t cached_id_prefix;
103        GHashTable *node_cache;
104        GHashTable *buddies;
105
106        GSList *filetransfers;
107        GSList *streamhosts;
108        int have_streamhosts;
109};
110
111struct jabber_away_state
112{
113        char code[5];
114        char *full_name;
115};
116
117typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
118
119struct jabber_cache_entry
120{
121        time_t saved_at;
122        struct xt_node *node;
123        jabber_cache_event func;
124};
125
126/* Somewhat messy data structure: We have a hash table with the bare JID as
127   the key and the head of a struct jabber_buddy list as the value. The head
128   is always a bare JID. If the JID has other resources (often the case,
129   except for some transports that don't support multiple resources), those
130   follow. In that case, the bare JID at the beginning doesn't actually
131   refer to a real session and should only be used for operations that
132   support incomplete JIDs. */
133struct jabber_buddy
134{
135        char *bare_jid;
136        char *full_jid;
137        char *resource;
138       
139        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
140                       /* otherwise something similar to the conference JID. */
141       
142        int priority;
143        struct jabber_away_state *away_state;
144        char *away_message;
145        GSList *features;
146       
147        time_t last_msg;
148        jabber_buddy_flags_t flags;
149       
150        struct jabber_buddy *next;
151};
152
153struct jabber_chat
154{
155        int flags;
156        char *name;
157        char *my_full_jid; /* Separate copy because of case sensitivity. */
158        struct jabber_buddy *me;
159};
160
161struct jabber_transfer
162{
163        /* bitlbee's handle for this transfer */
164        file_transfer_t *ft;
165
166        /* the stream's private handle */
167        gpointer streamhandle;
168
169        /* timeout for discover queries */
170        gint disco_timeout;
171        gint disco_timeout_fired;
172
173        struct im_connection *ic;
174
175        struct jabber_buddy *bud;
176
177        int watch_in;
178        int watch_out;
179
180        char *ini_jid;
181        char *tgt_jid;
182        char *iq_id;
183        char *sid;
184        int accepted;
185
186        size_t bytesread, byteswritten;
187        int fd;
188        struct sockaddr_storage saddr;
189};
190
191#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
192
193/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
194   first one should be used, but when storing a packet in the cache, a
195   "special" kind of ID is assigned to make it easier later to figure out
196   if we have to do call an event handler for the response packet. Also
197   we'll append a hash to make sure we won't trigger on cached packets from
198   other BitlBee users. :-) */
199#define JABBER_PACKET_ID "BeeP"
200#define JABBER_CACHED_ID "BeeC"
201
202/* The number of seconds to keep cached packets before garbage collecting
203   them. This gc is done on every keepalive (every minute). */
204#define JABBER_CACHE_MAX_AGE 600
205
206/* RFC 392[01] stuff */
207#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
208#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
209#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
210#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
211#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
212#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
213#define XMLNS_ROSTER       "jabber:iq:roster"
214
215/* Some supported extensions/legacy stuff */
216#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
217#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
218#define XMLNS_TIME_OLD     "jabber:iq:time"                                      /* XEP-0090 */
219#define XMLNS_TIME         "urn:xmpp:time"                                       /* XEP-0202 */
220#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
221#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
222#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
223#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
224#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
225#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
226#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
227#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
228#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
229#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
230#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
231#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
232#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
233#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
234#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
235
236/* jabber.c */
237void jabber_connect( struct im_connection *ic );
238
239/* iq.c */
240xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
241int jabber_init_iq_auth( struct im_connection *ic );
242xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
243int jabber_get_roster( struct im_connection *ic );
244int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
245int jabber_add_to_roster( struct im_connection *ic, const char *handle, const char *name, const char *group );
246int jabber_remove_from_roster( struct im_connection *ic, char *handle );
247xt_status jabber_iq_query_features( struct im_connection *ic, char *bare_jid );
248xt_status jabber_iq_query_server( struct im_connection *ic, char *jid, char *xmlns );
249void jabber_iq_version_send( struct im_connection *ic, struct jabber_buddy *bud, void *data );
250
251/* si.c */
252int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
253void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
254void jabber_si_free_transfer( file_transfer_t *ft);
255
256/* s5bytestream.c */
257int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
258gboolean jabber_bs_send_start( struct jabber_transfer *tf );
259gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, unsigned int len );
260
261/* message.c */
262xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
263
264/* presence.c */
265xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
266int presence_send_update( struct im_connection *ic );
267int presence_send_request( struct im_connection *ic, char *handle, char *request );
268
269/* jabber_util.c */
270char *set_eval_priority( set_t *set, char *value );
271char *set_eval_tls( set_t *set, char *value );
272struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
273struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
274void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
275struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
276void jabber_cache_entry_free( gpointer entry );
277void jabber_cache_clean( struct im_connection *ic );
278xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
279const struct jabber_away_state *jabber_away_state_by_code( char *code );
280const struct jabber_away_state *jabber_away_state_by_name( char *name );
281void jabber_buddy_ask( struct im_connection *ic, char *handle );
282char *jabber_normalize( const char *orig );
283
284typedef enum
285{
286        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
287        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
288        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
289        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
290        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
291} get_buddy_flags_t;
292
293struct jabber_error
294{
295        char *code, *text, *type;
296};
297
298struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
299struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
300struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
301int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
302int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
303void jabber_buddy_remove_all( struct im_connection *ic );
304time_t jabber_get_timestamp( struct xt_node *xt );
305struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
306void jabber_error_free( struct jabber_error *err );
307
308extern const struct jabber_away_state jabber_away_state_list[];
309
310/* io.c */
311int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
312int jabber_write( struct im_connection *ic, char *buf, int len );
313gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
314gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
315gboolean jabber_start_stream( struct im_connection *ic );
316void jabber_end_stream( struct im_connection *ic );
317
318/* sasl.c */
319xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
320xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
321xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
322gboolean sasl_supported( struct im_connection *ic );
323void sasl_oauth2_init( struct im_connection *ic );
324int sasl_oauth2_get_refresh_token( struct im_connection *ic, const char *msg );
325int sasl_oauth2_refresh( struct im_connection *ic, const char *refresh_token );
326
327/* conference.c */
328struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
329struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
330void jabber_chat_free( struct groupchat *c );
331int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
332int jabber_chat_topic( struct groupchat *c, char *topic );
333int jabber_chat_leave( struct groupchat *c, const char *reason );
334void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
335void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
336void jabber_chat_invite( struct groupchat *c, char *who, char *message );
337
338#endif
Note: See TracBrowser for help on using the repository browser.