]> andersk Git - libfaim.git/blame - faim/aim.h
Added stubs for those capability TLVs in userinfo.
[libfaim.git] / faim / aim.h
CommitLineData
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
53/*
54 * Login info. Passes information from the Authorization
55 * stage of login to the service (BOS, etc) connection
56 * phase.
57 *
58 */
59struct aim_login_struct {
60 char screen_name[MAXSNLEN+1];
61 char *BOSIP;
62 char cookie[AIM_COOKIELEN];
63 char *email;
64 u_short regstatus;
01b59e1e 65 char *errorurl;
66 u_short errorcode;
bd71fa88 67};
68
69/*
70 * Client info. Filled in by the client and passed
71 * in to aim_login(). The information ends up
72 * getting passed to OSCAR through the initial
73 * login command.
74 *
75 * XXX: Should this be per-session? -mid
76 *
77 */
78struct client_info_s {
79 char clientstring[100]; /* arbitrary size */
80 int major;
81 int minor;
82 int build;
83 char country[3];
84 char lang[3];
85};
86
87#ifndef TRUE
88#define TRUE 1
89#define FALSE 0
90#endif
91
92/*
93 * These could be arbitrary, but its easier to use the actual AIM values
94 */
95#define AIM_CONN_TYPE_AUTH 0x0007
96#define AIM_CONN_TYPE_ADS 0x0005
97#define AIM_CONN_TYPE_BOS 0x0002
98#define AIM_CONN_TYPE_CHAT 0x000e
99#define AIM_CONN_TYPE_CHATNAV 0x000d
100
101/*
102 * Status values returned from aim_conn_new(). ORed together.
103 */
104#define AIM_CONN_STATUS_READY 0x0001
105#define AIM_CONN_STATUS_INTERNALERR 0x0002
106#define AIM_CONN_STATUS_RESOLVERR 0x0080
107#define AIM_CONN_STATUS_CONNERR 0x0040
108
109struct aim_conn_t {
110 int fd;
111 int type;
112 int seqnum;
113 int status;
114 void *priv; /* misc data the client may want to store */
115 time_t lastactivity; /* time of last transmit */
116 int forcedlatency;
117 struct aim_rxcblist_t *handlerlist;
118};
119
120/* struct for incoming commands */
121struct command_rx_struct {
122 /* byte 1 assumed to always be 0x2a */
123 char type; /* type code (byte 2) */
124 u_int seqnum; /* sequence number (bytes 3 and 4) */
125 u_int commandlen; /* total packet len - 6 (bytes 5 and 6) */
126 u_char *data; /* packet data (from 7 byte on) */
127 u_int lock; /* 0 = open, !0 = locked */
128 u_int handled; /* 0 = new, !0 = been handled */
129 struct aim_conn_t *conn; /* the connection it came in on... */
130 struct command_rx_struct *next; /* ptr to next struct in list */
131};
132
133/* struct for outgoing commands */
134struct command_tx_struct {
135 /* byte 1 assumed to be 0x2a */
136 char type; /* type/family code */
137 u_int seqnum; /* seqnum dynamically assigned on tx */
138 u_int commandlen; /* SNAC length */
139 u_char *data; /* packet data */
140 u_int lock; /* 0 = open, !0 = locked */
141 u_int sent; /* 0 = pending, !0 = has been sent */
142 struct aim_conn_t *conn;
143 struct command_tx_struct *next; /* ptr to next struct in list */
144};
145
146
147/*
148 * AIM Session: The main client-data interface.
149 *
150 */
151struct aim_session_t {
152
153 /* ---- Client Accessible ------------------------ */
154 /*
155 * Login information. See definition above.
156 *
157 */
158 struct aim_login_struct logininfo;
159
160 /*
161 * Pointer to anything the client wants to
162 * explicitly associate with this session.
163 */
164 void *aux_data;
165
166
167 /* ---- Internal Use Only ------------------------ */
168 /*
169 * Connection information
170 */
171 struct aim_conn_t conns[AIM_CONN_MAX];
172
173 /*
174 * TX/RX queues
175 */
176 struct command_tx_struct *queue_outgoing;
177 struct command_rx_struct *queue_incoming;
178
179 /*
180 * Outstanding snac handling
181 *
182 * XXX: Should these be per-connection? -mid
183 **/
184 struct aim_snac_t *outstanding_snacs;
185 u_long snac_nextid;
186};
187
188
189/*
190 * AIM User Info, Standard Form.
191 */
192struct aim_userinfo_s {
193 char sn[MAXSNLEN+1];
194 u_short warnlevel;
195 u_short idletime;
196 u_short class;
197 u_long membersince;
198 u_long onlinesince;
199 u_long sessionlen;
200};
201
202/*
203 * TLV handling
204 */
205
206/* Generic TLV structure. */
207struct aim_tlv_t {
208 u_short type;
209 u_short length;
210 u_char *value;
211};
212
213/* List of above. */
214struct aim_tlvlist_t {
215 struct aim_tlv_t *tlv;
216 struct aim_tlvlist_t *next;
217};
218
219/* TLV-handling functions */
220struct aim_tlvlist_t *aim_readtlvchain(u_char *buf, int maxlen);
221void aim_freetlvchain(struct aim_tlvlist_t **list);
222struct aim_tlv_t *aim_grabtlv(u_char *src);
223struct aim_tlv_t *aim_grabtlvstr(u_char *src);
224struct aim_tlv_t *aim_gettlv(struct aim_tlvlist_t *, u_short, int);
225char *aim_gettlv_str(struct aim_tlvlist_t *, u_short, int);
226int aim_puttlv (u_char *dest, struct aim_tlv_t *newtlv);
227struct aim_tlv_t *aim_createtlv(void);
228int aim_freetlv(struct aim_tlv_t **oldtlv);
229int aim_puttlv_16(u_char *, u_short, u_short);
01b59e1e 230int aim_puttlv_32(u_char *, u_short, u_long);
231int aim_puttlv_str(u_char *buf, u_short t, u_short l, u_char *v);
bd71fa88 232
233
234/*
235 * Get command from connections / Dispatch commands
236 * already in queue.
237 */
238int aim_get_command(struct aim_session_t *);
239int aim_rxdispatch(struct aim_session_t *);
240
241int aim_logoff(struct aim_session_t *);
242
243
244typedef int (*rxcallback_t)(struct aim_session_t *, struct command_rx_struct *, ...);
245int aim_register_callbacks(rxcallback_t *);
246
247u_long aim_genericreq_n(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype);
248u_long aim_genericreq_l(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_long *);
249u_long aim_genericreq_s(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short subtype, u_short *);
250
251/* aim_login.c */
01b59e1e 252int aim_sendconnack(struct aim_session_t *sess, struct aim_conn_t *conn);
253int aim_request_login (struct aim_session_t *sess, struct aim_conn_t *conn, char *sn);
bd71fa88 254int aim_send_login (struct aim_session_t *, struct aim_conn_t *, char *, char *, struct client_info_s *);
255int aim_encode_password(const char *, u_char *);
256
257
258struct command_rx_struct *aim_purge_rxqueue(struct command_rx_struct *queue);
259
260
261int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *command, ...);
262int aim_parse_missed_im(struct aim_session_t *, struct command_rx_struct *, ...);
263int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
264
265int aim_tx_enqueue(struct aim_session_t *, struct command_tx_struct *);
266u_int aim_get_next_txseqnum(struct aim_conn_t *);
267int aim_tx_flushqueue(struct aim_session_t *);
268int aim_tx_printqueue(struct aim_session_t *);
269int aim_tx_purgequeue(struct aim_session_t *);
270
271struct aim_rxcblist_t {
272 u_short family;
273 u_short type;
274 rxcallback_t handler;
275 u_short flags;
276 struct aim_rxcblist_t *next;
277};
278
279int aim_conn_setlatency(struct aim_conn_t *conn, int newval);
280
281int aim_conn_addhandler(struct aim_session_t *, struct aim_conn_t *conn, u_short family, u_short type, rxcallback_t newhandler, u_short flags);
282rxcallback_t aim_callhandler(struct aim_conn_t *conn, u_short family, u_short type);
283int aim_clearhandlers(struct aim_conn_t *conn);
284
285/*
286 * Generic SNAC structure. Rarely if ever used.
287 */
288struct aim_snac_t {
289 u_long id;
290 u_short family;
291 u_short type;
292 u_short flags;
293 void *data;
294 time_t issuetime;
295 struct aim_snac_t *next;
296};
297u_long aim_newsnac(struct aim_session_t *, struct aim_snac_t *newsnac);
298struct aim_snac_t *aim_remsnac(struct aim_session_t *, u_long id);
299int aim_cleansnacs(struct aim_session_t *, int maxage);
300int aim_putsnac(u_char *, int, int, int, u_long);
301
302
303void aim_connrst(struct aim_session_t *);
304struct aim_conn_t *aim_conn_getnext(struct aim_session_t *);
305void aim_conn_close(struct aim_conn_t *deadconn);
306struct aim_conn_t *aim_getconn_type(struct aim_session_t *, int type);
307struct aim_conn_t *aim_newconn(struct aim_session_t *, int type, char *dest);
308int aim_conngetmaxfd(struct aim_session_t *);
309struct aim_conn_t *aim_select(struct aim_session_t *, struct timeval *);
310int aim_conn_isready(struct aim_conn_t *);
311int aim_conn_setstatus(struct aim_conn_t *, int);
312void aim_session_init(struct aim_session_t *);
313
314/* aim_misc.c */
315
316#define AIM_VISIBILITYCHANGE_PERMITADD 0x05
317#define AIM_VISIBILITYCHANGE_PERMITREMOVE 0x06
318#define AIM_VISIBILITYCHANGE_DENYADD 0x07
319#define AIM_VISIBILITYCHANGE_DENYREMOVE 0x08
320
321u_long aim_bos_setidle(struct aim_session_t *, struct aim_conn_t *, u_long);
322u_long aim_bos_changevisibility(struct aim_session_t *, struct aim_conn_t *, int, char *);
323u_long aim_bos_setbuddylist(struct aim_session_t *, struct aim_conn_t *, char *);
324u_long aim_bos_setprofile(struct aim_session_t *, struct aim_conn_t *, char *);
325u_long aim_bos_setgroupperm(struct aim_session_t *, struct aim_conn_t *, u_long);
326u_long aim_bos_clientready(struct aim_session_t *, struct aim_conn_t *);
327u_long aim_bos_reqrate(struct aim_session_t *, struct aim_conn_t *);
328u_long aim_bos_ackrateresp(struct aim_session_t *, struct aim_conn_t *);
329u_long aim_bos_setprivacyflags(struct aim_session_t *, struct aim_conn_t *, u_long);
330u_long aim_bos_reqpersonalinfo(struct aim_session_t *, struct aim_conn_t *);
331u_long aim_bos_reqservice(struct aim_session_t *, struct aim_conn_t *, u_short);
332u_long aim_bos_reqrights(struct aim_session_t *, struct aim_conn_t *);
333u_long aim_bos_reqbuddyrights(struct aim_session_t *, struct aim_conn_t *);
334u_long aim_bos_reqlocaterights(struct aim_session_t *, struct aim_conn_t *);
335u_long aim_bos_reqicbmparaminfo(struct aim_session_t *, struct aim_conn_t *);
336
337/* aim_rxhandlers.c */
338int aim_rxdispatch(struct aim_session_t *);
339int aim_authparse(struct aim_session_t *, struct command_rx_struct *);
340int aim_handleredirect_middle(struct aim_session_t *, struct command_rx_struct *, ...);
341int aim_parse_unknown(struct aim_session_t *, struct command_rx_struct *, ...);
342int aim_parse_last_bad(struct aim_session_t *, struct command_rx_struct *, ...);
343int aim_parse_generalerrs(struct aim_session_t *, struct command_rx_struct *command, ...);
01b59e1e 344int aim_parsemotd_middle(struct aim_session_t *sess, struct command_rx_struct *command, ...);
bd71fa88 345
346/* aim_im.c */
347#define AIM_IMFLAGS_AWAY 0x01 /* mark as an autoreply */
348#define AIM_IMFLAGS_ACK 0x02 /* request a receipt notice */
349
350u_long aim_send_im(struct aim_session_t *, struct aim_conn_t *, char *, u_int, char *);
351int aim_parse_incoming_im_middle(struct aim_session_t *, struct command_rx_struct *);
352u_long aim_seticbmparam(struct aim_session_t *, struct aim_conn_t *conn);
353int aim_parse_msgerror_middle(struct aim_session_t *, struct command_rx_struct *);
354
355/* aim_info.c */
356u_long aim_getinfo(struct aim_session_t *, struct aim_conn_t *, const char *);
357int aim_extractuserinfo(u_char *, struct aim_userinfo_s *);
358int aim_parse_userinfo_middle(struct aim_session_t *, struct command_rx_struct *);
359int aim_parse_oncoming_middle(struct aim_session_t *, struct command_rx_struct *);
360int aim_parse_offgoing_middle(struct aim_session_t *, struct command_rx_struct *);
361
362/* aim_auth.c */
363int aim_auth_sendcookie(struct aim_session_t *, struct aim_conn_t *, u_char *);
364u_long aim_auth_clientready(struct aim_session_t *, struct aim_conn_t *);
365u_long aim_auth_changepasswd(struct aim_session_t *, struct aim_conn_t *, char *, char *);
366
367/* aim_buddylist.c */
368u_long aim_add_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
369u_long aim_remove_buddy(struct aim_session_t *, struct aim_conn_t *, char *);
370
371/* aim_search.c */
372u_long aim_usersearch_address(struct aim_session_t *, struct aim_conn_t *, char *);
373/* u_long aim_usersearch_name(struct aim_session_t *, struct aim_conn_t *, char *); */
374
375/* aim_util.c */
376int aimutil_put8(u_char *, u_char);
377u_char aimutil_get8(u_char *buf);
378int aimutil_put16(u_char *, u_short);
379u_short aimutil_get16(u_char *);
380int aimutil_put32(u_char *, u_long);
381u_long aimutil_get32(u_char *);
382int aimutil_putstr(u_char *, const u_char *, int);
383int aimutil_tokslen(char *toSearch, int index, char dl);
384int aimutil_itemcnt(char *toSearch, char dl);
385char *aimutil_itemidx(char *toSearch, int index, char dl);
386
387#endif /* __AIM_H__ */
388
This page took 0.096008 seconds and 5 git commands to generate.