source: protocols/jabber/jabber.h @ eded1f7

Last change on this file since eded1f7 was eded1f7, checked in by kenobi <kenobi@…>, at 2007-12-18T23:59:35Z

Merged in 280..288 from upstream (e.g. PING)

  • Property mode set to 100644
File size: 12.5 KB
RevLine 
[f06894d]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
[21167d2]32typedef enum
33{
[bb95d43]34        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
[a21a8ac]35                                           and want to do auth. */
[bb95d43]36        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
37        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
[a21a8ac]38                                           SASL or TLS). */
[bb95d43]39        JFLAG_WAIT_SESSION = 8,         /* Set if we sent a <session> tag and need a reply
[a21a8ac]40                                           before we continue. */
[bb95d43]41        JFLAG_WAIT_BIND = 16,           /* ... for <bind> tag. */
42        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
[788a1af]43                                           activates all XEP-85 related code. */
[bb95d43]44        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
[21167d2]45} jabber_flags_t;
46
[a21a8ac]47typedef enum
48{
[788a1af]49        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
[a21a8ac]50                                           sure it gets sent only once. */
[788a1af]51        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
52                                           XEP85 (typing notification shite). */
[e35d1a1]53        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
54                                           groupchat state info too. */
[6286f80]55        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
56                                           have a real JID. */
[0d3f30f]57} jabber_buddy_flags_t;
[a21a8ac]58
[dc0ba9c]59/* Stores a streamhost's(a.k.a. proxy) data */
60typedef struct
61{
62        char *jid;
63        char *host;
64        char port[6];
65} jabber_streamhost_t;
66
[5e202b0]67struct jabber_data
68{
[0da65d5]69        struct im_connection *ic;
[5e202b0]70       
71        int fd;
72        void *ssl;
73        char *txq;
74        int tx_len;
75        int r_inpa, w_inpa;
76       
77        struct xt_parser *xt;
78        jabber_flags_t flags;
79       
80        char *username;         /* USERNAME@server */
81        char *server;           /* username@SERVER -=> server/domain, not hostname */
[172a73f1]82       
83        /* After changing one of these two (or the priority setting), call
84           presence_send_update() to inform the server about the changes. */
[5e202b0]85        struct jabber_away_state *away_state;
86        char *away_message;
87       
[608f8cf]88        char *cached_id_prefix;
[038d17f]89        GHashTable *node_cache;
[6a1128d]90        GHashTable *buddies;
[2c2df7d]91
92        GSList *filetransfers;
[dc0ba9c]93        GSList *streamhosts;
94        int have_streamhosts;
[5e202b0]95};
96
97struct jabber_away_state
98{
99        char code[5];
100        char *full_name;
101};
102
[0da65d5]103typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
[038d17f]104
105struct jabber_cache_entry
106{
107        struct xt_node *node;
108        jabber_cache_event func;
109};
110
[6a1128d]111struct jabber_buddy
112{
[0d3f30f]113        char *bare_jid;
[a21a8ac]114        char *full_jid;
[6a1128d]115        char *resource;
116       
[6286f80]117        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
118                       /* otherwise something similar to the conference JID. */
[e35d1a1]119       
[6a1128d]120        int priority;
121        struct jabber_away_state *away_state;
122        char *away_message;
[dc0ba9c]123        GSList *features;
[6a1128d]124       
125        time_t last_act;
[0d3f30f]126        jabber_buddy_flags_t flags;
[6a1128d]127       
128        struct jabber_buddy *next;
129};
130
[e35d1a1]131struct jabber_chat
132{
133        int flags;
134        char *name;
[9c9b37c]135        char *my_full_jid; /* Separate copy because of case sensitivity. */
[e35d1a1]136        struct jabber_buddy *me;
137};
138
[2c2df7d]139struct jabber_transfer
140{
141        /* bitlbee's handle for this transfer */
142        file_transfer_t *ft;
143
144        /* the stream's private handle */
145        gpointer streamhandle;
146
147        struct im_connection *ic;
148
149        int watch_in;
150        int watch_out;
151
152        char *ini_jid;
153        char *tgt_jid;
154        char *iq_id;
155        char *sid;
156        int accepted;
157
158        size_t bytesread, byteswritten;
159        int fd;
[2ff2076]160        struct sockaddr_storage saddr;
[2c2df7d]161};
162
[bb95d43]163#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
164
165#define JABBER_PORT_DEFAULT "5222"
166#define JABBER_PORT_MIN 5220
167#define JABBER_PORT_MAX 5229
168
[dfa41a4]169/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
170   first one should be used, but when storing a packet in the cache, a
171   "special" kind of ID is assigned to make it easier later to figure out
[608f8cf]172   if we have to do call an event handler for the response packet. Also
173   we'll append a hash to make sure we won't trigger on cached packets from
174   other BitlBee users. :-) */
[dfa41a4]175#define JABBER_PACKET_ID "BeeP"
176#define JABBER_CACHED_ID "BeeC"
177
[47d3ac4]178/* RFC 392[01] stuff */
179#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
180#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
181#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
182#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
183#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
184#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
185#define XMLNS_ROSTER       "jabber:iq:roster"
186
187/* Some supported extensions/legacy stuff */
[2c2df7d]188#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
189#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
190#define XMLNS_TIME         "jabber:iq:time"                                      /* XEP-0090 */
[eded1f7]191#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
[2c2df7d]192#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
193#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
194#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
195#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
[dc0ba9c]196#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
197#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
[2c2df7d]198#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
199#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
200#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
201#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
202#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
203#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
204#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
[47d3ac4]205
[21167d2]206/* iq.c */
[f06894d]207xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
[0da65d5]208int jabber_init_iq_auth( struct im_connection *ic );
209xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
210int jabber_get_roster( struct im_connection *ic );
211int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
212int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
213int jabber_remove_from_roster( struct im_connection *ic, char *handle );
[dc0ba9c]214xt_status jabber_iq_query_features( struct im_connection *ic, char *bare_jid );
215xt_status jabber_iq_query_server( struct im_connection *ic, char *jid, char *xmlns );
[21167d2]216
[2c2df7d]217/* si.c */
[2ff2076]218int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
219void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
220void jabber_si_free_transfer( file_transfer_t *ft);
221
222/* s5bytestream.c */
223int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
224gboolean jabber_bs_send_start( struct jabber_transfer *tf );
[dce3903]225gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, unsigned int len );
[2c2df7d]226
[cfbb3a6]227/* message.c */
[f06894d]228xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
[0b4a0db]229
230/* presence.c */
[f06894d]231xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
[0da65d5]232int presence_send_update( struct im_connection *ic );
233int presence_send_request( struct im_connection *ic, char *handle, char *request );
[f06894d]234
[21167d2]235/* jabber_util.c */
[ebe7b36]236char *set_eval_priority( set_t *set, char *value );
[f06894d]237char *set_eval_tls( set_t *set, char *value );
[21167d2]238struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
[2c2df7d]239struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
[0da65d5]240void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
241struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
[038d17f]242void jabber_cache_entry_free( gpointer entry );
[0da65d5]243void jabber_cache_clean( struct im_connection *ic );
[4306d8b]244xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
[5e202b0]245const struct jabber_away_state *jabber_away_state_by_code( char *code );
246const struct jabber_away_state *jabber_away_state_by_name( char *name );
[0da65d5]247void jabber_buddy_ask( struct im_connection *ic, char *handle );
[e35d1a1]248char *jabber_normalize( const char *orig );
[0d3f30f]249
250typedef enum
251{
252        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
[e35d1a1]253        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
254        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
[0d3f30f]255} get_buddy_flags_t;
256
[1baaef8]257struct jabber_error
258{
259        char *code, *text, *type;
260};
261
[0da65d5]262struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
263struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[b9f8b87]264struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[0da65d5]265int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
266int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
[43671b9]267time_t jabber_get_timestamp( struct xt_node *xt );
[1baaef8]268struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
269void jabber_error_free( struct jabber_error *err );
[5e202b0]270
271extern const struct jabber_away_state jabber_away_state_list[];
[21167d2]272
273/* io.c */
[0da65d5]274int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
275int jabber_write( struct im_connection *ic, char *buf, int len );
[21167d2]276gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
[42127dc]277gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
[0da65d5]278gboolean jabber_start_stream( struct im_connection *ic );
279void jabber_end_stream( struct im_connection *ic );
[21167d2]280
[5997488]281/* sasl.c */
282xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
283xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
284xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
[0da65d5]285gboolean sasl_supported( struct im_connection *ic );
[5997488]286
[e35d1a1]287/* conference.c */
288struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
[5bd21df]289struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
[9da0bbf]290void jabber_chat_free( struct groupchat *c );
[43671b9]291int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
[ef5c185]292int jabber_chat_topic( struct groupchat *c, char *topic );
[e35d1a1]293int jabber_chat_leave( struct groupchat *c, const char *reason );
294void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
295void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
[eded1f7]296void jabber_chat_invite( struct groupchat *c, char *who, char *message );
[e35d1a1]297
[f06894d]298#endif
Note: See TracBrowser for help on using the repository browser.