Mercurial > pidgin

comparison src/protocols/jabber/jabber.h @ 2086:424a40f12a6c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[gaim-migrate @ 2096] moving protocols from plugins/ to src/protocols. making it so that you can select which protocols are compiled statically. committer: Tailor Script <tailor@pidgin.im>
author Eric Warmenhoven <eric@warmenhoven.org>
date Tue, 31 Jul 2001 01:00:39 +0000
parents
children 9682c0e022c6
comparison
equal deleted inserted replaced
2085:7ebb4322f89b 2086:424a40f12a6c
1 /*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
15 *
16 * Jabber
17 * Copyright (C) 1998-1999 The Jabber Team http://jabber.org/
18 */
19
20 #include <string.h>
21 #include <stdlib.h>
22 #include <sys/types.h>
23 #include <stdio.h>
24 #include <setjmp.h>
25 #include <sys/stat.h>
26 #include <fcntl.h>
27 #include <errno.h>
28 #include <signal.h>
29 #include <stdarg.h>
30 #include <syslog.h>
31 #include <strings.h>
32 #include <unistd.h>
33 #include <sys/socket.h>
34 #include <netinet/in.h>
35 #include <netdb.h>
36 #include <arpa/inet.h>
37 #include <sys/time.h>
38 #include <time.h>
39 #include <ctype.h>
40
41 #include "libxode.h"
42
43 #ifndef INCL_JABBER_H
44 #define INCL_JABBER_H
45
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49
50 /* --------------------------------------------------------- */
51 /* */
52 /* JID structures & constants */
53 /* */
54 /* --------------------------------------------------------- */
55 #define JID_RESOURCE 1
56 #define JID_USER 2
57 #define JID_SERVER 4
58
59 typedef struct jid_struct
60 {
61 pool p;
62 char* resource;
63 char* user;
64 char* server;
65 char* full;
66 struct jid_struct *next; /* for lists of jids */
67 } *jid;
68
69 jid jid_new(pool p, char *idstr); /* Creates a jabber id from the idstr */
70 void jid_set(jid id, char *str, int item); /* Individually sets jid components */
71 char* jid_full(jid id); /* Builds a string type=user/resource@server from the jid data */
72 int jid_cmp(jid a, jid b); /* Compares two jid's, returns 0 for perfect match */
73 int jid_cmpx(jid a, jid b, int parts); /* Compares just the parts specified as JID_|JID_ */
74 jid jid_append(jid a, jid b); /* Appending b to a (list), no dups */
75 xmlnode jid_xres(jid id); /* Returns xmlnode representation of the resource?query=string */
76 xmlnode jid_nodescan(jid id, xmlnode x); /* Scans the children of the node for a matching jid attribute */
77
78
79 /* --------------------------------------------------------- */
80 /* */
81 /* JPacket structures & constants */
82 /* */
83 /* --------------------------------------------------------- */
84 #define JPACKET_UNKNOWN 0x00
85 #define JPACKET_MESSAGE 0x01
86 #define JPACKET_PRESENCE 0x02
87 #define JPACKET_IQ 0x04
88 #define JPACKET_S10N 0x08
89
90 #define JPACKET__UNKNOWN 0
91 #define JPACKET__NONE 1
92 #define JPACKET__ERROR 2
93 #define JPACKET__CHAT 3
94 #define JPACKET__GROUPCHAT 4
95 #define JPACKET__GET 5
96 #define JPACKET__SET 6
97 #define JPACKET__RESULT 7
98 #define JPACKET__SUBSCRIBE 8
99 #define JPACKET__SUBSCRIBED 9
100 #define JPACKET__UNSUBSCRIBE 10
101 #define JPACKET__UNSUBSCRIBED 11
102 #define JPACKET__AVAILABLE 12
103 #define JPACKET__UNAVAILABLE 13
104 #define JPACKET__PROBE 14
105 #define JPACKET__HEADLINE 15
106
107 typedef struct jpacket_struct
108 {
109 unsigned char type;
110 int subtype;
111 int flag;
112 void* aux1;
113 xmlnode x;
114 jid to;
115 jid from;
116 char* iqns;
117 xmlnode iq;
118 pool p;
119 } *jpacket, _jpacket;
120
121 jpacket jpacket_new(xmlnode x); /* Creates a jabber packet from the xmlnode */
122 jpacket jpacket_reset(jpacket p); /* Resets the jpacket values based on the xmlnode */
123 int jpacket_subtype(jpacket p); /* Returns the subtype value (looks at xmlnode for it) */
124
125
126 /* --------------------------------------------------------- */
127 /* */
128 /* Presence Proxy DB structures & constants */
129 /* */
130 /* --------------------------------------------------------- */
131 typedef struct ppdb_struct
132 {
133 jid id; /* entry data */
134 int pri;
135 xmlnode x;
136 struct ppdb_struct* user; /* linked list for user@server */
137 pool p; /* db-level data */
138 struct ppdb_struct* next;
139 } _ppdb, *ppdb;
140
141 ppdb ppdb_insert(ppdb db, jid id, xmlnode x); /* Inserts presence into the proxy */
142 xmlnode ppdb_primary(ppdb db, jid id); /* Fetches the matching primary presence for the id */
143 void ppdb_free(ppdb db); /* Frees the db and all entries */
144 xmlnode ppdb_get(ppdb db, jid id); /* Called successively to return each presence xmlnode */
145 /* for the id and children, returns NULL at the end */
146
147
148 /* --------------------------------------------------------- */
149 /* */
150 /* Simple Jabber Rate limit functions */
151 /* */
152 /* --------------------------------------------------------- */
153 typedef struct jlimit_struct
154 {
155 char *key;
156 int start;
157 int points;
158 int maxt, maxp;
159 pool p;
160 } *jlimit, _jlimit;
161
162 jlimit jlimit_new(int maxt, int maxp);
163 void jlimit_free(jlimit r);
164 int jlimit_check(jlimit r, char *key, int points);
165
166
167 /* --------------------------------------------------------- */
168 /* */
169 /* Error structures & constants */
170 /* */
171 /* --------------------------------------------------------- */
172 typedef struct terror_struct
173 {
174 int code;
175 char msg[64];
176 } terror;
177
178 #define TERROR_BAD (terror){400,"Bad Request"}
179 #define TERROR_AUTH (terror){401,"Unauthorized"}
180 #define TERROR_PAY (terror){402,"Payment Required"}
181 #define TERROR_FORBIDDEN (terror){403,"Forbidden"}
182 #define TERROR_NOTFOUND (terror){404,"Not Found"}
183 #define TERROR_NOTALLOWED (terror){405,"Not Allowed"}
184 #define TERROR_NOTACCEPTABLE (terror){406,"Not Acceptable"}
185 #define TERROR_REGISTER (terror){407,"Registration Required"}
186 #define TERROR_REQTIMEOUT (terror){408,"Request Timeout"}
187 #define TERROR_CONFLICT (terror){409,"Conflict"}
188
189 #define TERROR_INTERNAL (terror){500,"Internal Server Error"}
190 #define TERROR_NOTIMPL (terror){501,"Not Implemented"}
191 #define TERROR_EXTERNAL (terror){502,"Remote Server Error"}
192 #define TERROR_UNAVAIL (terror){503,"Service Unavailable"}
193 #define TERROR_EXTTIMEOUT (terror){504,"Remote Server Timeout"}
194 #define TERROR_DISCONNECTED (terror){510,"Disconnected"}
195
196 /* --------------------------------------------------------- */
197 /* */
198 /* Namespace constants */
199 /* */
200 /* --------------------------------------------------------- */
201 #define NSCHECK(x,n) (j_strcmp(xmlnode_get_attrib(x,"xmlns"),n) == 0)
202
203 #define NS_CLIENT "jabber:client"
204 #define NS_SERVER "jabber:server"
205 #define NS_AUTH "jabber:iq:auth"
206 #define NS_REGISTER "jabber:iq:register"
207 #define NS_ROSTER "jabber:iq:roster"
208 #define NS_OFFLINE "jabber:x:offline"
209 #define NS_AGENT "jabber:iq:agent"
210 #define NS_AGENTS "jabber:iq:agents"
211 #define NS_DELAY "jabber:x:delay"
212 #define NS_VERSION "jabber:iq:version"
213 #define NS_TIME "jabber:iq:time"
214 #define NS_VCARD "vcard-temp"
215 #define NS_PRIVATE "jabber:iq:private"
216 #define NS_SEARCH "jabber:iq:search"
217 #define NS_OOB "jabber:iq:oob"
218 #define NS_XOOB "jabber:x:oob"
219 #define NS_ADMIN "jabber:iq:admin"
220 #define NS_FILTER "jabber:iq:filter"
221 #define NS_AUTH_0K "jabber:iq:auth:0k"
222
223
224 /* --------------------------------------------------------- */
225 /* */
226 /* Message Types */
227 /* */
228 /* --------------------------------------------------------- */
229 #define TMSG_NORMAL "normal"
230 #define TMSG_ERROR "error"
231 #define TMSG_CHAT "chat"
232 #define TMSG_GROUPCHAT "groupchat"
233 #define TMSG_HEADLINE "headline"
234
235
236 /* --------------------------------------------------------- */
237 /* */
238 /* JUtil functions */
239 /* */
240 /* --------------------------------------------------------- */
241 xmlnode jutil_presnew(int type, char *to, char *status); /* Create a skeleton presence packet */
242 xmlnode jutil_iqnew(int type, char *ns); /* Create a skeleton iq packet */
243 xmlnode jutil_msgnew(char *type, char *to, char *subj, char *body);
244 /* Create a skeleton message packet */
245 xmlnode jutil_header(char* xmlns, char* server); /* Create a skeleton stream packet */
246 int jutil_priority(xmlnode x); /* Determine priority of this packet */
247 void jutil_tofrom(xmlnode x); /* Swaps to/from fields on a packet */
248 xmlnode jutil_iqresult(xmlnode x); /* Generate a skeleton iq/result, given a iq/query */
249 char* jutil_timestamp(void); /* Get stringified timestamp */
250 void jutil_error(xmlnode x, terror E); /* Append an <error> node to x */
251 void jutil_delay(xmlnode msg, char *reason); /* Append a delay packet to msg */
252 char* jutil_regkey(char *key, char *seed); /* pass a seed to generate a key, pass the key again to validate (returns it) */
253
254
255 /* --------------------------------------------------------- */
256 /* */
257 /* JConn structures & functions */
258 /* */
259 /* --------------------------------------------------------- */
260 #define JCONN_STATE_OFF 0
261 #define JCONN_STATE_CONNECTED 1
262 #define JCONN_STATE_ON 2
263 #define JCONN_STATE_AUTH 3
264
265 typedef struct jconn_struct
266 {
267 /* Core structure */
268 pool p; /* Memory allocation pool */
269 int state; /* Connection state flag */
270 int fd; /* Connection file descriptor */
271 jid user; /* User info */
272 char *pass; /* User passwd */
273
274 /* Stream stuff */
275 int id; /* id counter for jab_getid() function */
276 char idbuf[9]; /* temporary storage for jab_getid() */
277 char *sid; /* stream id from server, for digest auth */
278 XML_Parser parser; /* Parser instance */
279 xmlnode current; /* Current node in parsing instance.. */
280
281 /* Event callback ptrs */
282 void (*on_state)(struct jconn_struct *j, int state);
283 void (*on_packet)(struct jconn_struct *j, jpacket p);
284
285 } *jconn, jconn_struct;
286
287 typedef void (*jconn_state_h)(jconn j, int state);
288 typedef void (*jconn_packet_h)(jconn j, jpacket p);
289
290
291 jconn jab_new(char *user, char *pass);
292 void jab_delete(jconn j);
293 void jab_state_handler(jconn j, jconn_state_h h);
294 void jab_packet_handler(jconn j, jconn_packet_h h);
295 void jab_start(jconn j);
296 void jab_stop(jconn j);
297
298 int jab_getfd(jconn j);
299 jid jab_getjid(jconn j);
300 char *jab_getsid(jconn j);
301 char *jab_getid(jconn j);
302
303 void jab_send(jconn j, xmlnode x);
304 void jab_send_raw(jconn j, const char *str);
305 void jab_recv(jconn j);
306 void jab_poll(jconn j, int timeout);
307
308 char *jab_auth(jconn j);
309 char *jab_reg(jconn j);
310
311
312
313 #ifdef __cplusplus
314 }
315 #endif
316
317 #endif /* INCL_JABBER_H */