source: protocols/jabber/jabber.h @ 20e830b

Last change on this file since 20e830b was 76c85b4c, checked in by Wilmer van der Gaast <wilmer@…>, at 2009-11-19T13:11:38Z

resource_select now defaults to activity instead of priority. Also, adding
a activity_timeout setting. Now, messages to someone who hasn't spoken for
a while will be sent to his/her bare JID, usually resulting in a broadcast.
This should fix issues with messages sometimes arriving on someone's
Crackberry/Android/etc instead of some place s/he's paying attention to.
Last, the activity timer is only reset on incoming messages.

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