source: protocols/jabber/jabber.h @ 8661caa

Last change on this file since 8661caa was 8661caa, checked in by ulim <a.sporto+bee@…>, at 2008-08-04T14:45:24Z

merged in upstream r410.

Only conflict was the correction of jabber normalization which I had already done.

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