source: protocols/jabber/jabber.h @ 3c80a9d

Last change on this file since 3c80a9d was b5c8a34, checked in by Wilmer van der Gaast <wilmer@…>, at 2008-01-24T22:49:47Z

Keeping track of valid Jabber connections so _connected() events will be
ignored if the connection's dead already. Necessary if using GLib for event
handling for now. :-/
  • Property mode set to 100644
File size: 10.5 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
61struct jabber_data
62{
63        struct im_connection *ic;
64       
65        int fd;
66        void *ssl;
67        char *txq;
68        int tx_len;
69        int r_inpa, w_inpa;
70       
71        struct xt_parser *xt;
72        jabber_flags_t flags;
73       
74        char *username;         /* USERNAME@server */
75        char *server;           /* username@SERVER -=> server/domain, not hostname */
76       
77        /* After changing one of these two (or the priority setting), call
78           presence_send_update() to inform the server about the changes. */
79        struct jabber_away_state *away_state;
80        char *away_message;
81       
82        char *cached_id_prefix;
83        GHashTable *node_cache;
84        GHashTable *buddies;
85};
86
87struct jabber_away_state
88{
89        char code[5];
90        char *full_name;
91};
92
93typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
94
95struct jabber_cache_entry
96{
97        struct xt_node *node;
98        jabber_cache_event func;
99};
100
101struct jabber_buddy
102{
103        char *bare_jid;
104        char *full_jid;
105        char *resource;
106       
107        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
108                       /* otherwise something similar to the conference JID. */
109       
110        int priority;
111        struct jabber_away_state *away_state;
112        char *away_message;
113       
114        time_t last_act;
115        jabber_buddy_flags_t flags;
116       
117        struct jabber_buddy *next;
118};
119
120struct jabber_chat
121{
122        int flags;
123        char *name;
124        char *my_full_jid; /* Separate copy because of case sensitivity. */
125        struct jabber_buddy *me;
126};
127
128#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
129
130#define JABBER_PORT_DEFAULT "5222"
131#define JABBER_PORT_MIN 5220
132#define JABBER_PORT_MAX 5229
133
134/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
135   first one should be used, but when storing a packet in the cache, a
136   "special" kind of ID is assigned to make it easier later to figure out
137   if we have to do call an event handler for the response packet. Also
138   we'll append a hash to make sure we won't trigger on cached packets from
139   other BitlBee users. :-) */
140#define JABBER_PACKET_ID "BeeP"
141#define JABBER_CACHED_ID "BeeC"
142
143/* RFC 392[01] stuff */
144#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
145#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
146#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
147#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
148#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
149#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
150#define XMLNS_ROSTER       "jabber:iq:roster"
151
152/* Some supported extensions/legacy stuff */
153#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
154#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
155#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
156#define XMLNS_PING         "urn:xmpp:ping"                      /* XEP-0199 */
157#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
158#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
159#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
160#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
161#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
162#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
163
164/* iq.c */
165xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
166int jabber_init_iq_auth( struct im_connection *ic );
167xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
168int jabber_get_roster( struct im_connection *ic );
169int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
170int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
171int jabber_remove_from_roster( struct im_connection *ic, char *handle );
172
173/* message.c */
174xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
175
176/* presence.c */
177xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
178int presence_send_update( struct im_connection *ic );
179int presence_send_request( struct im_connection *ic, char *handle, char *request );
180
181/* jabber_util.c */
182char *set_eval_priority( set_t *set, char *value );
183char *set_eval_tls( set_t *set, char *value );
184struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
185struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
186void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
187struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
188void jabber_cache_entry_free( gpointer entry );
189void jabber_cache_clean( struct im_connection *ic );
190xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
191const struct jabber_away_state *jabber_away_state_by_code( char *code );
192const struct jabber_away_state *jabber_away_state_by_name( char *name );
193void jabber_buddy_ask( struct im_connection *ic, char *handle );
194char *jabber_normalize( const char *orig );
195
196typedef enum
197{
198        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
199        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
200        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
201} get_buddy_flags_t;
202
203struct jabber_error
204{
205        char *code, *text, *type;
206};
207
208struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
209struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
210struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
211int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
212int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
213time_t jabber_get_timestamp( struct xt_node *xt );
214struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
215void jabber_error_free( struct jabber_error *err );
216
217extern const struct jabber_away_state jabber_away_state_list[];
218
219/* io.c */
220int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
221int jabber_write( struct im_connection *ic, char *buf, int len );
222gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
223gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
224gboolean jabber_start_stream( struct im_connection *ic );
225void jabber_end_stream( struct im_connection *ic );
226
227/* sasl.c */
228xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
229xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
230xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
231gboolean sasl_supported( struct im_connection *ic );
232
233/* conference.c */
234struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
235struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
236void jabber_chat_free( struct groupchat *c );
237int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
238int jabber_chat_topic( struct groupchat *c, char *topic );
239int jabber_chat_leave( struct groupchat *c, const char *reason );
240void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
241void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
242void jabber_chat_invite( struct groupchat *c, char *who, char *message );
243
244#endif
Note: See TracBrowser for help on using the repository browser.