Mercurial > pidgin

comparison plugins/jabber/jabber.h @ 1347:afa63ac2fd84

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