1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-session.c : Abstract class for an email session */
/*
*
* Author:
* Bertrand Guiheneuf <bertrand@helixcode.com>
* Dan Winship <danw@helixcode.com>
* Jeffrey Stedfast <fejj@helixcode.com>
*
* Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*/
#include <config.h>
#include <errno.h>
#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include "camel-session.h"
#include "camel-store.h"
#include "camel-transport.h"
#include "camel-exception.h"
#include "string-utils.h"
#include "camel-url.h"
#include "hash-table-utils.h"
static CamelObjectClass *parent_class;
static void
camel_session_init (CamelSession *session)
{
session->modules = camel_provider_init ();
session->providers = g_hash_table_new (g_strcase_hash, g_strcase_equal);
}
static gboolean
camel_session_destroy_provider (gpointer key, gpointer value, gpointer user_data)
{
CamelProvider *prov = (CamelProvider *)value;
g_hash_table_destroy (prov->service_cache);
return TRUE;
}
static void
camel_session_finalise (CamelObject *o)
{
CamelSession *session = (CamelSession *)o;
g_hash_table_foreach_remove (session->providers,
camel_session_destroy_provider, NULL);
g_hash_table_destroy (session->providers);
}
static void
camel_session_class_init (CamelSessionClass *camel_session_class)
{
parent_class = camel_type_get_global_classfuncs (camel_object_get_type ());
}
CamelType
camel_session_get_type (void)
{
static CamelType camel_session_type = CAMEL_INVALID_TYPE;
if (camel_session_type == CAMEL_INVALID_TYPE) {
camel_session_type = camel_type_register (camel_object_get_type (), "CamelSession",
sizeof (CamelSession),
sizeof (CamelSessionClass),
(CamelObjectClassInitFunc) camel_session_class_init,
NULL,
(CamelObjectInitFunc) camel_session_init,
(CamelObjectFinalizeFunc) camel_session_finalise);
}
return camel_session_type;
}
/**
* camel_session_new:
* @storage_path: Path to a directory Camel can use for persistent storage.
* (This directory must already exist.)
* @authenticator: A callback for discussing authentication information
* @registrar: A callback for registering timeout callbacks
* @remove: A callback for removing timeout callbacks
*
* This creates a new CamelSession object, which represents global state
* for the Camel library, and contains callbacks that can be used to
* interact with the main application.
*
* Return value: the new CamelSession
**/
CamelSession *
camel_session_new (const char *storage_path,
CamelAuthCallback authenticator,
CamelTimeoutRegisterCallback registrar,
CamelTimeoutRemoveCallback remover)
{
CamelSession *session = CAMEL_SESSION (camel_object_new (CAMEL_SESSION_TYPE));
session->storage_path = g_strdup (storage_path);
session->authenticator = authenticator;
session->registrar = registrar;
session->remover = remover;
return session;
}
/**
* camel_session_register_provider:
* @session: a session object
* @protocol: the protocol the provider provides for
* @provider: provider object
*
* Registers a protocol to provider mapping for the session.
**/
void
camel_session_register_provider (CamelSession *session,
CamelProvider *provider)
{
g_return_if_fail (CAMEL_IS_SESSION (session));
g_return_if_fail (provider != NULL);
g_hash_table_insert (session->providers, provider->protocol, provider);
}
static void
ensure_loaded (gpointer key, gpointer value, gpointer user_data)
{
CamelSession *session = user_data;
char *name = key;
char *path = value;
if (!g_hash_table_lookup (session->providers, name)) {
CamelException ex;
camel_exception_init (&ex);
camel_provider_load (session, path, &ex);
camel_exception_clear (&ex);
}
}
static gint
provider_compare (gconstpointer a, gconstpointer b)
{
const CamelProvider *cpa = (const CamelProvider *)a;
const CamelProvider *cpb = (const CamelProvider *)b;
return strcmp (cpa->name, cpb->name);
}
static void
add_to_list (gpointer key, gpointer value, gpointer user_data)
{
GList **list = user_data;
CamelProvider *prov = value;
*list = g_list_insert_sorted (*list, prov, provider_compare);
}
/**
* camel_session_list_providers:
* @session: the session
* @load: whether or not to load in providers that are not already loaded
*
* This returns a list of available providers in this session. If @load
* is %TRUE, it will first load in all available providers that haven't
* yet been loaded.
*
* Return value: a GList of providers, which the caller must free.
**/
GList *
camel_session_list_providers (CamelSession *session, gboolean load)
{
GList *list;
g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
if (load) {
g_hash_table_foreach (session->modules, ensure_loaded, session);
}
list = NULL;
g_hash_table_foreach (session->providers, add_to_list, &list);
return list;
}
static void
service_cache_remove (CamelService *service, gpointer event_data, gpointer user_data)
{
CamelProvider *provider;
CamelSession *session = CAMEL_SESSION (user_data);
g_return_if_fail (CAMEL_IS_SESSION (session));
g_return_if_fail (service != NULL);
g_return_if_fail (service->url != NULL);
provider = g_hash_table_lookup (session->providers, service->url->protocol);
g_hash_table_remove (provider->service_cache, service->url);
}
/**
* camel_session_get_service:
* @session: the CamelSession
* @url_string: a Camel URL describing the service to get
* @type: the provider type (%CAMEL_PROVIDER_STORE or
* %CAMEL_PROVIDER_TRANSPORT) to get, since some URLs may be able
* to specify either type.
* @ex: a CamelException
*
* This resolves a CamelURL into a CamelService, including loading the
* provider library for that service if it has not already been loaded.
*
* Services are cached, and asking for "the same" @url_string multiple
* times will return the same CamelService (with its reference count
* incremented by one each time). What constitutes "the same" URL
* depends in part on the provider.
*
* Return value: the requested CamelService, or %NULL
**/
CamelService *
camel_session_get_service (CamelSession *session, const char *url_string,
CamelProviderType type, CamelException *ex)
{
CamelURL *url;
CamelProvider *provider;
CamelService *service;
url = camel_url_new (url_string, ex);
if (!url)
return NULL;
/* We need to look up the provider so we can then lookup
the service in the provider's cache */
provider = g_hash_table_lookup (session->providers, url->protocol);
if (!provider) {
/* See if there's one we can load. */
char *path;
path = g_hash_table_lookup (session->modules, url->protocol);
if (path) {
camel_provider_load (session, path, ex);
if (camel_exception_get_id (ex) !=
CAMEL_EXCEPTION_NONE) {
camel_url_free (url);
return NULL;
}
}
provider = g_hash_table_lookup (session->providers, url->protocol);
}
if (!provider || !provider->object_types[type]) {
camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_URL_INVALID,
_("No provider available for protocol `%s'"),
url->protocol);
camel_url_free (url);
return NULL;
}
/* Now look up the service in the provider's cache */
service = g_hash_table_lookup (provider->service_cache, url);
if (service != NULL) {
camel_url_free (url);
camel_object_ref (CAMEL_OBJECT (service));
return service;
}
service = camel_service_new (provider->object_types[type], session, provider, url, ex);
if (service) {
g_hash_table_insert (provider->service_cache, url, service);
camel_object_hook_event (CAMEL_OBJECT (service), "finalize", (CamelObjectEventHookFunc) service_cache_remove, session);
}
return service;
}
/**
* camel_session_get_service_connected:
* @session: the CamelSession
* @url_string: a Camel URL describing the service to get
* @type: the provider type
* @ex: a CamelException
*
* This works like camel_session_get_service(), but also ensures that
* the returned service will have been successfully connected (via
* camel_service_connect().)
*
* Return value: the requested CamelService, or %NULL
**/
CamelService *
camel_session_get_service_connected (CamelSession *session,
const char *url_string,
CamelProviderType type,
CamelException *ex)
{
CamelService *svc;
svc = camel_session_get_service (session, url_string, type, ex);
if (svc == NULL)
return NULL;
if (svc->connected == FALSE) {
if (camel_service_connect (svc, ex) == FALSE) {
camel_object_unref (CAMEL_OBJECT (svc));
return NULL;
}
}
return svc;
}
/**
* camel_session_get_storage_path:
* @session: session object
* @service: a CamelService
* @ex: a CamelException
*
* This returns the path to a directory which the service can use for
* its own purposes. Data stored there will remain between Evolution
* sessions. No code outside of that service should ever touch the
* files in this directory. If the directory does not exist, it will
* be created.
*
* Return value: the path (which the caller must free), or %NULL if
* an error occurs.
**/
char *
camel_session_get_storage_path (CamelSession *session, CamelService *service,
CamelException *ex)
{
char *path, *p;
p = camel_service_get_path (service);
path = g_strdup_printf ("%s/%s", session->storage_path, p);
g_free (p);
if (access (path, F_OK) == 0)
return path;
if (e_mkdir_hier (path, S_IRWXU) == -1) {
camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
_("Could not create directory %s:\n%s"),
path, g_strerror (errno));
g_free (path);
return NULL;
}
return path;
}
/**
* camel_session_query_authenticator: query the session authenticator
* @session: session object
* @mode: %CAMEL_AUTHENTICATOR_ASK or %CAMEL_AUTHENTICATOR_TELL
* @data: prompt to query user with, or data to cache
* @secret: whether or not the data is secret (eg, a password)
* @service: the service this query is being made by
* @item: an identifier, unique within this service, for the information
* @ex: a CamelException
*
* This function is used by a CamelService to discuss authentication
* information with the application.
*
* @service and @item together uniquely identify the piece of data the
* caller is concerned with.
*
* If @mode is %CAMEL_AUTHENTICATOR_ASK, then @data is a question to
* ask the user (if the application doesn't already have the answer
* cached). If @secret is set, the user's input should not be echoed
* back. The authenticator should set @ex to
* %CAMEL_EXCEPTION_USER_CANCEL if the user did not provide the
* information. The caller must g_free() the information returned when
* it is done with it.
*
* If @mode is %CAMEL_AUTHENTICATOR_TELL, then @data is information
* that the application should cache, or %NULL if it should stop
* caching anything about that datum (eg, because the data is a
* password that turned out to be incorrect).
*
* Return value: the authentication information or %NULL.
**/
char *
camel_session_query_authenticator (CamelSession *session,
CamelAuthCallbackMode mode,
char *prompt, gboolean secret,
CamelService *service, char *item,
CamelException *ex)
{
return session->authenticator (mode, prompt, secret,
service, item, ex);
}
/**
* camel_session_register_timeout: Register a timeout to be called
* periodically.
*
* @session: the CamelSession
* @interval: the number of milliseconds interval between calls
* @callback: the function to call
* @user_data: extra data to be passed to the callback
*
* This function will use the registrar callback provided upon
* camel_session_new to register the timeout. The callback will
* be called every @interval milliseconds until it returns @FALSE.
* It will be passed one argument, @user_data.
*
* Returns a nonzero handle that can be used with
* camel_session_remove_timeout on success, and 0 on failure to
* register the timeout.
**/
guint
camel_session_register_timeout (CamelSession *session,
guint32 interval,
CamelTimeoutCallback callback,
gpointer user_data)
{
g_return_val_if_fail (CAMEL_IS_SESSION (session), FALSE);
return session->registrar (interval, callback, user_data);
}
/**
* camel_session_remove_timeout: Remove a previously registered
* timeout.
*
* @session: the CamelSession
* @handle: a value returned from camel_session_register_timeout
*
* This function will use the remover callback provided upon
* camel_session_new to remove the timeout.
*
* Returns TRUE on success and FALSE on failure.
**/
gboolean
camel_session_remove_timeout (CamelSession *session, guint handle)
{
return session->remover (handle);
}
|