]>
Commit | Line | Data |
---|---|---|
bd71fa88 | 1 | /* |
2 | * Main libfaim header. Must be included in client for prototypes/macros. | |
3 | * | |
4 | */ | |
5 | ||
6 | #ifndef __AIM_H__ | |
7 | #define __AIM_H__ | |
8 | ||
9 | #include <faim/faimconfig.h> | |
10 | #include <faim/aim_cbtypes.h> | |
11 | ||
12 | #include <stdio.h> | |
13 | #include <string.h> | |
14 | #include <fcntl.h> | |
15 | #include <sys/types.h> | |
16 | #include <stdlib.h> | |
17 | #include <stdarg.h> | |
18 | #include <errno.h> | |
19 | ||
20 | #ifdef _WIN32 | |
21 | #include <windows.h> | |
22 | #include <time.h> | |
23 | #include <io.h> | |
24 | #else | |
25 | #include <netdb.h> | |
26 | #include <sys/socket.h> | |
27 | #include <netinet/in.h> | |
28 | #include <sys/time.h> | |
29 | #include <unistd.h> | |
30 | #endif | |
31 | ||
32 | /* Portability stuff (DMP) */ | |
33 | ||
34 | #ifdef _WIN32 | |
35 | #define sleep Sleep | |
36 | #define strlen(x) (int)strlen(x) /* win32 has a unsigned size_t */ | |
37 | #endif | |
38 | ||
39 | #if defined(_WIN32) || (defined(mach) && defined(__APPLE__)) | |
40 | #define gethostbyname2(x,y) gethostbyname(x) /* revert to IPv4 */ | |
41 | #endif | |
42 | ||
43 | /* | |
44 | * Current Maximum Length for Screen Names (not including NULL) | |
45 | */ | |
46 | #define MAXSNLEN 16 | |
47 | ||
48 | /* | |
49 | * Standard size of an AIM authorization cookie | |
50 | */ | |
51 | #define AIM_COOKIELEN 0x100 | |
52 | ||
b8d0da45 | 53 | #if debug > 0 |
54 | #define faimdprintf(l, x...) {if (l >= debug) printf(x); } | |
55 | #else | |
56 | #define faimdprintf(l, x...) | |
57 | #endif | |
58 | ||
bd71fa88 | 59 | /* |
60 | * Login info. Passes information from the Authorization | |
61 | * stage of login to the service (BOS, etc) connection | |
62 | * phase. | |
63 | * | |
64 | */ | |
65 | struct aim_login_struct { | |
66 | char screen_name[MAXSNLEN+1]; | |
67 | char *BOSIP; | |
68 | char cookie[AIM_COOKIELEN]; | |
69 | char *email; | |
70 | u_short regstatus; | |
01b59e1e | 71 | char *errorurl; |
72 | u_short errorcode; | |
bd71fa88 | 73 | }; |
74 | ||
75 | /* | |
76 | * Client info. Filled in by the client and passed | |
77 | * in to aim_login(). The information ends up | |
78 | * getting passed to OSCAR through the initial | |
79 | * login command. | |
80 | * | |
81 | * XXX: Should this be per-session? -mid | |
82 | * | |
83 | */ | |
84 | struct client_info_s { | |
85 | char clientstring[100]; /* arbitrary size */ | |
86 | int major; | |
87 | int minor; | |
88 | int build; | |
89 | char country[3]; | |
90 | char lang[3]; | |
91 | }; | |
92 | ||
93 | #ifndef TRUE | |
94 | #define TRUE 1 | |
95 | #define FALSE 0 | |
96 | #endif | |
97 | ||
98 | /* | |
99 | * These could be arbitrary, but its easier to use the actual AIM values | |
100 | */ | |
101 | #define AIM_CONN_TYPE_AUTH 0x0007 | |
102 | #define AIM_CONN_TYPE_ADS 0x0005 | |
103 | #define AIM_CONN_TYPE_BOS 0x0002 | |
104 | #define AIM_CONN_TYPE_CHAT 0x000e | |
105 | #define AIM_CONN_TYPE_CHATNAV 0x000d | |
106 | ||
107 | /* | |
108 | * Status values returned from aim_conn_new(). ORed together. | |
109 | */ | |
110 | #define AIM_CONN_STATUS_READY 0x0001 | |
111 | #define AIM_CONN_STATUS_INTERNALERR 0x0002 | |
112 | #define AIM_CONN_STATUS_RESOLVERR 0x0080 | |
113 | #define AIM_CONN_STATUS_CONNERR 0x0040 | |
114 | ||
115 | struct aim_conn_t { | |
116 | int fd; | |
117 | int type; | |
118 | int seqnum; | |
119 | int status; | |
120 | void *priv; /* misc data the client may want to store */ | |
121 | time_t lastactivity; /* time of last transmit */ | |
122 | int forcedlatency; | |
123 | struct aim_rxcblist_t *handlerlist; | |
124 | }; | |
125 | ||
126 | /* struct for incoming commands */ | |
127 | struct command_rx_struct { | |
128 | /* byte 1 assumed to always be 0x2a */ | |
129 | char type; /* type code (byte 2) */ | |
130 | u_int seqnum; /* sequence number (bytes 3 and 4) */ | |
131 | u_int commandlen; /* total packet len - 6 (bytes 5 and 6) */ | |
132 | u_char *data; /* packet data (from 7 byte on) */ | |
133 | u_int lock; /* 0 = open, !0 = locked */ | |
134 | u_int handled; /* 0 = new, !0 = been handled */ | |
b8d0da45 | 135 | u_int nofree; /* 0 = free data on purge, 1 = only unlink */ |
bd71fa88 | 136 | struct aim_conn_t *conn; /* the connection it came in on... */ |
137 | struct command_rx_struct *next; /* ptr to next struct in list */ | |
138 | }; | |
139 | ||
140 | /* struct for outgoing commands */ | |
141 | struct command_tx_struct { | |
142 | /* byte 1 assumed to be 0x2a */ | |
143 | char type; /* type/family code */ | |
144 | u_int seqnum; /* seqnum dynamically assigned on tx */ | |
145 | u_int commandlen; /* SNAC length */ | |
146 | u_char *data; /* packet data */ | |
147 | u_int lock; /* 0 = open, !0 = locked */ | |
148 | u_int sent; /* 0 = pending, !0 = has been sent */ | |
149 | struct aim_conn_t *conn; | |
150 | struct command_tx_struct *next; /* ptr to next struct in list */ | |
151 | }; | |
152 | ||
153 | ||
154 | /* | |
155 | * AIM Session: The main client-data interface. | |
156 | * | |
157 | */ | |
158 | struct aim_session_t { | |
159 | ||
160 | /* ---- Client Accessible ------------------------ */ | |
161 | /* | |
162 | * Login information. See definition above. | |
163 | * | |
164 | */ | |
165 | struct aim_login_struct logininfo; | |
166 | ||
167 | /* | |
168 | * Pointer to anything the client wants to | |
169 | * explicitly associate with this session. | |
170 | */ | |
171 | void *aux_data; | |
172 | ||
173 | ||
174 | /* ---- Internal Use Only ------------------------ */ | |
175 | /* | |
176 | * Connection information | |
177 | */ | |
178 | struct aim_conn_t conns[AIM_CONN_MAX]; | |
179 | ||
180 | /* | |
181 | * TX/RX queues | |
182 | */ | |
183 | struct command_tx_struct *queue_outgoing; | |
184 | struct command_rx_struct *queue_incoming; | |
185 | ||
0c20631f | 186 | /* |
187 | * This is a dreadful solution to the what-room-are-we-joining | |
188 | * problem. (There's no connection between the service | |
189 | * request and the resulting redirect.) | |
190 | */ | |
191 | char *pendingjoin; | |
192 | ||
bd71fa88 | 193 | /* |
194 | * Outstanding snac handling | |
195 | * | |
196 | * XXX: Should these be per-connection? -mid | |
197 | **/ | |
198 | struct aim_snac_t *outstanding_snacs; | |
199 | u_long snac_nextid; | |
200 | }; | |
201 | ||
202 | ||
203 | /* | |
204 | * AIM User Info, Standard Form. | |
205 | */ | |
206 | struct aim_userinfo_s { | |
207 | char sn[MAXSNLEN+1]; | |
208 | u_short warnlevel; | |
209 | u_short idletime; | |
210 | u_short class; | |
211 | u_long membersince; | |
212 | u_long onlinesince; | |
213 | u_long sessionlen; | |
214 | }; | |
215 | ||
0c20631f | 216 | #define AIM_CLASS_TRIAL 0x0001 |
217 | #define AIM_CLASS_UNKNOWN2 0x0002 | |
218 | #define AIM_CLASS_AOL 0x0004 | |
219 | #define AIM_CLASS_UNKNOWN4 0x0008 | |
220 | #define AIM_CLASS_FREE 0x0010 | |
221 | #define AIM_CLASS_AWAY 0x0020 | |
222 | #define AIM_CLASS_UNKNOWN40 0x0040 | |
223 | #define AIM_CLASS_UNKNOWN80 0x0080 | |
224 | ||
bd71fa88 | 225 | /* |
226 | * TLV handling | |
227 | */ | |
228 | ||
229 | /* Generic TLV structure. */ | |
230 | struct aim_tlv_t { | |
231 | u_short type; | |
232 | u_short length; | |
233 | u_char *value; | |
234 | }; | |
235 | ||
236 | /* List of above. */ | |
237 | struct aim_tlvlist_t { | |
238 | struct aim_tlv_t *tlv; | |
239 | struct aim_tlvlist_t *next; | |
240 | }; | |
241 | ||
242 | /* TLV-handling functions */ | |
243 | struct aim_tlvlist_t *aim_readtlvchain(u_char *buf, int maxlen); | |
244 | void aim_freetlvchain(struct aim_tlvlist_t **list); | |
245 | struct aim_tlv_t *aim_grabtlv(u_char *src); | |
246 | struct aim_tlv_t *aim_grabtlvstr(u_char *src); | |
247 | struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *, u_short, int); | |
248 | char *aim_gettlv_str(struct aim_tlvlist_t *, u_short, int); | |
249 | int aim_puttlv (u_char *dest, struct aim_tlv_t *newtlv); | |
250 | struct aim_tlv_t *aim_createtlv(void); | |
251 | int aim_freetlv(struct aim_tlv_t **oldtlv); | |
252 | int aim_puttlv_16(u_char *, u_short, u_short); | |
01b59e1e | 253 | int aim_puttlv_32(u_char *, u_short, u_long); |
254 | int aim_puttlv_str(u_char *buf, u_short t, u_short l, u_char *v); | |
0e2be272 | 255 | int aim_writetlvchain(u_char *buf, int buflen, struct aim_tlvlist_t **list); |
256 | int aim_addtlvtochain16(struct aim_tlvlist_t **list, unsigned short type, unsigned short val); | |
0e2be272 | 257 | int aim_addtlvtochain_str(struct aim_tlvlist_t **list, unsigned short type, char *str); |
bd71fa88 | 258 | |
259 | /* | |
260 | * Get command from connections / Dispatch commands | |
261 | * already in queue. | |
262 | */ | |
263 | int aim_get_command(struct aim_session_t *); | |
264 | int aim_rxdispatch(struct aim_session_t *); | |
265 | ||
266 | int aim_logoff(struct aim_session_t *); | |
267 | ||
268 | ||
269 | typedef int (*rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...); | |
270 | int aim_register_callbacks(rxcallback_t *); | |
271 | ||
272 | u_long aim_genericreq_n(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype); | |
273 | u_long aim_genericreq_l(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_long *); | |
274 | u_long aim_genericreq_s(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_short *); | |
275 | ||
276 | /* aim_login.c */ | |
01b59e1e | 277 | int aim_sendconnack(struct aim_session_t *sess, struct aim_conn_t *conn); |
278 | int aim_request_login (struct aim_session_t *sess, struct aim_conn_t *conn, char *sn); | |
bd71fa88 | 279 | int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *); |
280 | int aim_encode_password(const char *, u_char *); | |
281 | ||
282 | ||
b8d0da45 | 283 | void aim_purge_rxqueue(struct aim_session_t *); |
bd71fa88 | 284 | |
285 | ||
286 | int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *command, ...); | |
287 | int aim_parse_missed_im(struct aim_session_t *, struct command_rx_struct *, ...); | |
288 | int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...); | |
289 | ||
290 | int aim_tx_enqueue(struct aim_session_t *, struct command_tx_struct *); | |
291 | u_int aim_get_next_txseqnum(struct aim_conn_t *); | |
292 | int aim_tx_flushqueue(struct aim_session_t *); | |
293 | int aim_tx_printqueue(struct aim_session_t *); | |
b8d0da45 | 294 | void aim_tx_purgequeue(struct aim_session_t *); |
bd71fa88 | 295 | |
296 | struct aim_rxcblist_t { | |
297 | u_short family; | |
298 | u_short type; | |
299 | rxcallback_t handler; | |
300 | u_short flags; | |
301 | struct aim_rxcblist_t *next; | |
302 | }; | |
303 | ||
304 | int aim_conn_setlatency(struct aim_conn_t *conn, int newval); | |
305 | ||
306 | int aim_conn_addhandler(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short type, rxcallback_t newhandler, u_short flags); | |
307 | rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type); | |
308 | int aim_clearhandlers(struct aim_conn_t *conn); | |
309 | ||
310 | /* | |
311 | * Generic SNAC structure. Rarely if ever used. | |
312 | */ | |
313 | struct aim_snac_t { | |
314 | u_long id; | |
315 | u_short family; | |
316 | u_short type; | |
317 | u_short flags; | |
318 | void *data; | |
319 | time_t issuetime; | |
320 | struct aim_snac_t *next; | |
321 | }; | |
322 | u_long aim_newsnac(struct aim_session_t *, struct aim_snac_t *newsnac); | |
323 | struct aim_snac_t *aim_remsnac(struct aim_session_t *, u_long id); | |
324 | int aim_cleansnacs(struct aim_session_t *, int maxage); | |
325 | int aim_putsnac(u_char *, int, int, int, u_long); | |
326 | ||
327 | ||
328 | void aim_connrst(struct aim_session_t *); | |
329 | struct aim_conn_t *aim_conn_getnext(struct aim_session_t *); | |
330 | void aim_conn_close(struct aim_conn_t *deadconn); | |
331 | struct aim_conn_t *aim_getconn_type(struct aim_session_t *, int type); | |
332 | struct aim_conn_t *aim_newconn(struct aim_session_t *, int type, char *dest); | |
333 | int aim_conngetmaxfd(struct aim_session_t *); | |
b8d0da45 | 334 | struct aim_conn_t *aim_select(struct aim_session_t *, struct timeval *, int *); |
bd71fa88 | 335 | int aim_conn_isready(struct aim_conn_t *); |
336 | int aim_conn_setstatus(struct aim_conn_t *, int); | |
337 | void aim_session_init(struct aim_session_t *); | |
338 | ||
339 | /* aim_misc.c */ | |
340 | ||
341 | #define AIM_VISIBILITYCHANGE_PERMITADD 0x05 | |
342 | #define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06 | |
343 | #define AIM_VISIBILITYCHANGE_DENYADD 0x07 | |
344 | #define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08 | |
345 | ||
346 | u_long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long); | |
347 | u_long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *); | |
348 | u_long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *); | |
0c20631f | 349 | u_long aim_bos_setprofile(struct aim_session_t *, struct aim_conn_t *, char *, char *); |
bd71fa88 | 350 | u_long aim_bos_setgroupperm(struct aim_session_t *, struct aim_conn_t *, u_long); |
351 | u_long aim_bos_clientready(struct aim_session_t *, struct aim_conn_t *); | |
352 | u_long aim_bos_reqrate(struct aim_session_t *, struct aim_conn_t *); | |
353 | u_long aim_bos_ackrateresp(struct aim_session_t *, struct aim_conn_t *); | |
354 | u_long aim_bos_setprivacyflags(struct aim_session_t *, struct aim_conn_t *, u_long); | |
355 | u_long aim_bos_reqpersonalinfo(struct aim_session_t *, struct aim_conn_t *); | |
356 | u_long aim_bos_reqservice(struct aim_session_t *, struct aim_conn_t *, u_short); | |
357 | u_long aim_bos_reqrights(struct aim_session_t *, struct aim_conn_t *); | |
358 | u_long aim_bos_reqbuddyrights(struct aim_session_t *, struct aim_conn_t *); | |
359 | u_long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *); | |
360 | u_long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *); | |
0c20631f | 361 | u_long aim_setversions(struct aim_session_t *sess, struct aim_conn_t *conn); |
bd71fa88 | 362 | |
363 | /* aim_rxhandlers.c */ | |
364 | int aim_rxdispatch(struct aim_session_t *); | |
365 | int aim_authparse(struct aim_session_t *, struct command_rx_struct *); | |
366 | int aim_handleredirect_middle(struct aim_session_t *, struct command_rx_struct *, ...); | |
367 | int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *, ...); | |
368 | int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...); | |
369 | int aim_parse_generalerrs(struct aim_session_t *, struct command_rx_struct *command, ...); | |
01b59e1e | 370 | int aim_parsemotd_middle(struct aim_session_t *sess, struct command_rx_struct *command, ...); |
bd71fa88 | 371 | |
372 | /* aim_im.c */ | |
373 | #define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */ | |
374 | #define AIM_IMFLAGS_ACK 0x02 /* request a receipt notice */ | |
375 | ||
376 | u_long aim_send_im(struct aim_session_t *, struct aim_conn_t *, char *, u_int, char *); | |
377 | int aim_parse_incoming_im_middle(struct aim_session_t *, struct command_rx_struct *); | |
378 | u_long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn); | |
379 | int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *); | |
380 | ||
381 | /* aim_info.c */ | |
382 | u_long aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *); | |
383 | int aim_extractuserinfo(u_char *, struct aim_userinfo_s *); | |
384 | int aim_parse_userinfo_middle(struct aim_session_t *, struct command_rx_struct *); | |
385 | int aim_parse_oncoming_middle(struct aim_session_t *, struct command_rx_struct *); | |
386 | int aim_parse_offgoing_middle(struct aim_session_t *, struct command_rx_struct *); | |
387 | ||
388 | /* aim_auth.c */ | |
389 | int aim_auth_sendcookie(struct aim_session_t *, struct aim_conn_t *, u_char *); | |
390 | u_long aim_auth_clientready(struct aim_session_t *, struct aim_conn_t *); | |
391 | u_long aim_auth_changepasswd(struct aim_session_t *, struct aim_conn_t *, char *, char *); | |
392 | ||
393 | /* aim_buddylist.c */ | |
394 | u_long aim_add_buddy(struct aim_session_t *, struct aim_conn_t *, char *); | |
395 | u_long aim_remove_buddy(struct aim_session_t *, struct aim_conn_t *, char *); | |
396 | ||
397 | /* aim_search.c */ | |
398 | u_long aim_usersearch_address(struct aim_session_t *, struct aim_conn_t *, char *); | |
399 | /* u_long aim_usersearch_name(struct aim_session_t *, struct aim_conn_t *, char *); */ | |
400 | ||
0c20631f | 401 | |
402 | struct aim_chat_roominfo { | |
403 | u_short exchange; | |
404 | char *name; | |
405 | u_short instance; | |
406 | }; | |
407 | int aim_chat_readroominfo(u_char *buf, struct aim_chat_roominfo *outinfo); | |
408 | int aim_chat_parse_infoupdate(struct aim_session_t *sess, struct command_rx_struct *command); | |
409 | int aim_chat_parse_joined(struct aim_session_t *sess, struct command_rx_struct *command); | |
410 | int aim_chat_parse_leave(struct aim_session_t *sess, struct command_rx_struct *command); | |
411 | int aim_chat_parse_incoming(struct aim_session_t *sess, struct command_rx_struct *command); | |
412 | u_long aim_chat_send_im(struct aim_session_t *sess, struct aim_conn_t *conn, char *msg); | |
413 | u_long aim_chat_join(struct aim_session_t *sess, struct aim_conn_t *conn, u_short exchange, const char *roomname); | |
414 | u_long aim_chat_clientready(struct aim_session_t *sess, struct aim_conn_t *conn); | |
415 | int aim_chat_attachname(struct aim_conn_t *conn, char *roomname); | |
416 | char *aim_chat_getname(struct aim_conn_t *conn); | |
417 | struct aim_conn_t *aim_chat_getconn(struct aim_session_t *, char *name); | |
418 | ||
419 | u_long aim_chatnav_reqrights(struct aim_session_t *sess, struct aim_conn_t *conn); | |
420 | u_long aim_chatnav_clientready(struct aim_session_t *sess, struct aim_conn_t *conn); | |
421 | ||
422 | u_long aim_chat_invite(struct aim_session_t *sess, struct aim_conn_t *conn, char *sn, char *msg, u_short exchange, char *roomname, u_short instance); | |
423 | ||
424 | struct aim_chat_exchangeinfo { | |
425 | u_short number; | |
426 | char *name; | |
427 | char *charset1; | |
428 | char *lang1; | |
429 | char *charset2; | |
430 | char *lang2; | |
431 | }; | |
432 | int aim_chatnav_parse_info(struct aim_session_t *sess, struct command_rx_struct *command); | |
433 | u_long aim_chatnav_createroom(struct aim_session_t *sess, struct aim_conn_t *conn, char *name, u_short exchange); | |
434 | int aim_chat_leaveroom(struct aim_session_t *sess, char *name); | |
435 | ||
bd71fa88 | 436 | /* aim_util.c */ |
437 | int aimutil_put8(u_char *, u_char); | |
438 | u_char aimutil_get8(u_char *buf); | |
439 | int aimutil_put16(u_char *, u_short); | |
440 | u_short aimutil_get16(u_char *); | |
441 | int aimutil_put32(u_char *, u_long); | |
442 | u_long aimutil_get32(u_char *); | |
443 | int aimutil_putstr(u_char *, const u_char *, int); | |
444 | int aimutil_tokslen(char *toSearch, int index, char dl); | |
445 | int aimutil_itemcnt(char *toSearch, char dl); | |
446 | char *aimutil_itemidx(char *toSearch, int index, char dl); | |
447 | ||
448 | #endif /* __AIM_H__ */ | |
449 |