source: protocols/jabber/jabber.h @ c4bc92a

Last change on this file since c4bc92a was 638feab, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-18T14:38:06Z

Merging in Jabber resource selection fix. This adds the activity_timeout
setting, which makes BitlBee send a message to bare JIDs if there was no
recent seen activity from any of the person's resources. This should fix
most issues with messages going to the wrong resource (i.e. someone's
mobile phone instead of something more sensible).
  • Property mode set to 100644
File size: 11.6 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
63typedef enum
64{
65        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
66                                           we can detect echoes/backlogs. */
67} jabber_chat_flags_t;
68
69struct jabber_data
70{
71        struct im_connection *ic;
72       
73        int fd;
74        void *ssl;
75        char *txq;
76        int tx_len;
77        int r_inpa, w_inpa;
78       
79        struct xt_parser *xt;
80        jabber_flags_t flags;
81       
82        char *username;         /* USERNAME@server */
83        char *server;           /* username@SERVER -=> server/domain, not hostname */
84       
85        /* After changing one of these two (or the priority setting), call
86           presence_send_update() to inform the server about the changes. */
87        const struct jabber_away_state *away_state;
88        char *away_message;
89       
90        md5_state_t cached_id_prefix;
91        GHashTable *node_cache;
92        GHashTable *buddies;
93};
94
95struct jabber_away_state
96{
97        char code[5];
98        char *full_name;
99};
100
101typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
102
103struct jabber_cache_entry
104{
105        time_t saved_at;
106        struct xt_node *node;
107        jabber_cache_event func;
108};
109
110/* Somewhat messy data structure: We have a hash table with the bare JID as
111   the key and the head of a struct jabber_buddy list as the value. The head
112   is always a bare JID. If the JID has other resources (often the case,
113   except for some transports that don't support multiple resources), those
114   follow. In that case, the bare JID at the beginning doesn't actually
115   refer to a real session and should only be used for operations that
116   support incomplete JIDs. */
117struct jabber_buddy
118{
119        char *bare_jid;
120        char *full_jid;
121        char *resource;
122       
123        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
124                       /* otherwise something similar to the conference JID. */
125       
126        int priority;
127        struct jabber_away_state *away_state;
128        char *away_message;
129       
130        time_t last_msg;
131        jabber_buddy_flags_t flags;
132       
133        struct jabber_buddy *next;
134};
135
136struct jabber_chat
137{
138        int flags;
139        char *name;
140        char *my_full_jid; /* Separate copy because of case sensitivity. */
141        struct jabber_buddy *me;
142};
143
144#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
145
146/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
147   first one should be used, but when storing a packet in the cache, a
148   "special" kind of ID is assigned to make it easier later to figure out
149   if we have to do call an event handler for the response packet. Also
150   we'll append a hash to make sure we won't trigger on cached packets from
151   other BitlBee users. :-) */
152#define JABBER_PACKET_ID "BeeP"
153#define JABBER_CACHED_ID "BeeC"
154
155/* The number of seconds to keep cached packets before garbage collecting
156   them. This gc is done on every keepalive (every minute). */
157#define JABBER_CACHE_MAX_AGE 600
158
159/* RFC 392[01] stuff */
160#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
161#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
162#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
163#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
164#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
165#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
166#define XMLNS_ROSTER       "jabber:iq:roster"
167
168/* Some supported extensions/legacy stuff */
169#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
170#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
171#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
172#define XMLNS_PING         "urn:xmpp:ping"                      /* XEP-0199 */
173#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
174#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
175#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
176#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
177#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
178#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
179#define XMLNS_CAPS         "http://jabber.org/protocol/caps"    /* XEP-0115 */
180
181/* iq.c */
182xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
183int jabber_init_iq_auth( struct im_connection *ic );
184xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
185int jabber_get_roster( struct im_connection *ic );
186int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
187int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
188int jabber_remove_from_roster( struct im_connection *ic, char *handle );
189
190/* message.c */
191xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
192
193/* presence.c */
194xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
195int presence_send_update( struct im_connection *ic );
196int presence_send_request( struct im_connection *ic, char *handle, char *request );
197
198/* jabber_util.c */
199char *set_eval_priority( set_t *set, char *value );
200char *set_eval_tls( set_t *set, char *value );
201struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
202struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
203void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
204struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
205void jabber_cache_entry_free( gpointer entry );
206void jabber_cache_clean( struct im_connection *ic );
207xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
208const struct jabber_away_state *jabber_away_state_by_code( char *code );
209const struct jabber_away_state *jabber_away_state_by_name( char *name );
210void jabber_buddy_ask( struct im_connection *ic, char *handle );
211char *jabber_normalize( const char *orig );
212
213typedef enum
214{
215        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
216        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
217        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
218        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
219        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
220} get_buddy_flags_t;
221
222struct jabber_error
223{
224        char *code, *text, *type;
225};
226
227struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
228struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
229struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
230int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
231int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
232time_t jabber_get_timestamp( struct xt_node *xt );
233struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
234void jabber_error_free( struct jabber_error *err );
235
236extern const struct jabber_away_state jabber_away_state_list[];
237
238/* io.c */
239int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
240int jabber_write( struct im_connection *ic, char *buf, int len );
241gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
242gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
243gboolean jabber_start_stream( struct im_connection *ic );
244void jabber_end_stream( struct im_connection *ic );
245
246/* sasl.c */
247xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
248xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
249xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
250gboolean sasl_supported( struct im_connection *ic );
251
252/* conference.c */
253struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
254struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
255void jabber_chat_free( struct groupchat *c );
256int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
257int jabber_chat_topic( struct groupchat *c, char *topic );
258int jabber_chat_leave( struct groupchat *c, const char *reason );
259void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
260void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
261void jabber_chat_invite( struct groupchat *c, char *who, char *message );
262
263#endif
Note: See TracBrowser for help on using the repository browser.