source: protocols/jabber/jabber.h @ 12f500f

Last change on this file since 12f500f was 1444be5, checked in by Michael Stapelberg <michael@…>, at 2012-10-17T07:23:00Z

Implement jabber message receipts (XEP-0184)

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