~ubuntu-branches/ubuntu/natty/gnome-vfs/natty : revision 17

1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

2

<html>

3

<head>

4

5

<title>gnome-vfs-standard-callbacks</title>

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

</head>

24

25

26

27

28

29

30

<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>

31

32

</tr>

33

34

35

|

36

<a href="#gnome-vfs-2.0-gnome-vfs-standard-callbacks.description" class="shortcut">Description</a>

37

</td></tr>

38

</table>

39

40

41

42

43

<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-standard-callbacks.top_of_page"></a>gnome-vfs-standard-callbacks</span></h2>

44

<p>gnome-vfs-standard-callbacks — standard callbacks for use by gnome-vfs module writers</p>

45

</td>

46

47

</tr></table></div>

48

49

<a name="gnome-vfs-2.0-gnome-vfs-standard-callbacks.synopsis"></a><h2>Synopsis</h2>

50

51

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</a>

52

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationIn" title="GnomeVFSModuleCallbackFillAuthenticationIn">GnomeVFSModuleCallbackFillAuthenticationIn</a>;

53

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationOut" title="GnomeVFSModuleCallbackFillAuthenticationOut">GnomeVFSModuleCallbackFillAuthenticationOut</a>;

54

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</a>

55

enum <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags">GnomeVFSModuleCallbackFullAuthenticationFlags</a>;

56

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn">GnomeVFSModuleCallbackFullAuthenticationIn</a>;

57

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut">GnomeVFSModuleCallbackFullAuthenticationOut</a>;

58

enum <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOutFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationOutFlags">GnomeVFSModuleCallbackFullAuthenticationOutFlags</a>;

59

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</a>

60

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackSaveAuthenticationIn" title="GnomeVFSModuleCallbackSaveAuthenticationIn">GnomeVFSModuleCallbackSaveAuthenticationIn</a>;

61

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackSaveAuthenticationOut" title="GnomeVFSModuleCallbackSaveAuthenticationOut">GnomeVFSModuleCallbackSaveAuthenticationOut</a>;

62

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-QUESTION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_QUESTION">GNOME_VFS_MODULE_CALLBACK_QUESTION</a>

63

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackQuestionIn" title="GnomeVFSModuleCallbackQuestionIn">GnomeVFSModuleCallbackQuestionIn</a>;

64

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackQuestionOut" title="GnomeVFSModuleCallbackQuestionOut">GnomeVFSModuleCallbackQuestionOut</a>;

65

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE:CAPS" title="GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE">GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</a>

66

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageIn" title="GnomeVFSModuleCallbackStatusMessageIn">GnomeVFSModuleCallbackStatusMessageIn</a>;

67

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageOut" title="GnomeVFSModuleCallbackStatusMessageOut">GnomeVFSModuleCallbackStatusMessageOut</a>;

68

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS">GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</a>

69

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersIn" title="GnomeVFSModuleCallbackAdditionalHeadersIn">GnomeVFSModuleCallbackAdditionalHeadersIn</a>;

70

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersOut" title="GnomeVFSModuleCallbackAdditionalHeadersOut">GnomeVFSModuleCallbackAdditionalHeadersOut</a>;

71

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</a>

72

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersIn" title="GnomeVFSModuleCallbackReceivedHeadersIn">GnomeVFSModuleCallbackReceivedHeadersIn</a>;

73

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersOut" title="GnomeVFSModuleCallbackReceivedHeadersOut">GnomeVFSModuleCallbackReceivedHeadersOut</a>;

74

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</a>

75

#define <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION">GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</a>

76

enum <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationAuthType" title="enum GnomeVFSModuleCallbackAuthenticationAuthType">GnomeVFSModuleCallbackAuthenticationAuthType</a>;

77

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationIn" title="GnomeVFSModuleCallbackAuthenticationIn">GnomeVFSModuleCallbackAuthenticationIn</a>;

78

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationOut" title="GnomeVFSModuleCallbackAuthenticationOut">GnomeVFSModuleCallbackAuthenticationOut</a>;

79

</pre>

80

</div>

81

82

<a name="gnome-vfs-2.0-gnome-vfs-standard-callbacks.description"></a><h2>Description</h2>

83

<p>

84

</p>

85

</div>

86

87

<a name="gnome-vfs-2.0-gnome-vfs-standard-callbacks.details"></a><h2>Details</h2>

88

89

<a name="GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</h3>

90

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION "fill-authentication"

91

</pre>

92

<p>

93

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

94

ask the keyring manager for login data. It is expected to return stored or cached

95

login data, but may not query the user.

96

</p>

97

<p>

98

The login data consists of a username, a password and a domain, and is used to

99

access a resource. If the data is not suitable for accessing the resource, the

100

<span class="type">GnomeVFSModule</span> typically issues a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a>

101

module callback to query the user right after the authentication failed.

102

</p>

103

<p>

104

</p>

105

106

107

<tbody>

108

<tr>

109

110

<td>

111

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationIn" title="GnomeVFSModuleCallbackFillAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFillAuthenticationIn</span></a> * passed to the application,

112

specifying the authentication request. The application will usually proxy this

113

request to the keyring manager of the desktop environment, but it can also handle

114

the request itself.

115

</td>

116

</tr>

117

<tr>

118

119

<td>

120

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationOut" title="GnomeVFSModuleCallbackFillAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFillAuthenticationOut</span></a> * passing the cached

121

keyring data (i.e. username/password etc.) back to the module. Usually,

122

this is data that was stored using <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</span></a>,

123

and is either stored permanently on disk or cached.

124

</td>

125

</tr>

126

</tbody>

127

</table></div>

128

<p>

129

</p>

130

</div>

131

<hr>

132

133

<a name="GnomeVFSModuleCallbackFillAuthenticationIn"></a><h3>GnomeVFSModuleCallbackFillAuthenticationIn</h3>

134

<pre class="programlisting">typedef struct {

135

char *uri;

136

char *protocol;

137

char *server;

138

char *object;

139

int port;

140

char *authtype;

141

char *username;

142

char *domain;

143

} GnomeVFSModuleCallbackFillAuthenticationIn;

144

</pre>

145

<p>

146

A pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationIn" title="GnomeVFSModuleCallbackFillAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFillAuthenticationIn</span></a> structure is passed to the

147

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a> callback, and informs the application

148

about the authentication parameters that should be requested from the user.

149

</p>

150

<p>

151

The <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a> application callback will then set

152

the members of a pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationOut" title="GnomeVFSModuleCallbackFillAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFillAuthenticationOut</span></a> structure

153

according to the stored or cached data.</p>

154

<p>

155

</p>

156

157

158

<tbody>

159

<tr>

160

161

<td> The textual URI of the resource that requires authentication.

162

</td>

