source: protocols/jabber/jabber.h @ c4f2c6a

Last change on this file since c4f2c6a was 0da65d5, checked in by Wilmer van der Gaast <wilmer@…>, at 2007-03-31T05:40:45Z

s/gaim_connection/im_connection/ and some other minor API changes. The rest
will come tomorrow. It compiles, I'll leave the real testing up to someone
else. ;-)
  • Property mode set to 100644
File size: 8.1 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} jabber_buddy_flags_t;
53
54#define JABBER_PORT_DEFAULT "5222"
55#define JABBER_PORT_MIN 5220
56#define JABBER_PORT_MAX 5229
57
58struct jabber_data
59{
60        struct im_connection *ic;
61       
62        int fd;
63        void *ssl;
64        char *txq;
65        int tx_len;
66        int r_inpa, w_inpa;
67       
68        struct xt_parser *xt;
69        jabber_flags_t flags;
70       
71        char *username;         /* USERNAME@server */
72        char *server;           /* username@SERVER -=> server/domain, not hostname */
73       
74        /* After changing one of these two (or the priority setting), call
75           presence_send_update() to inform the server about the changes. */
76        struct jabber_away_state *away_state;
77        char *away_message;
78       
79        GHashTable *node_cache;
80        GHashTable *buddies;
81};
82
83struct jabber_away_state
84{
85        char code[5];
86        char *full_name;
87};
88
89typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
90
91struct jabber_cache_entry
92{
93        struct xt_node *node;
94        jabber_cache_event func;
95};
96
97struct jabber_buddy
98{
99        char *bare_jid;
100        char *full_jid;
101        char *resource;
102       
103        int priority;
104        struct jabber_away_state *away_state;
105        char *away_message;
106       
107        time_t last_act;
108        jabber_buddy_flags_t flags;
109       
110        struct jabber_buddy *next;
111};
112
113/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
114   first one should be used, but when storing a packet in the cache, a
115   "special" kind of ID is assigned to make it easier later to figure out
116   if we have to do call an event handler for the response packet. */
117#define JABBER_PACKET_ID "BeeP"
118#define JABBER_CACHED_ID "BeeC"
119
120/* RFC 392[01] stuff */
121#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
122#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
123#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
124#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
125#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
126#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
127#define XMLNS_ROSTER       "jabber:iq:roster"
128
129/* Some supported extensions/legacy stuff */
130#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
131#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
132#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
133#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
134#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
135#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
136
137/* iq.c */
138xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
139int jabber_init_iq_auth( struct im_connection *ic );
140xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
141int jabber_get_roster( struct im_connection *ic );
142int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
143int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
144int jabber_remove_from_roster( struct im_connection *ic, char *handle );
145
146/* message.c */
147xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
148
149/* presence.c */
150xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
151int presence_send_update( struct im_connection *ic );
152int presence_send_request( struct im_connection *ic, char *handle, char *request );
153
154/* jabber_util.c */
155char *set_eval_priority( set_t *set, char *value );
156char *set_eval_tls( set_t *set, char *value );
157struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
158struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
159void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
160struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
161void jabber_cache_entry_free( gpointer entry );
162void jabber_cache_clean( struct im_connection *ic );
163const struct jabber_away_state *jabber_away_state_by_code( char *code );
164const struct jabber_away_state *jabber_away_state_by_name( char *name );
165void jabber_buddy_ask( struct im_connection *ic, char *handle );
166char *jabber_normalize( char *orig );
167
168typedef enum
169{
170        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
171        GET_BUDDY_EXACT = 2,    /* Get an exact message (only makes sense with bare JIDs). */
172} get_buddy_flags_t;
173
174struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
175struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
176int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
177int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
178
179extern const struct jabber_away_state jabber_away_state_list[];
180
181/* io.c */
182int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
183int jabber_write( struct im_connection *ic, char *buf, int len );
184gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
185gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
186gboolean jabber_start_stream( struct im_connection *ic );
187void jabber_end_stream( struct im_connection *ic );
188
189/* sasl.c */
190xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
191xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
192xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
193gboolean sasl_supported( struct im_connection *ic );
194
195#endif
Note: See TracBrowser for help on using the repository browser.