aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-session.c
blob: c4e369b10bba1bf2ae957cdf5a65a835d6918d25 (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
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-session.c : Abstract class for an email session */

/*
 * Authors:
 *  Dan Winship <danw@ximian.com>
 *  Jeffrey Stedfast <fejj@ximian.com>
 *  Bertrand Guiheneuf <bertrand@helixcode.com>
 *
 * Copyright 1999 - 2003 Ximian, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 *
 * 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
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdio.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include <errno.h>

#include "camel-session.h"
#include "camel-store.h"
#include "camel-transport.h"
#include "camel-exception.h"
#include "camel-file-utils.h"
#include "camel-string-utils.h"
#include "camel-url.h"
#include "camel-vee-store.h"

#include "camel-private.h"

#define d(x)

#define CS_CLASS(so) CAMEL_SESSION_CLASS (CAMEL_OBJECT_GET_CLASS (so))

static void register_provider (CamelSession *session, CamelProvider *provider);
static GList *list_providers (CamelSession *session, gboolean load);
static CamelProvider *get_provider (CamelSession *session,
                    const char *url_string,
                    CamelException *ex);

static CamelService *get_service (CamelSession *session,
                  const char *url_string,
                  CamelProviderType type,
                  CamelException *ex);
static char *get_storage_path (CamelSession *session,
                   CamelService *service,
                   CamelException *ex);

static void *session_thread_msg_new(CamelSession *session, CamelSessionThreadOps *ops, unsigned int size);
static void session_thread_msg_free(CamelSession *session, CamelSessionThreadMsg *msg);
static int session_thread_queue(CamelSession *session, CamelSessionThreadMsg *msg, int flags);
static void session_thread_wait(CamelSession *session, int id);
static void session_thread_status(CamelSession *session, CamelSessionThreadMsg *msg, const char *text, int pc);

/* The vfolder provider is always available */
static CamelProvider vee_provider = {
    "vfolder",
    N_("Virtual folder email provider"),
    
    N_("For reading mail as a query of another set of folders"),
    
    "vfolder",
    
    CAMEL_PROVIDER_IS_STORAGE,
    
    CAMEL_URL_NEED_PATH, /* url_flags */
    
    /* ... */
};

static void
camel_session_init (CamelSession *session)
{
    session->online = TRUE;
    session->modules = camel_provider_init ();
    session->providers = g_hash_table_new (camel_strcase_hash, camel_strcase_equal);
    session->priv = g_malloc0(sizeof(*session->priv));
    
    session->priv->lock = g_mutex_new();
    session->priv->thread_lock = g_mutex_new();
    session->priv->thread_id = 1;
    session->priv->thread_active = g_hash_table_new(NULL, NULL);
    session->priv->thread_queue = NULL;
}

static gboolean
camel_session_destroy_provider (gpointer key, gpointer value, gpointer user_data)
{
    CamelProvider *prov = (CamelProvider *)value;
    int i;

    for (i = 0; i < CAMEL_NUM_PROVIDER_TYPES; i++) {
        if (prov->service_cache[i])
            camel_object_bag_destroy (prov->service_cache[i]);
    }
    return TRUE;
}

static void
camel_session_finalise (CamelObject *o)
{
    CamelSession *session = (CamelSession *)o;
    
    g_hash_table_destroy(session->priv->thread_active);
    if (session->priv->thread_queue)
        e_thread_destroy(session->priv->thread_queue);

    g_free(session->storage_path);
    g_hash_table_foreach_remove (session->providers,
                     camel_session_destroy_provider, NULL);
    g_hash_table_destroy (session->providers);
    
    g_mutex_free(session->priv->lock);
    g_mutex_free(session->priv->thread_lock);
    
    g_free(session->priv);
}

static void
camel_session_class_init (CamelSessionClass *camel_session_class)
{
    /* virtual method definition */
    camel_session_class->register_provider = register_provider;
    camel_session_class->list_providers = list_providers;
    camel_session_class->get_provider = get_provider;
    camel_session_class->get_service = get_service;
    camel_session_class->get_storage_path = get_storage_path;
    
    camel_session_class->thread_msg_new = session_thread_msg_new;
    camel_session_class->thread_msg_free = session_thread_msg_free;
    camel_session_class->thread_queue = session_thread_queue;
    camel_session_class->thread_wait = session_thread_wait;
    camel_session_class->thread_status = session_thread_status;
    
    vee_provider.object_types[CAMEL_PROVIDER_STORE] = camel_vee_store_get_type ();
    vee_provider.url_hash = camel_url_hash;
    vee_provider.url_equal = camel_url_equal;
}

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_construct:
 * @session: a session object to construct
 * @storage_path: path to a directory the session can use for
 * persistent storage. (This directory must already exist.)
 *
 * Constructs @session.
 **/
void
camel_session_construct (CamelSession *session, const char *storage_path)
{
    session->storage_path = g_strdup (storage_path);
    camel_session_register_provider(session, &vee_provider);
}


static void 
register_provider (CamelSession *session, CamelProvider *provider)
{
    int i;
    CamelProviderConfEntry *conf;
    GList *l;

    for (i = 0; i < CAMEL_NUM_PROVIDER_TYPES; i++) {
        if (provider->object_types[i])
            provider->service_cache[i] = camel_object_bag_new (provider->url_hash, provider->url_equal,
                                       (CamelCopyFunc)camel_url_copy, (GFreeFunc)camel_url_free);
    }

    /* Translate all strings here */

#define P_(string) dgettext (provider->translation_domain, string)

    provider->name = P_(provider->name);
    provider->description = P_(provider->description);
    conf = provider->extra_conf;
    if (conf) {
        for (i=0;conf[i].type != CAMEL_PROVIDER_CONF_END;i++) {
            if (conf[i].text)
                conf[i].text = P_(conf[i].text);
        }
    }
    l = provider->authtypes;
    while (l) {
        CamelServiceAuthType *auth = l->data;

        auth->name = P_(auth->name);
        auth->description = P_(auth->description);
        l = l->next;
    }

    g_hash_table_insert (session->providers, provider->protocol, provider);
}

/**
 * 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.
 *
 * Assumes the session lock has already been obtained,
 * which is the case for automatically loaded provider modules.
 **/
void
camel_session_register_provider (CamelSession *session,
                 CamelProvider *provider)
{
    g_return_if_fail (CAMEL_IS_SESSION (session));
    g_return_if_fail (provider != NULL);

    CS_CLASS (session)->register_provider (session, 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);
}

static GList *
list_providers (CamelSession *session, gboolean load)
{
    GList *list = NULL;

    if (load)
        g_hash_table_foreach (session->modules, ensure_loaded, session);

    g_hash_table_foreach (session->providers, add_to_list, &list);
    return list;
}

/**
 * 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);

    CAMEL_SESSION_LOCK (session, lock);
    list = CS_CLASS (session)->list_providers (session, load);
    CAMEL_SESSION_UNLOCK (session, lock);

    return list;
}


static CamelProvider *
get_provider (CamelSession *session, const char *url_string, CamelException *ex)
{
    CamelProvider *provider;
    char *protocol;

    protocol = g_strndup (url_string, strcspn (url_string, ":"));

    provider = g_hash_table_lookup (session->providers, protocol);
    if (!provider) {
        /* See if there's one we can load. */
        char *path;

        path = g_hash_table_lookup (session->modules, protocol);
        if (path) {
            camel_provider_load (session, path, ex);
            if (camel_exception_is_set (ex)) {
                g_free (protocol);
                return NULL;
            }
        }
        provider = g_hash_table_lookup (session->providers, protocol);
    }

    if (!provider) {
        camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_URL_INVALID,
                      _("No provider available for protocol `%s'"),
                      protocol);
    }
    g_free (protocol);

    return provider;
}

