source: protocols/jabber/jabber.h @ 64b6635

Last change on this file since 64b6635 was 64b6635, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-12-18T21:56:44Z

Restructured and updated code a little bit to support new-style (much better
and "proper" OAuth2) Facebook OAuth support. (And, add wl.offline scope to get
tokens that don't expire after an hour.)

  • Property mode set to 100644
File size: 14.9 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 "bitlbee.h"
[4cf80bb]30#include "md5.h"
31#include "xmltree.h"
[f06894d]32
[b5c8a34]33extern GSList *jabber_connections;
34
[21167d2]35typedef enum
36{
[bb95d43]37        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
[a21a8ac]38                                           and want to do auth. */
[bb95d43]39        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
40        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
[a21a8ac]41                                           SASL or TLS). */
[8fb1263]42        JFLAG_WANT_SESSION = 8,         /* Set if the server wants a <session/> tag
[a21a8ac]43                                           before we continue. */
[8fb1263]44        JFLAG_WANT_BIND = 16,           /* ... for <bind> tag. */
[bb95d43]45        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
[788a1af]46                                           activates all XEP-85 related code. */
[bb95d43]47        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
[af7f046]48        JFLAG_STARTTLS_DONE = 128,      /* If a plaintext session was converted to TLS. */
[e1c926f]49       
50        JFLAG_SASL_FB = 0x10000,        /* Trying Facebook authentication. */
[21167d2]51} jabber_flags_t;
52
[a21a8ac]53typedef enum
54{
[63075d7]55        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
[a21a8ac]56                                           sure it gets sent only once. */
[63075d7]57        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
[788a1af]58                                           XEP85 (typing notification shite). */
[63075d7]59        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
[e35d1a1]60                                           groupchat state info too. */
[63075d7]61        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
[6286f80]62                                           have a real JID. */
[31dbb90a]63        JBFLAG_HIDE_SUBJECT = 16,       /* Hide the subject field since we probably
64                                           showed it already. */
[0d3f30f]65} jabber_buddy_flags_t;
[a21a8ac]66
[1c3008a]67/* Stores a streamhost's (a.k.a. proxy) data */
[dc0ba9c]68typedef struct
69{
70        char *jid;
71        char *host;
72        char port[6];
73} jabber_streamhost_t;
74
[63075d7]75typedef enum
76{
77        JCFLAG_MESSAGE_SENT = 1,        /* Set this after sending the first message, so
78                                           we can detect echoes/backlogs. */
79} jabber_chat_flags_t;
80
[5e202b0]81struct jabber_data
82{
[0da65d5]83        struct im_connection *ic;
[5e202b0]84       
85        int fd;
86        void *ssl;
87        char *txq;
88        int tx_len;
89        int r_inpa, w_inpa;
90       
91        struct xt_parser *xt;
92        jabber_flags_t flags;
93       
94        char *username;         /* USERNAME@server */
95        char *server;           /* username@SERVER -=> server/domain, not hostname */
[172a73f1]96       
[18c6d36]97        const struct oauth2_service *oauth2_service;
[4a5d885]98        char *oauth2_access_token;
99       
[172a73f1]100        /* After changing one of these two (or the priority setting), call
101           presence_send_update() to inform the server about the changes. */
[840bba8]102        const struct jabber_away_state *away_state;
[5e202b0]103        char *away_message;
104       
[89d736a]105        md5_state_t cached_id_prefix;
[038d17f]106        GHashTable *node_cache;
[6a1128d]107        GHashTable *buddies;
[2c2df7d]108
109        GSList *filetransfers;
[dc0ba9c]110        GSList *streamhosts;
111        int have_streamhosts;
[5e202b0]112};
113
114struct jabber_away_state
115{
116        char code[5];
117        char *full_name;
118};
119
[0da65d5]120typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
[038d17f]121
122struct jabber_cache_entry
123{
[979cfb4]124        time_t saved_at;
[038d17f]125        struct xt_node *node;
126        jabber_cache_event func;
127};
128
[76c85b4c]129/* Somewhat messy data structure: We have a hash table with the bare JID as
130   the key and the head of a struct jabber_buddy list as the value. The head
131   is always a bare JID. If the JID has other resources (often the case,
132   except for some transports that don't support multiple resources), those
133   follow. In that case, the bare JID at the beginning doesn't actually
134   refer to a real session and should only be used for operations that
135   support incomplete JIDs. */
[6a1128d]136struct jabber_buddy
137{
[0d3f30f]138        char *bare_jid;
[a21a8ac]139        char *full_jid;
[6a1128d]140        char *resource;
141       
[6286f80]142        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
143                       /* otherwise something similar to the conference JID. */
[e35d1a1]144       
[6a1128d]145        int priority;
146        struct jabber_away_state *away_state;
147        char *away_message;
[dc0ba9c]148        GSList *features;
[6a1128d]149       
[76c85b4c]150        time_t last_msg;
[0d3f30f]151        jabber_buddy_flags_t flags;
[6a1128d]152       
153        struct jabber_buddy *next;
154};
155
[e35d1a1]156struct jabber_chat
157{
158        int flags;
159        char *name;
[9c9b37c]160        char *my_full_jid; /* Separate copy because of case sensitivity. */
[e35d1a1]161        struct jabber_buddy *me;
162};
163
[2c2df7d]164struct jabber_transfer
165{
166        /* bitlbee's handle for this transfer */
167        file_transfer_t *ft;
168
169        /* the stream's private handle */
170        gpointer streamhandle;
171
[b5cfc2b]172        /* timeout for discover queries */
173        gint disco_timeout;
174        gint disco_timeout_fired;
175
[2c2df7d]176        struct im_connection *ic;
177
[b5cfc2b]178        struct jabber_buddy *bud;
179
[2c2df7d]180        int watch_in;
181        int watch_out;
182
183        char *ini_jid;
184        char *tgt_jid;
185        char *iq_id;
186        char *sid;
187        int accepted;
188
189        size_t bytesread, byteswritten;
190        int fd;
[2ff2076]191        struct sockaddr_storage saddr;
[2c2df7d]192};
193
[bb95d43]194#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
195
[dfa41a4]196/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
197   first one should be used, but when storing a packet in the cache, a
198   "special" kind of ID is assigned to make it easier later to figure out
[608f8cf]199   if we have to do call an event handler for the response packet. Also
200   we'll append a hash to make sure we won't trigger on cached packets from
201   other BitlBee users. :-) */
[dfa41a4]202#define JABBER_PACKET_ID "BeeP"
203#define JABBER_CACHED_ID "BeeC"
204
[979cfb4]205/* The number of seconds to keep cached packets before garbage collecting
206   them. This gc is done on every keepalive (every minute). */
207#define JABBER_CACHE_MAX_AGE 600
208
[47d3ac4]209/* RFC 392[01] stuff */
210#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
211#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
212#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
213#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
214#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
215#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
216#define XMLNS_ROSTER       "jabber:iq:roster"
217
218/* Some supported extensions/legacy stuff */
[2c2df7d]219#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
220#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
[d76e12f]221#define XMLNS_TIME_OLD     "jabber:iq:time"                                      /* XEP-0090 */
222#define XMLNS_TIME         "urn:xmpp:time"                                       /* XEP-0202 */
[eded1f7]223#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
[2c2df7d]224#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
225#define XMLNS_DELAY        "jabber:x:delay"                                      /* XEP-0091 */
226#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
227#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
[dc0ba9c]228#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
229#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
[2c2df7d]230#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
231#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
[1ba7e8f]232#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
[2c2df7d]233#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
234#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
235#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
236#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
237#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
[47d3ac4]238
[4a5d885]239/* jabber.c */
240void jabber_connect( struct im_connection *ic );
241
[21167d2]242/* iq.c */
[f06894d]243xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
[0da65d5]244int jabber_init_iq_auth( struct im_connection *ic );
245xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
246int jabber_get_roster( struct im_connection *ic );
247int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
[46d215d]248int jabber_add_to_roster( struct im_connection *ic, const char *handle, const char *name, const char *group );
[0da65d5]249int jabber_remove_from_roster( struct im_connection *ic, char *handle );
[dc0ba9c]250xt_status jabber_iq_query_features( struct im_connection *ic, char *bare_jid );
251xt_status jabber_iq_query_server( struct im_connection *ic, char *jid, char *xmlns );
[d88c92a]252void jabber_iq_version_send( struct im_connection *ic, struct jabber_buddy *bud, void *data );
[21167d2]253
[2c2df7d]254/* si.c */
[2ff2076]255int jabber_si_handle_request( struct im_connection *ic, struct xt_node *node, struct xt_node *sinode );
256void jabber_si_transfer_request( struct im_connection *ic, file_transfer_t *ft, char *who );
257void jabber_si_free_transfer( file_transfer_t *ft);
258
259/* s5bytestream.c */
260int jabber_bs_recv_request( struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
261gboolean jabber_bs_send_start( struct jabber_transfer *tf );
[dce3903]262gboolean jabber_bs_send_write( file_transfer_t *ft, char *buffer, unsigned int len );
[21167d2]263
[cfbb3a6]264/* message.c */
[f06894d]265xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
[0b4a0db]266
267/* presence.c */
[f06894d]268xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
[0da65d5]269int presence_send_update( struct im_connection *ic );
270int presence_send_request( struct im_connection *ic, char *handle, char *request );
[f06894d]271
[21167d2]272/* jabber_util.c */
[ebe7b36]273char *set_eval_priority( set_t *set, char *value );
[f06894d]274char *set_eval_tls( set_t *set, char *value );
[21167d2]275struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
[2c2df7d]276struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type, char *err_code );
[0da65d5]277void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
278struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
[038d17f]279void jabber_cache_entry_free( gpointer entry );
[0da65d5]280void jabber_cache_clean( struct im_connection *ic );
[4306d8b]281xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
[5e202b0]282const struct jabber_away_state *jabber_away_state_by_code( char *code );
283const struct jabber_away_state *jabber_away_state_by_name( char *name );
[0da65d5]284void jabber_buddy_ask( struct im_connection *ic, char *handle );
[e35d1a1]285char *jabber_normalize( const char *orig );
[0d3f30f]286
287typedef enum
288{
289        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
[e35d1a1]290        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
291        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
[76c85b4c]292        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
293        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
[0d3f30f]294} get_buddy_flags_t;
295
[1baaef8]296struct jabber_error
297{
298        char *code, *text, *type;
299};
300
[0da65d5]301struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
302struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[b9f8b87]303struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[0da65d5]304int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
305int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
[04a927c]306void jabber_buddy_remove_all( struct im_connection *ic );
[43671b9]307time_t jabber_get_timestamp( struct xt_node *xt );
[1baaef8]308struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
309void jabber_error_free( struct jabber_error *err );
[5e202b0]310
311extern const struct jabber_away_state jabber_away_state_list[];
[21167d2]312
313/* io.c */
[0da65d5]314int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
315int jabber_write( struct im_connection *ic, char *buf, int len );
[21167d2]316gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
[42127dc]317gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
[0da65d5]318gboolean jabber_start_stream( struct im_connection *ic );
319void jabber_end_stream( struct im_connection *ic );
[21167d2]320
[5997488]321/* sasl.c */
322xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
323xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
324xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
[0da65d5]325gboolean sasl_supported( struct im_connection *ic );
[4a5d885]326void sasl_oauth2_init( struct im_connection *ic );
327int sasl_oauth2_get_refresh_token( struct im_connection *ic, const char *msg );
328int sasl_oauth2_refresh( struct im_connection *ic, const char *refresh_token );
[64b6635]329int sasl_oauth2_load_access_token( struct im_connection *ic );
[5997488]330
[18c6d36]331extern const struct oauth2_service oauth2_service_google;
332extern const struct oauth2_service oauth2_service_facebook;
333extern const struct oauth2_service oauth2_service_mslive;
334
[e35d1a1]335/* conference.c */
[94acdd0]336struct groupchat *jabber_chat_join( struct im_connection *ic, const char *room, const char *nick, const char *password );
[5bd21df]337struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
[9da0bbf]338void jabber_chat_free( struct groupchat *c );
[43671b9]339int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
[ef5c185]340int jabber_chat_topic( struct groupchat *c, char *topic );
[e35d1a1]341int jabber_chat_leave( struct groupchat *c, const char *reason );
342void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
343void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
[c058ff9]344void jabber_chat_invite( struct groupchat *c, char *who, char *message );
[e35d1a1]345
[f06894d]346#endif
Note: See TracBrowser for help on using the repository browser.