merge of '1cb1b4ee3379b50280fbc97f2c889a43cd7c8c41'
[pidgin-git:pidgin-git.git] / libpurple / protocols / yahoo / yahoo.h
1 /**
2  * @file yahoo.h The Yahoo! protocol plugin
3  *
4  * purple
5  *
6  * Purple is the legal property of its developers, whose names are too numerous
7  * to list here.  Please refer to the COPYRIGHT file distributed with this
8  * source distribution.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
23  */
24
25 #ifndef _YAHOO_H_
26 #define _YAHOO_H_
27
28 #include "circbuffer.h"
29 #include "prpl.h"
30
31 #define YAHOO_PAGER_HOST "scs.msg.yahoo.com"
32 #define YAHOO_PAGER_PORT 5050
33 #define YAHOO_PROFILE_URL "http://profiles.yahoo.com/"
34 #define YAHOO_MAIL_URL "https://login.yahoo.com/config/login?.src=ym"
35 #define YAHOO_XFER_HOST "filetransfer.msg.yahoo.com"
36 #define YAHOO_XFER_PORT 80
37 #define YAHOO_XFER_RELAY_HOST "relay.msg.yahoo.com"
38 #define YAHOO_XFER_RELAY_PORT 80
39 #define YAHOO_ROOMLIST_URL "http://insider.msg.yahoo.com/ycontent/"
40 #define YAHOO_ROOMLIST_LOCALE "us"
41 /* really we should get the list of servers from
42  http://update.messenger.yahoo.co.jp/servers.html */
43 #define YAHOOJP_PAGER_HOST "cs.yahoo.co.jp"
44 #define YAHOOJP_PROFILE_URL "http://profiles.yahoo.co.jp/"
45 #define YAHOOJP_MAIL_URL "http://mail.yahoo.co.jp/"
46 #define YAHOOJP_XFER_HOST "filetransfer.msg.yahoo.co.jp"
47 #define YAHOOJP_WEBCAM_HOST "wc.yahoo.co.jp"
48 /*not sure, must test:*/
49 #define YAHOOJP_XFER_RELAY_HOST "relay.msg.yahoo.co.jp" 
50 #define YAHOOJP_XFER_RELAY_PORT 80
51 #define YAHOOJP_ROOMLIST_URL "http://insider.msg.yahoo.co.jp/ycontent/"
52 #define YAHOOJP_ROOMLIST_LOCALE "ja"
53
54 #define YAHOO_AUDIBLE_URL "http://us.dl1.yimg.com/download.yahoo.com/dl/aud"
55
56 #define WEBMESSENGER_URL "http://login.yahoo.com/config/login?.src=pg"
57
58 #define YAHOO_PICURL_SETTING "picture_url"
59 #define YAHOO_PICCKSUM_SETTING "picture_checksum"
60 #define YAHOO_PICEXPIRE_SETTING "picture_expire"
61
62 #define YAHOO_STATUS_TYPE_OFFLINE "offline"
63 #define YAHOO_STATUS_TYPE_AVAILABLE "available"
64 #define YAHOO_STATUS_TYPE_BRB "brb"
65 #define YAHOO_STATUS_TYPE_BUSY "busy"
66 #define YAHOO_STATUS_TYPE_NOTATHOME "notathome"
67 #define YAHOO_STATUS_TYPE_NOTATDESK "notatdesk"
68 #define YAHOO_STATUS_TYPE_NOTINOFFICE "notinoffice"
69 #define YAHOO_STATUS_TYPE_ONPHONE "onphone"
70 #define YAHOO_STATUS_TYPE_ONVACATION "onvacation"
71 #define YAHOO_STATUS_TYPE_OUTTOLUNCH "outtolunch"
72 #define YAHOO_STATUS_TYPE_STEPPEDOUT "steppedout"
73 #define YAHOO_STATUS_TYPE_AWAY "away"
74 #define YAHOO_STATUS_TYPE_INVISIBLE "invisible"
75 #define YAHOO_STATUS_TYPE_MOBILE "mobile"
76
77 #define YAHOO_CLIENT_VERSION_ID "2097087"
78 #define YAHOO_CLIENT_VERSION "8.1.0.421"
79
80 #define YAHOOJP_CLIENT_VERSION_ID "524223"
81 #define YAHOOJP_CLIENT_VERSION "7,0,1,1"
82
83
84 /* Index into attention types list. */
85 #define YAHOO_BUZZ 0
86
87 enum yahoo_status {
88         YAHOO_STATUS_AVAILABLE = 0,
89         YAHOO_STATUS_BRB,
90         YAHOO_STATUS_BUSY,
91         YAHOO_STATUS_NOTATHOME,
92         YAHOO_STATUS_NOTATDESK,
93         YAHOO_STATUS_NOTINOFFICE,
94         YAHOO_STATUS_ONPHONE,
95         YAHOO_STATUS_ONVACATION,
96         YAHOO_STATUS_OUTTOLUNCH,
97         YAHOO_STATUS_STEPPEDOUT,
98         YAHOO_STATUS_INVISIBLE = 12,
99         YAHOO_STATUS_CUSTOM = 99,
100         YAHOO_STATUS_IDLE = 999,
101         YAHOO_STATUS_WEBLOGIN = 0x5a55aa55,
102         YAHOO_STATUS_OFFLINE = 0x5a55aa56, /* don't ask */
103         YAHOO_STATUS_TYPING = 0x16,
104         YAHOO_STATUS_DISCONNECTED = 0xffffffff /* in ymsg 15. doesnt mean the normal sense of 'disconnected' */
105 };
106
107 struct yahoo_buddy_icon_upload_data {
108         PurpleConnection *gc;
109         GString *str;
110         char *filename;
111         int pos;
112         int fd;
113         guint watcher;
114 };
115
116 struct _YchtConn;
117
118 struct yahoo_data {
119         PurpleConnection *gc;
120         int fd;
121         guchar *rxqueue;
122         int rxlen;
123         PurpleCircBuffer *txbuf;
124         guint txhandler;
125         GHashTable *friends;
126
127         /**
128          * This is used to keep track of the IMVironment chosen
129          * by people you talk to.  We don't do very much with
130          * this right now... but at least now if the remote user
131          * selects an IMVironment we won't reset it back to the
132          * default of nothing.
133          */
134         GHashTable *imvironments;
135
136         int current_status;
137         gboolean logged_in;
138         GString *tmp_serv_blist, *tmp_serv_ilist, *tmp_serv_plist;
139         GSList *confs;
140         unsigned int conf_id; /* just a counter */
141         gboolean chat_online;
142         gboolean in_chat;
143         char *chat_name;
144         char *pending_chat_room;
145         char *pending_chat_id;
146         char *pending_chat_topic;
147         char *pending_chat_goto;
148         char *auth;
149         gsize auth_written;
150         char *cookie_y;
151         char *cookie_t;
152         int session_id;
153         gboolean jp;
154         gboolean wm; /* connected w/ web messenger method */
155         /* picture aka buddy icon stuff */
156         char *picture_url;
157         int picture_checksum;
158
159         /* ew. we have to check the icon before we connect,
160          * but can't upload it til we're connected. */
161         struct yahoo_buddy_icon_upload_data *picture_upload_todo;
162         PurpleProxyConnectData *buddy_icon_connect_data;
163
164         struct _YchtConn *ycht;
165
166         /**
167          * This linked list contains PurpleUtilFetchUrlData structs
168          * for when we lookup people profile or photo information.
169          */
170         GSList *url_datas;
171         GHashTable *xfer_peer_idstring_map;/*Hey, i dont know, but putting this HashTable next to friends gives a run time fault...*/
172         GSList *cookies;/*contains all cookies, including _y and _t*/
173         
174         /**
175          * We may receive a list15 in multiple packets with no prior warning as to how many we'll be getting;
176          * the server expects us to keep track of the group for which it is sending us contact names.
177          */
178         char *current_list15_grp;
179         time_t last_ping;
180         time_t last_keepalive;
181 };
182
183 #define YAHOO_MAX_STATUS_MESSAGE_LENGTH (255)
184
185 /* sometimes i wish prpls could #include things from other prpls. then i could just
186  * use the routines from libfaim and not have to admit to knowing how they work. */
187 #define yahoo_put16(buf, data) ( \
188                 (*(buf) = (unsigned char)((data)>>8)&0xff), \
189                 (*((buf)+1) = (unsigned char)(data)&0xff),  \
190                 2)
191 #define yahoo_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
192 #define yahoo_put32(buf, data) ( \
193                 (*((buf)) = (unsigned char)((data)>>24)&0xff), \
194                 (*((buf)+1) = (unsigned char)((data)>>16)&0xff), \
195                 (*((buf)+2) = (unsigned char)((data)>>8)&0xff), \
196                 (*((buf)+3) = (unsigned char)(data)&0xff), \
197                 4)
198 #define yahoo_get32(buf) ((((*(buf))<<24)&0xff000000) + \
199                 (((*((buf)+1))<<16)&0x00ff0000) + \
200                 (((*((buf)+2))<< 8)&0x0000ff00) + \
201                 (((*((buf)+3)    )&0x000000ff)))
202
203 /* util.c */
204 void yahoo_init_colorht(void);
205 void yahoo_dest_colorht(void);
206 char *yahoo_codes_to_html(const char *x);
207 char *yahoo_html_to_codes(const char *src);
208
209 gboolean
210 yahoo_account_use_http_proxy(PurpleConnection *conn);
211
212 /**
213  * Encode some text to send to the yahoo server.
214  *
215  * @param gc The connection handle.
216  * @param str The null terminated utf8 string to encode.
217  * @param utf8 If not @c NULL, whether utf8 is okay or not.
218  *             Even if it is okay, we may not use it. If we
219  *             used it, we set this to @c TRUE, else to
220  *             @c FALSE. If @c NULL, false is assumed, and
221  *             it is not dereferenced.
222  * @return The g_malloced string in the appropriate encoding.
223  */
224 char *yahoo_string_encode(PurpleConnection *gc, const char *str, gboolean *utf8);
225
226 /**
227  * Decode some text received from the server.
228  *
229  * @param gc The gc handle.
230  * @param str The null terminated string to decode.
231  * @param utf8 Did the server tell us it was supposed to be utf8?
232  * @return The decoded, utf-8 string, which must be g_free()'d.
233  */
234 char *yahoo_string_decode(PurpleConnection *gc, const char *str, gboolean utf8);
235
236 char *yahoo_convert_to_numeric(const char *str);
237
238 /* previously-static functions, now needed for yahoo_profile.c */
239 void yahoo_tooltip_text(PurpleBuddy *b, PurpleNotifyUserInfo *user_info, gboolean full);
240
241 /* yahoo_profile.c */
242 void yahoo_get_info(PurpleConnection *gc, const char *name);
243
244 /* needed for xfer, thought theyd be useful for other enhancements later on
245    Returns list of cookies stored in yahoo_data formatted as a single null terminated string
246    returned value must be g_freed
247 */
248 gchar* yahoo_get_cookies(PurpleConnection *gc);
249
250 gboolean yahoo_send_attention(PurpleConnection *gc, const char *username, guint type);
251 GList *yahoo_attention_types(PurpleAccount *account);
252
253 #endif /* _YAHOO_H_ */