source: libfaim/aim_internal.h @ 5e53c4a

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