/**
 * camel_session_get_provider:
 * @session: the session
 * @url_string: the URL for the service whose provider you want
 * @ex: a CamelException
 *
 * This returns the CamelProvider that would be used to handle
 * @url_string, loading it in from disk if necessary.
 *
 * Return value: the provider, or %NULL, in which case @ex will be set.
 **/
CamelProvider *
camel_session_get_provider (CamelSession *session, const char *url_string,
                CamelException *ex)
{
    CamelProvider *provider;

    CAMEL_SESSION_LOCK (session, lock);
    provider = CS_CLASS (session)->get_provider (session, url_string, ex);
    CAMEL_SESSION_UNLOCK (session, lock);

    return provider;
}

static CamelService *
get_service (CamelSession *session, const char *url_string,
         CamelProviderType type, CamelException *ex)
{
    CamelURL *url;
    CamelProvider *provider;
    CamelService *service;
    CamelException internal_ex;
    
    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 = CS_CLASS (session)->get_provider (session, url->protocol, ex);
    if (provider && !provider->object_types[type]) {
        camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_URL_INVALID,
                      _("No provider available for protocol `%s'"),
                      url->protocol);
        provider = NULL;
    }
    
    if (!provider) {
        camel_url_free (url);
        return NULL;
    }
    
    /* If the provider doesn't use paths but the URL contains one,
     * ignore it.
     */
    if (url->path && !CAMEL_PROVIDER_ALLOWS (provider, CAMEL_URL_PART_PATH))
        camel_url_set_path (url, NULL);
    
    /* Now look up the service in the provider's cache */
    service = camel_object_bag_reserve(provider->service_cache[type], url);
    if (service != NULL) {
        camel_url_free (url);
        return service;
    }

    service = (CamelService *)camel_object_new (provider->object_types[type]);
    camel_exception_init (&internal_ex);
    camel_service_construct (service, session, provider, url, &internal_ex);
    if (camel_exception_is_set (&internal_ex)) {
        camel_exception_xfer (ex, &internal_ex);
        camel_object_unref (service);
        service = NULL;
        camel_object_bag_abort(provider->service_cache[type], url);
    } else {
        camel_object_bag_add(provider->service_cache[type], url, service);
    }

    return service;
}

