source: protocols/jabber/jabber.h @ ed320e8

Last change on this file since ed320e8 was 31dbb90a, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-08-30T22:02:46Z

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