Context Navigation

source: protocols/jabber/jabber.h @ e618d85

Last change on this file since e618d85 was 34ded90, checked in by Wilmer van der Gaast <wilmer@…>, at 2011-12-24T18:09:05Z
Slight cleanup: Use a constant instead of just "jabber_oauth" everywhere, and added some safeguards to keep the user from messaging it when we're not actually doing OAuth setup.
Property mode set to `100644`
File size: 15.0 KB

Line
1	/***************************************************************************\
2	* *
3	* BitlBee - An IRC to IM gateway *
4	* Jabber module - Main file *
5	* *
6	* Copyright 2006 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
33	extern GSList *jabber_connections;
34
35	typedef enum
36	{
37	JFLAG_STREAM_STARTED = 1, /* Set when we detected the beginning of the stream
38	and want to do auth. */
39	JFLAG_AUTHENTICATED = 2, /* Set when we're successfully authenticatd. */
40	JFLAG_STREAM_RESTART = 4, /* Set when we want to restart the stream (after
41	SASL or TLS). */
42	JFLAG_WANT_SESSION = 8, /* Set if the server wants a <session/> tag
43	before we continue. */
44	JFLAG_WANT_BIND = 16, /* ... for <bind> tag. */
45	JFLAG_WANT_TYPING = 32, /* Set if we ever sent a typing notification, this
46	activates all XEP-85 related code. */
47	JFLAG_XMLCONSOLE = 64, /* If the user added an xmlconsole buddy. */
48	JFLAG_STARTTLS_DONE = 128, /* If a plaintext session was converted to TLS. */
49
50	JFLAG_SASL_FB = 0x10000, /* Trying Facebook authentication. */
51	} jabber_flags_t;
52
53	typedef enum
54	{
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 */
68	typedef struct
69	{
70	char *jid;
71	char *host;
72	char port[6];
73	} jabber_streamhost_t;
74
75	typedef enum
76	{
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
81	struct jabber_data
82	{
83	struct im_connection *ic;
84
85	int fd;
86	void *ssl;
87	char *txq;
88	int tx_len;
89	int r_inpa, w_inpa;
90
91	struct xt_parser *xt;
92	jabber_flags_t flags;
93
94	char username; / USERNAME@server */
95	char server; / username@SERVER -=> server/domain, not hostname */
96	char me; / bare 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
106	md5_state_t cached_id_prefix;
107	GHashTable *node_cache;
108	GHashTable *buddies;
109
110	GSList *filetransfers;
111	GSList *streamhosts;
112	int have_streamhosts;
113	};
114
115	struct jabber_away_state
116	{
117	char code[5];
118	char *full_name;
119	};
120
121	typedef xt_status (jabber_cache_event) ( struct im_connection ic, struct xt_node node, struct xt_node orig );
122
123	struct jabber_cache_entry
124	{
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. */
137	struct jabber_buddy
138	{
139	char *bare_jid;
140	char *full_jid;
141	char *resource;
142
143	char ext_jid; / The JID to use in BitlBee. The real JID if possible, */
144	/* otherwise something similar to the conference JID. */
145
146	int priority;
147	struct jabber_away_state *away_state;
148	char *away_message;
149	GSList *features;
150
151	time_t last_msg;
152	jabber_buddy_flags_t flags;
153
154	struct jabber_buddy *next;
155	};
156
157	struct jabber_chat
158	{
159	int flags;
160	char *name;
161	char my_full_jid; / Separate copy because of case sensitivity. */
162	struct jabber_buddy *me;
163	};
164
165	struct jabber_transfer
166	{
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_VCARD "vcard-temp" /* XEP-0054 */
227	#define XMLNS_DELAY "jabber:x:delay" /* XEP-0091 */
228	#define XMLNS_XDATA "jabber:x:data" /* XEP-0004 */
229	#define XMLNS_CHATSTATES "http://jabber.org/protocol/chatstates" /* XEP-0085 */
230	#define XMLNS_DISCO_INFO "http://jabber.org/protocol/disco#info" /* XEP-0030 */
231	#define XMLNS_DISCO_ITEMS "http://jabber.org/protocol/disco#items" /* XEP-0030 */
232	#define XMLNS_MUC "http://jabber.org/protocol/muc" /* XEP-0045 */
233	#define XMLNS_MUC_USER "http://jabber.org/protocol/muc#user" /* XEP-0045 */
234	#define XMLNS_CAPS "http://jabber.org/protocol/caps" /* XEP-0115 */
235	#define XMLNS_FEATURE "http://jabber.org/protocol/feature-neg" /* XEP-0020 */
236	#define XMLNS_SI "http://jabber.org/protocol/si" /* XEP-0095 */
237	#define XMLNS_FILETRANSFER "http://jabber.org/protocol/si/profile/file-transfer" /* XEP-0096 */
238	#define XMLNS_BYTESTREAMS "http://jabber.org/protocol/bytestreams" /* XEP-0065 */
239	#define XMLNS_IBB "http://jabber.org/protocol/ibb" /* XEP-0047 */
240
241	/* jabber.c */
242	void jabber_connect( struct im_connection *ic );
243
244	/* iq.c */
245	xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
246	int jabber_init_iq_auth( struct im_connection *ic );
247	xt_status jabber_pkt_bind_sess( struct im_connection ic, struct xt_node node, struct xt_node *orig );
248	int jabber_get_roster( struct im_connection *ic );
249	int jabber_get_vcard( struct im_connection ic, char bare_jid );
250	int jabber_add_to_roster( struct im_connection ic, const char handle, const char name, const char group );
251	int jabber_remove_from_roster( struct im_connection ic, char handle );
252	xt_status jabber_iq_query_features( struct im_connection ic, char bare_jid );
253	xt_status jabber_iq_query_server( struct im_connection ic, char jid, char *xmlns );
254	void jabber_iq_version_send( struct im_connection ic, struct jabber_buddy bud, void *data );
255
256	/* si.c */
257	int jabber_si_handle_request( struct im_connection ic, struct xt_node node, struct xt_node *sinode );
258	void jabber_si_transfer_request( struct im_connection ic, file_transfer_t ft, char *who );
259	void jabber_si_free_transfer( file_transfer_t *ft);
260
261	/* s5bytestream.c */
262	int jabber_bs_recv_request( struct im_connection ic, struct xt_node node, struct xt_node *qnode);
263	gboolean jabber_bs_send_start( struct jabber_transfer *tf );
264	gboolean jabber_bs_send_write( file_transfer_t ft, char buffer, unsigned int len );
265
266	/* message.c */
267	xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
268
269	/* presence.c */
270	xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
271	int presence_send_update( struct im_connection *ic );
272	int presence_send_request( struct im_connection ic, char handle, char *request );
273
274	/* jabber_util.c */
275	char set_eval_priority( set_t set, char *value );
276	char set_eval_tls( set_t set, char *value );
277	struct xt_node jabber_make_packet( char name, char type, char to, struct xt_node *children );
278	struct xt_node jabber_make_error_packet( struct xt_node orig, char err_cond, char err_type, char *err_code );
279	void jabber_cache_add( struct im_connection ic, struct xt_node node, jabber_cache_event func );
280	struct xt_node jabber_cache_get( struct im_connection ic, char *id );
281	void jabber_cache_entry_free( gpointer entry );
282	void jabber_cache_clean( struct im_connection *ic );
283	xt_status jabber_cache_handle_packet( struct im_connection ic, struct xt_node node );
284	const struct jabber_away_state jabber_away_state_by_code( char code );
285	const struct jabber_away_state jabber_away_state_by_name( char name );
286	void jabber_buddy_ask( struct im_connection ic, char handle );
287	char jabber_normalize( const char orig );
288
289	typedef enum
290	{
291	GET_BUDDY_CREAT = 1, /* Try to create it, if necessary. */
292	GET_BUDDY_EXACT = 2, /* Get an exact match (only makes sense with bare JIDs). */
293	GET_BUDDY_FIRST = 4, /* No selection, simply get the first resource for this JID. */
294	GET_BUDDY_BARE = 8, /* Get the bare version of the JID (possibly inexistent). */
295	GET_BUDDY_BARE_OK = 16, /* Allow returning a bare JID if that seems better. */
296	} get_buddy_flags_t;
297
298	struct jabber_error
299	{
300	char code, text, *type;
301	};
302
303	struct jabber_buddy jabber_buddy_add( struct im_connection ic, char *full_jid );
304	struct jabber_buddy jabber_buddy_by_jid( struct im_connection ic, char *jid, get_buddy_flags_t flags );
305	struct jabber_buddy jabber_buddy_by_ext_jid( struct im_connection ic, char *jid, get_buddy_flags_t flags );
306	int jabber_buddy_remove( struct im_connection ic, char full_jid );
307	int jabber_buddy_remove_bare( struct im_connection ic, char bare_jid );
308	void jabber_buddy_remove_all( struct im_connection *ic );
309	time_t jabber_get_timestamp( struct xt_node *xt );
310	struct jabber_error jabber_error_parse( struct xt_node node, char *xmlns );
311	void jabber_error_free( struct jabber_error *err );
312	gboolean jabber_set_me( struct im_connection ic, const char me );
313
314	extern const struct jabber_away_state jabber_away_state_list[];
315
316	/* io.c */
317	int jabber_write_packet( struct im_connection ic, struct xt_node node );
318	int jabber_write( struct im_connection ic, char buf, int len );
319	gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
320	gboolean jabber_connected_ssl( gpointer data, int returncode, void *source, b_input_condition cond );
321	gboolean jabber_start_stream( struct im_connection *ic );
322	void jabber_end_stream( struct im_connection *ic );
323
324	/* sasl.c */
325	xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
326	xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
327	xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
328	gboolean sasl_supported( struct im_connection *ic );
329	void sasl_oauth2_init( struct im_connection *ic );
330	int sasl_oauth2_get_refresh_token( struct im_connection ic, const char msg );
331	int sasl_oauth2_refresh( struct im_connection ic, const char refresh_token );
332
333	extern const struct oauth2_service oauth2_service_google;
334	extern const struct oauth2_service oauth2_service_facebook;
335	extern const struct oauth2_service oauth2_service_mslive;
336
337	/* conference.c */
338	struct groupchat jabber_chat_join( struct im_connection ic, const char room, const char nick, const char *password );
339	struct groupchat jabber_chat_by_jid( struct im_connection ic, const char *name );
340	void jabber_chat_free( struct groupchat *c );
341	int jabber_chat_msg( struct groupchat ic, char message, int flags );
342	int jabber_chat_topic( struct groupchat c, char topic );
343	int jabber_chat_leave( struct groupchat c, const char reason );
344	void jabber_chat_pkt_presence( struct im_connection ic, struct jabber_buddy bud, struct xt_node *node );
345	void jabber_chat_pkt_message( struct im_connection ic, struct jabber_buddy bud, struct xt_node *node );
346	void jabber_chat_invite( struct groupchat c, char who, char *message );
347
348	#endif

Note: See TracBrowser for help on using the repository browser.

Download in other formats: