Mercurial > pidgin
annotate src/protocols/msn/session.h @ 11992:c824e39db0e7
[gaim-migrate @ 14285]
- make Offline a user setable status in MSN
- redo MSN status changing to query the core for the current status instead
of keeping track of it itself, as recommended by Mark on patch #1336338.
- bring back the buddy list synchronization by parsing the buddy list after
signon
committer: Tailor Script <tailor@pidgin.im>
author | Stu Tomlinson <stu@nosnilmot.com> |
---|---|
date | Sun, 06 Nov 2005 21:52:00 +0000 |
parents | 888d4c328be5 |
children | 442b23efba54 |
rev | line source |
---|---|
5309 | 1 /** |
2 * @file session.h MSN session functions | |
3 * | |
4 * gaim | |
5 * | |
9198
ab6636c5a136
[gaim-migrate @ 9993]
Christian Hammond <chipx86@chipx86.com>
parents:
9193
diff
changeset
|
6 * Gaim is the legal property of its developers, whose names are too numerous |
ab6636c5a136
[gaim-migrate @ 9993]
Christian Hammond <chipx86@chipx86.com>
parents:
9193
diff
changeset
|
7 * to list here. Please refer to the COPYRIGHT file distributed with this |
ab6636c5a136
[gaim-migrate @ 9993]
Christian Hammond <chipx86@chipx86.com>
parents:
9193
diff
changeset
|
8 * source distribution. |
6701
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
9 * |
5309 | 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
23 */ | |
24 #ifndef _MSN_SESSION_H_ | |
25 #define _MSN_SESSION_H_ | |
26 | |
27 typedef struct _MsnSession MsnSession; | |
28 | |
6701
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
29 #include "sslconn.h" |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
30 |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
31 #include "notification.h" |
5309 | 32 #include "switchboard.h" |
33 #include "user.h" | |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
34 #include "group.h" |
8171
d0ba2f7b40e7
[gaim-migrate @ 8884]
Christian Hammond <chipx86@chipx86.com>
parents:
7631
diff
changeset
|
35 |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
36 #include "cmdproc.h" |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
37 #include "nexus.h" |
10463 | 38 #include "httpconn.h" |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
39 |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
40 #include "userlist.h" |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
41 #include "sync.h" |
5309 | 42 |
10481 | 43 /** |
44 * Types of errors. | |
45 */ | |
46 typedef enum | |
47 { | |
48 MSN_ERROR_SERVCONN, | |
10519 | 49 MSN_ERROR_UNSUPPORTED_PROTOCOL, |
10481 | 50 MSN_ERROR_HTTP_MALFORMED, |
51 MSN_ERROR_AUTH, | |
52 MSN_ERROR_BAD_BLIST, | |
53 MSN_ERROR_SIGN_OTHER, | |
10568 | 54 MSN_ERROR_SERV_DOWN, |
55 MSN_ERROR_SERV_UNAVAILABLE | |
10481 | 56 |
57 } MsnErrorType; | |
58 | |
59 /** | |
60 * Login steps. | |
61 */ | |
62 typedef enum | |
63 { | |
64 MSN_LOGIN_STEP_START, | |
65 MSN_LOGIN_STEP_HANDSHAKE, | |
66 MSN_LOGIN_STEP_TRANSFER, | |
10514 | 67 MSN_LOGIN_STEP_HANDSHAKE2, |
10481 | 68 MSN_LOGIN_STEP_AUTH_START, |
69 MSN_LOGIN_STEP_AUTH, | |
70 MSN_LOGIN_STEP_GET_COOKIE, | |
71 MSN_LOGIN_STEP_AUTH_END, | |
72 MSN_LOGIN_STEP_SYN, | |
73 MSN_LOGIN_STEP_END | |
74 | |
75 } MsnLoginStep; | |
76 | |
77 #define MSN_LOGIN_STEPS MSN_LOGIN_STEP_END | |
78 | |
5309 | 79 struct _MsnSession |
80 { | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5518
diff
changeset
|
81 GaimAccount *account; |
5363
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5327
diff
changeset
|
82 MsnUser *user; |
5309 | 83 |
7631 | 84 guint protocol_ver; |
6701
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
85 |
10481 | 86 MsnLoginStep login_step; /**< The current step in the login process. */ |
5309 | 87 |
88 gboolean connected; | |
10296 | 89 gboolean logged_in; /**< A temporal flag to ignore local buddy list adds. */ |
90 gboolean destroying; /**< A flag that states if the session is being destroyed. */ | |
10481 | 91 gboolean http_method; |
5309 | 92 |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
93 MsnNotification *notification; |
8171
d0ba2f7b40e7
[gaim-migrate @ 8884]
Christian Hammond <chipx86@chipx86.com>
parents:
7631
diff
changeset
|
94 MsnNexus *nexus; |
10481 | 95 MsnSync *sync; |
7288
ff9127038a5a
[gaim-migrate @ 7869]
Christian Hammond <chipx86@chipx86.com>
parents:
6701
diff
changeset
|
96 |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
97 MsnUserList *userlist; |
5309 | 98 |
10403 | 99 int servconns_count; /**< The count of server connections. */ |
100 GList *switches; /**< The list of all the switchboards. */ | |
101 GList *directconns; /**< The list of all the directconnections. */ | |
10481 | 102 GList *slplinks; /**< The list of all the slplinks. */ |
5309 | 103 |
10481 | 104 int conv_seq; /**< The current conversation sequence number. */ |
5309 | 105 |
106 struct | |
107 { | |
108 char *kv; | |
109 char *sid; | |
110 char *mspauth; | |
111 unsigned long sl; | |
112 char *file; | |
6701
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
113 char *client_ip; |
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
114 int client_port; |
5309 | 115 |
116 } passport_info; | |
117 }; | |
118 | |
119 /** | |
120 * Creates an MSN session. | |
121 * | |
122 * @param account The account. | |
123 * | |
124 * @return The new MSN session. | |
125 */ | |
10481 | 126 MsnSession *msn_session_new(GaimAccount *account); |
5309 | 127 |
128 /** | |
129 * Destroys an MSN session. | |
130 * | |
131 * @param session The MSN session to destroy. | |
132 */ | |
133 void msn_session_destroy(MsnSession *session); | |
134 | |
135 /** | |
136 * Connects to and initiates an MSN session. | |
137 * | |
10481 | 138 * @param session The MSN session. |
139 * @param host The dispatch server host. | |
140 * @param port The dispatch server port. | |
141 * @param http_method Whether to use or not http_method. | |
5309 | 142 * |
143 * @return @c TRUE on success, @c FALSE on failure. | |
144 */ | |
10481 | 145 gboolean msn_session_connect(MsnSession *session, |
146 const char *host, int port, | |
147 gboolean http_method); | |
5309 | 148 |
149 /** | |
150 * Disconnects from an MSN session. | |
151 * | |
152 * @param session The MSN session. | |
153 */ | |
154 void msn_session_disconnect(MsnSession *session); | |
155 | |
10602 | 156 /** |
157 * Finds a switchboard with the given username. | |
158 * | |
159 * @param session The MSN session. | |
160 * @param username The username to search for. | |
161 * | |
162 * @return The switchboard, if found. | |
163 */ | |
164 MsnSwitchBoard *msn_session_find_swboard(MsnSession *session, | |
10621 | 165 const char *username); |
10602 | 166 |
10621 | 167 /** |
168 * Finds a switchboard with the given conversation. | |
169 * | |
170 * @param session The MSN session. | |
171 * @param conv The conversation to search for. | |
172 * | |
173 * @return The switchboard, if found. | |
174 */ | |
175 MsnSwitchBoard *msn_session_find_swboard_with_conv(MsnSession *session, | |
176 GaimConversation *conv); | |
5309 | 177 /** |
178 * Finds a switchboard with the given chat ID. | |
179 * | |
180 * @param session The MSN session. | |
181 * @param chat_id The chat ID to search for. | |
182 * | |
183 * @return The switchboard, if found. | |
184 */ | |
10602 | 185 MsnSwitchBoard *msn_session_find_swboard_with_id(const MsnSession *session, |
10621 | 186 int chat_id); |
5309 | 187 |
10602 | 188 /** |
189 * Returns a switchboard to communicate with certain username. | |
190 * | |
191 * @param session The MSN session. | |
192 * @param username The username to search for. | |
10773 | 193 * @param flag The flag of the switchboard |
10602 | 194 * |
195 * @return The switchboard. | |
196 */ | |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
197 MsnSwitchBoard *msn_session_get_swboard(MsnSession *session, |
10773 | 198 const char *username, MsnSBFlag flag); |
5309 | 199 |
10481 | 200 /** |
201 * Sets an error for the MSN session. | |
202 * | |
203 * @param session The MSN session. | |
204 * @param error The error. | |
205 * @param info Extra information. | |
206 */ | |
207 void msn_session_set_error(MsnSession *session, MsnErrorType error, | |
208 const char *info); | |
209 | |
210 /** | |
211 * Sets the current step in the login proccess. | |
212 * | |
213 * @param session The MSN session. | |
214 * @param step The current step. | |
215 */ | |
216 void msn_session_set_login_step(MsnSession *session, MsnLoginStep step); | |
217 | |
218 /** | |
219 * Finish the login proccess. | |
220 * | |
221 * @param session The MSN session. | |
222 */ | |
10044 | 223 void msn_session_finish_login(MsnSession *session); |
224 | |
5309 | 225 #endif /* _MSN_SESSION_H_ */ |