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