source: protocols/jabber/jabber.h @ 979cfb4

Last change on this file since 979cfb4 was 979cfb4, checked in by Wilmer van der Gaast <wilmer@…>, at 2008-02-03T13:54:19Z

Saner garbage collection of cached packets in the Jabber module. Now
cached packets are removed after about ten minues instead of something
between one and two minutes. Closes one issue in #354.

  • Property mode set to 100644
File size: 10.7 KB
RevLine 
[f06894d]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 "xmltree.h"
30#include "bitlbee.h"
31
[b5c8a34]32extern GSList *jabber_connections;
33
[21167d2]34typedef enum
35{
[bb95d43]36        JFLAG_STREAM_STARTED = 1,       /* Set when we detected the beginning of the stream
[a21a8ac]37                                           and want to do auth. */
[bb95d43]38        JFLAG_AUTHENTICATED = 2,        /* Set when we're successfully authenticatd. */
39        JFLAG_STREAM_RESTART = 4,       /* Set when we want to restart the stream (after
[a21a8ac]40                                           SASL or TLS). */
[bb95d43]41        JFLAG_WAIT_SESSION = 8,         /* Set if we sent a <session> tag and need a reply
[a21a8ac]42                                           before we continue. */
[bb95d43]43        JFLAG_WAIT_BIND = 16,           /* ... for <bind> tag. */
44        JFLAG_WANT_TYPING = 32,         /* Set if we ever sent a typing notification, this
[788a1af]45                                           activates all XEP-85 related code. */
[bb95d43]46        JFLAG_XMLCONSOLE = 64,          /* If the user added an xmlconsole buddy. */
[21167d2]47} jabber_flags_t;
48
[a21a8ac]49typedef enum
50{
[788a1af]51        JBFLAG_PROBED_XEP85 = 1,        /* Set this when we sent our probe packet to make
[a21a8ac]52                                           sure it gets sent only once. */
[788a1af]53        JBFLAG_DOES_XEP85 = 2,          /* Set this when the resource seems to support
54                                           XEP85 (typing notification shite). */
[e35d1a1]55        JBFLAG_IS_CHATROOM = 4,         /* It's convenient to use this JID thingy for
56                                           groupchat state info too. */
[6286f80]57        JBFLAG_IS_ANONYMOUS = 8,        /* For anonymous chatrooms, when we don't have
58                                           have a real JID. */
[0d3f30f]59} jabber_buddy_flags_t;
[a21a8ac]60
[5e202b0]61struct jabber_data
62{
[0da65d5]63        struct im_connection *ic;
[5e202b0]64       
65        int fd;
66        void *ssl;
67        char *txq;
68        int tx_len;
69        int r_inpa, w_inpa;
70       
71        struct xt_parser *xt;
72        jabber_flags_t flags;
73       
74        char *username;         /* USERNAME@server */
75        char *server;           /* username@SERVER -=> server/domain, not hostname */
[172a73f1]76       
77        /* After changing one of these two (or the priority setting), call
78           presence_send_update() to inform the server about the changes. */
[5e202b0]79        struct jabber_away_state *away_state;
80        char *away_message;
81       
[608f8cf]82        char *cached_id_prefix;
[038d17f]83        GHashTable *node_cache;
[6a1128d]84        GHashTable *buddies;
[5e202b0]85};
86
87struct jabber_away_state
88{
89        char code[5];
90        char *full_name;
91};
92
[0da65d5]93typedef xt_status (*jabber_cache_event) ( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
[038d17f]94
95struct jabber_cache_entry
96{
[979cfb4]97        time_t saved_at;
[038d17f]98        struct xt_node *node;
99        jabber_cache_event func;
100};
101
[6a1128d]102struct jabber_buddy
103{
[0d3f30f]104        char *bare_jid;
[a21a8ac]105        char *full_jid;
[6a1128d]106        char *resource;
107       
[6286f80]108        char *ext_jid; /* The JID to use in BitlBee. The real JID if possible, */
109                       /* otherwise something similar to the conference JID. */
[e35d1a1]110       
[6a1128d]111        int priority;
112        struct jabber_away_state *away_state;
113        char *away_message;
114       
115        time_t last_act;
[0d3f30f]116        jabber_buddy_flags_t flags;
[6a1128d]117       
118        struct jabber_buddy *next;
119};
120
[e35d1a1]121struct jabber_chat
122{
123        int flags;
124        char *name;
[9c9b37c]125        char *my_full_jid; /* Separate copy because of case sensitivity. */
[e35d1a1]126        struct jabber_buddy *me;
127};
128
[bb95d43]129#define JABBER_XMLCONSOLE_HANDLE "xmlconsole"
130
131#define JABBER_PORT_DEFAULT "5222"
132#define JABBER_PORT_MIN 5220
133#define JABBER_PORT_MAX 5229
134
[dfa41a4]135/* Prefixes to use for packet IDs (mainly for IQ packets ATM). Usually the
136   first one should be used, but when storing a packet in the cache, a
137   "special" kind of ID is assigned to make it easier later to figure out
[608f8cf]138   if we have to do call an event handler for the response packet. Also
139   we'll append a hash to make sure we won't trigger on cached packets from
140   other BitlBee users. :-) */
[dfa41a4]141#define JABBER_PACKET_ID "BeeP"
142#define JABBER_CACHED_ID "BeeC"
143
[979cfb4]144/* The number of seconds to keep cached packets before garbage collecting
145   them. This gc is done on every keepalive (every minute). */
146#define JABBER_CACHE_MAX_AGE 600
147
[47d3ac4]148/* RFC 392[01] stuff */
149#define XMLNS_TLS          "urn:ietf:params:xml:ns:xmpp-tls"
150#define XMLNS_SASL         "urn:ietf:params:xml:ns:xmpp-sasl"
151#define XMLNS_BIND         "urn:ietf:params:xml:ns:xmpp-bind"
152#define XMLNS_SESSION      "urn:ietf:params:xml:ns:xmpp-session"
153#define XMLNS_STANZA_ERROR "urn:ietf:params:xml:ns:xmpp-stanzas"
154#define XMLNS_STREAM_ERROR "urn:ietf:params:xml:ns:xmpp-streams"
155#define XMLNS_ROSTER       "jabber:iq:roster"
156
157/* Some supported extensions/legacy stuff */
158#define XMLNS_AUTH         "jabber:iq:auth"                     /* XEP-0078 */
159#define XMLNS_VERSION      "jabber:iq:version"                  /* XEP-0092 */
160#define XMLNS_TIME         "jabber:iq:time"                     /* XEP-0090 */
[529078a]161#define XMLNS_PING         "urn:xmpp:ping"                      /* XEP-0199 */
[47d3ac4]162#define XMLNS_VCARD        "vcard-temp"                         /* XEP-0054 */
[43671b9]163#define XMLNS_DELAY        "jabber:x:delay"                     /* XEP-0091 */
[47d3ac4]164#define XMLNS_CHATSTATES   "http://jabber.org/protocol/chatstates"  /* 0085 */
165#define XMLNS_DISCOVER     "http://jabber.org/protocol/disco#info"  /* 0030 */
[e35d1a1]166#define XMLNS_MUC          "http://jabber.org/protocol/muc"     /* XEP-0045 */
167#define XMLNS_MUC_USER     "http://jabber.org/protocol/muc#user"/* XEP-0045 */
[47d3ac4]168
[21167d2]169/* iq.c */
[f06894d]170xt_status jabber_pkt_iq( struct xt_node *node, gpointer data );
[0da65d5]171int jabber_init_iq_auth( struct im_connection *ic );
172xt_status jabber_pkt_bind_sess( struct im_connection *ic, struct xt_node *node, struct xt_node *orig );
173int jabber_get_roster( struct im_connection *ic );
174int jabber_get_vcard( struct im_connection *ic, char *bare_jid );
175int jabber_add_to_roster( struct im_connection *ic, char *handle, char *name );
176int jabber_remove_from_roster( struct im_connection *ic, char *handle );
[21167d2]177
[cfbb3a6]178/* message.c */
[f06894d]179xt_status jabber_pkt_message( struct xt_node *node, gpointer data );
[0b4a0db]180
181/* presence.c */
[f06894d]182xt_status jabber_pkt_presence( struct xt_node *node, gpointer data );
[0da65d5]183int presence_send_update( struct im_connection *ic );
184int presence_send_request( struct im_connection *ic, char *handle, char *request );
[f06894d]185
[21167d2]186/* jabber_util.c */
[ebe7b36]187char *set_eval_priority( set_t *set, char *value );
[f06894d]188char *set_eval_tls( set_t *set, char *value );
[21167d2]189struct xt_node *jabber_make_packet( char *name, char *type, char *to, struct xt_node *children );
[259edd4]190struct xt_node *jabber_make_error_packet( struct xt_node *orig, char *err_cond, char *err_type );
[0da65d5]191void jabber_cache_add( struct im_connection *ic, struct xt_node *node, jabber_cache_event func );
192struct xt_node *jabber_cache_get( struct im_connection *ic, char *id );
[038d17f]193void jabber_cache_entry_free( gpointer entry );
[0da65d5]194void jabber_cache_clean( struct im_connection *ic );
[4306d8b]195xt_status jabber_cache_handle_packet( struct im_connection *ic, struct xt_node *node );
[5e202b0]196const struct jabber_away_state *jabber_away_state_by_code( char *code );
197const struct jabber_away_state *jabber_away_state_by_name( char *name );
[0da65d5]198void jabber_buddy_ask( struct im_connection *ic, char *handle );
[e35d1a1]199char *jabber_normalize( const char *orig );
[0d3f30f]200
201typedef enum
202{
203        GET_BUDDY_CREAT = 1,    /* Try to create it, if necessary. */
[e35d1a1]204        GET_BUDDY_EXACT = 2,    /* Get an exact match (only makes sense with bare JIDs). */
205        GET_BUDDY_FIRST = 4,    /* No selection, simply get the first resource for this JID. */
[0d3f30f]206} get_buddy_flags_t;
207
[1baaef8]208struct jabber_error
209{
210        char *code, *text, *type;
211};
212
[0da65d5]213struct jabber_buddy *jabber_buddy_add( struct im_connection *ic, char *full_jid );
214struct jabber_buddy *jabber_buddy_by_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[b9f8b87]215struct jabber_buddy *jabber_buddy_by_ext_jid( struct im_connection *ic, char *jid, get_buddy_flags_t flags );
[0da65d5]216int jabber_buddy_remove( struct im_connection *ic, char *full_jid );
217int jabber_buddy_remove_bare( struct im_connection *ic, char *bare_jid );
[43671b9]218time_t jabber_get_timestamp( struct xt_node *xt );
[1baaef8]219struct jabber_error *jabber_error_parse( struct xt_node *node, char *xmlns );
220void jabber_error_free( struct jabber_error *err );
[5e202b0]221
222extern const struct jabber_away_state jabber_away_state_list[];
[21167d2]223
224/* io.c */
[0da65d5]225int jabber_write_packet( struct im_connection *ic, struct xt_node *node );
226int jabber_write( struct im_connection *ic, char *buf, int len );
[21167d2]227gboolean jabber_connected_plain( gpointer data, gint source, b_input_condition cond );
[42127dc]228gboolean jabber_connected_ssl( gpointer data, void *source, b_input_condition cond );
[0da65d5]229gboolean jabber_start_stream( struct im_connection *ic );
230void jabber_end_stream( struct im_connection *ic );
[21167d2]231
[5997488]232/* sasl.c */
233xt_status sasl_pkt_mechanisms( struct xt_node *node, gpointer data );
234xt_status sasl_pkt_challenge( struct xt_node *node, gpointer data );
235xt_status sasl_pkt_result( struct xt_node *node, gpointer data );
[0da65d5]236gboolean sasl_supported( struct im_connection *ic );
[5997488]237
[e35d1a1]238/* conference.c */
239struct groupchat *jabber_chat_join( struct im_connection *ic, char *room, char *nick, char *password );
[5bd21df]240struct groupchat *jabber_chat_by_jid( struct im_connection *ic, const char *name );
[9da0bbf]241void jabber_chat_free( struct groupchat *c );
[43671b9]242int jabber_chat_msg( struct groupchat *ic, char *message, int flags );
[ef5c185]243int jabber_chat_topic( struct groupchat *c, char *topic );
[e35d1a1]244int jabber_chat_leave( struct groupchat *c, const char *reason );
245void jabber_chat_pkt_presence( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
246void jabber_chat_pkt_message( struct im_connection *ic, struct jabber_buddy *bud, struct xt_node *node );
[c058ff9]247void jabber_chat_invite( struct groupchat *c, char *who, char *message );
[e35d1a1]248
[f06894d]249#endif
Note: See TracBrowser for help on using the repository browser.