merge of '131ee6ac42d38162c4fce7a7200a0afa01aed6ce'
[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.com" 
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 /* Index into attention types list. */
81 #define YAHOO_BUZZ 0
82
83 enum yahoo_status {
84         YAHOO_STATUS_AVAILABLE = 0,
85         YAHOO_STATUS_BRB,
86         YAHOO_STATUS_BUSY,
87         YAHOO_STATUS_NOTATHOME,
88         YAHOO_STATUS_NOTATDESK,
89         YAHOO_STATUS_NOTINOFFICE,
90         YAHOO_STATUS_ONPHONE,
91         YAHOO_STATUS_ONVACATION,
92         YAHOO_STATUS_OUTTOLUNCH,
93         YAHOO_STATUS_STEPPEDOUT,
94         YAHOO_STATUS_INVISIBLE = 12,
95         YAHOO_STATUS_CUSTOM = 99,
96         YAHOO_STATUS_IDLE = 999,
97         YAHOO_STATUS_WEBLOGIN = 0x5a55aa55,
98         YAHOO_STATUS_OFFLINE = 0x5a55aa56, /* don't ask */
99         YAHOO_STATUS_TYPING = 0x16,
100         YAHOO_STATUS_DISCONNECTED = 0xffffffff /* in ymsg 15. doesnt mean the normal sense of 'disconnected' */
101 };
102
103 struct yahoo_buddy_icon_upload_data {
104         PurpleConnection *gc;
105         GString *str;
106         char *filename;
107         int pos;
108         int fd;
109         guint watcher;
110 };
111
112 struct _YchtConn;
113
114 struct yahoo_data {
115         PurpleConnection *gc;
116         int fd;
117         guchar *rxqueue;
118         int rxlen;
119         PurpleCircBuffer *txbuf;
120         guint txhandler;
121         GHashTable *friends;
122
123         /**
124          * This is used to keep track of the IMVironment chosen
125          * by people you talk to.  We don't do very much with
126          * this right now... but at least now if the remote user
127          * selects an IMVironment we won't reset it back to the
128          * default of nothing.
129          */
130         GHashTable *imvironments;
131
132         int current_status;
133         gboolean logged_in;
134         GString *tmp_serv_blist, *tmp_serv_ilist, *tmp_serv_plist;
135         GSList *confs;
136         unsigned int conf_id; /* just a counter */
137         gboolean chat_online;
138         gboolean in_chat;
139         char *chat_name;
140         char *pending_chat_room;
141         char *pending_chat_id;
142         char *pending_chat_topic;
143         char *pending_chat_goto;
144         char *auth;
145         gsize auth_written;
146         char *cookie_y;
147         char *cookie_t;
148         int session_id;
149         gboolean jp;
150         gboolean wm; /* connected w/ web messenger method */
151         /* picture aka buddy icon stuff */
152         char *picture_url;
153         int picture_checksum;
154
155         /* ew. we have to check the icon before we connect,
156          * but can't upload it til we're connected. */
157         struct yahoo_buddy_icon_upload_data *picture_upload_todo;
158         PurpleProxyConnectData *buddy_icon_connect_data;
159
160         struct _YchtConn *ycht;
161
162         /**
163          * This linked list contains PurpleUtilFetchUrlData structs
164          * for when we lookup people profile or photo information.
165          */
166         GSList *url_datas;
167         GHashTable *xfer_peer_idstring_map;/*Hey, i dont know, but putting this HashTable next to friends gives a run time fault...*/
168         GSList *cookies;/*contains all cookies, including _y and _t*/
169 };
170
171 #define YAHOO_MAX_STATUS_MESSAGE_LENGTH (255)
172
173 /* sometimes i wish prpls could #include things from other prpls. then i could just
174  * use the routines from libfaim and not have to admit to knowing how they work. */
175 #define yahoo_put16(buf, data) ( \
176                 (*(buf) = (unsigned char)((data)>>8)&0xff), \
177                 (*((buf)+1) = (unsigned char)(data)&0xff),  \
178                 2)
179 #define yahoo_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
180 #define yahoo_put32(buf, data) ( \
181                 (*((buf)) = (unsigned char)((data)>>24)&0xff), \
182                 (*((buf)+1) = (unsigned char)((data)>>16)&0xff), \
183                 (*((buf)+2) = (unsigned char)((data)>>8)&0xff), \
184                 (*((buf)+3) = (unsigned char)(data)&0xff), \
185                 4)
186 #define yahoo_get32(buf) ((((*(buf))<<24)&0xff000000) + \
187                 (((*((buf)+1))<<16)&0x00ff0000) + \
188                 (((*((buf)+2))<< 8)&0x0000ff00) + \
189                 (((*((buf)+3)    )&0x000000ff)))
190
191 /* util.c */
192 void yahoo_init_colorht(void);
193 void yahoo_dest_colorht(void);
194 char *yahoo_codes_to_html(const char *x);
195 char *yahoo_html_to_codes(const char *src);
196
197 /**
198  * Encode some text to send to the yahoo server.
199  *
200  * @param gc The connection handle.
201  * @param str The null terminated utf8 string to encode.
202  * @param utf8 If not @c NULL, whether utf8 is okay or not.
203  *             Even if it is okay, we may not use it. If we
204  *             used it, we set this to @c TRUE, else to
205  *             @c FALSE. If @c NULL, false is assumed, and
206  *             it is not dereferenced.
207  * @return The g_malloced string in the appropriate encoding.
208  */
209 char *yahoo_string_encode(PurpleConnection *gc, const char *str, gboolean *utf8);
210
211 /**
212  * Decode some text received from the server.
213  *
214  * @param gc The gc handle.
215  * @param str The null terminated string to decode.
216  * @param utf8 Did the server tell us it was supposed to be utf8?
217  * @return The decoded, utf-8 string, which must be g_free()'d.
218  */
219 char *yahoo_string_decode(PurpleConnection *gc, const char *str, gboolean utf8);
220
221 char *yahoo_convert_to_numeric(const char *str);
222
223 /* previously-static functions, now needed for yahoo_profile.c */
224 void yahoo_tooltip_text(PurpleBuddy *b, PurpleNotifyUserInfo *user_info, gboolean full);
225
226 /* yahoo_profile.c */
227 void yahoo_get_info(PurpleConnection *gc, const char *name);
228
229 /* needed for xfer, thought theyd be useful for other enhancements later on
230    Returns list of cookies stored in yahoo_data formatted as a single null terminated string
231    returned value must be g_freed
232 */
233 gchar* yahoo_get_cookies(PurpleConnection *gc);
234
235 /**
236  * Check to see whether the sender is permitted to send
237  *
238  * @param gc The gc handle.
239  * @param who The sender of the packet to check
240 */
241 gboolean yahoo_privacy_check
242         (PurpleConnection *gc, const char *who);
243
244 gboolean yahoo_send_attention(PurpleConnection *gc, const char *username, guint type);
245 GList *yahoo_attention_types(PurpleAccount *account);
246
247 #endif /* _YAHOO_H_ */