Backport a conjunction of the portions of revisions
[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_LOGIN_URL "https://login.yahoo.com/config/pwtoken_login?src=ymsgr&ts=&token=%s"
34 #define YAHOO_TOKEN_URL "https://login.yahoo.com/config/pwtoken_get?src=ymsgr&ts=&login=%s&passwd=%s&chal=%s"
35 #define YAHOO_PROFILE_URL "http://profiles.yahoo.com/"
36 #define YAHOO_MAIL_URL "https://login.yahoo.com/config/login?.src=ym"
37 #define YAHOO_XFER_HOST "filetransfer.msg.yahoo.com"
38 #define YAHOO_XFER_PORT 80
39 #define YAHOO_XFER_RELAY_HOST "relay.msg.yahoo.com"
40 #define YAHOO_XFER_RELAY_PORT 80
41 #define YAHOO_ROOMLIST_URL "http://insider.msg.yahoo.com/ycontent/"
42 #define YAHOO_ROOMLIST_LOCALE "us"
43 /* really we should get the list of servers from
44  http://update.messenger.yahoo.co.jp/servers.html */
45 #define YAHOOJP_PAGER_HOST "cs.yahoo.co.jp"
46 #define YAHOOJP_TOKEN_URL "https://login.yahoo.co.jp/config/pwtoken_get?src=ymsgr&ts=&login=%s&passwd=%s&chal=%s"
47 #define YAHOOJP_LOGIN_URL "https://login.yahoo.co.jp/config/pwtoken_login?src=ymsgr&ts=&token=%s"
48 #define YAHOOJP_PROFILE_URL "http://profiles.yahoo.co.jp/"
49 #define YAHOOJP_MAIL_URL "http://mail.yahoo.co.jp/"
50 #define YAHOOJP_XFER_HOST "filetransfer.msg.yahoo.co.jp"
51 #define YAHOOJP_WEBCAM_HOST "wc.yahoo.co.jp"
52 /*not sure, must test:*/
53 #define YAHOOJP_XFER_RELAY_HOST "relay.msg.yahoo.co.jp" 
54 #define YAHOOJP_XFER_RELAY_PORT 80
55 #define YAHOOJP_ROOMLIST_URL "http://insider.msg.yahoo.co.jp/ycontent/"
56 #define YAHOOJP_ROOMLIST_LOCALE "ja"
57
58 #define YAHOO_AUDIBLE_URL "http://us.dl1.yimg.com/download.yahoo.com/dl/aud"
59
60 #define WEBMESSENGER_URL "http://login.yahoo.com/config/login?.src=pg"
61
62 #define YAHOO_PICURL_SETTING "picture_url"
63 #define YAHOO_PICCKSUM_SETTING "picture_checksum"
64 #define YAHOO_PICEXPIRE_SETTING "picture_expire"
65
66 #define YAHOO_STATUS_TYPE_OFFLINE "offline"
67 #define YAHOO_STATUS_TYPE_AVAILABLE "available"
68 #define YAHOO_STATUS_TYPE_BRB "brb"
69 #define YAHOO_STATUS_TYPE_BUSY "busy"
70 #define YAHOO_STATUS_TYPE_NOTATHOME "notathome"
71 #define YAHOO_STATUS_TYPE_NOTATDESK "notatdesk"
72 #define YAHOO_STATUS_TYPE_NOTINOFFICE "notinoffice"
73 #define YAHOO_STATUS_TYPE_ONPHONE "onphone"
74 #define YAHOO_STATUS_TYPE_ONVACATION "onvacation"
75 #define YAHOO_STATUS_TYPE_OUTTOLUNCH "outtolunch"
76 #define YAHOO_STATUS_TYPE_STEPPEDOUT "steppedout"
77 #define YAHOO_STATUS_TYPE_AWAY "away"
78 #define YAHOO_STATUS_TYPE_INVISIBLE "invisible"
79 #define YAHOO_STATUS_TYPE_MOBILE "mobile"
80
81 #define YAHOO_CLIENT_VERSION_ID "4194239"
82 #define YAHOO_CLIENT_VERSION "9.0.0.2152"
83
84 #define YAHOOJP_CLIENT_VERSION_ID "4194239"
85 #define YAHOOJP_CLIENT_VERSION "9.0.0.2152"
86
87
88 /* Index into attention types list. */
89 #define YAHOO_BUZZ 0
90
91 enum yahoo_status {
92         YAHOO_STATUS_AVAILABLE = 0,
93         YAHOO_STATUS_BRB,
94         YAHOO_STATUS_BUSY,
95         YAHOO_STATUS_NOTATHOME,
96         YAHOO_STATUS_NOTATDESK,
97         YAHOO_STATUS_NOTINOFFICE,
98         YAHOO_STATUS_ONPHONE,
99         YAHOO_STATUS_ONVACATION,
100         YAHOO_STATUS_OUTTOLUNCH,
101         YAHOO_STATUS_STEPPEDOUT,
102         YAHOO_STATUS_INVISIBLE = 12,
103         YAHOO_STATUS_CUSTOM = 99,
104         YAHOO_STATUS_IDLE = 999,
105         YAHOO_STATUS_WEBLOGIN = 0x5a55aa55,
106         YAHOO_STATUS_OFFLINE = 0x5a55aa56, /* don't ask */
107         YAHOO_STATUS_TYPING = 0x16,
108         YAHOO_STATUS_DISCONNECTED = 0xffffffff /* in ymsg 15. doesnt mean the normal sense of 'disconnected' */
109 };
110
111 struct yahoo_buddy_icon_upload_data {
112         PurpleConnection *gc;
113         GString *str;
114         char *filename;
115         int pos;
116         int fd;
117         guint watcher;
118 };
119
120 struct _YchtConn;
121
122 struct yahoo_data {
123         PurpleConnection *gc;
124         int fd;
125         guchar *rxqueue;
126         int rxlen;
127         PurpleCircBuffer *txbuf;
128         guint txhandler;
129         GHashTable *friends;
130
131         /**
132          * This is used to keep track of the IMVironment chosen
133          * by people you talk to.  We don't do very much with
134          * this right now... but at least now if the remote user
135          * selects an IMVironment we won't reset it back to the
136          * default of nothing.
137          */
138         GHashTable *imvironments;
139
140         int current_status;
141         gboolean logged_in;
142         GString *tmp_serv_blist, *tmp_serv_ilist, *tmp_serv_plist;
143         GSList *confs;
144         unsigned int conf_id; /* just a counter */
145         gboolean chat_online;
146         gboolean in_chat;
147         char *chat_name;
148         char *pending_chat_room;
149         char *pending_chat_id;
150         char *pending_chat_topic;
151         char *pending_chat_goto;
152         char *auth;
153         gsize auth_written;
154         char *cookie_y;
155         char *cookie_t;
156         int session_id;
157         gboolean jp;
158         gboolean wm; /* connected w/ web messenger method */
159         /* picture aka buddy icon stuff */
160         char *picture_url;
161         int picture_checksum;
162
163         /* ew. we have to check the icon before we connect,
164          * but can't upload it til we're connected. */
165         struct yahoo_buddy_icon_upload_data *picture_upload_todo;
166         PurpleProxyConnectData *buddy_icon_connect_data;
167
168         struct _YchtConn *ycht;
169
170         /**
171          * This linked list contains PurpleUtilFetchUrlData structs
172          * for when we lookup people profile or photo information.
173          */
174         GSList *url_datas;
175         GHashTable *xfer_peer_idstring_map;/*Hey, i dont know, but putting this HashTable next to friends gives a run time fault...*/
176         GSList *cookies;/*contains all cookies, including _y and _t*/
177         
178         /**
179          * We may receive a list15 in multiple packets with no prior warning as to how many we'll be getting;
180          * the server expects us to keep track of the group for which it is sending us contact names.
181          */
182         char *current_list15_grp;
183         time_t last_ping;
184         time_t last_keepalive;
185 };
186
187 #define YAHOO_MAX_STATUS_MESSAGE_LENGTH (255)
188
189 /*
190  * Current Maximum Length for Instant Messages
191  *
192  * This was found by experiment.
193  *
194  * The YMSG protocol allows a message of up to 948 bytes, but the official client
195  * limits to 800 characters.  According to experiments I conducted, it seems that
196  * the discrepancy is to allow some leeway for messages with mixed single- and
197  * multi-byte characters, as I was able to send messages of 840 and 932 bytes
198  * by using some multibyte characters (some random Chinese or Japanese characters,
199  * to be precise). - rekkanoryo
200  */
201 #define YAHOO_MAX_MESSAGE_LENGTH_BYTES 948
202 #define YAHOO_MAX_MESSAGE_LENGTH_CHARS 800
203
204 /* sometimes i wish prpls could #include things from other prpls. then i could just
205  * use the routines from libfaim and not have to admit to knowing how they work. */
206 #define yahoo_put16(buf, data) ( \
207                 (*(buf) = (unsigned char)((data)>>8)&0xff), \
208                 (*((buf)+1) = (unsigned char)(data)&0xff),  \
209                 2)
210 #define yahoo_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
211 #define yahoo_put32(buf, data) ( \
212                 (*((buf)) = (unsigned char)((data)>>24)&0xff), \
213                 (*((buf)+1) = (unsigned char)((data)>>16)&0xff), \
214                 (*((buf)+2) = (unsigned char)((data)>>8)&0xff), \
215                 (*((buf)+3) = (unsigned char)(data)&0xff), \
216                 4)
217 #define yahoo_get32(buf) ((((*(buf))<<24)&0xff000000) + \
218                 (((*((buf)+1))<<16)&0x00ff0000) + \
219                 (((*((buf)+2))<< 8)&0x0000ff00) + \
220                 (((*((buf)+3)    )&0x000000ff)))
221
222 /* util.c */
223 void yahoo_init_colorht(void);
224 void yahoo_dest_colorht(void);
225 char *yahoo_codes_to_html(const char *x);
226 char *yahoo_html_to_codes(const char *src);
227
228 gboolean
229 yahoo_account_use_http_proxy(PurpleConnection *conn);
230
231 /**
232  * Encode some text to send to the yahoo server.
233  *
234  * @param gc The connection handle.
235  * @param str The null terminated utf8 string to encode.
236  * @param utf8 If not @c NULL, whether utf8 is okay or not.
237  *             Even if it is okay, we may not use it. If we
238  *             used it, we set this to @c TRUE, else to
239  *             @c FALSE. If @c NULL, false is assumed, and
240  *             it is not dereferenced.
241  * @return The g_malloced string in the appropriate encoding.
242  */
243 char *yahoo_string_encode(PurpleConnection *gc, const char *str, gboolean *utf8);
244
245 /**
246  * Decode some text received from the server.
247  *
248  * @param gc The gc handle.
249  * @param str The null terminated string to decode.
250  * @param utf8 Did the server tell us it was supposed to be utf8?
251  * @return The decoded, utf-8 string, which must be g_free()'d.
252  */
253 char *yahoo_string_decode(PurpleConnection *gc, const char *str, gboolean utf8);
254
255 char *yahoo_convert_to_numeric(const char *str);
256
257 /* previously-static functions, now needed for yahoo_profile.c */
258 void yahoo_tooltip_text(PurpleBuddy *b, PurpleNotifyUserInfo *user_info, gboolean full);
259
260 /* yahoo_profile.c */
261 void yahoo_get_info(PurpleConnection *gc, const char *name);
262
263 /* needed for xfer, thought theyd be useful for other enhancements later on
264    Returns list of cookies stored in yahoo_data formatted as a single null terminated string
265    returned value must be g_freed
266 */
267 gchar* yahoo_get_cookies(PurpleConnection *gc);
268
269 gboolean yahoo_send_attention(PurpleConnection *gc, const char *username, guint type);
270 GList *yahoo_attention_types(PurpleAccount *account);
271
272 #endif /* _YAHOO_H_ */