source: protocols/jabber/jabber.h @ 71dc854

Last change on this file since 71dc854 was c058ff9, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-12-09T23:19:35Z

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