163

</tr>

164

<tr>

165

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationIn.protocol"></a>protocol</code></em>;</span></p></td>

166

<td> One of the protocols supported by the invoking module.

167

Typically matches <em class="parameter"><code>uri</code></em>'s protocol.

168

</td>

169

</tr>

170

<tr>

171

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationIn.server"></a>server</code></em>;</span></p></td>

172

<td> The server that contains the resource that requires authentication.

173

Typically matches <em class="parameter"><code>uri</code></em>'s hostname.

174

</td>

175

</tr>

176

<tr>

177

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationIn.object"></a>object</code></em>;</span></p></td>

178

<td> The type of the resource that requires authentication.

179

</td>

180

</tr>

181

<tr>

182

183

<td> The port that was used to connect to <em class="parameter"><code>server</code></em>. 0 means unset.

184

</td>

185

</tr>

186

<tr>

187

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationIn.authtype"></a>authtype</code></em>;</span></p></td>

188

<td> The type of authentication that was requested. For the

189

HTTP method, this may be "basic" or "proxy". For the SFTP method,

190

this may be "publickey" or "password".

191

</td>

192

</tr>

193

<tr>

194

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationIn.username"></a>username</code></em>;</span></p></td>

195

<td> The username that was used to connect to <em class="parameter"><code>server</code></em>.

196

</td>

197

</tr>

198

<tr>

199

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationIn.domain"></a>domain</code></em>;</span></p></td>

200

<td> The domain that <em class="parameter"><code>server</code></em> belongs to (only used by the SMB method).

201

</td>

202

</tr>

203

</tbody>

204

</table></div>

205

</div>

206

<hr>

207

208

<a name="GnomeVFSModuleCallbackFillAuthenticationOut"></a><h3>GnomeVFSModuleCallbackFillAuthenticationOut</h3>

209

<pre class="programlisting">typedef struct {

210

gboolean valid;

211

char *username;

212

char *domain;

213

char *password;

214

} GnomeVFSModuleCallbackFillAuthenticationOut;

215

</pre>

216

<p>

217

A pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationOut" title="GnomeVFSModuleCallbackFillAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFillAuthenticationOut</span></a> structure is passed to the

218

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a> callback, and informs the module

219

about the authentication parameters that were found in the cache or permanently stored.

220

</p>

221

<p>

222

The login data returned by <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a> was usually

223

previously stored using #<span class="type">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION.</span></p>

224

<p>

225

</p>

226

227

228

<tbody>

229

<tr>

230

<td><p><span class="term">gboolean <em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationOut.valid"></a>valid</code></em>;</span></p></td>

231

<td> Whether stored or cached login data was found for the resource referenced by

232

the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFillAuthenticationIn" title="GnomeVFSModuleCallbackFillAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFillAuthenticationIn</span></a> structure.

233

</td>

234

</tr>

235

<tr>

236

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationOut.username"></a>username</code></em>;</span></p></td>

237

<td> The cached username that should be used to access the resource.

238

This will be freed by the module when it isn't needed any longer. May only

239

be set if <em class="parameter"><code>valid</code></em> is <code class="literal">TRUE</code>.

240

</td>

241

</tr>

242

<tr>

243

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationOut.domain"></a>domain</code></em>;</span></p></td>

244

<td> The cached domain that should be used to access the resource.

245

This will be freed by the module when it isn't needed any longer. May only

246

be set if <em class="parameter"><code>valid</code></em> is <code class="literal">TRUE</code>.

247

</td>

248

</tr>

249

<tr>

250

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFillAuthenticationOut.password"></a>password</code></em>;</span></p></td>

251

<td> The cached password that should be used to access the resource.

252

This will be freed by the module when it isn't needed any longer. May only

253

be set if <em class="parameter"><code>valid</code></em> is <code class="literal">TRUE</code>.

254

</td>

255

</tr>

256

</tbody>

257

</table></div>

258

</div>

259

<hr>

260

261

<a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</h3>

262

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION "full-authentication"

263

</pre>

264

<p>

265

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

266

ask the user for login data. This includes username and password, but also

267

special login choices like anonymous login.

268

</p>

269

<p>

270

</p>

271

272

273

<tbody>

274

<tr>

275

276

<td>

277

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a> * passed to the application,

278

specifying the authentication request.

279

</td>

280

</tr>

281

<tr>

282

283

<td>

284

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> * passing the user's

285

provided authentication data (i.e. his username/password etc.) back to the module.

286

</td>

287

</tr>

288

</tbody>

289

</table></div>

290

<p>

291

</p>

292

</div>

293

<hr>

294

295

<a name="GnomeVFSModuleCallbackFullAuthenticationFlags"></a><h3>enum GnomeVFSModuleCallbackFullAuthenticationFlags</h3>

296

<pre class="programlisting">typedef enum {

297

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_PREVIOUS_ATTEMPT_FAILED = 1<<0,

298

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSWORD = 1<<1,

299

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME = 1<<2,

300

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN = 1<<3,

301

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED = 1<<4,

302

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED = 1<<5

303

} GnomeVFSModuleCallbackFullAuthenticationFlags;

304

</pre>

305

<p>

306

These flags will be passed to the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> callback,

307

as part of the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a> structure. The output data

308

will be stored in a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> structure.</p>

309

<p>

310

</p>

311

312

313

<tbody>

314

<tr>

315

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-PREVIOUS-ATTEMPT-FAILED:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_PREVIOUS_ATTEMPT_FAILED</code></span></p></td>

316

<td> This is not the first login attempt,

317

i.e. this callback was already invoked but the provided login data was not suitable for a successful login.

318

</td>

319

</tr>

320

<tr>

321

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-NEED-PASSWORD:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSWORD</code></span></p></td>

322

<td> The application should ask the user for

323

a password and set the <em class="parameter"><code>password</code></em> field of <span class="type">GnomeVFSModuleCallbackFullAuthenticationOut.</span>

324

</td>

325

</tr>

326

<tr>

327

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-NEED-USERNAME:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME</code></span></p></td>

328

<td> The application should ask the user for

329

a username and set the <em class="parameter"><code>username</code></em> field of <span class="type">GnomeVFSModuleCallbackFullAuthenticationOut.</span>

330

</td>

331

</tr>

332

<tr>

333

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-NEED-DOMAIN:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN</code></span></p></td>

334

<td> The application should ask the user for

335

a domain and set the <em class="parameter"><code>domain</code></em> field of <span class="type">GnomeVFSModuleCallbackFullAuthenticationOut.</span>

336

</td>

337

</tr>

338

<tr>

339

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-SAVING-SUPPORTED:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED</code></span></p></td>

340

<td> The application may ask the user

341

whether he wants to save the password. If this flag is not present, or the user does not want to

342

