aboutsummaryrefslogtreecommitdiffstats
path: root/camel/providers/pop3/camel-pop3-store.c
blob: 3713c086a60e73342c9e1cf6b636be28b3e3969f (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-pop3-store.c : class for a pop3 store */

/* 
 * Authors:
 *   Dan Winship <danw@helixcode.com>
 *
 * Copyright (C) 2000 Helix Code, Inc. (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 <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "camel-pop3-store.h"
#include "camel-pop3-folder.h"
#include "camel-stream-buffer.h"
#include "camel-stream-fs.h"
#include "camel-session.h"
#include "camel-exception.h"
#include "camel-url.h"
#include "md5-utils.h"

/* Specified in RFC 1939 */
#define POP3_PORT 110

static CamelServiceClass *service_class = NULL;

static void finalize (GtkObject *object);

static gboolean pop3_connect (CamelService *service, CamelException *ex);
static gboolean pop3_disconnect (CamelService *service, CamelException *ex);
static GList *query_auth_types (CamelService *service);
static void free_auth_types (CamelService *service, GList *authtypes);

static CamelFolder *get_folder (CamelStore *store, const char *folder_name, 
                CamelException *ex);
static char *get_folder_name (CamelStore *store, const char *folder_name, 
                  CamelException *ex);
static char *get_root_folder_name (CamelStore *store, CamelException *ex);


static void
camel_pop3_store_class_init (CamelPop3StoreClass *camel_pop3_store_class)
{
    GtkObjectClass *object_class =
        GTK_OBJECT_CLASS (camel_pop3_store_class);
    CamelServiceClass *camel_service_class =
        CAMEL_SERVICE_CLASS (camel_pop3_store_class);
    CamelStoreClass *camel_store_class =
        CAMEL_STORE_CLASS (camel_pop3_store_class);
    
    service_class = gtk_type_class (camel_service_get_type ());

    /* virtual method overload */
    object_class->finalize = finalize;

    camel_service_class->connect = pop3_connect;
    camel_service_class->disconnect = pop3_disconnect;
    camel_service_class->query_auth_types = query_auth_types;
    camel_service_class->free_auth_types = free_auth_types;

    camel_store_class->get_folder = get_folder;
    camel_store_class->get_folder_name = get_folder_name;
    camel_store_class->get_root_folder_name = get_root_folder_name;
}



static void
camel_pop3_store_init (gpointer object, gpointer klass)
{
    CamelService *service = CAMEL_SERVICE (object);
    CamelStore *store = CAMEL_STORE (object);

    service->url_flags = ( CAMEL_SERVICE_URL_NEED_USER |
                   CAMEL_SERVICE_URL_NEED_HOST );
    store->folders = g_hash_table_new (g_str_hash, g_str_equal);
}




GtkType
camel_pop3_store_get_type (void)
{
    static GtkType camel_pop3_store_type = 0;

    if (!camel_pop3_store_type) {
        GtkTypeInfo camel_pop3_store_info = 
        {
            "CamelPop3Store",
            sizeof (CamelPop3Store),
            sizeof (CamelPop3StoreClass),
            (GtkClassInitFunc) camel_pop3_store_class_init,
            (GtkObjectInitFunc) camel_pop3_store_init,
                /* reserved_1 */ NULL,
                /* reserved_2 */ NULL,
            (GtkClassInitFunc) NULL,
        };

        camel_pop3_store_type = gtk_type_unique (CAMEL_STORE_TYPE, &camel_pop3_store_info);
    }

    return camel_pop3_store_type;
}

static void
finalize (GtkObject *object)
{
    CamelException ex;

    camel_exception_init (&ex);
    pop3_disconnect (CAMEL_SERVICE (object), &ex);
    camel_exception_clear (&ex);
}


static CamelServiceAuthType password_authtype = {
    "Password/APOP",

    "This option will connect to the POP server using the APOP "
    "protocol if possible, or a plaintext password if not.",

    "",
    TRUE
};

static GList
*query_auth_types (CamelService *service)
{
    GList *ret;

    ret = g_list_append (NULL, &password_authtype);
    return ret;
}

static void
free_auth_types (CamelService *service, GList *authtypes)
{
    g_list_free (authtypes);
}

/**
 * camel_pop3_store_open: Connect to the server if we are currently
 * disconnected.
 * @store: the store
 * @ex: a CamelException
 *
 * The POP protocol does not allow deleted messages to be expunged
 * except by closing the connection. Thus, camel_pop3_folder_{open,close}
 * sometimes need to connect to or disconnect from the server. This
 * routine reconnects to the server if we have disconnected.
 *
 **/
void
camel_pop3_store_open (CamelPop3Store *store, CamelException *ex)
{
    CamelService *service = CAMEL_SERVICE (store);

    if (!camel_service_is_connected (service))
        pop3_connect (service, ex);
}

/**
 * camel_pop3_store_close: Close the connection to the server and
 * possibly expunge deleted messages.
 * @store: the store
 * @expunge: whether or not to expunge deleted messages
 * @ex: a CamelException
 *
 * See camel_pop3_store_open for an explanation of why this is needed.
 *
 **/
void
camel_pop3_store_close (CamelPop3Store *store, gboolean expunge,
            CamelException *ex)
{
    if (expunge)
        camel_pop3_command (store, NULL, "QUIT");
    else
        camel_pop3_command (store, NULL, "RSET");
    pop3_disconnect (CAMEL_SERVICE (store), ex);
}

static gboolean
pop3_connect (CamelService *service, CamelException *ex)
{
    struct hostent *h;
    struct sockaddr_in sin;
    int fd, status;
    char *buf, *apoptime, *apopend;
    CamelPop3Store *store = CAMEL_POP3_STORE (service);

    h = camel_service_gethost (service, ex);
    if (!h)
        return FALSE;

    if (!service->url->passwd) {
        char *prompt = g_strdup_printf ("Please enter the POP3 password for %s@%s",
                        service->url->user, h->h_name);
        service->url->passwd =
            camel_session_query_authenticator (camel_service_get_session (service),
                               prompt, TRUE,
                               service, "password",
                               ex);
        g_free (prompt);
        if (!service->url->passwd)
            return FALSE;
    }

    sin.sin_family = h->h_addrtype;
    sin.sin_port = htons (service->url->port ? service->url->port : POP3_PORT);
    memcpy (&sin.sin_addr, h->h_addr, sizeof (sin.sin_addr));

    fd = socket (h->h_addrtype, SOCK_STREAM, 0);
    if (fd == -1 ||
        connect (fd, (struct sockaddr *)&sin, sizeof(sin)) == -1) {
        camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                      "Could not connect to %s (port %s): %s",
                      service->url->host, service->url->port,
                      strerror(errno));
        if (fd > -1)
            close (fd);
        return FALSE;
    }

    store->ostream = camel_stream_fs_new_with_fd (fd);
    store->istream = camel_stream_buffer_new (store->ostream,
                          CAMEL_STREAM_BUFFER_READ);

    /* Read the greeting, note APOP timestamp, if any. */
    buf = camel_stream_buffer_read_line (CAMEL_STREAM_BUFFER (store->istream));
    if (!buf) {
        camel_exception_set (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                     "Could not read greeting from POP "
                     "server.");
        return FALSE;
        camel_stream_close (store->ostream);
        camel_stream_close (store->istream);
    }
    apoptime = strchr (buf, '<');
    apopend = apoptime ? strchr (apoptime, '>') : NULL;
    if (apoptime && apopend)
        apoptime = g_strndup (apoptime, apopend - apoptime + 1);
    else
        apoptime = NULL;
    g_free (buf);

    /* Authenticate via APOP if we can, USER/PASS if we can't. */
    status = CAMEL_POP3_FAIL;
    if (apoptime) {
        char *secret, md5asc[32], *d;
        unsigned char md5sum[16], *s;

        secret = g_strdup_printf ("%s%s", apoptime,
                      service->url->passwd);
        md5_get_digest (secret, strlen (secret), md5sum);
        g_free (apoptime);
        g_free (secret);

        for (s = md5sum, d = md5asc; d < md5asc + 32; s++, d += 2)
            sprintf (d, "%.2x", *s);

        status = camel_pop3_command (store, NULL, "APOP %s %s",
                         service->url->user, md5asc);
    }

    if (status != CAMEL_POP3_OK ) {
        char *msg;

        status = camel_pop3_command (store, &msg, "USER %s",
                         service->url->user);
        if (status != CAMEL_POP3_OK) {
            camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_CANT_AUTHENTICATE,
                          "Unable to connect to POP "
                          "server. Error sending username:"
                          " %s", msg ? msg : "(Unknown)");
            g_free (msg);
            camel_stream_close (store->ostream);
            camel_stream_close (store->istream);
            return FALSE;
        }

        status = camel_pop3_command(store, &msg, "PASS %s",
                        service->url->passwd);
        if (status != CAMEL_POP3_OK) {
            camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_CANT_AUTHENTICATE,
                          "Unable to authenticate to POP "
                          "server. Error sending password:"
                          " %s", msg ? msg : "(Unknown)");
            g_free (msg);
            camel_stream_close (store->ostream);
            camel_stream_close (store->istream);
            return FALSE;
        }
    }

    service_class->connect (service, ex);
    return TRUE;
}

