source: protocols/jabber/jabber.h @ d8acfd3

Last change on this file since d8acfd3 was 767a148, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-21T16:06:31Z

Merging in file transfer support. Most important points from my review
are fixed now, time to let it settle in and get people to try it.
  • Property mode set to 100644
File size: 13.8 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} jabber_buddy_flags_t;
62
63/* Stores a streamhost's (a.k.a. proxy) data */
64typedef struct
65{
66        char *jid;
67        char *host;
68        char port[6];
69} jabber_streamhost_t;
70
71typedef enum
72{
73        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
74                                           we can detect echoes/backlogs. */
75} jabber_chat_flags_t;
76
77struct jabber_data
78{
79        struct im_connection *ic;
80       
81        int fd;
82        void *ssl;
83        char *txq;
84        int tx_len;
85        int r_inpa, w_inpa;
86       
87        struct xt_parser *xt;
88        jabber_flags_t flags;
89       
90        char *username;         /* USERNAME@server */
91        char *server;           /* username@SERVER -=> server/domain, not hostname */
92       
93        /* After changing one of these two (or the priority setting), call
94           presence_send_update() to inform the server about the changes. */
95        const struct jabber_away_state *away_state;
96        char *away_message;
97       
98        md5_state_t cached_id_prefix;
99        GHashTable *node_cache;
100        GHashTable *buddies;
101
102        GSList *filetransfers;
103        GSList *streamhosts;
104        int have_streamhosts;
105};
106
107struct jabber_away_state
108{
109        char code[5];
110        char *full_name;
111};
112
113typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
114
115struct jabber_cache_entry
116{
117        time_t saved_at;
118        struct xt_node *node;
119        jabber_cache_event func;
120};
121
122/* Somewhat messy data structure: We have a hash table with the bare JID as
123   the key and the head of a struct jabber_buddy list as the value. The head
124   is always a bare JID. If the JID has other resources (often the case,
125   except for some transports that don't support multiple resources), those
126   follow. In that case, the bare JID at the beginning doesn't actually
127   refer to a real session and should only be used for operations that
128   support incomplete JIDs. */
129struct jabber_buddy
130{
131        char *bare_jid;
132        char *full_jid;
133        char *resource;
134       
135        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
136                       /* otherwise something similar to the conference JID. */
137       
138        int priority;
139        struct jabber_away_state *away_state;
140        char *away_message;
141        GSList *features;
142       
143        time_t last_msg;
144        jabber_buddy_flags_t flags;
145       
146        struct jabber_buddy *next;
147};
148
149struct jabber_chat
150{
151        int flags;
152        char *name;
153        char *my_full_jid; /* Separate copy because of case sensitivity. */
154        struct jabber_buddy *me;
155};
156
157struct jabber_transfer
158{
159        /* bitlbee's handle for this transfer */
160        file_transfer_t *ft;
161
162        /* the stream's private handle */
163        gpointer streamhandle;
164
165        /* timeout for discover queries */
166        gint disco_timeout;
167        gint disco_timeout_fired;
168
169        struct im_connection *ic;
170
171        struct jabber_buddy *bud;
172
173        int watch_in;
174        int watch_out;
175
176        char *ini_jid;
177        char *tgt_jid;
178        char *iq_id;
179        char *sid;
180        int accepted;
181
182        size_t bytesread, byteswritten;
183        int fd;
184        struct sockaddr_storage saddr;
185};
186
187#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
188
189/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
190   first one should be used, but when storing a packet in the cache, a
191   "special" kind of ID is assigned to make it easier later to figure out
192   if we have to do call an event handler for the response packet. Also
193   we'll append a hash to make sure we won't trigger on cached packets from
194   other BitlBee users. :-) */
195#define JABBER_PACKET_ID "BeeP"
196#define JABBER_CACHED_ID "BeeC"
197
198/* The number of seconds to keep cached packets before garbage collecting
199   them. This gc is done on every keepalive (every minute). */
200#define JABBER_CACHE_MAX_AGE 600
201
202/* RFC 392[01] stuff */
203#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
204#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
205#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
206#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
207#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
208#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
209#define XMLNS_ROSTER       "jabber:iq:roster"
210
211/* Some supported extensions/legacy stuff */
212#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
213#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
214#define XMLNS_TIME         "jabber:iq:time"                                      /* XEP-0090 */
215#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
216#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
217#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
218#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
219#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
220#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
221#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
222#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
223#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
224#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
225#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
226#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
227#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
228#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
229#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
230
231/* iq.c */
232xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
233int jabber_init_iq_auth( struct im_connection *ic );
234xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
235int jabber_get_roster( struct im_connection *ic );
236int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
237int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
238int jabber_remove_from_roster( struct im_connection *ic, char *handle );
239xt_status jabber_iq_query_features( struct im_connection *ic, char *bare_jid );
240xt_status jabber_iq_query_server( struct im_connection *ic, char *jid, char *xmlns );
241
242/* si.c */
243int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
244void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
245void jabber_si_free_transfer( file_transfer_t *ft);
246
247/* s5bytestream.c */
248int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
249gboolean jabber_bs_send_start( struct jabber_transfer *tf );
250gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, unsigned int len );
251
252/* message.c */
253xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
254
255/* presence.c */
256xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
257int presence_send_update( struct im_connection *ic );
258int presence_send_request( struct im_connection *ic, char *handle, char *request );
259
260/* jabber_util.c */
261char *set_eval_priority( set_t *set, char *value );
262char *set_eval_tls( set_t *set, char *value );
263struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
264struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
265void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
266struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
267void jabber_cache_entry_free( gpointer entry );
268void jabber_cache_clean( struct im_connection *ic );
269xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
270const struct jabber_away_state *jabber_away_state_by_code( char *code );
271const struct jabber_away_state *jabber_away_state_by_name( char *name );
272void jabber_buddy_ask( struct im_connection *ic, char *handle );
273char *jabber_normalize( const char *orig );
274
275typedef enum
276{
277        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
278        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
279        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
280        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
281        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
282} get_buddy_flags_t;
283
284struct jabber_error
285{
286        char *code, *text, *type;
287};
288
289struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
290struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
291struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
292int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
293int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
294time_t jabber_get_timestamp( struct xt_node *xt );
295struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
296void jabber_error_free( struct jabber_error *err );
297
298extern const struct jabber_away_state jabber_away_state_list[];
299
300/* io.c */
301int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
302int jabber_write( struct im_connection *ic, char *buf, int len );
303gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
304gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
305gboolean jabber_start_stream( struct im_connection *ic );
306void jabber_end_stream( struct im_connection *ic );
307
308/* sasl.c */
309xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
310xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
311xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
312gboolean sasl_supported( struct im_connection *ic );
313
314/* conference.c */
315struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
316struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
317void jabber_chat_free( struct groupchat *c );
318int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
319int jabber_chat_topic( struct groupchat *c, char *topic );
320int jabber_chat_leave( struct groupchat *c, const char *reason );
321void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
322void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
323void jabber_chat_invite( struct groupchat *c, char *who, char *message );
324
325#endif
Note: See TracBrowser for help on using the repository browser.