source: libfaim/aim_internal.h @ de03334

barnowl_perlaimdebianowlrelease-1.4release-1.5release-1.6release-1.7release-1.8release-1.9
Last change on this file since de03334 was 862371b, checked in by James M. Kretchmar <kretch@mit.edu>, 18 years ago
*** empty log message ***
  • Property mode set to 100644
File size: 10.2 KB
Line 
1/*
2 * aim_internal.h -- prototypes/structs for the guts of libfaim
3 *
4 */
5
6#ifdef FAIM_INTERNAL
7#ifndef __AIM_INTERNAL_H__
8#define __AIM_INTERNAL_H__ 1
9
10typedef struct {
11        fu16_t family;
12        fu16_t subtype;
13        fu16_t flags;
14        fu32_t id;
15} aim_modsnac_t;
16
17#define AIM_MODULENAME_MAXLEN 16
18#define AIM_MODFLAG_MULTIFAMILY 0x0001
19typedef struct aim_module_s {
20        fu16_t family;
21        fu16_t version;
22        fu16_t toolid;
23        fu16_t toolversion;
24        fu16_t flags;
25        char name[AIM_MODULENAME_MAXLEN+1];
26        int (*snachandler)(aim_session_t *sess, struct aim_module_s *mod, aim_frame_t *rx, aim_modsnac_t *snac, aim_bstream_t *bs);
27        int (*snacdestructor)(aim_session_t *sess, aim_conn_t *conn, aim_modsnac_t *snac, void *data);
28
29        void (*shutdown)(aim_session_t *sess, struct aim_module_s *mod);
30        void *priv;
31        struct aim_module_s *next;
32} aim_module_t;
33
34faim_internal int aim__registermodule(aim_session_t *sess, int (*modfirst)(aim_session_t *, aim_module_t *));
35faim_internal void aim__shutdownmodules(aim_session_t *sess);
36faim_internal aim_module_t *aim__findmodulebygroup(aim_session_t *sess, fu16_t group);
37faim_internal aim_module_t *aim__findmodule(aim_session_t *sess, const char *name);
38
39faim_internal int buddylist_modfirst(aim_session_t *sess, aim_module_t *mod);
40faim_internal int admin_modfirst(aim_session_t *sess, aim_module_t *mod);
41faim_internal int bos_modfirst(aim_session_t *sess, aim_module_t *mod);
42faim_internal int search_modfirst(aim_session_t *sess, aim_module_t *mod);
43faim_internal int stats_modfirst(aim_session_t *sess, aim_module_t *mod);
44faim_internal int auth_modfirst(aim_session_t *sess, aim_module_t *mod);
45faim_internal int msg_modfirst(aim_session_t *sess, aim_module_t *mod);
46faim_internal int misc_modfirst(aim_session_t *sess, aim_module_t *mod);
47faim_internal int chatnav_modfirst(aim_session_t *sess, aim_module_t *mod);
48faim_internal int chat_modfirst(aim_session_t *sess, aim_module_t *mod);
49faim_internal int locate_modfirst(aim_session_t *sess, aim_module_t *mod);
50faim_internal int general_modfirst(aim_session_t *sess, aim_module_t *mod);
51faim_internal int ssi_modfirst(aim_session_t *sess, aim_module_t *mod);
52faim_internal int invite_modfirst(aim_session_t *sess, aim_module_t *mod);
53faim_internal int translate_modfirst(aim_session_t *sess, aim_module_t *mod);
54faim_internal int popups_modfirst(aim_session_t *sess, aim_module_t *mod);
55faim_internal int adverts_modfirst(aim_session_t *sess, aim_module_t *mod);
56faim_internal int icq_modfirst(aim_session_t *sess, aim_module_t *mod);
57faim_internal int email_modfirst(aim_session_t *sess, aim_module_t *mod);
58faim_internal int newsearch_modfirst(aim_session_t *sess, aim_module_t *mod);
59
60faim_internal int aim_genericreq_n(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype);
61faim_internal int aim_genericreq_n_snacid(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype);
62faim_internal int aim_genericreq_l(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype, fu32_t *);
63faim_internal int aim_genericreq_s(aim_session_t *, aim_conn_t *conn, fu16_t family, fu16_t subtype, fu16_t *);
64
65#define AIMBS_CURPOSPAIR(x) ((x)->data + (x)->offset), ((x)->len - (x)->offset)
66
67/* bstream.c */
68faim_internal int aim_bstream_init(aim_bstream_t *bs, fu8_t *data, int len);
69faim_internal int aim_bstream_empty(aim_bstream_t *bs);
70faim_internal int aim_bstream_curpos(aim_bstream_t *bs);
71faim_internal int aim_bstream_setpos(aim_bstream_t *bs, int off);
72faim_internal void aim_bstream_rewind(aim_bstream_t *bs);
73faim_internal int aim_bstream_advance(aim_bstream_t *bs, int n);
74faim_internal fu8_t aimbs_get8(aim_bstream_t *bs);
75faim_internal fu16_t aimbs_get16(aim_bstream_t *bs);
76faim_internal fu32_t aimbs_get32(aim_bstream_t *bs);
77faim_internal fu8_t aimbs_getle8(aim_bstream_t *bs);
78faim_internal fu16_t aimbs_getle16(aim_bstream_t *bs);
79faim_internal fu32_t aimbs_getle32(aim_bstream_t *bs);
80faim_internal int aimbs_put8(aim_bstream_t *bs, fu8_t v);
81faim_internal int aimbs_put16(aim_bstream_t *bs, fu16_t v);
82faim_internal int aimbs_put32(aim_bstream_t *bs, fu32_t v);
83faim_internal int aimbs_putle8(aim_bstream_t *bs, fu8_t v);
84faim_internal int aimbs_putle16(aim_bstream_t *bs, fu16_t v);
85faim_internal int aimbs_putle32(aim_bstream_t *bs, fu32_t v);
86faim_internal int aimbs_getrawbuf(aim_bstream_t *bs, fu8_t *buf, int len);
87faim_internal fu8_t *aimbs_getraw(aim_bstream_t *bs, int len);
88faim_internal char *aimbs_getstr(aim_bstream_t *bs, int len);
89faim_internal int aimbs_putraw(aim_bstream_t *bs, const fu8_t *v, int len);
90faim_internal int aimbs_putbs(aim_bstream_t *bs, aim_bstream_t *srcbs, int len);
91
92/* conn.c */
93faim_internal aim_conn_t *aim_cloneconn(aim_session_t *sess, aim_conn_t *src);
94
95/* ft.c */
96faim_internal int aim_rxdispatch_rendezvous(aim_session_t *sess, aim_frame_t *fr);
97
98/* rxhandlers.c */
99faim_internal aim_rxcallback_t aim_callhandler(aim_session_t *sess, aim_conn_t *conn, u_short family, u_short type);
100faim_internal int aim_callhandler_noparam(aim_session_t *sess, aim_conn_t *conn, fu16_t family, fu16_t type, aim_frame_t *ptr);
101faim_internal int aim_parse_unknown(aim_session_t *, aim_frame_t *, ...);
102faim_internal void aim_clonehandlers(aim_session_t *sess, aim_conn_t *dest, aim_conn_t *src);
103
104/* rxqueue.c */
105faim_internal int aim_recv(int fd, void *buf, size_t count);
106faim_internal int aim_bstream_recv(aim_bstream_t *bs, int fd, size_t count);
107faim_internal void aim_rxqueue_cleanbyconn(aim_session_t *sess, aim_conn_t *conn);
108faim_internal void aim_frame_destroy(aim_frame_t *);
109
110/* txqueue.c */
111faim_internal aim_frame_t *aim_tx_new(aim_session_t *sess, aim_conn_t *conn, fu8_t framing, fu16_t chan, int datalen);
112faim_internal int aim_tx_enqueue(aim_session_t *, aim_frame_t *);
113faim_internal flap_seqnum_t aim_get_next_txseqnum(aim_conn_t *);
114faim_internal int aim_tx_sendframe(aim_session_t *sess, aim_frame_t *cur);
115faim_internal void aim_tx_cleanqueue(aim_session_t *, aim_conn_t *);
116
117/* XXX - What is this?   faim_internal int aim_tx_printqueue(aim_session_t *); */
118
119/*
120 * Generic SNAC structure.  Rarely if ever used.
121 */
122typedef struct aim_snac_s {
123        aim_snacid_t id;
124        fu16_t family;
125        fu16_t type;
126        fu16_t flags;
127        void *data;
128        time_t issuetime;
129        struct aim_snac_s *next;
130} aim_snac_t;
131
132struct aim_snac_destructor {
133        aim_conn_t *conn;
134        void *data;
135};
136
137/* snac.c */
138faim_internal void aim_initsnachash(aim_session_t *sess);
139faim_internal aim_snacid_t aim_newsnac(aim_session_t *, aim_snac_t *newsnac);
140faim_internal aim_snacid_t aim_cachesnac(aim_session_t *sess, const fu16_t family, const fu16_t type, const fu16_t flags, const void *data, const int datalen);
141faim_internal aim_snac_t *aim_remsnac(aim_session_t *, aim_snacid_t id);
142faim_internal void aim_cleansnacs(aim_session_t *, int maxage);
143faim_internal int aim_putsnac(aim_bstream_t *, fu16_t family, fu16_t type, fu16_t flags, aim_snacid_t id);
144
145/* Stored in ->priv of the service request SNAC for chats. */
146struct chatsnacinfo {
147        fu16_t exchange;
148        char name[128];
149        fu16_t instance;
150};
151
152/* these are used by aim_*_clientready */
153#define AIM_TOOL_JAVA   0x0001
154#define AIM_TOOL_MAC    0x0002
155#define AIM_TOOL_WIN16  0x0003
156#define AIM_TOOL_WIN32  0x0004
157#define AIM_TOOL_MAC68K 0x0005
158#define AIM_TOOL_MACPPC 0x0006
159#define AIM_TOOL_NEWWIN 0x0010
160struct aim_tool_version {
161        fu16_t group;
162        fu16_t version;
163        fu16_t tool;
164        fu16_t toolversion;
165};
166
167/*
168 * In SNACland, the terms 'family' and 'group' are synonymous -- the former
169 * is my term, the latter is AOL's.
170 */
171struct snacgroup {
172        fu16_t group;
173        struct snacgroup *next;
174};
175
176#ifdef FAIM_NEED_CONN_INTERNAL
177struct snacpair {
178        fu16_t group;
179        fu16_t subtype;
180        struct snacpair *next;
181};
182
183struct rateclass {
184        fu16_t classid;
185        fu32_t windowsize;
186        fu32_t clear;
187        fu32_t alert;
188        fu32_t limit;
189        fu32_t disconnect;
190        fu32_t current;
191        fu32_t max;
192        fu8_t unknown[5]; /* only present in versions >= 3 */
193        struct snacpair *members;
194        struct rateclass *next;
195};
196#endif /* FAIM_NEED_CONN_INTERNAL */
197
198/*
199 * This is inside every connection.  But it is a void * to anything
200 * outside of libfaim.  It should remain that way.  It's called data
201 * abstraction.  Maybe you've heard of it.  (Probably not if you're a
202 * libfaim user.)
203 *
204 */
205typedef struct aim_conn_inside_s {
206        struct snacgroup *groups;
207        struct rateclass *rates;
208} aim_conn_inside_t;
209
210faim_internal void aim_conn_addgroup(aim_conn_t *conn, fu16_t group);
211
212faim_internal fu32_t aim_getcap(aim_session_t *sess, aim_bstream_t *bs, int len);
213faim_internal int aim_putcap(aim_bstream_t *bs, fu32_t caps);
214
215faim_internal int aim_cachecookie(aim_session_t *sess, aim_msgcookie_t *cookie);
216faim_internal aim_msgcookie_t *aim_uncachecookie(aim_session_t *sess, fu8_t *cookie, int type);
217faim_internal aim_msgcookie_t *aim_mkcookie(fu8_t *, int, void *);
218faim_internal aim_msgcookie_t *aim_checkcookie(aim_session_t *, const unsigned char *, const int);
219faim_internal int aim_freecookie(aim_session_t *sess, aim_msgcookie_t *cookie);
220faim_internal int aim_msgcookie_gettype(int reqclass);
221faim_internal int aim_cookie_free(aim_session_t *sess, aim_msgcookie_t *cookie);
222
223faim_internal int aim_extractuserinfo(aim_session_t *sess, aim_bstream_t *bs, aim_userinfo_t *);
224faim_internal int aim_putuserinfo(aim_bstream_t *bs, aim_userinfo_t *info);
225
226faim_internal int aim_chat_readroominfo(aim_bstream_t *bs, struct aim_chat_roominfo *outinfo);
227
228faim_internal void faimdprintf(aim_session_t *sess, int dlevel, const char *format, ...);
229
230faim_internal int aim_request_directim(aim_session_t *sess, const char *destsn, fu8_t *ip, fu16_t port, fu8_t *ckret);
231faim_internal int aim_request_sendfile(aim_session_t *sess, const char *sn, const char *filename, fu16_t numfiles, fu32_t totsize, fu8_t *ip, fu16_t port, fu8_t *ckret);
232faim_internal void aim_conn_close_rend(aim_session_t *sess, aim_conn_t *conn);
233faim_internal void aim_conn_kill_rend(aim_session_t *sess, aim_conn_t *conn);
234
235faim_internal void aim_conn_kill_chat(aim_session_t *sess, aim_conn_t *conn);
236
237/* These are all handled internally now. */
238faim_internal int aim_setversions(aim_session_t *sess, aim_conn_t *conn);
239faim_internal int aim_reqrates(aim_session_t *, aim_conn_t *);
240faim_internal int aim_rates_addparam(aim_session_t *, aim_conn_t *);
241faim_internal int aim_rates_delparam(aim_session_t *, aim_conn_t *);
242
243#ifndef FAIM_INTERNAL_INSANE
244#define printf() printf called inside libfaim
245#define sprintf() unbounded sprintf used inside libfaim
246#endif
247
248#endif /* __AIM_INTERNAL_H__ */
249#endif /* FAIM_INTERNAL */
Note: See TracBrowser for help on using the repository browser.