13234
|
1 /*
|
|
2 * Gaim's oscar protocol plugin
|
|
3 * This file is the legal property of its developers.
|
|
4 * Please see the AUTHORS file distributed alongside this file.
|
|
5 *
|
|
6 * This library is free software; you can redistribute it and/or
|
|
7 * modify it under the terms of the GNU Lesser General Public
|
|
8 * License as published by the Free Software Foundation; either
|
|
9 * version 2 of the License, or (at your option) any later version.
|
|
10 *
|
|
11 * This library is distributed in the hope that it will be useful,
|
|
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
14 * Lesser General Public License for more details.
|
|
15 *
|
|
16 * You should have received a copy of the GNU Lesser General Public
|
|
17 * License along with this library; if not, write to the Free Software
|
|
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
19 */
|
|
20
|
|
21 /*
|
|
22 * oscar_internal.h -- prototypes/structs for the guts of libfaim
|
|
23 *
|
|
24 */
|
|
25
|
|
26 #ifndef _OSCAR_INTERNAL_H_
|
|
27 #define _OSCAR_INTERNAL_H_
|
|
28
|
|
29 typedef struct {
|
|
30 guint16 family;
|
|
31 guint16 subtype;
|
|
32 guint16 flags;
|
|
33 guint32 id;
|
|
34 } aim_modsnac_t;
|
|
35
|
|
36 #define AIM_MODULENAME_MAXLEN 16
|
|
37 #define AIM_MODFLAG_MULTIFAMILY 0x0001
|
|
38 typedef struct aim_module_s {
|
|
39 guint16 family;
|
|
40 guint16 version;
|
|
41 guint16 toolid;
|
|
42 guint16 toolversion;
|
|
43 guint16 flags;
|
|
44 char name[AIM_MODULENAME_MAXLEN+1];
|
13239
|
45 int (*snachandler)(OscarSession *sess, struct aim_module_s *mod, FlapFrame *rx, aim_modsnac_t *snac, ByteStream *bs);
|
13234
|
46
|
13239
|
47 void (*shutdown)(OscarSession *sess, struct aim_module_s *mod);
|
13234
|
48 void *priv;
|
|
49 struct aim_module_s *next;
|
|
50 } aim_module_t;
|
|
51
|
13239
|
52 faim_internal int aim__registermodule(OscarSession *sess, int (*modfirst)(OscarSession *, aim_module_t *));
|
|
53 faim_internal void aim__shutdownmodules(OscarSession *sess);
|
|
54 faim_internal aim_module_t *aim__findmodulebygroup(OscarSession *sess, guint16 group);
|
|
55 faim_internal aim_module_t *aim__findmodule(OscarSession *sess, const char *name);
|
13234
|
56
|
13239
|
57 faim_internal int admin_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
58 faim_internal int buddylist_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
59 faim_internal int bos_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
60 faim_internal int search_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
61 faim_internal int stats_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
62 faim_internal int auth_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
63 faim_internal int msg_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
64 faim_internal int misc_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
65 faim_internal int chatnav_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
66 faim_internal int chat_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
67 faim_internal int locate_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
68 faim_internal int service_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
69 faim_internal int invite_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
70 faim_internal int translate_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
71 faim_internal int popups_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
72 faim_internal int adverts_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
73 faim_internal int odir_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
74 faim_internal int bart_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
75 faim_internal int ssi_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
76 faim_internal int icq_modfirst(OscarSession *sess, aim_module_t *mod);
|
|
77 faim_internal int email_modfirst(OscarSession *sess, aim_module_t *mod);
|
13234
|
78
|
13239
|
79 faim_internal int aim_genericreq_n(OscarSession *, OscarConnection *conn, guint16 family, guint16 subtype);
|
|
80 faim_internal int aim_genericreq_n_snacid(OscarSession *, OscarConnection *conn, guint16 family, guint16 subtype);
|
|
81 faim_internal int aim_genericreq_l(OscarSession *, OscarConnection *conn, guint16 family, guint16 subtype, guint32 *);
|
|
82 faim_internal int aim_genericreq_s(OscarSession *, OscarConnection *conn, guint16 family, guint16 subtype, guint16 *);
|
13234
|
83
|
|
84 #define AIMBS_CURPOSPAIR(x) ((x)->data + (x)->offset), ((x)->len - (x)->offset)
|
|
85
|
|
86 /* bstream.c */
|
13239
|
87 faim_internal int aim_bstream_init(ByteStream *bs, guint8 *data, int len);
|
|
88 faim_internal int aim_bstream_empty(ByteStream *bs);
|
|
89 faim_internal int aim_bstream_curpos(ByteStream *bs);
|
|
90 faim_internal int aim_bstream_setpos(ByteStream *bs, unsigned int off);
|
|
91 faim_internal void aim_bstream_rewind(ByteStream *bs);
|
|
92 faim_internal int aim_bstream_advance(ByteStream *bs, int n);
|
|
93 faim_internal guint8 aimbs_get8(ByteStream *bs);
|
|
94 faim_internal guint16 aimbs_get16(ByteStream *bs);
|
|
95 faim_internal guint32 aimbs_get32(ByteStream *bs);
|
|
96 faim_internal guint8 aimbs_getle8(ByteStream *bs);
|
|
97 faim_internal guint16 aimbs_getle16(ByteStream *bs);
|
|
98 faim_internal guint32 aimbs_getle32(ByteStream *bs);
|
|
99 faim_internal int aimbs_getrawbuf(ByteStream *bs, guint8 *buf, int len);
|
|
100 faim_internal guint8 *aimbs_getraw(ByteStream *bs, int len);
|
|
101 faim_internal char *aimbs_getstr(ByteStream *bs, int len);
|
|
102 faim_internal int aimbs_put8(ByteStream *bs, guint8 v);
|
|
103 faim_internal int aimbs_put16(ByteStream *bs, guint16 v);
|
|
104 faim_internal int aimbs_put32(ByteStream *bs, guint32 v);
|
|
105 faim_internal int aimbs_putle8(ByteStream *bs, guint8 v);
|
|
106 faim_internal int aimbs_putle16(ByteStream *bs, guint16 v);
|
|
107 faim_internal int aimbs_putle32(ByteStream *bs, guint32 v);
|
|
108 faim_internal int aimbs_putraw(ByteStream *bs, const guint8 *v, int len);
|
|
109 faim_internal int aimbs_putstr(ByteStream *bs, const char *str);
|
|
110 faim_internal int aimbs_putbs(ByteStream *bs, ByteStream *srcbs, int len);
|
|
111 faim_internal int aimbs_putcaps(ByteStream *bs, guint32 caps);
|
13234
|
112
|
|
113 /* conn.c */
|
13239
|
114 faim_internal OscarConnection *aim_cloneconn(OscarSession *sess, OscarConnection *src);
|
13234
|
115
|
|
116 /* rxhandlers.c */
|
13239
|
117 faim_internal aim_rxcallback_t aim_callhandler(OscarSession *sess, OscarConnection *conn, guint16 family, guint16 type);
|
|
118 faim_internal int aim_callhandler_noparam(OscarSession *sess, OscarConnection *conn, guint16 family, guint16 type, FlapFrame *ptr);
|
|
119 faim_internal int aim_parse_unknown(OscarSession *, FlapFrame *, ...);
|
|
120 faim_internal void aim_clonehandlers(OscarSession *sess, OscarConnection *dest, OscarConnection *src);
|
13234
|
121
|
|
122 /* rxqueue.c */
|
|
123 faim_internal int aim_recv(int fd, void *buf, size_t count);
|
13239
|
124 faim_internal int aim_bstream_recv(ByteStream *bs, int fd, size_t count);
|
|
125 faim_internal void aim_rxqueue_cleanbyconn(OscarSession *sess, OscarConnection *conn);
|
|
126 faim_internal void aim_frame_destroy(FlapFrame *);
|
13234
|
127
|
|
128 /* txqueue.c */
|
13239
|
129 faim_internal FlapFrame *aim_tx_new(OscarSession *sess, OscarConnection *conn, guint8 framing, guint16 chan, int datalen);
|
|
130 faim_internal int aim_tx_enqueue(OscarSession *, FlapFrame *);
|
|
131 faim_internal int aim_bstream_send(ByteStream *bs, OscarConnection *conn, size_t count);
|
|
132 faim_internal int aim_tx_sendframe(OscarSession *sess, FlapFrame *cur);
|
|
133 faim_internal void aim_tx_cleanqueue(OscarSession *, OscarConnection *);
|
13234
|
134
|
|
135 /*
|
|
136 * Generic SNAC structure. Rarely if ever used.
|
|
137 */
|
|
138 typedef struct aim_snac_s {
|
|
139 aim_snacid_t id;
|
|
140 guint16 family;
|
|
141 guint16 type;
|
|
142 guint16 flags;
|
|
143 void *data;
|
|
144 time_t issuetime;
|
|
145 struct aim_snac_s *next;
|
|
146 } aim_snac_t;
|
|
147
|
|
148 /* snac.c */
|
13239
|
149 faim_internal void aim_initsnachash(OscarSession *sess);
|
|
150 faim_internal aim_snacid_t aim_newsnac(OscarSession *, aim_snac_t *newsnac);
|
|
151 faim_internal aim_snacid_t aim_cachesnac(OscarSession *sess, const guint16 family, const guint16 type, const guint16 flags, const void *data, const int datalen);
|
|
152 faim_internal aim_snac_t *aim_remsnac(OscarSession *, aim_snacid_t id);
|
|
153 faim_internal int aim_putsnac(ByteStream *, guint16 family, guint16 type, guint16 flags, aim_snacid_t id);
|
13234
|
154
|
|
155 /* Stored in ->priv of the service request SNAC for chats. */
|
|
156 struct chatsnacinfo {
|
|
157 guint16 exchange;
|
|
158 char name[128];
|
|
159 guint16 instance;
|
|
160 };
|
|
161
|
|
162 /*
|
|
163 * In SNACland, the terms 'family' and 'group' are synonymous -- the former
|
|
164 * is my term, the latter is AOL's.
|
|
165 */
|
|
166 struct snacgroup {
|
|
167 guint16 group;
|
|
168 struct snacgroup *next;
|
|
169 };
|
|
170
|
|
171 struct snacpair {
|
|
172 guint16 group;
|
|
173 guint16 subtype;
|
|
174 struct snacpair *next;
|
|
175 };
|
|
176
|
|
177 struct rateclass {
|
|
178 guint16 classid;
|
|
179 guint32 windowsize;
|
|
180 guint32 clear;
|
|
181 guint32 alert;
|
|
182 guint32 limit;
|
|
183 guint32 disconnect;
|
|
184 guint32 current;
|
|
185 guint32 max;
|
|
186 guint8 unknown[5]; /* only present in versions >= 3 */
|
|
187 struct snacpair *members;
|
|
188 struct rateclass *next;
|
|
189 };
|
|
190
|
|
191 /*
|
|
192 * This is inside every connection. But it is a void * to anything
|
|
193 * outside of libfaim. It should remain that way. It's called data
|
|
194 * abstraction. Maybe you've heard of it. (Probably not if you're a
|
|
195 * libfaim user.)
|
|
196 *
|
|
197 */
|
|
198 typedef struct aim_conn_inside_s {
|
|
199 struct snacgroup *groups;
|
|
200 struct rateclass *rates;
|
|
201 } aim_conn_inside_t;
|
|
202
|
13239
|
203 faim_internal void aim_conn_addgroup(OscarConnection *conn, guint16 group);
|
13234
|
204
|
13239
|
205 faim_internal int aim_cachecookie(OscarSession *sess, IcbmCookie *cookie);
|
|
206 faim_internal IcbmCookie *aim_uncachecookie(OscarSession *sess, guint8 *cookie, int type);
|
|
207 faim_internal IcbmCookie *aim_mkcookie(guint8 *, int, void *);
|
|
208 faim_internal IcbmCookie *aim_checkcookie(OscarSession *, const unsigned char *, const int);
|
|
209 faim_internal int aim_freecookie(OscarSession *sess, IcbmCookie *cookie);
|
13234
|
210 faim_internal int aim_msgcookie_gettype(int reqclass);
|
13239
|
211 faim_internal int aim_cookie_free(OscarSession *sess, IcbmCookie *cookie);
|
13234
|
212
|
|
213 /* 0x0002 - locate.c */
|
13239
|
214 faim_internal void aim_locate_requestuserinfo(OscarSession *sess, const char *sn);
|
|
215 faim_internal guint32 aim_locate_getcaps(OscarSession *sess, ByteStream *bs, int len);
|
|
216 faim_internal guint32 aim_locate_getcaps_short(OscarSession *sess, ByteStream *bs, int len);
|
13234
|
217 faim_internal void aim_info_free(aim_userinfo_t *);
|
13239
|
218 faim_internal int aim_info_extract(OscarSession *sess, ByteStream *bs, aim_userinfo_t *);
|
|
219 faim_internal int aim_putuserinfo(ByteStream *bs, aim_userinfo_t *info);
|
13234
|
220
|
13239
|
221 faim_internal int aim_chat_readroominfo(ByteStream *bs, struct aim_chat_roominfo *outinfo);
|
13234
|
222
|
13239
|
223 faim_internal void aim_conn_kill_chat(OscarSession *sess, OscarConnection *conn);
|
13234
|
224
|
|
225 /* These are all handled internally now. */
|
13239
|
226 faim_internal int aim_setversions(OscarSession *sess, OscarConnection *conn);
|
|
227 faim_internal int aim_reqrates(OscarSession *, OscarConnection *);
|
|
228 faim_internal int aim_rates_addparam(OscarSession *, OscarConnection *);
|
|
229 faim_internal int aim_rates_delparam(OscarSession *, OscarConnection *);
|
13234
|
230
|
|
231 #endif /* _OSCAR_INTERNAL_H_ */
|