/**
 * 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)
{
    CamelService *service;

    g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
    g_return_val_if_fail (url_string != NULL, NULL);

    CAMEL_SESSION_LOCK (session, lock);
    service = CS_CLASS (session)->get_service (session, url_string, type, ex);
    CAMEL_SESSION_UNLOCK (session, lock);

    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->status != CAMEL_SERVICE_CONNECTED) {
        if (camel_service_connect (svc, ex) == FALSE) {
            camel_object_unref (svc);
            return NULL;
        }
    }

    return svc;
}


static char *
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 (camel_mkdir (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_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)
{
    g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
    g_return_val_if_fail (CAMEL_IS_SERVICE (service), NULL);

    return CS_CLASS (session)->get_storage_path (session, service, ex);
}


/**
 * camel_session_get_password:
 * @session: session object
 * @prompt: prompt to provide to user
 * @reprompt: TRUE if the prompt should force a reprompt
 * @secret: whether or not the data is secret (eg, a password, as opposed
 * to a smartcard response)
 * @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 ask the application and
 * the user for a password or other authentication data.
 *
 * @service and @item together uniquely identify the piece of data the
 * caller is concerned with.
 *
 * @prompt 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 will 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.
 *
 * Return value: the authentication information or %NULL.
 **/
char *
camel_session_get_password (CamelSession *session, const char *prompt,
                gboolean reprompt, gboolean secret,
                CamelService *service, const char *item,
                CamelException *ex)
{
    g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
    g_return_val_if_fail (prompt != NULL, NULL);
    g_return_val_if_fail (item != NULL, NULL);
    
    return CS_CLASS (session)->get_password (session, prompt, reprompt, secret, service, item, ex);
}


/**
 * camel_session_forget_password:
 * @session: session object
 * @service: the service rejecting the password
 * @item: an identifier, unique within this service, for the information
 * @ex: a CamelException
 *
 * This function is used by a CamelService to tell the application
 * that the authentication information it provided via
 * camel_session_get_password was rejected by the service. If the
 * application was caching this information, it should stop,
 * and if the service asks for it again, it should ask the user.
 *
 * @service and @item identify the rejected authentication information,
 * as with camel_session_get_password.
 **/
