aboutsummaryrefslogtreecommitdiffstats
path: root/www/squid/pkg-install
blob: b277f08d26601090bda95727ff4fc007938d0f1e (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
#!/bin/sh
#
# $FreeBSD$
#

PATH=/bin:/usr/bin:/usr/sbin
pkgname=$1
squid_base=${PKG_PREFIX:-/usr/local}/squid
squid_confdir=${PKG_PREFIX:-/usr/local}/etc/squid
if [ -x /usr/sbin/nologin ]; then
    nologin=/usr/sbin/nologin
else
    nologin=/sbin/nologin
fi
squid_user=${squid_user:-squid}
squid_group=${squid_group:-squid}
squid_gid=100
squid_uid=100
# Try to catch the case where the $squid_user might have been created with an
# id greater than or equal 3128. The valid exception is "nobody".
nobody_uid=65534
nobody_gid=65534
squid_oldgid=3128
squid_olduid=3128
unset wrong_id
case $2 in
PRE-INSTALL)
    echo "===> Pre-installation configuration for ${pkgname}"
    if ! pw groupshow ${squid_group} -q >/dev/null ; then
        echo "There is no group '${squid_group}' on this system, so I will try to create it:"
        if ! pw groupadd ${squid_group} -g ${squid_gid} -q ; then
            echo "Failed to create group \"${squid_group}\"!" >&2
            echo "Please create it manually." >&2
            exit 1
        else
            echo "Group '${squid_group}' created successfully:"
        fi
    else
        echo "I will use the existing group '${squid_group}':"
        current_gid=`pw groupshow ${squid_group}|cut -f 3 -d :`
        if [ ${current_gid} -ge ${squid_oldgid} \
            -a ${current_gid} -ne ${nobody_gid} ]; then
            wrong_id=1
        fi  
    fi
    pw groupshow ${squid_group}

    if ! pw usershow ${squid_user} -q >/dev/null ; then
        echo "There is no account '${squid_user}' on this system, so I will try to create it:"
        if ! pw useradd -q -n ${squid_user} \
            -u ${squid_uid} -g ${squid_group} \
            -c "squid caching-proxy pseudo user" \
            -d "${squid_base}" -s "${nologin}" \
            -h - ; then
            echo "Failed to create user '${squid_user}'!" >&2
            echo "Please create it manually." >&2
            exit 1
        else
            echo "User '${squid_user}' created successfully:"
        fi
    else
        echo "I will use the existing user '${squid_user}':"
        current_uid=`id -u ${squid_user}`
        if [ ${current_uid} -ge ${squid_olduid} \
            -a ${current_uid} -ne ${nobody_uid} ];
        then
            wrong_id=1
        fi
    fi
    pw usershow ${squid_user}
    if [ "${wrong_id}" ]; then
        echo ""
        echo " * NOTICE *"
        echo ""
        echo "The squid pseudo-user's uid and/or gid have been found"
        echo "to be greater than or equal 3128."
        echo ""
        echo "This is not a problem as such, but violates the FreeBSD"
        echo "ports' principle that a ports must not claim a uid greater"
        echo "than 999."
        echo ""
        echo "Since version 2.5.4_11, the squid user is thus created"
        echo "with an id of ${squid_uid}:${squid_gid} while earlier versions of this"
        echo "port used the first unused uid/gid greater than or"
        echo "equal 3128."
        echo ""
        echo "If you want to change the existing squid user's id, run"
        echo "'make changeuser' after the installation has completed."
        echo "If you installed this port via a package, issue the"
        echo "following commands as root:"
        echo ""
        echo "pw userdel -u ${current_uid}"
        echo "pw groupadd -n ${squid_group} -g ${squid_gid}"
        echo "pw useradd -n ${squid_user} -u ${squid_uid} \\"
        echo "    -c \"squid caching-proxy pseudo user\" \\"
        echo "    -g ${squid_group} -d ${squid_base} -s /sbin/nologin \\"
        echo "    -h -"
        echo "find -H ${PKG_PREFIX} -user ${current_uid} -exec chown ${squid_user} {} \\;"
        echo "find -H ${PKG_PREFIX} -group ${current_gid} -exec chgrp ${squid_group} {} \\;"
        echo ""
        echo "In case you have installed third party software for squid"
        echo "like squidGuard, you should additionally run:"
        echo "find -H /var -user ${current_uid} -exec chown ${squid_user} {} \\;"
        echo "find -H /var -group ${current_gid} -exec chgrp ${squid_group} {} \\;"
        echo ""
        if [ -z "${PACKAGE_BUILDING}" -a -z "${BATCH}" ]; then
            sleep 30
        fi
    fi
    for dir in cache logs; do
    if [ ! -d ${squid_base}/${dir} ]; then
        echo "Creating ${squid_base}/${dir}..."
        install -d -o ${squid_user} -g ${squid_group} \
            -m 0750 ${squid_base}/${dir}
    fi
    done
    if [ ! -d ${squid_confdir} ]; then
        echo "Creating ${squid_confdir}..."
        install -d -o root -g ${squid_group} \
            -m 0750 ${squid_confdir}
    fi
    ;;
