source: protocols/jabber/jabber.h @ 1962ac1

Last change on this file since 1962ac1 was 9c9b37c, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-07-01T19:58:23Z

Keeping an original (not normalized) copy of the user's nickname. This
fixes a bug reported by James Teh in the monster ticket #20. There's no
proper garbage collection yet in the Jabber conference code, really have
to do that soon. :-(
  • Property mode set to 100644
File size: 9.8 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
32typedef enum
33{
34        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
35                                           and want to do auth. */
36        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
37        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
38                                           SASL or TLS). */
39        JFLAG_WAIT_SESSION = 8,         /* Set if we sent a <session> tag and need a reply
40                                           before we continue. */
41        JFLAG_WAIT_BIND = 16,           /* ... for <bind> tag. */
42        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
43                                           activates all XEP-85 related code. */
44        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
45} jabber_flags_t;
46
47typedef enum
48{
49        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
50                                           sure it gets sent only once. */
51        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
52                                           XEP85 (typing notification shite). */
53        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
54                                           groupchat state info too. */
55        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
56                                           have a real JID. */
57} jabber_buddy_flags_t;
58
59struct jabber_data
60{
61        struct im_connection *ic;
62       
63        int fd;
64        void *ssl;
65        char *txq;
66        int tx_len;
67        int r_inpa, w_inpa;
68       
69        struct xt_parser *xt;
70        jabber_flags_t flags;
71       
72        char *username;         /* USERNAME@server */
73        char *server;           /* username@SERVER -=> server/domain, not hostname */
74       
75        /* After changing one of these two (or the priority setting), call
76           presence_send_update() to inform the server about the changes. */
77        struct jabber_away_state *away_state;
78        char *away_message;
79       
80        GHashTable *node_cache;
81        GHashTable *buddies;
82};
83
84struct jabber_away_state
85{
86        char code[5];
87        char *full_name;
88};
89
90typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
91
92struct jabber_cache_entry
93{
94        struct xt_node *node;
95        jabber_cache_event func;
96};
97
98struct jabber_buddy
99{
100        char *bare_jid;
101        char *full_jid;
102        char *resource;
103       
104        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
105                       /* otherwise something similar to the conference JID. */
106       
107        int priority;
108        struct jabber_away_state *away_state;
109        char *away_message;
110       
111        time_t last_act;
112        jabber_buddy_flags_t flags;
113       
114        struct jabber_buddy *next;
115};
116
117struct jabber_chat
118{
119        int flags;
120        char *name;
121        char *my_full_jid; /* Separate copy because of case sensitivity. */
122        struct jabber_buddy *me;
123};
124
125#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
126
127#define JABBER_PORT_DEFAULT "5222"
128#define JABBER_PORT_MIN 5220
129#define JABBER_PORT_MAX 5229
130
131/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
132   first one should be used, but when storing a packet in the cache, a
133   "special" kind of ID is assigned to make it easier later to figure out
134   if we have to do call an event handler for the response packet. */
135#define JABBER_PACKET_ID "BeeP"
136#define JABBER_CACHED_ID "BeeC"
137
138/* RFC 392[01] stuff */
139#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
140#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
141#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
142#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
143#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
144#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
145#define XMLNS_ROSTER       "jabber:iq:roster"
146
147/* Some supported extensions/legacy stuff */
148#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
149#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
150#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
151#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
152#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
153#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
154#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
155#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
156#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
157
158/* iq.c */
159xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
160int jabber_init_iq_auth( struct im_connection *ic );
161xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
162int jabber_get_roster( struct im_connection *ic );
163int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
164int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
165int jabber_remove_from_roster( struct im_connection *ic, char *handle );
166
167/* message.c */
168xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
169
170/* presence.c */
171xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
172int presence_send_update( struct im_connection *ic );
173int presence_send_request( struct im_connection *ic, char *handle, char *request );
174
175/* jabber_util.c */
176char *set_eval_priority( set_t *set, char *value );
177char *set_eval_tls( set_t *set, char *value );
178struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
179struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
180void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
181struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
182void jabber_cache_entry_free( gpointer entry );
183void jabber_cache_clean( struct im_connection *ic );
184const struct jabber_away_state *jabber_away_state_by_code( char *code );
185const struct jabber_away_state *jabber_away_state_by_name( char *name );
186void jabber_buddy_ask( struct im_connection *ic, char *handle );
187char *jabber_normalize( const char *orig );
188
189typedef enum
190{
191        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
192        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
193        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
194} get_buddy_flags_t;
195
196struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
197struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
198struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
199int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
200int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
201struct groupchat *jabber_chat_by_name( struct im_connection *ic, const char *name );
202time_t jabber_get_timestamp( struct xt_node *xt );
203
204extern const struct jabber_away_state jabber_away_state_list[];
205
206/* io.c */
207int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
208int jabber_write( struct im_connection *ic, char *buf, int len );
209gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
210gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
211gboolean jabber_start_stream( struct im_connection *ic );
212void jabber_end_stream( struct im_connection *ic );
213
214/* sasl.c */
215xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
216xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
217xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
218gboolean sasl_supported( struct im_connection *ic );
219
220/* conference.c */
221struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
222int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
223int jabber_chat_leave( struct groupchat *c, const char *reason );
224void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
225void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
226
227#endif
Note: See TracBrowser for help on using the repository browser.