aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-service.c
blob: e843826a8104afe5931d54b0e7457615b6df8902 (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camelService.c : Abstract class for an email service */

/* 
 *
 * Copyright (C) 1999 Bertrand Guiheneuf <Bertrand.Guiheneuf@inria.fr> .
 *
 * 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 "camel-service.h"

static GtkObjectClass *parent_class=NULL;

/* Returns the class for a CamelService */
#define CSERV_CLASS(so) CAMEL_SERVICE_CLASS (GTK_OBJECT(so)->klass)

static void __camel_service_connect(CamelService *service);
static void __camel_service_connect_to_with_login_passwd(CamelService *service, GString *host, GString *login, GString *passwd);
static void __camel_service_connect_to_with_login_passwd_port(CamelService *service, GString *host, GString *login, GString *passwd, guint port);
static gboolean __camel_service_is_connected(CamelService *service);
static void __camel_service_set_connected(CamelService *service, gboolean state);
static GString *__camel_service_get_url(CamelService *service);

static void
camel_service_class_init (CamelServiceClass *camel_service_class)
{
    parent_class = gtk_type_class (gtk_object_get_type ());
    
    /* virtual method definition */
    camel_service_class->connect = __camel_service_connect;
    camel_service_class->connect_to_with_login_passwd = __camel_service_connect_to_with_login_passwd;
    camel_service_class->connect_to_with_login_passwd_port = __camel_service_connect_to_with_login_passwd_port;
    camel_service_class->is_connected = __camel_service_is_connected;
    camel_service_class->set_connected = __camel_service_set_connected;
    camel_service_class->get_url = __camel_service_get_url;

    /* virtual method overload */
}







GtkType
camel_service_get_type (void)
{
    static GtkType camel_service_type = 0;
    
    if (!camel_service_type)    {
        GtkTypeInfo camel_service_info =    
        {
            "CamelService",
            sizeof (CamelService),
            sizeof (CamelServiceClass),
            (GtkClassInitFunc) camel_service_class_init,
            (GtkObjectInitFunc) NULL,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };
        
        camel_service_type = gtk_type_unique (gtk_object_get_type (), &camel_service_info);
    }
    
    return camel_service_type;
}





/**
 * __camel_service_connect : connect to a service 
 *
 * connect to the service using the parameters 
 * stored in the session it is initialized with
 * WARNING: session not implemented for the moment
 *
 * @service: object to connect
 **/
static void
__camel_service_connect(CamelService *service)
{
    CSERV_CLASS(service)->set_connected(service, TRUE);
}


/**
 * camel_service_connect : connect to a service 
 *
 * connect to the service using the parameters 
 * stored in the session it is initialized with
 * WARNING: session not implemented for the moment
 *
 * @service: object to connect to
 **/
void
camel_service_connect(CamelService *service)
{
    CSERV_CLASS(service)->connect(service);
}



/**
 * __camel_service_connect_to: connect to the specified address
 * 
 * Connect to the service, but do not use the session
 * default parameters to retrieve server's address
 *
 * @service: object to connect
 * @host: host to connect to
 * @login: user name used to log in
 * @passwd: password used to log in
 **/
static void
__camel_service_connect_to_with_login_passwd(CamelService *service, GString *host, GString *login, GString *passwd)
{
  CSERV_CLASS(service)->set_connected(service, TRUE);
}

/**
 * camel_service_connect_to_with_login_passwd: connect a service 
 * @service: the service to connect
 * @host: host to connect to
 * @login: login to connect with
 * @passwd: password to connect with
 * 
 * Connect to a service, but do not use the session
 * default parameters to retrieve server's address
 * 
 **/
void
camel_service_connect_to_with_login_passwd(CamelService *service, GString *host, GString *login, GString *passwd)
{
    CSERV_CLASS(service)->connect_to_with_login_passwd (service, host, login, passwd);
}



/**
 * __camel_service_connect_to:login:password : connect to the specified address
 * 
 * Connect to the service, but do not use the session
 * default parameters to retrieve server's address
 *
 * @service: object to connect
 * @host: host to connect to
 * @login: user name used to log in
 * @passwd: password used to log in
 * @port: port to connect to
 *
 **/
static void
__camel_service_connect_to_with_login_passwd_port(CamelService *service, GString *host, GString *login, GString *passwd, guint port)
{
    CSERV_CLASS(service)->set_connected(service, TRUE);
}


/**
 * camel_service_connect_to_with_login_passwd_port: connect a service 
 * @service: the service to connect
 * @host: host to connect to
 * @login: login to connect with
 * @passwd: password to connect with
 * @port: port to connect to 
 * 
 * Connect to a service, but do not use the session
 * default parameters to retrieve server's address
 * 
 **/
void
camel_service_connect_to_with_login_passwd_port(CamelService *service, GString *host, GString *login, GString *passwd, guint port)
{
    CSERV_CLASS(service)->connect_to_with_login_passwd_port (service, host, login, passwd, port);
}




/**
 * __camel_service_is_connected: test if the service object is connected
 *
 *
 * @service: object to test
 *  
 **/
static gboolean
__camel_service_is_connected(CamelService *service)
{
  return service->connected;
}


/**
 * camel_service_is_connected: test if a service object is connected
 *
 * @service:  the service
 * 
 * 
 * 
 * Return value: TRUE is the service is connected
 **/
gboolean
camel_service_is_connected(CamelService *service)
{
  return CSERV_CLASS(service)->is_connected(service);
}


/**
 * __camel_service_set_connected: set the connected state
 * 
 * This routine has to be called by providers to set the 
 * connection state, mainly when the service is disconnected
 * wheras the close() method has not been called.
 *
 * @service: object to set the state of
 * @state: connected/disconnected
 *  
 **/
static void
__camel_service_set_connected(CamelService *service, gboolean state)
{
  service->connected = state;
}



/**
 * __camel_service_get_url: get url representing a service
 * @service: the service
 * 
 * This method merely returns the "url" field. Subclasses
 * may provide more active implementations.
 * 
 * Return value: 
 **/
static GString *
__camel_service_get_url(CamelService *service)
{
    return service->url;
}

/**
 * camel_service_get_url: get the url representing a service
 * @service: the service
 * 
 * returns the URL representing a service. For security reasons 
 * This routine may not always return the password.
 * 
 * Return value: the url name
 **/
GString *
camel_service_get_url(CamelService *service)
{
    return CSERV_CLASS(service)->get_url(service);
}