save the password, the application must set the <em class="parameter"><code>save_password</code></em> field of <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a>

343

to <code class="literal">FALSE</code> and its keyring field to <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>. If the <em class="parameter"><code>save_password</code></em> field is <code class="literal">TRUE</code>, the module invoking

344

the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> callback is expected to invoke the

345

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</span></a> callback if the login attempt was successful with

346

the <em class="parameter"><code>username</code></em>, <em class="parameter"><code>password</code></em>, <em class="parameter"><code>domain</code></em> and <em class="parameter"><code>keyring</code></em> fields of <span class="type">GnomeVFSModuleCallbackFullAuthenticationOut.</span>

347

</td>

348

</tr>

349

<tr>

350

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-ANON-SUPPORTED:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED</code></span></p></td>

351

<td> The application

352

should offer the user a choice to login anonymously (used for example by the FTP module).

353

If the user requests anonymous login, <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-OUT-ANON-SELECTED:CAPS"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED</span></a>

354

must be set in the <em class="parameter"><code>out_flags</code></em> field of <span class="type">GnomeVFSModuleCallbackFullAuthenticationOut.</span>

355

</td>

356

</tr>

357

</tbody>

358

</table></div>

359

</div>

360

<hr>

361

362

<a name="GnomeVFSModuleCallbackFullAuthenticationIn"></a><h3>GnomeVFSModuleCallbackFullAuthenticationIn</h3>

363

<pre class="programlisting">typedef struct {

364

GnomeVFSModuleCallbackFullAuthenticationFlags flags;

365

366

char *uri;

367

char *protocol;

368

char *server;

369

char *object;

370

int port;

371

char *authtype;

372

char *username;

373

char *domain;

374

375

/* for pre-filling the dialog */

376

char *default_user;

377

char *default_domain;

378

} GnomeVFSModuleCallbackFullAuthenticationIn;

379

</pre>

380

<p>

381

A pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a> structure is passed to the

382

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> callback, and informs the application

383

about the authentication parameters that should be requested from the user.

384

</p>

385

<p>

386

The <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> application callback will then set

387

the members of a pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> structure

388

according to the user input.</p>

389

<p>

390

</p>

391

392

393

<tbody>

394

<tr>

395

<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags">GnomeVFSModuleCallbackFullAuthenticationFlags</a> <em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.flags"></a>flags</code></em>;</span></p></td>

396

<td> <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationFlags</span></a> influencing the user query.

397

</td>

398

</tr>

399

<tr>

400

401

<td> The textual URI of the resource that requires authentication.

402

</td>

403

</tr>

404

<tr>

405

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.protocol"></a>protocol</code></em>;</span></p></td>

406

<td> One of the protocols supported by the invoking module. Typically matches <em class="parameter"><code>uri</code></em>'s protocol.

407

</td>

408

</tr>

409

<tr>

410

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.server"></a>server</code></em>;</span></p></td>

411

<td> The server that contains the resource that requires authentication. Typically matches <em class="parameter"><code>uri</code></em>'s hostname.

412

</td>

413

</tr>

414

<tr>

415

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.object"></a>object</code></em>;</span></p></td>

416

<td> The type of the resource that requires authentication.

417

</td>

418

</tr>

419

<tr>

420

421

<td> The port that was used to connect to <em class="parameter"><code>server</code></em>. 0 means unset.

422

</td>

423

</tr>

424

<tr>

425

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.authtype"></a>authtype</code></em>;</span></p></td>

426

<td> The type of authentication that was requested. For the

427

HTTP method, this may be "basic" or "proxy". For the SFTP method,

428

this may be "publickey" or "password".

429

</td>

430

</tr>

431

<tr>

432

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.username"></a>username</code></em>;</span></p></td>

433

<td> The username that was used to connect to <em class="parameter"><code>server</code></em>. This variable

434

should just be used for display purposes, i.e. like “<span class="quote">You were trying

435

to access foo<em class="parameter"><code>bar.com</code></em></span>” where foo is the <em class="parameter"><code>username</code></em> and bar.com is the

436

<em class="parameter"><code>server</code></em>. Do not make the contents of the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a>

437

output variables depend on the value of this variable. If you want to handle

438

absence of user input, pass back <em class="parameter"><code>default_user</code></em> instead.

439

</td>

440

</tr>

441

<tr>

442

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.domain"></a>domain</code></em>;</span></p></td>

443

<td> The domain that <em class="parameter"><code>server</code></em> belongs to (only used by the SMB method).

444

This variable should just be used for display purposes where foo is the <em class="parameter"><code>username</code></em>

445

and bar.com is the <em class="parameter"><code>server</code></em>. Do not make the contents of the

446

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> output variables depend on the value

447

of this variable. If you want to handle absence of user input, pass back

448

<em class="parameter"><code>default_domain</code></em> instead.

449

</td>

450

</tr>

451

<tr>

452

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.default_user"></a>default_user</code></em>;</span></p></td>

453

<td> The username that should be provided to the user by default.

454

Typically matches <em class="parameter"><code>username</code></em>.

455

</td>

456

</tr>

457

<tr>

458

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationIn.default_domain"></a>default_domain</code></em>;</span></p></td>

459

<td> The domain that should be provided to the user by default.

460

Typically matches <em class="parameter"><code>domain</code></em>.

461

</td>

462

</tr>

463

</tbody>

464

</table></div>

465

</div>

466

<hr>

467

468

<a name="GnomeVFSModuleCallbackFullAuthenticationOut"></a><h3>GnomeVFSModuleCallbackFullAuthenticationOut</h3>

469

<pre class="programlisting">typedef struct {

470

gboolean abort_auth;

471

472

char *username;

473

char *domain;

474

char *password;

475

476

gboolean save_password;

477

char *keyring;

478

479

gsize out_flags;

480

} GnomeVFSModuleCallbackFullAuthenticationOut;

481

</pre>

482

<p>

483

A pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> structure is passed to the

484

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> callback, and informs the module

485

about the authentication parameters that the user provided by setting the respective

486

fields according to the user input and the passed-in <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a>

487

pointer.</p>

488

<p>

489

</p>

490

491

492

<tbody>

493

<tr>

494

<td><p><span class="term">gboolean <em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.abort_auth"></a>abort_auth</code></em>;</span></p></td>

495

<td> Whether the user somehow cancelled the login process. The application

496

is expected to offer the user a cancellation point during the authentication query.

497

In a graphical user interface, this is typically achieved by providing a "Cancel"

498

button.

499

</td>

500

</tr>

501

<tr>

502

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.username"></a>username</code></em>;</span></p></td>

503

<td> The user-provided username that should be used to access the resource

504

referenced by <span class="type">GnomeVFSModuleCallbackFullAuthenticationIn.</span> This will be freed by

505

the module when it isn't needed any longer. Must not be set if the

506

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationFlags</span></a> don't contain

507

<span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_USERNAME.</span>

508

</td>

509

</tr>

510

<tr>

511

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.domain"></a>domain</code></em>;</span></p></td>

512

<td> The user-provided domain that should be used to access the resource

513

referenced by <span class="type">GnomeVFSModuleCallbackFullAuthenticationIn.</span> This will be freed by

514

the module when it isn't needed any longer. Must not be set if the

515

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationFlags</span></a> don't contain

516

<span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_DOMAIN.</span>

517

</td>

518

</tr>

519

<tr>

520

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.password"></a>password</code></em>;</span></p></td>

521

<td> The user-provided password that should be used to access the resource

522

referenced by <span class="type">GnomeVFSModuleCallbackFullAuthenticationIn.</span> This will be freed by

523

the module when it isn't needed any longer. Must not be set if the

524

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationFlags</span></a> don't contain

525

<span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_NEED_PASSOWRD.</span>

526

</td>

527

</tr>

528

<tr>

529

<td><p><span class="term">gboolean <em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.save_password"></a>save_password</code></em>;</span></p></td>

530

<td> Flags whether the user requested to save the provided login

531

data. Must be <code class="literal">FALSE</code> if the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationFlags</span></a>

532

don't contain <span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_SAVING_SUPPORTED.</span>

533

</td>

534

</tr>

535

<tr>

536

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.keyring"></a>keyring</code></em>;</span></p></td>

537

<td> Flags which keyring should be used to save the password. This will

538

later be passed to the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</span></a> callback

539

if the login attempt was successful with the specified <em class="parameter"><code>username</code></em>, <em class="parameter"><code>password</code></em> and

540

<em class="parameter"><code>domain</code></em>. This will NOT be freed by the module, so the application typically

541

provides a <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> pointer or a pointer to a static string.

542

</td>

543

</tr>

544

<tr>

545

<td><p><span class="term">gsize <em class="structfield"><code><a name="GnomeVFSModuleCallbackFullAuthenticationOut.out_flags"></a>out_flags</code></em>;</span></p></td>

546

<td> <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOutFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationOutFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOutFlags</span></a> signalling a special request, for instance

547

anonymous access to an FTP server.

548

</td>

549

</tr>

550

</tbody>

551

</table></div>

552

</div>

553

<hr>

554

555

<a name="GnomeVFSModuleCallbackFullAuthenticationOutFlags"></a><h3>enum GnomeVFSModuleCallbackFullAuthenticationOutFlags</h3>

556

<pre class="programlisting">typedef enum {

557

GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED = 1<<0

558

} GnomeVFSModuleCallbackFullAuthenticationOutFlags;

559

</pre>

560

<p>

561

These flags will be passed from a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> callback

562

back to the module, as part of the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> structure.</p>

563

<p>

564

</p>

565

566

567

568

<td><p><a name="GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION-OUT-ANON-SELECTED:CAPS"></a><span class="term"><code class="literal">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_OUT_ANON_SELECTED</code></span></p></td>

569

<td> Anonymous login requested.

570

May only be set if the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a>'s

571

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationFlags" title="enum GnomeVFSModuleCallbackFullAuthenticationFlags"><span class="type">GnomeVFSModuleCallbackFullAuthenticationFlags</span></a> contain

572

<span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION_ANON_SUPPORTED.</span>

573

</td>

574

</tr></tbody>

575

</table></div>

576

</div>

577

<hr>

578

579

<a name="GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</h3>

580

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION "save-authentication"

581

</pre>

582

<p>

583

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

584

request permanent or temporary storage of login data. The storage is typically

585

done using a keyring manager.

586

</p>

587

<p>

588

Called after a successfull authentication, to allow the client to e.g.

589

store the password for future use. It may be queried again within the

590

current session (temporary storage) or in future sessions (permanent

591

storage) using <span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION.</span>

592

</p>

593

<p>

594

This is typically called after the user provided login data with

595

<span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</span>

596

</p>

597

<p>

598

</p>

599

600

601

<tbody>

602

<tr>

603

604

<td>

605

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackSaveAuthenticationIn" title="GnomeVFSModuleCallbackSaveAuthenticationIn"><span class="type">GnomeVFSModuleCallbackSaveAuthenticationIn</span></a> * specifying the login data.

606

</td>

607

</tr>

608

<tr>

609

610

<td>

611

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackSaveAuthenticationOut" title="GnomeVFSModuleCallbackSaveAuthenticationOut"><span class="type">GnomeVFSModuleCallbackSaveAuthenticationOut</span></a> * (unused).

612

</td>

613

</tr>

614

</tbody>

615

</table></div>

616

<p>

617

</p>

618

</div>

619

<hr>

620

621

<a name="GnomeVFSModuleCallbackSaveAuthenticationIn"></a><h3>GnomeVFSModuleCallbackSaveAuthenticationIn</h3>

622

<pre class="programlisting">typedef struct {

623

char *keyring;

624

625

char *uri;

626

char *protocol;

627

char *server;

628

char *object;

629

int port;

630

char *authtype;

631

char *username;

632

char *domain;

633

char *password;

634

} GnomeVFSModuleCallbackSaveAuthenticationIn;

635

</pre>

636

<p>

637

A <span class="type">GnomeVFSModuleCallbackSaveAuthenticatioIn</span> pointer is passed to a

638

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</span></a> application callback,

639

and specifies the login data that should be stored permanently on

640

disk or temporarily cached.

641

</p>

642

<p>

643

This data may be queried in future sessions (permanent storage) or within

644

the current session (temporary storage) using

645

<span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION.</span></p>

646

<p>

647

</p>

648

649

650

<tbody>

651

<tr>

652

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.keyring"></a>keyring</code></em>;</span></p></td>

653

<td> Keyring provided by <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a> callback.

654

</td>

655

</tr>

656

<tr>

657

658

<td> The textual URI of the resource that is accessed.

659

</td>

660

</tr>

661

<tr>

662

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.protocol"></a>protocol</code></em>;</span></p></td>

663

<td> One of the protocols supported by the invoking module.

664

Typically matches <em class="parameter"><code>uri</code></em>'s protocol.

665

</td>

666

</tr>

667

<tr>

668

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.server"></a>server</code></em>;</span></p></td>

669

<td> The server that contains the resource that is accessed.

670

Typically matches <em class="parameter"><code>uri</code></em>'s hostname.

671

</td>

672

</tr>

673

<tr>

674

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.object"></a>object</code></em>;</span></p></td>

675

<td> The type of the resource that is accessed.

676

</td>

677

</tr>

678

<tr>

679

680

<td> The port that was used to connect to <em class="parameter"><code>server</code></em>. 0 means unset.

681

</td>

