source: protocols/jabber/jabber.h @ c1a3c27

Last change on this file since c1a3c27 was e8c8d00, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-17T15:15:19Z

Merging mainline.
  • Property mode set to 100644
File size: 13.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} 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
122struct jabber_buddy
123{
124        char *bare_jid;
125        char *full_jid;
126        char *resource;
127       
128        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
129                       /* otherwise something similar to the conference JID. */
130       
131        int priority;
132        struct jabber_away_state *away_state;
133        char *away_message;
134        GSList *features;
135       
136        time_t last_act;
137        jabber_buddy_flags_t flags;
138       
139        struct jabber_buddy *next;
140};
141
142struct jabber_chat
143{
144        int flags;
145        char *name;
146        char *my_full_jid; /* Separate copy because of case sensitivity. */
147        struct jabber_buddy *me;
148};
149
150struct jabber_transfer
151{
152        /* bitlbee's handle for this transfer */
153        file_transfer_t *ft;
154
155        /* the stream's private handle */
156        gpointer streamhandle;
157
158        /* timeout for discover queries */
159        gint disco_timeout;
160        gint disco_timeout_fired;
161
162        struct im_connection *ic;
163
164        struct jabber_buddy *bud;
165
166        int watch_in;
167        int watch_out;
168
169        char *ini_jid;
170        char *tgt_jid;
171        char *iq_id;
172        char *sid;
173        int accepted;
174
175        size_t bytesread, byteswritten;
176        int fd;
177        struct sockaddr_storage saddr;
178};
179
180#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
181
182/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
183   first one should be used, but when storing a packet in the cache, a
184   "special" kind of ID is assigned to make it easier later to figure out
185   if we have to do call an event handler for the response packet. Also
186   we'll append a hash to make sure we won't trigger on cached packets from
187   other BitlBee users. :-) */
188#define JABBER_PACKET_ID "BeeP"
189#define JABBER_CACHED_ID "BeeC"
190
191/* The number of seconds to keep cached packets before garbage collecting
192   them. This gc is done on every keepalive (every minute). */
193#define JABBER_CACHE_MAX_AGE 600
194
195/* RFC 392[01] stuff */
196#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
197#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
198#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
199#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
200#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
201#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
202#define XMLNS_ROSTER       "jabber:iq:roster"
203
204/* Some supported extensions/legacy stuff */
205#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
206#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
207#define XMLNS_TIME         "jabber:iq:time"                                      /* XEP-0090 */
208#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
209#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
210#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
211#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
212#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
213#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
214#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
215#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
216#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
217#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
218#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
219#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
220#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
221#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
222#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
223
224/* iq.c */
225xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
226int jabber_init_iq_auth( struct im_connection *ic );
227xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
228int jabber_get_roster( struct im_connection *ic );
229int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
230int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
231int jabber_remove_from_roster( struct im_connection *ic, char *handle );
232xt_status jabber_iq_query_features( struct im_connection *ic, char *bare_jid );
233xt_status jabber_iq_query_server( struct im_connection *ic, char *jid, char *xmlns );
234
235/* si.c */
236int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
237void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
238void jabber_si_free_transfer( file_transfer_t *ft);
239
240/* s5bytestream.c */
241int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
242gboolean jabber_bs_send_start( struct jabber_transfer *tf );
243gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, unsigned int len );
244
245/* message.c */
246xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
247
248/* presence.c */
249xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
250int presence_send_update( struct im_connection *ic );
251int presence_send_request( struct im_connection *ic, char *handle, char *request );
252
253/* jabber_util.c */
254char *set_eval_priority( set_t *set, char *value );
255char *set_eval_tls( set_t *set, char *value );
256struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
257struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
258void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
259struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
260void jabber_cache_entry_free( gpointer entry );
261void jabber_cache_clean( struct im_connection *ic );
262xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
263const struct jabber_away_state *jabber_away_state_by_code( char *code );
264const struct jabber_away_state *jabber_away_state_by_name( char *name );
265void jabber_buddy_ask( struct im_connection *ic, char *handle );
266char *jabber_normalize( const char *orig );
267
268typedef enum
269{
270        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
271        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
272        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
273} get_buddy_flags_t;
274
275struct jabber_error
276{
277        char *code, *text, *type;
278};
279
280struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
281struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
282struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
283int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
284int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
285time_t jabber_get_timestamp( struct xt_node *xt );
286struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
287void jabber_error_free( struct jabber_error *err );
288
289extern const struct jabber_away_state jabber_away_state_list[];
290
291/* io.c */
292int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
293int jabber_write( struct im_connection *ic, char *buf, int len );
294gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
295gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
296gboolean jabber_start_stream( struct im_connection *ic );
297void jabber_end_stream( struct im_connection *ic );
298
299/* sasl.c */
300xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
301xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
302xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
303gboolean sasl_supported( struct im_connection *ic );
304
305/* conference.c */
306struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
307struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
308void jabber_chat_free( struct groupchat *c );
309int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
310int jabber_chat_topic( struct groupchat *c, char *topic );
311int jabber_chat_leave( struct groupchat *c, const char *reason );
312void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
313void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
314void jabber_chat_invite( struct groupchat *c, char *who, char *message );
315
316#endif
Note: See TracBrowser for help on using the repository browser.