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

Last change on this file since 2ff2076 was 2ff2076, checked in by ulim <a.sporto+bee@…>, at 2007-12-03T14:28:45Z

Intermediate commit. Sending seems to work. TODOs:

  • move from out_of_data to is_writable, eliminate buffers
  • implement "transfers reject [id]"
  • documentation in commands.xml
  • implement throughput and cummulative throughput boundaries
  • feature discovery before sending
  • implement sending over a proxy (proxy discovery, socks5 client handshake for sending, activate message)
  • integrate toxik-mek-ft
  • Property mode set to 100644
File size: 11.8 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
[5e202b0]59struct jabber_data
60{
[0da65d5]61        struct im_connection *ic;
[5e202b0]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 */
[172a73f1]74       
75        /* After changing one of these two (or the priority setting), call
76           presence_send_update() to inform the server about the changes. */
[5e202b0]77        struct jabber_away_state *away_state;
78        char *away_message;
79       
[608f8cf]80        char *cached_id_prefix;
[038d17f]81        GHashTable *node_cache;
[6a1128d]82        GHashTable *buddies;
[2c2df7d]83
84        GSList *filetransfers;
[5e202b0]85};
86
87struct jabber_away_state
88{
89        char code[5];
90        char *full_name;
91};
92
[0da65d5]93typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
[038d17f]94
95struct jabber_cache_entry
96{
97        struct xt_node *node;
98        jabber_cache_event func;
99};
100
[6a1128d]101struct jabber_buddy
102{
[0d3f30f]103        char *bare_jid;
[a21a8ac]104        char *full_jid;
[6a1128d]105        char *resource;
106       
[6286f80]107        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
108                       /* otherwise something similar to the conference JID. */
[e35d1a1]109       
[6a1128d]110        int priority;
111        struct jabber_away_state *away_state;
112        char *away_message;
113       
114        time_t last_act;
[0d3f30f]115        jabber_buddy_flags_t flags;
[6a1128d]116       
117        struct jabber_buddy *next;
118};
119
[e35d1a1]120struct jabber_chat
121{
122        int flags;
123        char *name;
[9c9b37c]124        char *my_full_jid; /* Separate copy because of case sensitivity. */
[e35d1a1]125        struct jabber_buddy *me;
126};
127
[2c2df7d]128struct jabber_transfer
129{
130        /* bitlbee's handle for this transfer */
131        file_transfer_t *ft;
132
133        /* the stream's private handle */
134        gpointer streamhandle;
135
136        struct im_connection *ic;
137
138        int watch_in;
139        int watch_out;
140
141        char *ini_jid;
142        char *tgt_jid;
143        char *iq_id;
144        char *sid;
145        int accepted;
146
147        size_t bytesread, byteswritten;
148        int receiver_overflow;
149        int fd;
[2ff2076]150        struct sockaddr_storage saddr;
[2c2df7d]151};
152
[bb95d43]153#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
154
155#define JABBER_PORT_DEFAULT "5222"
156#define JABBER_PORT_MIN 5220
157#define JABBER_PORT_MAX 5229
158
[dfa41a4]159/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
160   first one should be used, but when storing a packet in the cache, a
161   "special" kind of ID is assigned to make it easier later to figure out
[608f8cf]162   if we have to do call an event handler for the response packet. Also
163   we'll append a hash to make sure we won't trigger on cached packets from
164   other BitlBee users. :-) */
[dfa41a4]165#define JABBER_PACKET_ID "BeeP"
166#define JABBER_CACHED_ID "BeeC"
167
[47d3ac4]168/* RFC 392[01] stuff */
169#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
170#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
171#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
172#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
173#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
174#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
175#define XMLNS_ROSTER       "jabber:iq:roster"
176
177/* Some supported extensions/legacy stuff */
[2c2df7d]178#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
179#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
180#define XMLNS_TIME         "jabber:iq:time"                                      /* XEP-0090 */
181#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
182#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
183#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
184#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
185#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
186#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
187#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
188#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
189#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
190#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
191#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
192#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
[47d3ac4]193
[21167d2]194/* iq.c */
[f06894d]195xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
[0da65d5]196int jabber_init_iq_auth( struct im_connection *ic );
197xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
198int jabber_get_roster( struct im_connection *ic );
199int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
200int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
201int jabber_remove_from_roster( struct im_connection *ic, char *handle );
[21167d2]202
[2c2df7d]203/* si.c */
[2ff2076]204int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
205void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
206void jabber_si_free_transfer( file_transfer_t *ft);
207
208/* s5bytestream.c */
209int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
210gboolean jabber_bs_send_start( struct jabber_transfer *tf );
211gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, int len );
[2c2df7d]212
[cfbb3a6]213/* message.c */
[f06894d]214xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
[0b4a0db]215
216/* presence.c */
[f06894d]217xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
[0da65d5]218int presence_send_update( struct im_connection *ic );
219int presence_send_request( struct im_connection *ic, char *handle, char *request );
[f06894d]220
[21167d2]221/* jabber_util.c */
[ebe7b36]222char *set_eval_priority( set_t *set, char *value );
[f06894d]223char *set_eval_tls( set_t *set, char *value );
[21167d2]224struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
[2c2df7d]225struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
[0da65d5]226void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
227struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
[038d17f]228void jabber_cache_entry_free( gpointer entry );
[0da65d5]229void jabber_cache_clean( struct im_connection *ic );
[5e202b0]230const struct jabber_away_state *jabber_away_state_by_code( char *code );
231const struct jabber_away_state *jabber_away_state_by_name( char *name );
[0da65d5]232void jabber_buddy_ask( struct im_connection *ic, char *handle );
[e35d1a1]233char *jabber_normalize( const char *orig );
[0d3f30f]234
235typedef enum
236{
237        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
[e35d1a1]238        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
239        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
[0d3f30f]240} get_buddy_flags_t;
241
[1baaef8]242struct jabber_error
243{
244        char *code, *text, *type;
245};
246
[0da65d5]247struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
248struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[b9f8b87]249struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[0da65d5]250int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
251int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
[e35d1a1]252struct groupchat *jabber_chat_by_name( struct im_connection *ic, const char *name );
[43671b9]253time_t jabber_get_timestamp( struct xt_node *xt );
[1baaef8]254struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
255void jabber_error_free( struct jabber_error *err );
[5e202b0]256
257extern const struct jabber_away_state jabber_away_state_list[];
[21167d2]258
259/* io.c */
[0da65d5]260int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
261int jabber_write( struct im_connection *ic, char *buf, int len );
[21167d2]262gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
[42127dc]263gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
[0da65d5]264gboolean jabber_start_stream( struct im_connection *ic );
265void jabber_end_stream( struct im_connection *ic );
[21167d2]266
[5997488]267/* sasl.c */
268xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
269xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
270xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
[0da65d5]271gboolean sasl_supported( struct im_connection *ic );
[5997488]272
[e35d1a1]273/* conference.c */
274struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
[9da0bbf]275void jabber_chat_free( struct groupchat *c );
[43671b9]276int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
[ef5c185]277int jabber_chat_topic( struct groupchat *c, char *topic );
[e35d1a1]278int jabber_chat_leave( struct groupchat *c, const char *reason );
279void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
280void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
281
[f06894d]282#endif
Note: See TracBrowser for help on using the repository browser.