682

</tr>

683

<tr>

684

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.authtype"></a>authtype</code></em>;</span></p></td>

685

<td> The type of authentication that was requested. For the

686

HTTP method, this may be "basic" or "proxy". For the SFTP method,

687

this may be "publickey" or "password".

688

</td>

689

</tr>

690

<tr>

691

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.username"></a>username</code></em>;</span></p></td>

692

<td> The username that was used to connect to <em class="parameter"><code>server</code></em>.

693

</td>

694

</tr>

695

<tr>

696

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.domain"></a>domain</code></em>;</span></p></td>

697

<td> The domain that <em class="parameter"><code>server</code></em> belongs to (only used by the SMB method).

698

</td>

699

</tr>

700

<tr>

701

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackSaveAuthenticationIn.password"></a>password</code></em>;</span></p></td>

702

<td> The password that was used to connect to <em class="parameter"><code>server</code></em>.

703

</td>

704

</tr>

705

</tbody>

706

</table></div>

707

</div>

708

<hr>

709

710

<a name="GnomeVFSModuleCallbackSaveAuthenticationOut"></a><h3>GnomeVFSModuleCallbackSaveAuthenticationOut</h3>

711

<pre class="programlisting">typedef struct {

712

} GnomeVFSModuleCallbackSaveAuthenticationOut;

713

</pre>

714

<p>

715

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackSaveAuthenticationOut" title="GnomeVFSModuleCallbackSaveAuthenticationOut"><span class="type">GnomeVFSModuleCallbackSaveAuthenticationOut</span></a> pointer is passed to a

716

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-SAVE-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_SAVE_AUTHENTICATION</span></a> application callback,

717

and is reserved for future use. Applications are not expected

718

to modify this data, because its interpretation might change

719

in the future.</p>

720

<p>

721

</p>

722

</div>

723

<hr>

724

725

<a name="GNOME-VFS-MODULE-CALLBACK-QUESTION:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_QUESTION</h3>

726

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_QUESTION "ask-question"

727

</pre>

728

<p>

729

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

730

ask the user a question.

731

</p>

732

<p>

733

Called when access to a URI requires the user to make a choice.

734

</p>

735

<p>

736

</p>

737

738

739

<tbody>

740

<tr>

741

742

<td>

743

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a> * passed to the application,

744

</td>

745

</tr>

746

<tr>

747

748

<td>

749

specifying the proxy authentication request.

750

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationOut" title="GnomeVFSModuleCallbackFullAuthenticationOut"><span class="type">GnomeVFSModuleCallbackFullAuthenticationOut</span></a> * passing the user's

751

provided proxy authentication data (i.e. his username/password) back to the module.

752

</td>

753

</tr>

754

</tbody>

755

</table></div>

756

<p>

757

</p>

758

</div>

759

<hr>

760

761

<a name="GnomeVFSModuleCallbackQuestionIn"></a><h3>GnomeVFSModuleCallbackQuestionIn</h3>

762

<pre class="programlisting">typedef struct {

763

char *primary_message;

764

char *secondary_message;

765

char **choices;

766

} GnomeVFSModuleCallbackQuestionIn;

767

</pre>

768

<p>

769

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackQuestionIn" title="GnomeVFSModuleCallbackQuestionIn"><span class="type">GnomeVFSModuleCallbackQuestionIn</span></a> pointer is passed to a

770

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-QUESTION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_QUESTION"><span class="type">GNOME_VFS_MODULE_CALLBACK_QUESTION</span></a> application callback.

771

Applications are expected to request a decision from the

772

user, and store the answer in a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackQuestionOut" title="GnomeVFSModuleCallbackQuestionOut"><span class="type">GnomeVFSModuleCallbackQuestionOut</span></a>

773

structure.</p>

774

<p>

775

</p>

776

777

778

<tbody>

779

<tr>

780

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackQuestionIn.primary_message"></a>primary_message</code></em>;</span></p></td>

781

<td> A short message explaining the question to the user,

782

or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no message.

783

</td>

784

</tr>

785

<tr>

786

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackQuestionIn.secondary_message"></a>secondary_message</code></em>;</span></p></td>

787

<td> The long version of the message, containing more

788

details, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no message.

789

</td>

790

</tr>

791

<tr>

792

<td><p><span class="term">char **<em class="structfield"><code><a name="GnomeVFSModuleCallbackQuestionIn.choices"></a>choices</code></em>;</span></p></td>

793

<td> <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>-terminated string list of choices the user has to choose from.

794

The first item in the list should be affermative, and will be put on the right

795

in a GUI dialog.

796

</td>

797

</tr>

798

</tbody>

799

</table></div>

800

</div>

801

<hr>

802

803

<a name="GnomeVFSModuleCallbackQuestionOut"></a><h3>GnomeVFSModuleCallbackQuestionOut</h3>

804

<pre class="programlisting">typedef struct {

805

int answer;

806

} GnomeVFSModuleCallbackQuestionOut;

807

</pre>

808

<p>

809

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackQuestionOut" title="GnomeVFSModuleCallbackQuestionOut"><span class="type">GnomeVFSModuleCallbackQuestionOut</span></a> pointer is passed to a

810

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-QUESTION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_QUESTION"><span class="type">GNOME_VFS_MODULE_CALLBACK_QUESTION</span></a> application callback, and

811

is used by applications to store the user's decision.</p>

812

<p>

813

</p>

814

815

816

817

<td><p><span class="term">int <em class="structfield"><code><a name="GnomeVFSModuleCallbackQuestionOut.answer"></a>answer</code></em>;</span></p></td>

818

<td> The index of the answer the user picked. Matches the base

819

pointer address of the user's choice in <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackQuestionIn" title="GnomeVFSModuleCallbackQuestionIn"><span class="type">GnomeVFSModuleCallbackQuestionIn</span></a>,

820

i.e. its index in choices, where the first choice has index <code class="literal">0</code>.

821

</td>

822

</tr></tbody>

823

</table></div>

824

</div>

825

<hr>

826

827

<a name="GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</h3>

828

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE "status-message"

829

</pre>

830

<p>

831

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

832

inform the user about an ongoing operation.

833

</p>

834

<p>

835

Called when a <span class="type">GnomeVFSModule</span> has a status message to return to the user.

836

</p>

837

<p>

838

</p>

839

840

841

<tbody>

842

<tr>

843

844

<td>

845

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageIn" title="GnomeVFSModuleCallbackStatusMessageIn"><span class="type">GnomeVFSModuleCallbackStatusMessageIn</span></a> * containing the message to present to the user.

846

</td>

847

</tr>

848

<tr>

849

850

<td>

851

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageOut" title="GnomeVFSModuleCallbackStatusMessageOut"><span class="type">GnomeVFSModuleCallbackStatusMessageOut</span></a> * (not used).