static gboolean
pop3_disconnect (CamelService *service, CamelException *ex)
{
    CamelPop3Store *store = CAMEL_POP3_STORE (service);

    if (!service->connected)
        return TRUE;

    if (!service_class->disconnect (service, ex))
        return FALSE;

    /* Closing the buffered write stream will close the
     * unbuffered read stream wrapped inside it as well.
     */
    camel_stream_close (store->ostream);
    gtk_object_unref (GTK_OBJECT (store->ostream));
    store->ostream = NULL;
    store->istream = NULL;
    return TRUE;
}

static CamelFolder *
get_folder (CamelStore *store, const char *folder_name, CamelException *ex)
{
    return camel_pop3_folder_new (store, ex);
}

static char *
get_folder_name (CamelStore *store, const char *folder_name,
         CamelException *ex)
{
    if (!strcasecmp (folder_name, "inbox"))
        return g_strdup ("inbox");
    else {
        camel_exception_setv (ex, CAMEL_EXCEPTION_FOLDER_INVALID,
                      "No such folder `%s'.", folder_name);
        return NULL;
    }
}

static char *
get_root_folder_name (CamelStore *store, CamelException *ex)
{
    return g_strdup ("inbox");
}


/**
 * camel_pop3_command: Send a command to a POP3 server.
 * @store: the POP3 store
 * @ret: a pointer to return the full server response in
 * @fmt: a printf-style format string, followed by arguments
 *
 * This command sends the command specified by @fmt and the following
 * arguments to the connected POP3 store specified by @store. It then
 * reads the server's response and parses out the status code. If
 * the caller passed a non-NULL pointer for @ret, camel_pop3_command
 * will set it to point to an buffer containing the rest of the
 * response from the POP3 server. (If @ret was passed but there was
 * no extended response, @ret will be set to NULL.) The caller must
 * free this buffer when it is done with it.
 *
 * Return value: one of CAMEL_POP3_OK (command executed successfully),
 * CAMEL_POP3_ERR (command encounted an error), or CAMEL_POP3_FAIL
 * (a protocol-level error occurred, and Camel is uncertain of the
 * result of the command.)
 **/