void
camel_session_forget_password (CamelSession *session, CamelService *service,
                   const char *item, CamelException *ex)
{
    g_return_if_fail (CAMEL_IS_SESSION (session));
    g_return_if_fail (item != NULL);

    CS_CLASS (session)->forget_password (session, service, item, ex);
}


/**
 * camel_session_alert_user:
 * @session: session object
 * @type: the type of alert (info, warning, or error)
 * @prompt: the message for the user
 * @cancel: whether or not to provide a "Cancel" option in addition to
 * an "OK" option.
 *
 * Presents the given @prompt to the user, in the style indicated by
 * @type. If @cancel is %TRUE, the user will be able to accept or
 * cancel. Otherwise, the message is purely informational.
 *
 * Return value: %TRUE if the user accepts, %FALSE if they cancel.
 */
gboolean
camel_session_alert_user (CamelSession *session, CamelSessionAlertType type,
              const char *prompt, gboolean cancel)
{
    g_return_val_if_fail (CAMEL_IS_SESSION (session), FALSE);
    g_return_val_if_fail (prompt != NULL, FALSE);

    return CS_CLASS (session)->alert_user (session, type, prompt, cancel);
}


/**
 * camel_session_is_online:
 * @session: the session.
 *
 * Return value: whether or not @session is online.
 **/
gboolean
camel_session_is_online (CamelSession *session)
{
    return session->online;
}


/**
 * camel_session_set_online:
 * @session: the session
 * @online: whether or not the session should be online
 *
 * Sets the online status of @session to @online.
 **/
void
camel_session_set_online (CamelSession *session, gboolean online)
{
    session->online = online;
}


/**
 * camel_session_get_filter_driver:
 * @session: the session
 * @type: the type of filter (eg, "incoming")
 * @ex: a CamelException
 *
 * Return value: a filter driver, loaded with applicable rules
 **/
CamelFilterDriver *
camel_session_get_filter_driver (CamelSession *session,
                 const char *type,
                 CamelException *ex)
{
    return CS_CLASS (session)->get_filter_driver (session, type, ex);
}

static void
cs_thread_status(CamelOperation *op, const char *what, int pc, void *data)
{
    CamelSessionThreadMsg *m = data;

    CS_CLASS(m->session)->thread_status(m->session, m, what, pc);
}

static void *session_thread_msg_new(CamelSession *session, CamelSessionThreadOps *ops, unsigned int size)
{
    CamelSessionThreadMsg *m;

    g_assert(size >= sizeof(*m));

    m = g_malloc0(size);
    m->ops = ops;
    m->session = session;
    camel_object_ref(session);
    m->op = camel_operation_new(cs_thread_status, m);
    camel_exception_init(&m->ex);
    CAMEL_SESSION_LOCK(session, thread_lock);
    m->id = session->priv->thread_id++;
    g_hash_table_insert(session->priv->thread_active, GINT_TO_POINTER(m->id), m);
    CAMEL_SESSION_UNLOCK(session, thread_lock);

    return m;
}

static void session_thread_msg_free(CamelSession *session, CamelSessionThreadMsg *msg)
{
    g_assert(msg->ops != NULL);

    d(printf("free message %p session %p\n", msg, session));

    CAMEL_SESSION_LOCK(session, thread_lock);
    g_hash_table_remove(session->priv->thread_active, GINT_TO_POINTER(msg->id));
    CAMEL_SESSION_UNLOCK(session, thread_lock);

    d(printf("free msg, ops->free = %p\n", msg->ops->free));
    
    if (msg->ops->free)
        msg->ops->free(session, msg);
    if (msg->op)
        camel_operation_unref(msg->op);
    camel_exception_clear(&msg->ex);
    camel_object_unref(msg->session);
    g_free(msg);
}

