propagate from branch 'im.pidgin.pidgin' (head 483b6435074838149d6e95b836d4a2d9263f265d)
[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_ROOMLIST_URL "http://insider.msg.yahoo.com/ycontent/"
38 #define YAHOO_ROOMLIST_LOCALE "us"
39 /* really we should get the list of servers from
40  http://update.messenger.yahoo.co.jp/servers.html */
41 #define YAHOOJP_PAGER_HOST "cs.yahoo.co.jp"
42 #define YAHOOJP_PROFILE_URL "http://profiles.yahoo.co.jp/"
43 #define YAHOOJP_MAIL_URL "http://mail.yahoo.co.jp/"
44 #define YAHOOJP_XFER_HOST "filetransfer.msg.yahoo.co.jp"
45 #define YAHOOJP_WEBCAM_HOST "wc.yahoo.co.jp"
46
47 #define YAHOO_AUDIBLE_URL "http://us.dl1.yimg.com/download.yahoo.com/dl/aud"
48
49 #define WEBMESSENGER_URL "http://login.yahoo.com/config/login?.src=pg"
50
51 #define YAHOO_PICURL_SETTING "picture_url"
52 #define YAHOO_PICCKSUM_SETTING "picture_checksum"
53 #define YAHOO_PICEXPIRE_SETTING "picture_expire"
54
55 #define YAHOO_STATUS_TYPE_OFFLINE "offline"
56 #define YAHOO_STATUS_TYPE_AVAILABLE "available"
57 #define YAHOO_STATUS_TYPE_BRB "brb"
58 #define YAHOO_STATUS_TYPE_BUSY "busy"
59 #define YAHOO_STATUS_TYPE_NOTATHOME "notathome"
60 #define YAHOO_STATUS_TYPE_NOTATDESK "notatdesk"
61 #define YAHOO_STATUS_TYPE_NOTINOFFICE "notinoffice"
62 #define YAHOO_STATUS_TYPE_ONPHONE "onphone"
63 #define YAHOO_STATUS_TYPE_ONVACATION "onvacation"
64 #define YAHOO_STATUS_TYPE_OUTTOLUNCH "outtolunch"
65 #define YAHOO_STATUS_TYPE_STEPPEDOUT "steppedout"
66 #define YAHOO_STATUS_TYPE_AWAY "away"
67 #define YAHOO_STATUS_TYPE_INVISIBLE "invisible"
68 #define YAHOO_STATUS_TYPE_MOBILE "mobile"
69
70 /* Index into attention types list. */
71 #define YAHOO_BUZZ 0
72
73 enum yahoo_status {
74         YAHOO_STATUS_AVAILABLE = 0,
75         YAHOO_STATUS_BRB,
76         YAHOO_STATUS_BUSY,
77         YAHOO_STATUS_NOTATHOME,
78         YAHOO_STATUS_NOTATDESK,
79         YAHOO_STATUS_NOTINOFFICE,
80         YAHOO_STATUS_ONPHONE,
81         YAHOO_STATUS_ONVACATION,
82         YAHOO_STATUS_OUTTOLUNCH,
83         YAHOO_STATUS_STEPPEDOUT,
84         YAHOO_STATUS_INVISIBLE = 12,
85         YAHOO_STATUS_CUSTOM = 99,
86         YAHOO_STATUS_IDLE = 999,
87         YAHOO_STATUS_WEBLOGIN = 0x5a55aa55,
88         YAHOO_STATUS_OFFLINE = 0x5a55aa56, /* don't ask */
89         YAHOO_STATUS_TYPING = 0x16
90 };
91
92 struct yahoo_buddy_icon_upload_data {
93         PurpleConnection *gc;
94         GString *str;
95         char *filename;
96         int pos;
97         int fd;
98         guint watcher;
99 };
100
101 struct _YchtConn;
102
103 struct yahoo_data {
104         PurpleConnection *gc;
105         int fd;
106         guchar *rxqueue;
107         int rxlen;
108         PurpleCircBuffer *txbuf;
109         guint txhandler;
110         GHashTable *friends;
111
112         /**
113          * This is used to keep track of the IMVironment chosen
114          * by people you talk to.  We don't do very much with
115          * this right now... but at least now if the remote user
116          * selects an IMVironment we won't reset it back to the
117          * default of nothing.
118          */
119         GHashTable *imvironments;
120
121         int current_status;
122         gboolean logged_in;
123         GString *tmp_serv_blist, *tmp_serv_ilist, *tmp_serv_plist;
124         GSList *confs;
125         unsigned int conf_id; /* just a counter */
126         gboolean chat_online;
127         gboolean in_chat;
128         char *chat_name;
129         char *pending_chat_room;
130         char *pending_chat_id;
131         char *pending_chat_topic;
132         char *pending_chat_goto;
133         char *auth;
134         gsize auth_written;
135         char *cookie_y;
136         char *cookie_t;
137         int session_id;
138         gboolean jp;
139         gboolean wm; /* connected w/ web messenger method */
140         /* picture aka buddy icon stuff */
141         char *picture_url;
142         int picture_checksum;
143
144         /* ew. we have to check the icon before we connect,
145          * but can't upload it til we're connected. */
146         struct yahoo_buddy_icon_upload_data *picture_upload_todo;
147         PurpleProxyConnectData *buddy_icon_connect_data;
148
149         struct _YchtConn *ycht;
150
151         /**
152          * This linked list contains PurpleUtilFetchUrlData structs
153          * for when we lookup people profile or photo information.
154          */
155         GSList *url_datas;
156 };
157
158 #define YAHOO_MAX_STATUS_MESSAGE_LENGTH (255)
159
160 /* sometimes i wish prpls could #include things from other prpls. then i could just
161  * use the routines from libfaim and not have to admit to knowing how they work. */
162 #define yahoo_put16(buf, data) ( \
163                 (*(buf) = (unsigned char)((data)>>8)&0xff), \
164                 (*((buf)+1) = (unsigned char)(data)&0xff),  \
165                 2)
166 #define yahoo_get16(buf) ((((*(buf))<<8)&0xff00) + ((*((buf)+1)) & 0xff))
167 #define yahoo_put32(buf, data) ( \
168                 (*((buf)) = (unsigned char)((data)>>24)&0xff), \
169                 (*((buf)+1) = (unsigned char)((data)>>16)&0xff), \
170                 (*((buf)+2) = (unsigned char)((data)>>8)&0xff), \
171                 (*((buf)+3) = (unsigned char)(data)&0xff), \
172                 4)
173 #define yahoo_get32(buf) ((((*(buf))<<24)&0xff000000) + \
174                 (((*((buf)+1))<<16)&0x00ff0000) + \
175                 (((*((buf)+2))<< 8)&0x0000ff00) + \
176                 (((*((buf)+3)    )&0x000000ff)))
177
178 /* util.c */
179 void yahoo_init_colorht(void);
180 void yahoo_dest_colorht(void);
181 char *yahoo_codes_to_html(const char *x);
182 char *yahoo_html_to_codes(const char *src);
183
184 /**
185  * Encode some text to send to the yahoo server.
186  *
187  * @param gc The connection handle.
188  * @param str The null terminated utf8 string to encode.
189  * @param utf8 If not @c NULL, whether utf8 is okay or not.
190  *             Even if it is okay, we may not use it. If we
191  *             used it, we set this to @c TRUE, else to
192  *             @c FALSE. If @c NULL, false is assumed, and
193  *             it is not dereferenced.
194  * @return The g_malloced string in the appropriate encoding.
195  */
196 char *yahoo_string_encode(PurpleConnection *gc, const char *str, gboolean *utf8);
197
198 /**
199  * Decode some text received from the server.
200  *
201  * @param gc The gc handle.
202  * @param str The null terminated string to decode.
203  * @param utf8 Did the server tell us it was supposed to be utf8?
204  * @return The decoded, utf-8 string, which must be g_free()'d.
205  */
206 char *yahoo_string_decode(PurpleConnection *gc, const char *str, gboolean utf8);
207
208 /* previously-static functions, now needed for yahoo_profile.c */
209 void yahoo_tooltip_text(PurpleBuddy *b, PurpleNotifyUserInfo *user_info, gboolean full);
210
211 /* yahoo_profile.c */
212 void yahoo_get_info(PurpleConnection *gc, const char *name);
213
214 /**
215  * Check to see whether the sender is permitted to send
216  *
217  * @param gc The gc handle.
218  * @param who The sender of the packet to check
219 */
220 gboolean yahoo_privacy_check
221         (PurpleConnection *gc, const char *who);
222
223 gboolean yahoo_send_attention(PurpleConnection *gc, const char *username, guint type);
224 GList *yahoo_attention_types(PurpleAccount *account);
225
226 #endif /* _YAHOO_H_ */