source: protocols/jabber/jabber.h @ 830864d

Last change on this file since 830864d was 0e4c3dd, checked in by dequis <dx@…>, at 2015-02-21T06:18:21Z

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