852

</td>

853

</tr>

854

</tbody>

855

</table></div>

856

<p>

857

</p>

858

</div>

859

<hr>

860

861

<a name="GnomeVFSModuleCallbackStatusMessageIn"></a><h3>GnomeVFSModuleCallbackStatusMessageIn</h3>

862

<pre class="programlisting">typedef struct {

863

char *uri;

864

char *message;

865

int percentage;

866

} GnomeVFSModuleCallbackStatusMessageIn;

867

</pre>

868

<p>

869

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageIn" title="GnomeVFSModuleCallbackStatusMessageIn"><span class="type">GnomeVFSModuleCallbackStatusMessageIn</span></a> pointer is passed to a

870

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE:CAPS" title="GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE"><span class="type">GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</span></a> application callback,

871

to inform it about the progress and/or status of an ongoing operation.</p>

872

<p>

873

</p>

874

875

876

<tbody>

877

<tr>

878

879

<td> The textual URI the status message refers to.

880

</td>

881

</tr>

882

<tr>

883

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackStatusMessageIn.message"></a>message</code></em>;</span></p></td>

884

<td> The message the application should display to the user,

885

indicating the current state, or it is <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>.

886

</td>

887

</tr>

888

<tr>

889

<td><p><span class="term">int <em class="structfield"><code><a name="GnomeVFSModuleCallbackStatusMessageIn.percentage"></a>percentage</code></em>;</span></p></td>

890

<td> The percentage indicating the completeness of

891

a currently pending operation on <em class="parameter"><code>uri</code></em> (1-100), or -1 if there

892

is no progress percentage to report.

893

</td>

894

</tr>

895

</tbody>

896

</table></div>

897

</div>

898

<hr>

899

900

<a name="GnomeVFSModuleCallbackStatusMessageOut"></a><h3>GnomeVFSModuleCallbackStatusMessageOut</h3>

901

<pre class="programlisting">typedef struct {

902

/* empty structs not allowed */

903

int dummy;

904

} GnomeVFSModuleCallbackStatusMessageOut;

905

</pre>

906

<p>

907

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackStatusMessageOut" title="GnomeVFSModuleCallbackStatusMessageOut"><span class="type">GnomeVFSModuleCallbackStatusMessageOut</span></a> pointer is passed to a

908

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-STATUS-MESSAGE:CAPS" title="GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE"><span class="type">GNOME_VFS_MODULE_CALLBACK_STATUS_MESSAGE</span></a> application callback,

909

and is reserved for future use. Applications are not expected

910

to modify this data, because its interpretation might change

911

in the future.</p>

912

<p>

913

</p>

914

915

916

917

<td><p><span class="term">int <em class="structfield"><code><a name="GnomeVFSModuleCallbackStatusMessageOut.dummy"></a>dummy</code></em>;</span></p></td>

918

<td> unused.

919

</td>

920

</tr></tbody>

921

</table></div>

922

</div>

923

<hr>

924

925

<a name="GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</h3>

926

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS "http:send-additional-headers"

927

</pre>

928

<p>

929

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

930

request additional HTTP headers.

931

</p>

932

<p>

933

Called before sending headers to an HTTP server. Client applications can add

934

additional headers.

935

</p>

936

<p>

937

</p>

938

939

940

<tbody>

941

<tr>

942

943

<td>

944

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersIn" title="GnomeVFSModuleCallbackAdditionalHeadersIn"><span class="type">GnomeVFSModuleCallbackAdditionalHeadersIn</span></a> * identifying the resource.

945

</td>

946

</tr>

947

<tr>

948

949

<td>

950

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersOut" title="GnomeVFSModuleCallbackAdditionalHeadersOut"><span class="type">GnomeVFSModuleCallbackAdditionalHeadersOut</span></a> * allowing to add headers

951

to the request.

952

</td>

953

</tr>

954

</tbody>

955

</table></div>

956

<p>

957

</p>

958

</div>

959

<hr>

960

961

<a name="GnomeVFSModuleCallbackAdditionalHeadersIn"></a><h3>GnomeVFSModuleCallbackAdditionalHeadersIn</h3>

962

<pre class="programlisting">typedef struct {

963

GnomeVFSURI *uri;

964

} GnomeVFSModuleCallbackAdditionalHeadersIn;

965

</pre>

966

<p>

967

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersIn" title="GnomeVFSModuleCallbackAdditionalHeadersIn"><span class="type">GnomeVFSModuleCallbackAdditionalHeadersIn</span></a> pointer is passed to a

968

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS"><span class="type">GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</span></a> application

969

callback, to inform it about a pending HTTP request and allow it to

970

add additional headers.</p>

971

<p>

972

</p>

973

974

975

976

<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *<em class="structfield"><code><a name="GnomeVFSModuleCallbackAdditionalHeadersIn.uri"></a>uri</code></em>;</span></p></td>

977

<td> A <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> identifying the resource of the currently pending request.

978

</td>

979

</tr></tbody>

980

</table></div>

981

</div>

982

<hr>

983

984

<a name="GnomeVFSModuleCallbackAdditionalHeadersOut"></a><h3>GnomeVFSModuleCallbackAdditionalHeadersOut</h3>

985

<pre class="programlisting">typedef struct {

986

GList *headers;

987

} GnomeVFSModuleCallbackAdditionalHeadersOut;

988

</pre>

989

<p>

990

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAdditionalHeadersOut" title="GnomeVFSModuleCallbackAdditionalHeadersOut"><span class="type">GnomeVFSModuleCallbackAdditionalHeadersOut</span></a> pointer is passed to a

991

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-SEND-ADDITIONAL-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS"><span class="type">GNOME_VFS_MODULE_CALLBACK_HTTP_SEND_ADDITIONAL_HEADERS</span></a> application

992

callback, to store the headers the application wants to add to

993

a pending HTTP request.</p>

994

<p>

995

</p>

996

997

998

999

<td><p><span class="term">GList *<em class="structfield"><code><a name="GnomeVFSModuleCallbackAdditionalHeadersOut.headers"></a>headers</code></em>;</span></p></td>

1000

<td> A <span class="type">GList</span> of strings, each of them is an additional header that

1001

is added to the HTTP request. <em class="parameter"><code>headers</code></em> and all its strings will be freed

1002

by the module when they aren't needed any longer.

1003

</td>

1004

</tr></tbody>

1005

</table></div>

1006

</div>

1007

<hr>

1008

1009

<a name="GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</h3>

1010

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS "http:received-headers"

1011

</pre>

1012

<p>

1013

A module callback name used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a> to

1014

inform an application about the delivery of a HTTP request.

1015

</p>

1016

<p>

1017

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS"><span class="type">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</span></a> is called after

1018

receiving HTTP headers from a server that belonged to a HTTP