POST-INSTALL)
    for file in cachemgr.conf mime.conf squid.conf; do
        if [ ! -f ${squid_confdir}/${file} \
            -a -f ${squid_confdir}/${file}.default ]; then
            echo "Creating ${file} from default..."
            install -c -o root -g ${squid_group} -m 0640 \
                    ${squid_confdir}/${file}.default \
                ${squid_confdir}/${file}
        fi
    done

    echo "===> Post-installation informations for ${pkgname}"
    echo ""
    echo "     o You can find the configuration files for this package"
    echo "       in the directory ${squid_confdir}."
    echo ""
    echo "     o A cache directory has been created in ${squid_base}/cache."
    echo "       Log files will be written to ${squid_base}/logs."
    echo ""
    echo "     o The default configuration will deny everyone access to the"
    echo "       proxy service. Edit the \"http_access\" directives in"
    echo "       ${squid_confdir}/squid.conf to suit your needs."
    echo ""
    echo "     o If you never ran squid on this system before, you need to"
    echo "       initialize the cache directory by running \"squid -z\""
    echo "       as 'root' or '${squid_user}' before starting squid."
    echo ""
    echo "     Please note that ${PKG_PREFIX}/etc/rc.d/squid.sh is a"
    echo "     new style rc script. This means that squid will not"
    echo "     start automatically at boot time."
    echo ""
    echo "     To enable squid, set squid_enable=yes in either"
    echo "     /etc/rc.conf, /etc/rc.conf.local or /etc/rc.conf.d/squid"
    echo "     See ${PKG_PREFIX}/etc/rc.d/squid.sh for more"
    echo "     configuration options."
    echo ""
    echo "     If you want the port to install an old style rc script, run"
    echo "     'make config' and deselect the option to install an"
    echo "     rcNG script."
    echo ""
    ;;
*)
    exit 64
    ;;
esac
exit 0
e97ea2f93886767aa7f64'>f9595bb213
0524f7c06a

6de256c2a2


f9595bb213
0524f7c06a


f9595bb213
0524f7c06a

f9595bb213
63e96e1002
f9595bb213

63e96e1002
ba6b73fe56

































63e96e1002











ba6b73fe56

















63e96e1002


6de256c2a2
ba6b73fe56


63e96e1002
d3ce110bb7
63e96e1002
d3ce110bb7

63e96e1002


d3ce110bb7








63e96e1002

d3ce110bb7
63e96e1002
d3ce110bb7








63e96e1002
d3ce110bb7



















d3ce110bb7
63e96e1002


d3ce110bb7




631dda8ae0
8cb514d6dd
631dda8ae0
a7f40b2f5f
8cb514d6dd
a7f40b2f5f




6de256c2a2

a7f40b2f5f

6de256c2a2

631dda8ae0
f9595bb213
63e96e1002



f9595bb213
0524f7c06a
1fb4f1bfee
631dda8ae0
e8aa23866a
a0b95ac74d

0524f7c06a
d3d2adb98c
a7f40b2f5f

63e96e1002
d3ce110bb7
4f686ae899
360675f54b
0524f7c06a
d3ce110bb7


0524f7c06a
d3d2adb98c
4f686ae899
a7f40b2f5f

a7f40b2f5f

a7f40b2f5f
8cb514d6dd
a7f40b2f5f

d3d2adb98c
65eb577ecd
e8aa23866a



65eb577ecd


a7f40b2f5f
8cb514d6dd
631dda8ae0
63e96e1002


































9272361bba
631dda8ae0
f888058fc6
8ea1212d99
1fb4f1bfee












2bdcfe5c47
1fb4f1bfee



2bdcfe5c47















8ea1212d99
8cc3a0e4dc
63e96e1002






















8ea1212d99
1fb4f1bfee

















63e96e1002



1fb4f1bfee

63e96e1002
1fb4f1bfee
63e96e1002
8ea1212d99
63e96e1002


8ea1212d99



63e96e1002

8ea1212d99
2aefadf282


63e96e1002



2aefadf282


2aefadf282
8ea1212d99
63e96e1002



8ea1212d99
63e96e1002
63e96e1002



8ea1212d99
8cb514d6dd
63e96e1002




















63e96e1002



405f1c5229
8cb514d6dd
63e96e1002









8cb514d6dd
63e96e1002













8cb514d6dd




63e96e1002


8cb514d6dd
63e96e1002

8cb514d6dd
8cb514d6dd





63e96e1002
8cb514d6dd
63e96e1002
8cb514d6dd


63e96e1002
8cb514d6dd
63e96e1002
8cb514d6dd
63e96e1002
8cb514d6dd
63e96e1002
8cb514d6dd
1fb4f1bfee

8cb514d6dd
63e96e1002


8cb514d6dd
630241d74b

























