source: protocols/jabber/jabber.h @ ad9ac5d

Last change on this file since ad9ac5d was 9c8dbc7, checked in by dequis <dx@…>, at 2015-11-23T17:49:09Z

hipchat: 'chat add hipchat "channel name"' now tries to guess the JID

It's basically prepending the organization id, appending the default MUC
host from the success packet, and generating a slug based on the name
for the middle part, which is replacing a few characters with
underscores and doing a unicode aware lowercasing.

Includes tests, which are useless other than validating the initial
implementation with the test vectors that i already tested manually.
Guaranteed to detect zero breakages in the future. Good test code.
  • Property mode set to 100644
File size: 16.3 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        char *muc_host;
117};
118
119struct jabber_away_state {
120        char code[5];
121        char *full_name;
122};
123
124typedef xt_status (*jabber_cache_event) (struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
125
126struct jabber_cache_entry {
127        time_t saved_at;
128        struct xt_node *node;
129        jabber_cache_event func;
130};
131
132/* Somewhat messy data structure: We have a hash table with the bare JID as
133   the key and the head of a struct jabber_buddy list as the value. The head
134   is always a bare JID. If the JID has other resources (often the case,
135   except for some transports that don't support multiple resources), those
136   follow. In that case, the bare JID at the beginning doesn't actually
137   refer to a real session and should only be used for operations that
138   support incomplete JIDs. */
139struct jabber_buddy {
140        char *bare_jid;
141        char *full_jid;
142        char *resource;
143
144        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
145                       /* otherwise something similar to the conference JID. */
146
147        int priority;
148        struct jabber_away_state *away_state;
149        char *away_message;
150        GSList *features;
151
152        time_t last_msg;
153        jabber_buddy_flags_t flags;
154
155        struct jabber_buddy *next;
156};
157
158struct jabber_chat {
159        int flags;
160        char *name;
161        char *my_full_jid; /* Separate copy because of case sensitivity. */
162        struct jabber_buddy *me;
163        char *invite;
164};
165
166struct jabber_transfer {
167        /* bitlbee's handle for this transfer */
168        file_transfer_t *ft;
169
170        /* the stream's private handle */
171        gpointer streamhandle;
172
173        /* timeout for discover queries */
174        gint disco_timeout;
175        gint disco_timeout_fired;
176
177        struct im_connection *ic;
178
179        struct jabber_buddy *bud;
180
181        int watch_in;
182        int watch_out;
183
184        char *ini_jid;
185        char *tgt_jid;
186        char *iq_id;
187        char *sid;
188        int accepted;
189
190        size_t bytesread, byteswritten;
191        int fd;
192        struct sockaddr_storage saddr;
193};
194
195#define JABBER_XMLCONSOLE_HANDLE "_xmlconsole"
196#define JABBER_OAUTH_HANDLE "jabber_oauth"
197
198/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
199   first one should be used, but when storing a packet in the cache, a
200   "special" kind of ID is assigned to make it easier later to figure out
201   if we have to do call an event handler for the response packet. Also
202   we'll append a hash to make sure we won't trigger on cached packets from
203   other BitlBee users. :-) */
204#define JABBER_PACKET_ID "BeeP"
205#define JABBER_CACHED_ID "BeeC"
206
207/* The number of seconds to keep cached packets before garbage collecting
208   them. This gc is done on every keepalive (every minute). */
209#define JABBER_CACHE_MAX_AGE 600
210
211/* RFC 392[01] stuff */
212#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
213#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
214#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
215#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
216#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
217#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
218#define XMLNS_ROSTER       "jabber:iq:roster"
219
220/* Some supported extensions/legacy stuff */
221#define XMLNS_AUTH         "jabber:iq:auth"                                      /* XEP-0078 */
222#define XMLNS_VERSION      "jabber:iq:version"                                   /* XEP-0092 */
223#define XMLNS_TIME_OLD     "jabber:iq:time"                                      /* XEP-0090 */
224#define XMLNS_TIME         "urn:xmpp:time"                                       /* XEP-0202 */
225#define XMLNS_PING         "urn:xmpp:ping"                                       /* XEP-0199 */
226#define XMLNS_RECEIPTS     "urn:xmpp:receipts"                                   /* XEP-0184 */
227#define XMLNS_VCARD        "vcard-temp"                                          /* XEP-0054 */
228#define XMLNS_DELAY_OLD    "jabber:x:delay"                                      /* XEP-0091 */
229#define XMLNS_DELAY        "urn:xmpp:delay"                                      /* XEP-0203 */
230#define XMLNS_XDATA        "jabber:x:data"                                       /* XEP-0004 */
231#define XMLNS_GMAILNOTIFY  "google:mail:notify"                                  /* Not a XEP */
232#define XMLNS_CARBONS      "urn:xmpp:carbons:2"                                  /* XEP-0280 */
233#define XMLNS_FORWARDING   "urn:xmpp:forward:0"                                  /* XEP-0297 */
234#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"               /* XEP-0085 */
235#define XMLNS_DISCO_INFO   "http://jabber.org/protocol/disco#info"               /* XEP-0030 */
236#define XMLNS_DISCO_ITEMS  "http://jabber.org/protocol/disco#items"              /* XEP-0030 */
237#define XMLNS_MUC          "http://jabber.org/protocol/muc"                      /* XEP-0045 */
238#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"                 /* XEP-0045 */
239#define XMLNS_CAPS         "http://jabber.org/protocol/caps"                     /* XEP-0115 */
240#define XMLNS_FEATURE      "http://jabber.org/protocol/feature-neg"              /* XEP-0020 */
241#define XMLNS_SI           "http://jabber.org/protocol/si"                       /* XEP-0095 */
242#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
243#define XMLNS_BYTESTREAMS  "http://jabber.org/protocol/bytestreams"              /* XEP-0065 */
244#define XMLNS_IBB          "http://jabber.org/protocol/ibb"                      /* XEP-0047 */
245
246/* Hipchat protocol extensions*/
247#define XMLNS_HIPCHAT         "http://hipchat.com"
248#define XMLNS_HIPCHAT_PROFILE "http://hipchat.com/protocol/profile"
249
250/* jabber.c */
251void jabber_connect(struct im_connection *ic);
252
253/* iq.c */
254xt_status jabber_pkt_iq(struct xt_node *node, gpointer data);
255int jabber_init_iq_auth(struct im_connection *ic);
256xt_status jabber_pkt_bind_sess(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
257int jabber_get_roster(struct im_connection *ic);
258int jabber_get_vcard(struct im_connection *ic, char *bare_jid);
259int jabber_add_to_roster(struct im_connection *ic, const char *handle, const char *name, const char *group);
260int jabber_remove_from_roster(struct im_connection *ic, char *handle);
261xt_status jabber_iq_query_features(struct im_connection *ic, char *bare_jid);
262xt_status jabber_iq_query_server(struct im_connection *ic, char *jid, char *xmlns);
263void jabber_iq_version_send(struct im_connection *ic, struct jabber_buddy *bud, void *data);
264int jabber_iq_disco_server(struct im_connection *ic);
265
266/* si.c */
267int jabber_si_handle_request(struct im_connection *ic, struct xt_node *node, struct xt_node *sinode);
268void jabber_si_transfer_request(struct im_connection *ic, file_transfer_t *ft, char *who);
269void jabber_si_free_transfer(file_transfer_t *ft);
270
271/* s5bytestream.c */
272int jabber_bs_recv_request(struct im_connection *ic, struct xt_node *node, struct xt_node *qnode);
273gboolean jabber_bs_send_start(struct jabber_transfer *tf);
274gboolean jabber_bs_send_write(file_transfer_t *ft, char *buffer, unsigned int len);
275
276/* message.c */
277xt_status jabber_pkt_message(struct xt_node *node, gpointer data);
278
279/* presence.c */
280xt_status jabber_pkt_presence(struct xt_node *node, gpointer data);
281int presence_send_update(struct im_connection *ic);
282int presence_send_request(struct im_connection *ic, char *handle, char *request);
283
284/* jabber_util.c */
285char *set_eval_priority(set_t *set, char *value);
286char *set_eval_tls(set_t *set, char *value);
287struct xt_node *jabber_make_packet(char *name, char *type, char *to, struct xt_node *children);
288struct xt_node *jabber_make_error_packet(struct xt_node *orig, char *err_cond, char *err_type, char *err_code);
289void jabber_cache_add(struct im_connection *ic, struct xt_node *node, jabber_cache_event func);
290struct xt_node *jabber_cache_get(struct im_connection *ic, char *id);
291void jabber_cache_entry_free(gpointer entry);
292void jabber_cache_clean(struct im_connection *ic);
293xt_status jabber_cache_handle_packet(struct im_connection *ic, struct xt_node *node);
294const struct jabber_away_state *jabber_away_state_by_code(char *code);
295const struct jabber_away_state *jabber_away_state_by_name(char *name);
296void jabber_buddy_ask(struct im_connection *ic, char *handle);
297int jabber_compare_jid(const char *jid1, const char *jid2);
298char *jabber_normalize(const char *orig);
299
300typedef enum {
301        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
302        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
303        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
304        GET_BUDDY_BARE = 8,     /* Get the bare version of the JID (possibly inexistent). */
305        GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
306} get_buddy_flags_t;
307
308struct jabber_error {
309        char *code, *text, *type;
310};
311
312struct jabber_buddy *jabber_buddy_add(struct im_connection *ic, char *full_jid);
313struct jabber_buddy *jabber_buddy_by_jid(struct im_connection *ic, char *jid, get_buddy_flags_t flags);
314struct jabber_buddy *jabber_buddy_by_ext_jid(struct im_connection *ic, char *jid, get_buddy_flags_t flags);
315int jabber_buddy_remove(struct im_connection *ic, char *full_jid);
316int jabber_buddy_remove_bare(struct im_connection *ic, char *bare_jid);
317void jabber_buddy_remove_all(struct im_connection *ic);
318time_t jabber_get_timestamp(struct xt_node *xt);
319struct jabber_error *jabber_error_parse(struct xt_node *node, char *xmlns);
320void jabber_error_free(struct jabber_error *err);
321gboolean jabber_set_me(struct im_connection *ic, const char *me);
322char *jabber_get_bare_jid(char *jid);
323
324extern const struct jabber_away_state jabber_away_state_list[];
325
326/* io.c */
327int jabber_write_packet(struct im_connection *ic, struct xt_node *node);
328int jabber_write(struct im_connection *ic, char *buf, int len);
329gboolean jabber_connected_plain(gpointer data, gint source, b_input_condition cond);
330gboolean jabber_connected_ssl(gpointer data, int returncode, void *source, b_input_condition cond);
331gboolean jabber_start_stream(struct im_connection *ic);
332void jabber_end_stream(struct im_connection *ic);
333
334/* sasl.c */
335xt_status sasl_pkt_mechanisms(struct xt_node *node, gpointer data);
336xt_status sasl_pkt_challenge(struct xt_node *node, gpointer data);
337xt_status sasl_pkt_result(struct xt_node *node, gpointer data);
338gboolean sasl_supported(struct im_connection *ic);
339void sasl_oauth2_init(struct im_connection *ic);
340int sasl_oauth2_get_refresh_token(struct im_connection *ic, const char *msg);
341int sasl_oauth2_refresh(struct im_connection *ic, const char *refresh_token);
342
343extern const struct oauth2_service oauth2_service_google;
344extern const struct oauth2_service oauth2_service_facebook;
345
346/* conference.c */
347struct groupchat *jabber_chat_join(struct im_connection *ic, const char *room, const char *nick, const char *password);
348struct groupchat *jabber_chat_with(struct im_connection *ic, char *who);
349struct groupchat *jabber_chat_by_jid(struct im_connection *ic, const char *name);
350void jabber_chat_free(struct groupchat *c);
351int jabber_chat_msg(struct groupchat *ic, char *message, int flags);
352int jabber_chat_topic(struct groupchat *c, char *topic);
353int jabber_chat_leave(struct groupchat *c, const char *reason);
354void jabber_chat_pkt_presence(struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node);
355void jabber_chat_pkt_message(struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node);
356void jabber_chat_invite(struct groupchat *c, char *who, char *message);
357
358/* hipchat.c */
359int jabber_get_hipchat_profile(struct im_connection *ic);
360xt_status jabber_parse_hipchat_profile(struct im_connection *ic, struct xt_node *node, struct xt_node *orig);
361xt_status hipchat_handle_success(struct im_connection *ic, struct xt_node *node);
362char *hipchat_make_channel_slug(const char *name);
363char *hipchat_guess_channel_name(struct im_connection *ic, const char *name);
364
365#endif
Note: See TracBrowser for help on using the repository browser.