aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-session.c
blob: bc8393b7effa3d74ead262f1e8b4ae05ae70ca85 (plain) (blame)
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
/* -*- 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>
 *
 * 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 <stdio.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);
    session->service_cache =
        g_hash_table_new (camel_url_hash, camel_url_equal);
}

static void
hash_unref_service(void *key, void *value, void *data)
{
    gtk_object_unref((GtkObject *)value);
}

static void
camel_session_finalise(GtkObject *o)
{
    CamelSession *session = (CamelSession *)o;

    g_hash_table_foreach(session->service_cache, hash_unref_service, 0);
    g_hash_table_destroy(session->service_cache);
    g_hash_table_destroy(session->providers);

    GTK_OBJECT_CLASS (parent_class)->finalize (o);
}

static void
camel_session_class_init (CamelServiceClass *camel_service_class)
{
    GtkObjectClass *object_class = (GtkObjectClass *)camel_service_class;

    parent_class = gtk_type_class (camel_object_get_type ());
    object_class->finalize = camel_session_finalise;
}

GtkType
camel_session_get_type (void)
{
    static GtkType camel_session_type = 0;

    if (!camel_session_type) {
        GtkTypeInfo camel_session_info =
        {
            "CamelSession",
            sizeof (CamelSession),
            sizeof (CamelSessionClass),
            (GtkClassInitFunc) camel_session_class_init,
            (GtkObjectInitFunc) camel_session_init,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };

        camel_session_type = gtk_type_unique (camel_object_get_type (),
                              &camel_session_info);
    }

    return camel_session_type;
}


CamelSession *
camel_session_new (CamelAuthCallback authenticator)
{
    CamelSession *session = gtk_type_new (CAMEL_SESSION_TYPE);

    session->authenticator = authenticator;
    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, CamelSession *session)
{
    gtk_object_unref(GTK_OBJECT(service));
    g_hash_table_remove(session->service_cache, service->url);
}

CamelService *
camel_session_get_service (CamelSession *session, const char *url_string,
               CamelProviderType type, CamelException *ex)
{
    CamelURL *url;
    const CamelProvider *provider;
    CamelService *service;

    url = camel_url_new (url_string, ex);
    if (!url)
        return NULL;

    /* lookup in cache first */
    printf("looking up service in cache: %s\n", url_string);
    service = g_hash_table_lookup(session->service_cache, url);
    if (service != NULL) {
        printf("found!!\n");
        camel_url_free(url);
        gtk_object_ref((GtkObject *)service);
        return service;
    }
    printf("not found, creating service\n");

    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 %s available for protocol `%s'",
                      camel_provider_type_name[type],
                      url->protocol);
        camel_url_free (url);
        return NULL;
    }

    service = camel_service_new (provider->object_types[type], session, url, ex);
    if (service) {
        g_hash_table_insert(session->service_cache, url, service);
        gtk_object_ref(GTK_OBJECT(service));
        gtk_signal_connect((GtkObject *)service, "destroy", service_cache_remove, session);
    }
    return service;
}


/**
 * camel_session_query_authenticator: query the session authenticator
 * @session: session object
 * @prompt: prompt to use if authenticator can query the user
 * @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 request authentication
 * information it needs to complete a connection. If the authenticator
 * stores any authentication information in configuration files, it
 * should use @service and @item as keys to find the right piece of
 * information. If it doesn't store authentication information in config
 * files, it should use the given @prompt to ask the user for the
 * information. 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 when it is
 * done with it.
 *
 * Return value: the authentication information or NULL.
 **/
char *
camel_session_query_authenticator (CamelSession *session, char *prompt,
                   gboolean secret,
                   CamelService *service, char *item,
                   CamelException *ex)
{
    return session->authenticator (prompt, secret, service, item, ex);
}