faac871501
















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


                                                                           
  


                                      
                                               
  
                                     
  

                                                                 












                                                                      
 
                    
                   

      
                  
                  


                     
                          
                        
                            
                            
                         
                      
                             
                            
 

                          














                                                                               
 
 








                                                                    
                      
 
                          
 
                 

  


                                          
                               
                                                  
                                                                                



                                                          









                                                                                 


           
                                       


                                                  
                                      


                                                                           





                                          


           
                                                                 
 








                                                                                        

 
         

                             


                                                                 







                                                                            
         
 


                                  
   



                                                             
  
                       
    

                                                                         
 
                                                        
                                                                

 
 



                                                                               

 
   


                                                    
                             

                                                            


                                                               
    


                                                         
 

                                                      
 
                                                                  

 
 

































                                                                     











                                                                                

















                                                                         


                                                                  
 


                    
 
                      
                                                                                

                                


                                                                     








                                                                        

                                                          
                                            
                         








                                                                                   
                          



















                                                                          
 


                                                                              




                        
           
                                                                                     
 
                                
                                                          




                                                      

                                          

                                                                                    

                                            
 
 



                                                           
 
                      
                                
                              
                                   

                                             
                            
 

                                                                
                                                                                 
                                                        
                                                                              
                                                                                   
                                                     


                                
                                     
                            
         

                                                             

                                                                     
                                     
                                                          

                               
 
                                                                                  



                                                                                


                                                            
                                                                            
                                                                                                                                       
         


































                                                                                  
 
                       
 
 












                                                                     
              



                                                            















                                                                        
 
 






















                                                                                   
   

















                                                                             



                                                                           

 
 
   
                              
                           


                                                                         



                                                                        

                                                                     
  


                                                                      



                                                                    


                                                                      
                                                         
    



                                                                      
 
                                                                



                                                                                             
 
 




















                                                                            



                                                                         
 
   









                                                                      
  













                                                                              




                                                               


                                                                 
  

                                                                    
    





                                                              
                                                             
 
                                                                                             


   
                                
                             
                                                                  
  
                                 
  
                                                     
    

                                                                  
 


                                                                    
 

























                                                                 
















                                                                         
/* -*- 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 - 2001 Ximian, Inc.
 *
 * 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
 */

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

#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"
#include "camel-vee-store.h"

#include "camel-private.h"

#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);


/* The vfolder provider is always avilable */
static CamelProvider vee_provider = {
    "vfolder",
    N_("Virtual folder email provider"),

    N_("For reading mail as a query of another set of folders"),

    "vfolder",

    0, /* flags */

    0, /* url_flags */

    /* ... */
};

static void
camel_session_init (CamelSession *session)
{
    session->online = TRUE;
    session->modules = camel_provider_init ();
    session->providers = g_hash_table_new (g_strcase_hash, g_strcase_equal);
    session->priv = g_malloc0(sizeof(*session->priv));
#ifdef ENABLE_THREADS
    session->priv->lock = g_mutex_new();
#endif  
}

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_free(session->storage_path);
    g_hash_table_foreach_remove (session->providers,
                     camel_session_destroy_provider, NULL);
    g_hash_table_destroy (session->providers);

#ifdef ENABLE_THREADS
    g_mutex_free(session->priv->lock);
#endif  

    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;

    vee_provider.object_types[CAMEL_PROVIDER_STORE] = camel_vee_store_get_type ();
    vee_provider.service_cache = g_hash_table_new (camel_url_hash, 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)
{
    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 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);
    
    CAMEL_SESSION_LOCK(session, lock);

    provider = g_hash_table_lookup (session->providers, service->url->protocol);
    g_hash_table_remove (provider->service_cache, service->url);

    CAMEL_SESSION_UNLOCK(session, lock);
}


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;
    }
    
    /* 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 = (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 (CAMEL_OBJECT (service));
        service = NULL;
    } else {
        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:
 * @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->connected == FALSE) {
        if (camel_service_connect (svc, ex) == FALSE) {
            camel_object_unref (CAMEL_OBJECT (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_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_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
 * @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 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, 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_register_timeout:
 * @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
 *
 * Registers the given timeout. @callback will be called every
 * @interval milliseconds with one argument, @user_data, until it
 * returns %FALSE.
 *
 * Return value: On success, a non-zero handle that can be used with
 * camel_session_remove_timeout(). On failure, 0.
 **/
guint
camel_session_register_timeout (CamelSession *session,
                guint32 interval,
                CamelTimeoutCallback callback,
                gpointer user_data)
{
    g_return_val_if_fail (CAMEL_IS_SESSION (session), 0);

    return CS_CLASS (session)->register_timeout (session, interval, callback, user_data);
}

/**
 * camel_session_remove_timeout:
 * @session: the CamelSession
 * @handle: a value returned from camel_session_register_timeout()
 *
 * Removes the indicated timeout.
 *
 * Return value: %TRUE on success, %FALSE on failure.
 **/
gboolean
camel_session_remove_timeout (CamelSession *session, guint handle)
{
    g_return_val_if_fail (CAMEL_IS_SESSION (session), FALSE);

    return CS_CLASS (session)->remove_timeout (session, handle);
}


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