1019

request that was issued by the application and allows the

1020

application to analyze the returned headers.

1021

</p>

1022

<p>

1023

</p>

1024

1025

1026

<tbody>

1027

<tr>

1028

1029

<td>

1030

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersIn" title="GnomeVFSModuleCallbackReceivedHeadersIn"><span class="type">GnomeVFSModuleCallbackReceivedHeadersIn</span></a> *.

1031

</td>

1032

</tr>

1033

<tr>

1034

1035

<td>

1036

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersOut" title="GnomeVFSModuleCallbackReceivedHeadersOut"><span class="type">GnomeVFSModuleCallbackReceivedHeadersOut</span></a> * (not used).

1037

</td>

1038

</tr>

1039

</tbody>

1040

</table></div>

1041

<p>

1042

</p>

1043

</div>

1044

<hr>

1045

1046

<a name="GnomeVFSModuleCallbackReceivedHeadersIn"></a><h3>GnomeVFSModuleCallbackReceivedHeadersIn</h3>

1047

<pre class="programlisting">typedef struct {

1048

GnomeVFSURI *uri;

1049

GList *headers;

1050

} GnomeVFSModuleCallbackReceivedHeadersIn;

1051

</pre>

1052

<p>

1053

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersIn" title="GnomeVFSModuleCallbackReceivedHeadersIn"><span class="type">GnomeVFSModuleCallbackReceivedHeadersIn</span></a> pointer is passed to a

1054

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS"><span class="type">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</span></a> application

1055

callback, to inform it about a delivered HTTP request and allow

1056

it to analyze the returned headers.</p>

1057

<p>

1058

</p>

1059

1060

1061

<tbody>

1062

<tr>

1063

<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *<em class="structfield"><code><a name="GnomeVFSModuleCallbackReceivedHeadersIn.uri"></a>uri</code></em>;</span></p></td>

1064

<td> A <a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> identifying the resource of the currently delivered request.

1065

</td>

1066

</tr>

1067

<tr>

1068

<td><p><span class="term">GList *<em class="structfield"><code><a name="GnomeVFSModuleCallbackReceivedHeadersIn.headers"></a>headers</code></em>;</span></p></td>

1069

<td> A <span class="type">GList</span> of strings, each of them is a header that was received when

1070

delivering the HTTP request. <em class="parameter"><code>headers</code></em> and all its strings will be freed

1071

by the module when they aren't needed any longer.

1072

</td>

1073

</tr>

1074

</tbody>

1075

</table></div>

1076

</div>

1077

<hr>

1078

1079

<a name="GnomeVFSModuleCallbackReceivedHeadersOut"></a><h3>GnomeVFSModuleCallbackReceivedHeadersOut</h3>

1080

<pre class="programlisting">typedef struct {

1081

int dummy;

1082

} GnomeVFSModuleCallbackReceivedHeadersOut;

1083

</pre>

1084

<p>

1085

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackReceivedHeadersOut" title="GnomeVFSModuleCallbackReceivedHeadersOut"><span class="type">GnomeVFSModuleCallbackReceivedHeadersOut</span></a> pointer is passed to a

1086

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-HTTP-RECEIVED-HEADERS:CAPS" title="GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS"><span class="type">GNOME_VFS_MODULE_CALLBACK_HTTP_RECEIVED_HEADERS</span></a> application

1087

callback, and is reserved for future use. Applications are not

1088

expected to modify this data, because its interpretation might

1089

change in the future.</p>

1090

<p>

1091

</p>

1092

1093

1094

1095

<td><p><span class="term">int <em class="structfield"><code><a name="GnomeVFSModuleCallbackReceivedHeadersOut.dummy"></a>dummy</code></em>;</span></p></td>

1096

<td> unused.

1097

</td>

1098

</tr></tbody>

1099

</table></div>

1100

</div>

1101

<hr>

1102

1103

<a name="GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</h3>

1104

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION "simple-authentication"

1105

</pre>

1106

1107

<h3 class="title">Warning</h3>

1108

<p><code class="literal">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</code> is deprecated and should not be used in newly-written code. Modules should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a>

1109

and <span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</span></p>

1110

</div>

1111

<p>

1112

A module callback name formerly used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a>.

1113

</p>

1114

<p>

1115

Formerly called when access to a URI requires a username/password.

1116

</p>

1117

<p>

1118

</p>

1119

1120

1121

<tbody>

1122

<tr>

1123

1124

<td>

1125

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationIn" title="GnomeVFSModuleCallbackAuthenticationIn"><span class="type">GnomeVFSModuleCallbackAuthenticationIn</span></a> *.

1126

</td>

1127

</tr>

1128

<tr>

1129

1130

<td>

1131

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationOut" title="GnomeVFSModuleCallbackAuthenticationOut"><span class="type">GnomeVFSModuleCallbackAuthenticationOut</span></a> *.

1132

</td>

1133

</tr>

1134

</tbody>

1135

</table></div>

1136

<p>

1137

</p>

1138

</div>

1139

<hr>

1140

1141

<a name="GNOME-VFS-MODULE-CALLBACK-HTTP-PROXY-AUTHENTICATION:CAPS"></a><h3>GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</h3>

1142

<pre class="programlisting">#define GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION "http:proxy-authentication"

1143

</pre>

1144

1145

<h3 class="title">Warning</h3>

1146

<p><code class="literal">GNOME_VFS_MODULE_CALLBACK_HTTP_PROXY_AUTHENTICATION</code> is deprecated and should not be used in newly-written code. Proxy authentication now works desktop-wide through GConf.</p>

1147

</div>

1148

<p>

1149

A module callback name formerly used together with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback-module-api.html#gnome-vfs-module-callback-invoke" title="gnome_vfs_module_callback_invoke ()"><code class="function">gnome_vfs_module_callback_invoke()</code></a>

1150

to ask the user for HTTP proxy login data. It works exactly like

1151

<a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FULL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION</span></a>, and used to be kept separate to

1152

allow applications to distinguish proxy authentication from actual server

1153

authentication, so that the wording of the interface could be adapted.

1154

</p>

1155

<p>

1156

Formerly called when access to an HTTP proxy required a username/password.

1157

</p>

1158

<p>

1159

</p>

1160

1161

1162

<tbody>

1163

<tr>

1164

1165

<td>

1166

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationIn" title="GnomeVFSModuleCallbackAuthenticationIn"><span class="type">GnomeVFSModuleCallbackAuthenticationIn</span></a> *.

1167

</td>

1168

</tr>

1169

<tr>

1170

1171

<td>

1172

A <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationOut" title="GnomeVFSModuleCallbackAuthenticationOut"><span class="type">GnomeVFSModuleCallbackAuthenticationOut</span></a> *.

1173

</td>

1174

