source: protocols/jabber/jabber.h @ c82a88d

Last change on this file since c82a88d was 40cfbc5, checked in by dequis <dx@…>, at 2015-04-28T13:47:48Z

hipchat: Basic implementation: Auth, profile and mention names

This is enough to log in with their usernames, make 'chat add' based
groupchat joins slightly more smooth, and see mention names as nicks.

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