int
camel_pop3_command (CamelPop3Store *store, char **ret, char *fmt, ...)
{
    char *cmdbuf, *respbuf;
    va_list ap;
    int status;

    va_start (ap, fmt);
    cmdbuf = g_strdup_vprintf (fmt, ap);
    va_end (ap);

    /* Send the command */
    camel_stream_write (store->ostream, cmdbuf, strlen (cmdbuf));
    g_free (cmdbuf);
    camel_stream_write (store->ostream, "\r\n", 2);

    /* Read the response */
    respbuf = camel_stream_buffer_read_line (CAMEL_STREAM_BUFFER (store->istream));
    if (!strncmp (respbuf, "+OK", 3))
        status = CAMEL_POP3_OK;
    else if (!strncmp (respbuf, "-ERR", 4))
        status = CAMEL_POP3_ERR;
    else
        status = CAMEL_POP3_FAIL;

    if (ret) {
        if (status != CAMEL_POP3_FAIL) {
            *ret = strchr (respbuf, ' ');
            if (*ret)
                *ret = g_strdup (*ret + 1);
        } else
            *ret = NULL;
    }
    g_free (respbuf);

    return status;
}

/**
 * camel_pop3_command_get_additional_data: get "additional data" from
 * a POP3 command.
 * @store: the POP3 store
 *
 * This command gets the additional data returned by "multi-line" POP
 * commands, such as LIST, RETR, TOP, and UIDL. This command _must_
 * be called after a successful (CAMEL_POP3_OK) call to
 * camel_pop3_command for a command that has a multi-line response.
 * The returned data is un-byte-stuffed, and has lines termined by
 * newlines rather than CR/LF pairs.
 *
 * Return value: the data, which the caller must free.
 **/
char *
camel_pop3_command_get_additional_data (CamelPop3Store *store)
{
    CamelStreamBuffer *stream = CAMEL_STREAM_BUFFER (store->istream);
    GPtrArray *data;
    char *buf;
    int i, status = CAMEL_POP3_OK;

    data = g_ptr_array_new ();
    while (1) {
        buf = camel_stream_buffer_read_line (stream);
        if (!buf) {
            status = CAMEL_POP3_FAIL;
            break;
        }

        if (!strcmp (buf, "."))
            break;
        if (*buf == '.')
            memmove (buf, buf + 1, strlen (buf));
        g_ptr_array_add (data, buf);
    }

    if (status == CAMEL_POP3_OK) {
        /* Append an empty string to the end of the array
         * so when we g_strjoinv it, we get a "\n" after
         * the last real line.
         */
        g_ptr_array_add (data, "");
        g_ptr_array_add (data, NULL);
        buf = g_strjoinv ("\n", (char **)data->pdata);
    } else
        buf = NULL;

    for (i = 0; i < data->len - 2; i++)
        g_free (data->pdata[i]);
    g_ptr_array_free (data, TRUE);

    return buf;
}