source: protocols/jabber/jabber.h @ 0b9daac

Last change on this file since 0b9daac was 0b9daac, checked in by dequis <dx@…>, at 2015-02-20T23:16:08Z

Reorganize include files to avoid conflicts with other libs

  • Change all header includes to be relative to the project root
  • Remove -I${includedir} from bitlbee.pc Cflags
  • Install lib and protocols headers to their own directories. So now it is:

/usr/include/bitlbee/*.h
/usr/include/bitlbee/lib/*.h
/usr/include/bitlbee/protocols/*.h

This breaks backwards compatibility of third party plugins, but now
they don't have to do ambiguous includes like #include <proxy.h>

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