</tr>

1175

</tbody>

1176

</table></div>

1177

<p>

1178

</p>

1179

</div>

1180

<hr>

1181

1182

<a name="GnomeVFSModuleCallbackAuthenticationAuthType"></a><h3>enum GnomeVFSModuleCallbackAuthenticationAuthType</h3>

1183

<pre class="programlisting">typedef enum {

1184

AuthTypeBasic,

1185

AuthTypeDigest

1186

} GnomeVFSModuleCallbackAuthenticationAuthType;

1187

</pre>

1188

1189

<h3 class="title">Warning</h3>

1190

<p><code class="literal">GnomeVFSModuleCallbackAuthenticationAuthType</code> is deprecated and should not be used in newly-written code. Modules should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a>

1191

and <span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</span></p>

1192

</div>

1193

<p>

1194

This defines the possible values of the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationIn" title="GnomeVFSModuleCallbackAuthenticationIn"><span class="type">GnomeVFSModuleCallbackAuthenticationIn</span></a>'s

1195

<code class="literal">auth_type</code> field.</p>

1196

<p>

1197

</p>

1198

1199

1200

<tbody>

1201

<tr>

1202

<td><p><a name="AuthTypeBasic"></a><span class="term"><code class="literal">AuthTypeBasic</code></span></p></td>

1203

<td> transmit password unencrypted.

1204

</td>

1205

</tr>

1206

<tr>

1207

<td><p><a name="AuthTypeDigest"></a><span class="term"><code class="literal">AuthTypeDigest</code></span></p></td>

1208

<td> transmit digest instead of plaintext credentials.

1209

</td>

1210

</tr>

1211

</tbody>

1212

</table></div>

1213

</div>

1214

<hr>

1215

1216

<a name="GnomeVFSModuleCallbackAuthenticationIn"></a><h3>GnomeVFSModuleCallbackAuthenticationIn</h3>

1217

<pre class="programlisting">typedef struct {

1218

char *uri;

1219

char *realm;

1220

gboolean previous_attempt_failed;

1221

GnomeVFSModuleCallbackAuthenticationAuthType auth_type;

1222

} GnomeVFSModuleCallbackAuthenticationIn;

1223

</pre>

1224

1225

<h3 class="title">Warning</h3>

1226

<p><code class="literal">GnomeVFSModuleCallbackAuthenticationIn</code> is deprecated and should not be used in newly-written code. Modules should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a>

1227

and <span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</span></p>

1228

</div>

1229

<p>

1230

A pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationIn" title="GnomeVFSModuleCallbackAuthenticationIn"><span class="type">GnomeVFSModuleCallbackAuthenticationIn</span></a> structure that used to be

1231

passed to the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</span></a> callback, and informed

1232

the application about the authentication parameters that should be requested.</p>

1233

<p>

1234

</p>

1235

1236

1237

<tbody>

1238

<tr>

1239

1240

<td> The textual URI of the resource that requires authentication.

1241

</td>

1242

</tr>

1243

<tr>

1244

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackAuthenticationIn.realm"></a>realm</code></em>;</span></p></td>

1245

<td> "auth" for HTTP, <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> for others.

1246

</td>

1247

</tr>

1248

<tr>

1249

<td><p><span class="term">gboolean <em class="structfield"><code><a name="GnomeVFSModuleCallbackAuthenticationIn.previous_attempt_failed"></a>previous_attempt_failed</code></em>;</span></p></td>

1250

<td> <code class="literal">TRUE</code> if there already was login data

1251

specified for this request, but the login failed. <code class="literal">FALSE</code> if no

1252

previous login attempt has been made right before this one.

1253

</td>

1254

</tr>

1255

<tr>

1256

<td><p><span class="term"><a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationAuthType" title="enum GnomeVFSModuleCallbackAuthenticationAuthType">GnomeVFSModuleCallbackAuthenticationAuthType</a> <em class="structfield"><code><a name="GnomeVFSModuleCallbackAuthenticationIn.auth_type"></a>auth_type</code></em>;</span></p></td>

1257

<td> Whether the login data will be transmitted in plaintext or encrypted.

1258

</td>

1259

</tr>

1260

</tbody>

1261

</table></div>

1262

</div>

1263

<hr>

1264

1265

<a name="GnomeVFSModuleCallbackAuthenticationOut"></a><h3>GnomeVFSModuleCallbackAuthenticationOut</h3>

1266

<pre class="programlisting">typedef struct {

1267

char *username;

1268

char *password;

1269

} GnomeVFSModuleCallbackAuthenticationOut;

1270

</pre>

1271

1272

<h3 class="title">Warning</h3>

1273

<p><code class="literal">GnomeVFSModuleCallbackAuthenticationOut</code> is deprecated and should not be used in newly-written code. Modules should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-FILL-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_FILL_AUTHENTICATION</span></a>

1274

and <span class="type">GNOME_VFS_MODULE_CALLBACK_FULL_AUTHENTICATION.</span></p>

1275

</div>

1276

<p>

1277

A pointer to a <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackAuthenticationOut" title="GnomeVFSModuleCallbackAuthenticationOut"><span class="type">GnomeVFSModuleCallbackAuthenticationOut</span></a> structure that used to be

1278

passed to the <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GNOME-VFS-MODULE-CALLBACK-AUTHENTICATION:CAPS" title="GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION"><span class="type">GNOME_VFS_MODULE_CALLBACK_AUTHENTICATION</span></a> callback, and was

1279

used to pass the login data back to the module.</p>

1280

<p>

1281

</p>

1282

1283

1284

<tbody>

1285

<tr>

1286

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackAuthenticationOut.username"></a>username</code></em>;</span></p></td>

1287

<td> The username that should be used to access the resource

1288

referenced by <a class="link" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html#GnomeVFSModuleCallbackFullAuthenticationIn" title="GnomeVFSModuleCallbackFullAuthenticationIn"><span class="type">GnomeVFSModuleCallbackFullAuthenticationIn</span></a>, or <a href="/gnome/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a>

1289

if no data was provided. This will be freed by the module when it

1290

isn't needed any longer.

1291

</td>

1292

</tr>

1293

<tr>

1294

<td><p><span class="term">char *<em class="structfield"><code><a name="GnomeVFSModuleCallbackAuthenticationOut.password"></a>password</code></em>;</span></p></td>

1295

<td> The password that should be used to access the resource

1296

referenced by <span class="type">GnomeVFSModuleCallbackFullAuthenticationIn.</span> This will

1297

be freed by the module when it isn't needed any longer.

1298

</td>

1299

</tr>

1300

</tbody>

1301

</table></div>

1302

</div>

1303

</div>

1304

</div>

1305

1306

<hr>

1307

Generated by GTK-Doc V1.12</div>

1308

</body>

1309

</html>