Mercurial > pidgin.yaz
annotate src/protocols/msn/session.h @ 10514:8f1316d77315
[gaim-migrate @ 11814]
Prevent the login progress going backwards if MSN decides to throw an extra
step into the login process. And a spelling fix.
committer: Tailor Script <tailor@pidgin.im>
author | Stu Tomlinson <stu@nosnilmot.com> |
---|---|
date | Thu, 13 Jan 2005 19:37:34 +0000 |
parents | bcfea6c3d5c9 |
children | bec9130b24d2 |
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, | |
49 MSN_ERROR_UNSUPORTED_PROTOCOL, | |
50 MSN_ERROR_HTTP_MALFORMED, | |
51 MSN_ERROR_AUTH, | |
52 MSN_ERROR_BAD_BLIST, | |
53 MSN_ERROR_SIGN_OTHER, | |
54 MSN_ERROR_SERV_DOWN | |
55 | |
56 } MsnErrorType; | |
57 | |
58 /** | |
59 * Login steps. | |
60 */ | |
61 typedef enum | |
62 { | |
63 MSN_LOGIN_STEP_START, | |
64 MSN_LOGIN_STEP_HANDSHAKE, | |
65 MSN_LOGIN_STEP_TRANSFER, | |
10514 | 66 MSN_LOGIN_STEP_HANDSHAKE2, |
10481 | 67 MSN_LOGIN_STEP_AUTH_START, |
68 MSN_LOGIN_STEP_AUTH, | |
69 MSN_LOGIN_STEP_GET_COOKIE, | |
70 MSN_LOGIN_STEP_AUTH_END, | |
71 MSN_LOGIN_STEP_SYN, | |
72 MSN_LOGIN_STEP_END | |
73 | |
74 } MsnLoginStep; | |
75 | |
76 #define MSN_LOGIN_STEPS MSN_LOGIN_STEP_END | |
77 | |
5309 | 78 struct _MsnSession |
79 { | |
5564
187c740f2a4e
[gaim-migrate @ 5966]
Christian Hammond <chipx86@chipx86.com>
parents:
5518
diff
changeset
|
80 GaimAccount *account; |
5363
ebebc833cf77
[gaim-migrate @ 5739]
Christian Hammond <chipx86@chipx86.com>
parents:
5327
diff
changeset
|
81 MsnUser *user; |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
82 int state; |
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; |
10044 | 98 MsnUserList *sync_userlist; |
5309 | 99 |
10403 | 100 int servconns_count; /**< The count of server connections. */ |
101 GList *switches; /**< The list of all the switchboards. */ | |
102 GList *directconns; /**< The list of all the directconnections. */ | |
10481 | 103 GList *slplinks; /**< The list of all the slplinks. */ |
5309 | 104 |
10481 | 105 int conv_seq; /**< The current conversation sequence number. */ |
5309 | 106 |
107 struct | |
108 { | |
109 char *kv; | |
110 char *sid; | |
111 char *mspauth; | |
112 unsigned long sl; | |
113 char *file; | |
6701
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
114 char *client_ip; |
b7e113a59b51
[gaim-migrate @ 7227]
Christian Hammond <chipx86@chipx86.com>
parents:
5898
diff
changeset
|
115 int client_port; |
5309 | 116 |
117 } passport_info; | |
118 }; | |
119 | |
120 /** | |
121 * Creates an MSN session. | |
122 * | |
123 * @param account The account. | |
124 * | |
125 * @return The new MSN session. | |
126 */ | |
10481 | 127 MsnSession *msn_session_new(GaimAccount *account); |
5309 | 128 |
129 /** | |
130 * Destroys an MSN session. | |
131 * | |
132 * @param session The MSN session to destroy. | |
133 */ | |
134 void msn_session_destroy(MsnSession *session); | |
135 | |
136 /** | |
137 * Connects to and initiates an MSN session. | |
138 * | |
10481 | 139 * @param session The MSN session. |
140 * @param host The dispatch server host. | |
141 * @param port The dispatch server port. | |
142 * @param http_method Whether to use or not http_method. | |
5309 | 143 * |
144 * @return @c TRUE on success, @c FALSE on failure. | |
145 */ | |
10481 | 146 gboolean msn_session_connect(MsnSession *session, |
147 const char *host, int port, | |
148 gboolean http_method); | |
5309 | 149 |
150 /** | |
151 * Disconnects from an MSN session. | |
152 * | |
153 * @param session The MSN session. | |
154 */ | |
155 void msn_session_disconnect(MsnSession *session); | |
156 | |
157 /** | |
158 * Finds a switchboard with the given chat ID. | |
159 * | |
160 * @param session The MSN session. | |
161 * @param chat_id The chat ID to search for. | |
162 * | |
163 * @return The switchboard, if found. | |
164 */ | |
165 MsnSwitchBoard *msn_session_find_switch_with_id(const MsnSession *session, | |
166 int chat_id); | |
167 | |
9193
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
168 MsnSwitchBoard *msn_session_find_swboard(MsnSession *session, |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
169 const char *username); |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
170 MsnSwitchBoard *msn_session_get_swboard(MsnSession *session, |
502707ca1836
[gaim-migrate @ 9988]
Christian Hammond <chipx86@chipx86.com>
parents:
9158
diff
changeset
|
171 const char *username); |
5309 | 172 |
10481 | 173 /** |
174 * Sets an error for the MSN session. | |
175 * | |
176 * @param session The MSN session. | |
177 * @param error The error. | |
178 * @param info Extra information. | |
179 */ | |
180 void msn_session_set_error(MsnSession *session, MsnErrorType error, | |
181 const char *info); | |
182 | |
183 /** | |
184 * Sets the current step in the login proccess. | |
185 * | |
186 * @param session The MSN session. | |
187 * @param step The current step. | |
188 */ | |
189 void msn_session_set_login_step(MsnSession *session, MsnLoginStep step); | |
190 | |
191 /** | |
192 * Finish the login proccess. | |
193 * | |
194 * @param session The MSN session. | |
195 */ | |
10044 | 196 void msn_session_finish_login(MsnSession *session); |
197 | |
5309 | 198 #endif /* _MSN_SESSION_H_ */ |