source: protocols/jabber/jabber.h @ e4f08bf

Last change on this file since e4f08bf was d2d2b80, checked in by dequis <dx@…>, at 2015-05-28T05:52:44Z

Merge branch 'develop' into feat/hip-cat
  • Property mode set to 100644
File size: 16.2 KB
Line 
1/***************************************************************************\
2*                                                                           *
3*  BitlBee - An IRC to IM gateway                                           *
4*  Jabber module - Main file                                                *
5*                                                                           *
6*  Copyright 2006-2013 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"
30#include "md5.h"
31#include "xmltree.h"
32
33extern GSList *jabber_connections;
34
35typedef enum {
36        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
37                                           and want to do auth. */
38        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
39        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
40                                           SASL or TLS). */
41        JFLAG_WANT_SESSION = 8,         /* Set if the server wants a <session/> tag
42                                           before we continue. */
43        JFLAG_WANT_BIND = 16,           /* ... for <bind> tag. */
44        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
45                                           activates all XEP-85 related code. */
46        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
47        JFLAG_STARTTLS_DONE = 128,      /* If a plaintext session was converted to TLS. */
48        JFLAG_GMAILNOTIFY = 256,        /* If gmail notification is enabled */
49
50        JFLAG_GTALK =  0x100000,        /* Is Google Talk, as confirmed by iq discovery */
51        JFLAG_HIPCHAT = 0x200000,       /* Is hipchat, because prpl->name says so */
52
53        JFLAG_SASL_FB = 0x10000,        /* Trying Facebook authentication. */
54} jabber_flags_t;
55
56typedef enum {
57        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
58                                           sure it gets sent only once. */
59        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
60                                           XEP85 (typing notification shite). */
61        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
62                                           groupchat state info too. */
63        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
64                                           have a real JID. */
65        JBFLAG_HIDE_SUBJECT = 16,       /* Hide the subject field since we probably
66                                           showed it already. */
67} jabber_buddy_flags_t;
68
69/* Stores a streamhost's (a.k.a. proxy) data */
70typedef struct {
71        char *jid;
72        char *host;
73        char port[6];
74} jabber_streamhost_t;
75
76typedef enum {
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
81struct jabber_data {
82        struct im_connection *ic;
83
84        int fd;
85        void *ssl;
86        char *txq;
87        int tx_len;
88        int r_inpa, w_inpa;
89
90        struct xt_parser *xt;
91        jabber_flags_t flags;
92
93        char *username;         /* USERNAME@server */
94        char *server;           /* username@SERVER -=> server/domain, not hostname */
95        char *me;               /* bare jid */
96        char *internal_jid;
97
98        const struct oauth2_service *oauth2_service;
99        char *oauth2_access_token;
100
101        /* After changing one of these two (or the priority setting), call
102           presence_send_update() to inform the server about the changes. */
103        const struct jabber_away_state *away_state;
104        char *away_message;
105        guint64 gmail_time;
106        char *gmail_tid;
107
108        md5_state_t cached_id_prefix;
109        GHashTable *node_cache;
110        GHashTable *buddies;
111
112        GSList *filetransfers;
113        GSList *streamhosts;
114        int have_streamhosts;
115};
116
117struct jabber_away_state {
118        char code[5];
119        char *full_name;
120};
121
122typedef xt_status (*jabber_cache_event) (struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
123
124struct jabber_cache_entry {
125        time_t saved_at;
126        struct xt_node *node;
127        jabber_cache_event func;
128};
129
130/* Somewhat messy data structure: We have a hash table with the bare JID as
131   the key and the head of a struct jabber_buddy list as the value. The head
132   is always a bare JID. If the JID has other resources (often the case,
133   except for some transports that don't support multiple resources), those
134   follow. In that case, the bare JID at the beginning doesn't actually
135   refer to a real session and should only be used for operations that
136   support incomplete JIDs. */
137struct jabber_buddy {
138        char *bare_jid;
139        char *full_jid;
140        char *resource;
141
142        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
143                       /* otherwise something similar to the conference JID. */
144
145        int priority;
146        struct jabber_away_state *away_state;
147        char *away_message;
148        GSList *features;
149
150        time_t last_msg;
151        jabber_buddy_flags_t flags;
152
153        struct jabber_buddy *next;
154};
155
156struct jabber_chat {
157        int flags;
158        char *name;
159        char *my_full_jid; /* Separate copy because of case sensitivity. */
160        struct jabber_buddy *me;
161        char *invite;
162};
163
164struct jabber_transfer {
165        /* bitlbee's handle for this transfer */
166        file_transfer_t *ft;
167
168        /* the stream's private handle */
169        gpointer streamhandle;
170
171        /* timeout for discover queries */
172        gint disco_timeout;
173        gint disco_timeout_fired;
174
175        struct im_connection *ic;
176
177        struct jabber_buddy *bud;
178
179        int watch_in;
180        int watch_out;
181
182        char *ini_jid;
183        char *tgt_jid;
184        char *iq_id;
185        char *sid;
186        int accepted;
187
188        size_t bytesread, byteswritten;
189        int fd;
190        struct sockaddr_storage saddr;
191};
192
193#define JABBER_XMLCONSOLE_HANDLE "_xmlconsole"
194#define JABBER_OAUTH_HANDLE "jabber_oauth"
195
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
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. :-) */
202#define JABBER_PACKET_ID "BeeP"
203#define JABBER_CACHED_ID "BeeC"
204
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
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 */
219#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
220#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
221#define XMLNS_TIME_OLD     "jabber:iq:time"                                      /* XEP-0090 */
222#define XMLNS_TIME         "urn:xmpp:time"                                       /* XEP-0202 */
223#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
224#define XMLNS_RECEIPTS     "urn:xmpp:receipts"                                   /* XEP-0184 */
225#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
226#define XMLNS_DELAY_OLD    "jabber:x:delay"                                      /* XEP-0091 */
227#define XMLNS_DELAY        "urn:xmpp:delay"                                      /* XEP-0203 */
228#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
229#define XMLNS_GMAILNOTIFY  "google:mail:notify"                                  /* Not a XEP */
230#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
231#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
232#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
233#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
234#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
235#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
236#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
237#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
238#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
239#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
240#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
241
242/* Hipchat protocol extensions*/
243#define XMLNS_HIPCHAT         "http://hipchat.com"
244#define XMLNS_HIPCHAT_PROFILE "http://hipchat.com/protocol/profile"
245#define XMLNS_HIPCHAT_MUC     "http://hipchat.com/protocol/muc#room"
246
247/* jabber.c */
248void jabber_connect(struct im_connection *ic);
249
250/* iq.c */
251xt_status jabber_pkt_iq(struct xt_node *node, gpointer data);
252int jabber_init_iq_auth(struct im_connection *ic);
253xt_status jabber_pkt_bind_sess(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
254int jabber_get_roster(struct im_connection *ic);
255int jabber_get_vcard(struct im_connection *ic, char *bare_jid);
256int jabber_iq_disco_muc(struct im_connection *ic, char *muc_server);
257int jabber_add_to_roster(struct im_connection *ic, const char *handle, const char *name, const char *group);
258int jabber_remove_from_roster(struct im_connection *ic, char *handle);
259xt_status jabber_iq_query_features(struct im_connection *ic, char *bare_jid);
260xt_status jabber_iq_query_server(struct im_connection *ic, char *jid, char *xmlns);
261void jabber_iq_version_send(struct im_connection *ic, struct jabber_buddy *bud, void *data);
262int jabber_iq_disco_server(struct im_connection *ic);
263
264/* si.c */
265int jabber_si_handle_request(struct im_connection *ic, struct xt_node *node, struct xt_node *sinode);
266void jabber_si_transfer_request(struct im_connection *ic, file_transfer_t *ft, char *who);
267void jabber_si_free_transfer(file_transfer_t *ft);
268
269/* s5bytestream.c */
270int jabber_bs_recv_request(struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
271gboolean jabber_bs_send_start(struct jabber_transfer *tf);
272gboolean jabber_bs_send_write(file_transfer_t *ft, char *buffer, unsigned int len);
273
274/* message.c */
275xt_status jabber_pkt_message(struct xt_node *node, gpointer data);
276
277/* presence.c */
278xt_status jabber_pkt_presence(struct xt_node *node, gpointer data);
279int presence_send_update(struct im_connection *ic);
280int presence_send_request(struct im_connection *ic, char *handle, char *request);
281
282/* jabber_util.c */
283char *set_eval_priority(set_t *set, char *value);
284char *set_eval_tls(set_t *set, char *value);
285struct xt_node *jabber_make_packet(char *name, char *type, char *to, struct xt_node *children);
286struct xt_node *jabber_make_error_packet(struct xt_node *orig, char *err_cond, char *err_type, char *err_code);
287void jabber_cache_add(struct im_connection *ic, struct xt_node *node, jabber_cache_event func);
288struct xt_node *jabber_cache_get(struct im_connection *ic, char *id);
289void jabber_cache_entry_free(gpointer entry);
290void jabber_cache_clean(struct im_connection *ic);
291xt_status jabber_cache_handle_packet(struct im_connection *ic, struct xt_node *node);
292const struct jabber_away_state *jabber_away_state_by_code(char *code);
293const struct jabber_away_state *jabber_away_state_by_name(char *name);
294void jabber_buddy_ask(struct im_connection *ic, char *handle);
295int jabber_compare_jid(const char *jid1, const char *jid2);
296char *jabber_normalize(const char *orig);
297
298typedef enum {
299        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
300        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
301        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
302        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
303        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
304} get_buddy_flags_t;
305
306struct jabber_error {
307        char *code, *text, *type;
308};
309
310struct jabber_buddy *jabber_buddy_add(struct im_connection *ic, char *full_jid);
311struct jabber_buddy *jabber_buddy_by_jid(struct im_connection *ic, char *jid, get_buddy_flags_t flags);
312struct jabber_buddy *jabber_buddy_by_ext_jid(struct im_connection *ic, char *jid, get_buddy_flags_t flags);
313int jabber_buddy_remove(struct im_connection *ic, char *full_jid);
314int jabber_buddy_remove_bare(struct im_connection *ic, char *bare_jid);
315void jabber_buddy_remove_all(struct im_connection *ic);
316time_t jabber_get_timestamp(struct xt_node *xt);
317struct jabber_error *jabber_error_parse(struct xt_node *node, char *xmlns);
318void jabber_error_free(struct jabber_error *err);
319gboolean jabber_set_me(struct im_connection *ic, const char *me);
320char *jabber_get_bare_jid(char *jid);
321
322extern const struct jabber_away_state jabber_away_state_list[];
323
324/* io.c */
325int jabber_write_packet(struct im_connection *ic, struct xt_node *node);
326int jabber_write(struct im_connection *ic, char *buf, int len);
327gboolean jabber_connected_plain(gpointer data, gint source, b_input_condition cond);
328gboolean jabber_connected_ssl(gpointer data, int returncode, void *source, b_input_condition cond);
329gboolean jabber_start_stream(struct im_connection *ic);
330void jabber_end_stream(struct im_connection *ic);
331
332/* sasl.c */
333xt_status sasl_pkt_mechanisms(struct xt_node *node, gpointer data);
334xt_status sasl_pkt_challenge(struct xt_node *node, gpointer data);
335xt_status sasl_pkt_result(struct xt_node *node, gpointer data);
336gboolean sasl_supported(struct im_connection *ic);
337void sasl_oauth2_init(struct im_connection *ic);
338int sasl_oauth2_get_refresh_token(struct im_connection *ic, const char *msg);
339int sasl_oauth2_refresh(struct im_connection *ic, const char *refresh_token);
340
341extern const struct oauth2_service oauth2_service_google;
342extern const struct oauth2_service oauth2_service_facebook;
343
344/* conference.c */
345struct groupchat *jabber_chat_join(struct im_connection *ic, const char *room, const char *nick, const char *password);
346struct groupchat *jabber_chat_with(struct im_connection *ic, char *who);
347struct groupchat *jabber_chat_by_jid(struct im_connection *ic, const char *name);
348void jabber_chat_free(struct groupchat *c);
349int jabber_chat_msg(struct groupchat *ic, char *message, int flags);
350int jabber_chat_topic(struct groupchat *c, char *topic);
351int jabber_chat_leave(struct groupchat *c, const char *reason);
352void jabber_chat_pkt_presence(struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node);
353void jabber_chat_pkt_message(struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node);
354void jabber_chat_invite(struct groupchat *c, char *who, char *message);
355
356/* hipchat.c */
357int jabber_get_hipchat_profile(struct im_connection *ic);
358xt_status jabber_parse_hipchat_profile(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
359xt_status hipchat_handle_success(struct im_connection *ic, struct xt_node *node);
360xt_status jabber_parse_muc_list(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
361
362#endif
Note: See TracBrowser for help on using the repository browser.