source: protocols/jabber/jabber.h @ b051d39

Last change on this file since b051d39 was 840bba8, checked in by Wilmer van der Gaast <wilmer@…>, at 2010-03-06T14:50:52Z

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