source: protocols/jabber/jabber.h @ 0b510af

Last change on this file since 0b510af was 8fb1263, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-14T17:45:33Z

Don't send bind and session requests at the same time when logging in
because some very picky jabberd's don't like it. (Fixes Bug #569)
  • Property mode set to 100644
File size: 11.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} 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
110struct jabber_buddy
111{
112        char *bare_jid;
113        char *full_jid;
114        char *resource;
115       
116        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
117                       /* otherwise something similar to the conference JID. */
118       
119        int priority;
120        struct jabber_away_state *away_state;
121        char *away_message;
122       
123        time_t last_act;
124        jabber_buddy_flags_t flags;
125       
126        struct jabber_buddy *next;
127};
128
129struct jabber_chat
130{
131        int flags;
132        char *name;
133        char *my_full_jid; /* Separate copy because of case sensitivity. */
134        struct jabber_buddy *me;
135};
136
137#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
138
139/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
140   first one should be used, but when storing a packet in the cache, a
141   "special" kind of ID is assigned to make it easier later to figure out
142   if we have to do call an event handler for the response packet. Also
143   we'll append a hash to make sure we won't trigger on cached packets from
144   other BitlBee users. :-) */
145#define JABBER_PACKET_ID "BeeP"
146#define JABBER_CACHED_ID "BeeC"
147
148/* The number of seconds to keep cached packets before garbage collecting
149   them. This gc is done on every keepalive (every minute). */
150#define JABBER_CACHE_MAX_AGE 600
151
152/* RFC 392[01] stuff */
153#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
154#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
155#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
156#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
157#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
158#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
159#define XMLNS_ROSTER       "jabber:iq:roster"
160
161/* Some supported extensions/legacy stuff */
162#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
163#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
164#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
165#define XMLNS_PING         "urn:xmpp:ping"                      /* XEP-0199 */
166#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
167#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
168#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
169#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
170#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
171#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
172#define XMLNS_CAPS         "http://jabber.org/protocol/caps"    /* XEP-0115 */
173
174/* iq.c */
175xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
176int jabber_init_iq_auth( struct im_connection *ic );
177xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
178int jabber_get_roster( struct im_connection *ic );
179int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
180int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
181int jabber_remove_from_roster( struct im_connection *ic, char *handle );
182
183/* message.c */
184xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
185
186/* presence.c */
187xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
188int presence_send_update( struct im_connection *ic );
189int presence_send_request( struct im_connection *ic, char *handle, char *request );
190
191/* jabber_util.c */
192char *set_eval_priority( set_t *set, char *value );
193char *set_eval_tls( set_t *set, char *value );
194struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
195struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
196void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
197struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
198void jabber_cache_entry_free( gpointer entry );
199void jabber_cache_clean( struct im_connection *ic );
200xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
201const struct jabber_away_state *jabber_away_state_by_code( char *code );
202const struct jabber_away_state *jabber_away_state_by_name( char *name );
203void jabber_buddy_ask( struct im_connection *ic, char *handle );
204char *jabber_normalize( const char *orig );
205
206typedef enum
207{
208        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
209        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
210        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
211} get_buddy_flags_t;
212
213struct jabber_error
214{
215        char *code, *text, *type;
216};
217
218struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
219struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
220struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
221int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
222int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
223time_t jabber_get_timestamp( struct xt_node *xt );
224struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
225void jabber_error_free( struct jabber_error *err );
226
227extern const struct jabber_away_state jabber_away_state_list[];
228
229/* io.c */
230int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
231int jabber_write( struct im_connection *ic, char *buf, int len );
232gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
233gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
234gboolean jabber_start_stream( struct im_connection *ic );
235void jabber_end_stream( struct im_connection *ic );
236
237/* sasl.c */
238xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
239xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
240xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
241gboolean sasl_supported( struct im_connection *ic );
242
243/* conference.c */
244struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
245struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
246void jabber_chat_free( struct groupchat *c );
247int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
248int jabber_chat_topic( struct groupchat *c, char *topic );
249int jabber_chat_leave( struct groupchat *c, const char *reason );
250void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
251void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
252void jabber_chat_invite( struct groupchat *c, char *who, char *message );
253
254#endif
Note: See TracBrowser for help on using the repository browser.