source: protocols/jabber/jabber.h @ 11e7828

Last change on this file since 11e7828 was be1efa3, checked in by dequis <dx@…>, at 2015-01-26T02:43:34Z

Add handle_is_self() prpl function to fix JID mismatch confusion bugs

When bee_chat needs to check for self messages, it can call this
function to let the protocol implementation do the comparison.

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