source: protocols/jabber/jabber.h @ 1c3008a

Last change on this file since 1c3008a was 1c3008a, checked in by Wilmer van der Gaast <wilmer@…>, at 2009-12-13T14:48:56Z

No functional changes, just some style "fixes". Although I admit I'm
somewhat growing out of my own coding style, I do try to keep things
consistent at least within files.

Comments are now in reviewboard:

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