static void session_thread_destroy(EThread *thread, CamelSessionThreadMsg *msg, CamelSession *session)
{
    d(printf("destroy message %p session %p\n", msg, session));
    camel_session_thread_msg_free(session, msg);
}

static void session_thread_received(EThread *thread, CamelSessionThreadMsg *msg, CamelSession *session)
{
    d(printf("receive message %p session %p\n", msg, session));
    if (msg->ops->receive) {
        CamelOperation *oldop;

        oldop = camel_operation_register(msg->op);
        msg->ops->receive(session, msg);
        camel_operation_register(oldop);
    }
}

static int session_thread_queue(CamelSession *session, CamelSessionThreadMsg *msg, int flags)
{
    int id;

    CAMEL_SESSION_LOCK(session, thread_lock);
    if (session->priv->thread_queue == NULL) {
        session->priv->thread_queue = e_thread_new(E_THREAD_QUEUE);
        e_thread_set_msg_destroy(session->priv->thread_queue, (EThreadFunc)session_thread_destroy, session);
        e_thread_set_msg_received(session->priv->thread_queue, (EThreadFunc)session_thread_received, session);
    }
    CAMEL_SESSION_UNLOCK(session, thread_lock);

    id = msg->id;
    e_thread_put(session->priv->thread_queue, &msg->msg);

    return id;
}

static void session_thread_wait(CamelSession *session, int id)
{
    int wait;

    /* we just busy wait, only other alternative is to setup a reply port? */
    do {
        CAMEL_SESSION_LOCK(session, thread_lock);
        wait = g_hash_table_lookup(session->priv->thread_active, GINT_TO_POINTER(id)) != NULL;
        CAMEL_SESSION_UNLOCK(session, thread_lock);
        if (wait) {
            usleep(20000);
        }
    } while (wait);
}

static void session_thread_status(CamelSession *session, CamelSessionThreadMsg *msg, const char *text, int pc)
{
}

/**
 * camel_session_thread_msg_new:
 * @session: 
 * @ops: 
 * @size: 
 * 
 * Create a new thread message, using ops as the receive/reply/free
 * ops, of @size bytes.
 *
 * @ops points to the operations used to recieve/process and finally
 * free the message.
 **/
void *camel_session_thread_msg_new(CamelSession *session, CamelSessionThreadOps *ops, unsigned int size)
{
    g_assert(CAMEL_IS_SESSION(session));
    g_assert(ops != NULL);
    g_assert(size >= sizeof(CamelSessionThreadMsg));
         
    return CS_CLASS (session)->thread_msg_new(session, ops, size);
}

/**
 * camel_session_thread_msg_free:
 * @session: 
 * @msg: 
 * 
 * Free a @msg.  Note that the message must have been allocated using
 * msg_new, and must nto have been submitted to any queue function.
 **/
void camel_session_thread_msg_free(CamelSession *session, CamelSessionThreadMsg *msg)
{
    g_assert(CAMEL_IS_SESSION(session));
    g_assert(msg != NULL);
    g_assert(msg->ops != NULL);

    CS_CLASS (session)->thread_msg_free(session, msg);
}

/**
 * camel_session_thread_queue:
 * @session: 
 * @msg: 
 * @flags: queue type flags, currently 0.
 * 
 * Queue a thread message in another thread for processing.
 * The operation should be (but needn't) run in a queued manner
 * with other operations queued in this manner.
 * 
 * Return value: The id of the operation queued.
 **/
int camel_session_thread_queue(CamelSession *session, CamelSessionThreadMsg *msg, int flags)
{
    g_assert(CAMEL_IS_SESSION(session));
    g_assert(msg != NULL);

    return CS_CLASS (session)->thread_queue(session, msg, flags);
}

/**
 * camel_session_thread_wait:
 * @session: 
 * @id: 
 * 
 * Wait on an operation to complete (by id).
 **/
void camel_session_thread_wait(CamelSession *session, int id)
{
    g_assert(CAMEL_IS_SESSION(session));
    
    if (id == -1)
        return;

    CS_CLASS (session)->thread_wait(session, id);
}