source: protocols/jabber/jabber.h @ 2d317bb

Last change on this file since 2d317bb was 43671b9, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-04-22T23:39:37Z

You can send messages too now. But it's still very kludgy and doesn't work
with anonymous rooms (ie about 95% of all available Jabber chatrooms?).

  • Property mode set to 100644
File size: 9.2 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} jabber_flags_t;
45
46typedef enum
47{
48        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
49                                           sure it gets sent only once. */
50        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
51                                           XEP85 (typing notification shite). */
52        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
53                                           groupchat state info too. */
54} jabber_buddy_flags_t;
55
56#define JABBER_PORT_DEFAULT "5222"
57#define JABBER_PORT_MIN 5220
58#define JABBER_PORT_MAX 5229
59
60struct jabber_data
61{
62        struct im_connection *ic;
63       
64        int fd;
65        void *ssl;
66        char *txq;
67        int tx_len;
68        int r_inpa, w_inpa;
69       
70        struct xt_parser *xt;
71        jabber_flags_t flags;
72       
73        char *username;         /* USERNAME@server */
74        char *server;           /* username@SERVER -=> server/domain, not hostname */
75       
76        /* After changing one of these two (or the priority setting), call
77           presence_send_update() to inform the server about the changes. */
78        struct jabber_away_state *away_state;
79        char *away_message;
80       
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        /* Groupchat-only */
106        char *orig_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        struct jabber_buddy *me;
123};
124
125/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
126   first one should be used, but when storing a packet in the cache, a
127   "special" kind of ID is assigned to make it easier later to figure out
128   if we have to do call an event handler for the response packet. */
129#define JABBER_PACKET_ID "BeeP"
130#define JABBER_CACHED_ID "BeeC"
131
132/* RFC 392[01] stuff */
133#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
134#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
135#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
136#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
137#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
138#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
139#define XMLNS_ROSTER       "jabber:iq:roster"
140
141/* Some supported extensions/legacy stuff */
142#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
143#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
144#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
145#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
146#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
147#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
148#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
149#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
150#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
151
152/* iq.c */
153xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
154int jabber_init_iq_auth( struct im_connection *ic );
155xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
156int jabber_get_roster( struct im_connection *ic );
157int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
158int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
159int jabber_remove_from_roster( struct im_connection *ic, char *handle );
160
161/* message.c */
162xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
163
164/* presence.c */
165xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
166int presence_send_update( struct im_connection *ic );
167int presence_send_request( struct im_connection *ic, char *handle, char *request );
168
169/* jabber_util.c */
170char *set_eval_priority( set_t *set, char *value );
171char *set_eval_tls( set_t *set, char *value );
172struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
173struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
174void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
175struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
176void jabber_cache_entry_free( gpointer entry );
177void jabber_cache_clean( struct im_connection *ic );
178const struct jabber_away_state *jabber_away_state_by_code( char *code );
179const struct jabber_away_state *jabber_away_state_by_name( char *name );
180void jabber_buddy_ask( struct im_connection *ic, char *handle );
181char *jabber_normalize( const char *orig );
182
183typedef enum
184{
185        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
186        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
187        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
188} get_buddy_flags_t;
189
190struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
191struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
192int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
193int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
194struct groupchat *jabber_chat_by_name( struct im_connection *ic, const char *name );
195time_t jabber_get_timestamp( struct xt_node *xt );
196
197extern const struct jabber_away_state jabber_away_state_list[];
198
199/* io.c */
200int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
201int jabber_write( struct im_connection *ic, char *buf, int len );
202gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
203gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
204gboolean jabber_start_stream( struct im_connection *ic );
205void jabber_end_stream( struct im_connection *ic );
206
207/* sasl.c */
208xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
209xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
210xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
211gboolean sasl_supported( struct im_connection *ic );
212
213/* conference.c */
214struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
215int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
216int jabber_chat_leave( struct groupchat *c, const char *reason );
217void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
218void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
219
220#endif
Note: See TracBrowser for help on using the repository browser.