aboutsummaryrefslogtreecommitdiffstats
path: root/camel/providers/imap/camel-imap-command.c
blob: db113e0fd77f57537b152f521a32bad542798d6e (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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* camel-imap-command.c: IMAP command sending/parsing routines */

/*
 *  Authors:
 *    Dan Winship <danw@ximian.com>
 *    Jeffrey Stedfast <fejj@ximian.com>
 *
 *  Copyright 2000, 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 Street #330, Boston, MA 02111-1307, USA.
 *
 */

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

#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>

#include "camel-imap-command.h"
#include "camel-imap-utils.h"
#include "camel-imap-folder.h"
#include "camel-imap-store.h"
#include "camel-imap-private.h"
#include <camel/camel-exception.h>

static char *imap_read_untagged (CamelImapStore *store, char *line,
                 CamelException *ex);
static CamelImapResponse *imap_read_response (CamelImapStore *store,
                          CamelException *ex);
static char *imap_command_strdup_vprintf (CamelImapStore *store,
                      const char *fmt, va_list ap);

/**
 * camel_imap_command: Send a command to a IMAP server and get a response
 * @store: the IMAP store
 * @folder: The folder to perform the operation in (or %NULL if not
 * relevant).
 * @ex: a CamelException
 * @fmt: an sort of printf-style format string, followed by arguments
 *
 * This function makes sure that @folder (if non-%NULL) is the
 * currently-selected folder on @store and then sends the IMAP command
 * specified by @fmt and the following arguments. It then reads the
 * server's response(s) and parses the final result.
 *
 * As a special case, if @fmt is %NULL, it will just select @folder
 * and return the response from doing so.
 * 
 * @fmt can include the following %-escapes ONLY:
 *  %s, %d, %%: as with printf
 *  %S: an IMAP "string" (quoted string or literal)
 *
 * %S strings will be passed as literals if the server supports LITERAL+
 * and quoted strings otherwise. (%S does not support strings that
 * contain newlines.)
 *
 * On success, the store's command_lock will be locked. It will be freed
 * when you call camel_imap_response_free. (The lock is recursive, so
 * callers can grab and release it themselves if they need to run
 * multiple commands atomically.)
 *
 * Return value: %NULL if an error occurred (in which case @ex will
 * be set). Otherwise, a CamelImapResponse describing the server's
 * response, which the caller must free with camel_imap_response_free().
 **/
CamelImapResponse *
camel_imap_command (CamelImapStore *store, CamelFolder *folder,
            CamelException *ex, const char *fmt, ...)
{
    gchar *cmdbuf;
    va_list ap;
    CamelException internal_ex;

    CAMEL_IMAP_STORE_LOCK (store, command_lock);

    /* Check for current folder */
    if (folder && (!fmt || folder != store->current_folder)) {
        CamelImapResponse *response;

        if (store->current_folder) {
            camel_object_unref (CAMEL_OBJECT (store->current_folder));
            store->current_folder = NULL;
        }
        response = camel_imap_command (store, NULL, ex, "SELECT %S",
                           folder->full_name);
        if (!response) {
            CAMEL_IMAP_STORE_UNLOCK (store, command_lock);
            return NULL;
        }
        store->current_folder = folder;
        camel_object_ref (CAMEL_OBJECT (folder));

        camel_imap_folder_selected (folder, response, ex);
        if (!fmt) {
            /* This undoes the level of locking we did,
             * but not the level of locking associated with
             * "response".
             */
            CAMEL_IMAP_STORE_UNLOCK (store, command_lock);
            return response;
        }

        /* Contrariwise, this undoes "response"s lock,
         * but not our own.
         */
        camel_imap_response_free (store, response);
    }

    /* Send the command */
    va_start (ap, fmt);
    cmdbuf = imap_command_strdup_vprintf (store, fmt, ap);
    va_end (ap);

    camel_exception_init (&internal_ex);
    camel_remote_store_send_string (CAMEL_REMOTE_STORE (store), &internal_ex,
                    "%c%.5d %s\r\n", store->tag_prefix,
                    store->command++, cmdbuf);
    g_free (cmdbuf);
    if (camel_exception_is_set (&internal_ex)) {
        camel_exception_xfer (ex, &internal_ex);
        CAMEL_IMAP_STORE_UNLOCK (store, command_lock);
        return NULL;
    }

    /* Read the response. */
    return imap_read_response (store, ex);
}

/**
 * camel_imap_command_continuation: Send more command data to the IMAP server
 * @store: the IMAP store
 * @ex: a CamelException
 * @cmdbuf: buffer containing the response/request data
 *
 * This method is for sending continuing responses to the IMAP server
 * after camel_imap_command returns a CAMEL_IMAP_PLUS response.
 * 
 * This function assumes you have an exclusive lock on the remote stream.
 *
 * Return value: as for camel_imap_command(). On failure, the store's
 * command_lock will be released.
 **/
CamelImapResponse *
camel_imap_command_continuation (CamelImapStore *store, CamelException *ex,
                 const char *cmdbuf)
{
    if (camel_remote_store_send_string (CAMEL_REMOTE_STORE (store), ex,
                        "%s\r\n", cmdbuf) < 0) {
        CAMEL_IMAP_STORE_UNLOCK (store, command_lock);
        return NULL;
    }

    return imap_read_response (store, ex);
}

/* Read the response to an IMAP command. */
static CamelImapResponse *
imap_read_response (CamelImapStore *store, CamelException *ex)
{
    CamelImapResponse *response;
    CamelException internal_ex;
    char *respbuf, *retcode;

    /* Read first line */
    if (camel_remote_store_recv_line (CAMEL_REMOTE_STORE (store),
                      &respbuf, ex) < 0) {
        CAMEL_IMAP_STORE_UNLOCK (store, command_lock);
        return NULL;
    }

    response = g_new0 (CamelImapResponse, 1);
    if (camel_disco_store_status (CAMEL_DISCO_STORE (store)) != CAMEL_DISCO_STORE_RESYNCING) {
        response->folder = store->current_folder;
        if (response->folder)
            camel_object_ref (CAMEL_OBJECT (response->folder));
    }
    response->untagged = g_ptr_array_new ();

    camel_exception_init (&internal_ex);

    /* Check for untagged data */
    while (!strncmp (respbuf, "* ", 2)) {
        /* Read the rest of the response if it is multi-line. */
        respbuf = imap_read_untagged (store, respbuf, &internal_ex);
        if (camel_exception_is_set (&internal_ex))
            break;

        if (!g_strncasecmp (respbuf, "* BYE", 5)) {
            /* Connection was lost, no more data to fetch */
            store->connected = FALSE;
            g_free (respbuf);
            respbuf = NULL;
            break;
        }

        g_ptr_array_add (response->untagged, respbuf);
        if (camel_remote_store_recv_line (
            CAMEL_REMOTE_STORE (store), &respbuf, ex) < 0)
            break;
    }

    if (!respbuf || camel_exception_is_set (&internal_ex)) {
        camel_exception_xfer (ex, &internal_ex);
        camel_imap_response_free_without_processing (store, response);
        return NULL;
    }

    response->status = respbuf;

    /* Check for OK or continuation response. */
    if (*respbuf == '+')
        return response;
    retcode = imap_next_word (respbuf);
    if (!strncmp (retcode, "OK", 2))
        return response;

    /* We should never get BAD, or anything else but +, OK, or NO
     * for that matter.
     */
    if (strncmp (retcode, "NO", 2) != 0) {
        g_warning ("Unexpected response from IMAP server: %s",
               respbuf);
        camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                      _("Unexpected response from IMAP "
                    "server: %s"), respbuf);
        camel_imap_response_free_without_processing (store, response);
        return NULL;
    }

    retcode = imap_next_word (retcode);
    camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                  _("IMAP command failed: %s"),
                  retcode ? retcode : _("Unknown error"));
    camel_imap_response_free_without_processing (store, response);
    return NULL;
}

/* Given a line that is the start of an untagged response, read and
 * return the complete response, which may include an arbitrary number
 * of literals.
 */
static char *
imap_read_untagged (CamelImapStore *store, char *line, CamelException *ex)
{
    int fulllen, length, ldigits, nread, i;
    GPtrArray *data;
    GString *str;
    char *end, *p, *s, *d;

    p = strrchr (line, '{');
    if (!p)
        return line;

    data = g_ptr_array_new ();
    fulllen = 0;

    while (1) {
        str = g_string_new (line);
        g_free (line);
        fulllen += str->len;
        g_ptr_array_add (data, str);

        p = strrchr (str->str, '{');
        if (!p)
            break;

        length = strtoul (p + 1, &end, 10);
        if (*end != '}' || *(end + 1) || end == p + 1)
            break;
        ldigits = end - (p + 1);

        /* Read the literal */
        str = g_string_sized_new (length + 2);
        str->str[0] = '\n';
        nread = camel_stream_read (CAMEL_REMOTE_STORE (store)->istream,
                       str->str + 1, length);
        if (nread == -1) {
            if (errno == EINTR)
                camel_exception_set (ex, CAMEL_EXCEPTION_USER_CANCEL, _("Operation cancelled"));
            else
                camel_exception_set (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE, strerror(errno));
            camel_service_disconnect (CAMEL_SERVICE (store), FALSE, NULL);
            goto lose;
        }
        if (nread < length) {
            camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                          _("Server response ended too soon."));
            camel_service_disconnect (CAMEL_SERVICE (store),
                          FALSE, NULL);
            goto lose;
        }
        str->str[length + 1] = '\0';

        /* Fix up the literal, turning CRLFs into LF. Also, if
         * we find any embedded NULs, strip them. This is
         * dubious, but:
         *   - The IMAP grammar says you can't have NULs here
         *     anyway, so this will not affect our behavior
         *     against any completely correct server.
         *   - WU-imapd 12.264 (at least) will cheerily pass
         *     NULs along if they are embedded in the message
         *   - The only cause of embedded NULs we've seen is an
         *     Evolution base64-encoder bug that sometimes
         *     inserts a NUL into the last line when it
         *     shouldn't.
         */

        s = d = str->str + 1;
        end = str->str + 1 + length;
        while (s < end) {
            while (s < end && *s == '\0') {
                s++;
                length--;
            }
            if (*s == '\r' && *(s + 1) == '\n') {
                s++;
                length--;
            }
            *d++ = *s++;
        }
        *d = '\0';
        str->len = length + 1;

        /* p points to the "{" in the line that starts the
         * literal. The length of the CR-less response must be
         * less than or equal to the length of the response
         * with CRs, therefore overwriting the old value with
         * the new value cannot cause an overrun. However, we
         * don't want it to be shorter either, because then the
         * GString's length would be off...
         */
        sprintf (p, "{%0*d}", ldigits, length);

        fulllen += str->len;
        g_ptr_array_add (data, str);

        /* Read the next line. */
        if (camel_remote_store_recv_line (CAMEL_REMOTE_STORE (store),
                          &line, ex) < 0)
            goto lose;
    }

    /* Now reassemble the data. */
    p = line = g_malloc (fulllen + 1);
    for (i = 0; i < data->len; i++) {
        str = data->pdata[i];
        memcpy (p, str->str, str->len);
        p += str->len;
        g_string_free (str, TRUE);
    }
    *p = '\0';
    g_ptr_array_free (data, TRUE);
    return line;

 lose:
    for (i = 0; i < data->len; i++)
        g_string_free (data->pdata[i], TRUE);
    g_ptr_array_free (data, TRUE);
    return NULL;
}


/**
 * camel_imap_response_free:
 * @store: the CamelImapStore the response is from
 * @response: a CamelImapResponse
 *
 * Frees all of the data in @response and processes any untagged
 * EXPUNGE and EXISTS responses in it. Releases @store's command_lock.
 **/
void
camel_imap_response_free (CamelImapStore *store, CamelImapResponse *response)
{
    int i, number, exists = 0;
    GArray *expunged = NULL;
    char *resp, *p;

    if (!response)
        return;

    for (i = 0; i < response->untagged->len; i++) {
        resp = response->untagged->pdata[i];

        if (response->folder) {
            /* Check if it's something we need to handle. */
            number = strtoul (resp + 2, &p, 10);
            if (!g_strcasecmp (p, " EXISTS")) {
                exists = number;
            } else if (!g_strcasecmp (p, " EXPUNGE")) {
                if (!expunged) {
                    expunged = g_array_new (FALSE, FALSE,
                                sizeof (int));
                }
                g_array_append_val (expunged, number);

                /* camel_imap_folder_changed expects
                 * "exists" to be the value after all
                 * expunges.
                 */
                if (exists)
                    exists--;
            }
        }
        g_free (resp);
    }

    g_ptr_array_free (response->untagged, TRUE);
    g_free (response->status);

    if (response->folder) {
        if (exists > 0 || expunged) {
            /* Update the summary */
            CamelException ex;
            
            camel_exception_init (&ex);
            camel_imap_folder_changed (response->folder, exists, expunged, &ex);
            camel_exception_clear (&ex);
            
            if (expunged)
                g_array_free (expunged, TRUE);
        }

        camel_object_unref (CAMEL_OBJECT (response->folder));
    }

    g_free (response);
    CAMEL_IMAP_STORE_UNLOCK (store, command_lock);
}

/**
 * camel_imap_response_free_without_processing:
 * @store: the CamelImapStore the response is from.
 * @response: a CamelImapResponse:
 *
 * Frees all of the data in @response without processing any untagged
 * responses. Releases @store's command lock.
 **/
void
camel_imap_response_free_without_processing (CamelImapStore *store,
                         CamelImapResponse *response)
{
    if (response->folder) {
        camel_object_unref (CAMEL_OBJECT (response->folder));
        response->folder = NULL;
    }
    camel_imap_response_free (store, response);
}

/**
 * camel_imap_response_extract:
 * @store: the store the response came from
 * @response: the response data returned from camel_imap_command
 * @type: the response type to extract
 * @ex: a CamelException
 *
 * This checks that @response contains a single untagged response of
 * type @type and returns just that response data. If @response
 * doesn't contain the right information, the function will set @ex
 * and return %NULL. Either way, @response will be freed and the
 * store's command_lock released.
 *
 * Return value: the desired response string, which the caller must free.
 **/
char *
camel_imap_response_extract (CamelImapStore *store,
                 CamelImapResponse *response,
                 const char *type,
                 CamelException *ex)
{
    int len = strlen (type), i;
    char *resp;

    for (i = 0; i < response->untagged->len; i++) {
        resp = response->untagged->pdata[i];
        /* Skip "* ", and initial sequence number, if present */
        strtoul (resp + 2, &resp, 10);
        if (*resp == ' ')
            resp = imap_next_word (resp);

        if (!g_strncasecmp (resp, type, len))
            break;
    }

    if (i < response->untagged->len) {
        resp = response->untagged->pdata[i];
        g_ptr_array_remove_index (response->untagged, i);
    } else {
        resp = NULL;
        camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                      _("IMAP server response did not contain "
                    "%s information"), type);
    }

    camel_imap_response_free (store, response);
    return resp;
}

/**
 * camel_imap_response_extract_continuation:
 * @store: the store the response came from
 * @response: the response data returned from camel_imap_command
 * @ex: a CamelException
 *
 * This checks that @response contains a continuation response, and
 * returns just that data. If @response doesn't contain a continuation
 * response, the function will set @ex, release @store's command_lock,
 * and return %NULL. Either way, @response will be freed.
 *
 * Return value: the desired response string, which the caller must free.
 **/
char *
camel_imap_response_extract_continuation (CamelImapStore *store,
                      CamelImapResponse *response,
                      CamelException *ex)
{
    char *status;

    if (response->status && *response->status == '+') {
        status = response->status;
        response->status = NULL;
        CAMEL_IMAP_STORE_LOCK (store, command_lock);
        camel_imap_response_free (store, response);
        return status;
    }

    camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_UNAVAILABLE,
                  _("Unexpected OK response from IMAP server: %s"),
                  response->status);
    camel_imap_response_free (store, response);
    return NULL;
}


static char *
imap_command_strdup_vprintf (CamelImapStore *store, const char *fmt,
                 va_list ap)
{
    GPtrArray *args;
    const char *p, *start;
    char *out, *op, *string;
    int num, len, i;

    args = g_ptr_array_new ();

    /* Determine the length of the data */
    len = strlen (fmt);
    p = start = fmt;
    while (*p) {
        p = strchr (start, '%');
        if (!p)
            break;

        switch (*++p) {
        case 'd':
            num = va_arg (ap, int);
            g_ptr_array_add (args, GINT_TO_POINTER (num));
            start = p + 1;
            len += 10;
            break;

        case 's':
            string = va_arg (ap, char *);
            g_ptr_array_add (args, string);
            start = p + 1;
            len += strlen (string);
            break;

        case 'S':
            string = va_arg (ap, char *);
            g_ptr_array_add (args, string);
            if (store->capabilities & IMAP_CAPABILITY_LITERALPLUS)
                len += strlen (string) + 15;
            else
                len += strlen (string) * 2;
            start = p + 1;
            break;

        case '%':
            start = p;
            break;

        default:
            g_warning ("camel-imap-command is not printf. I don't "
                   "know what '%%%c' means.", *p);
            start = *p ? p + 1 : p;
            break;
        }
    }

    /* Now write out the string */
    op = out = g_malloc (len + 1);
    p = start = fmt;
    i = 0;
    while (*p) {
        p = strchr (start, '%');
        if (!p) {
            strcpy (op, start);
            break;
        } else {
            strncpy (op, start, p - start);
            op += p - start;
        }

        switch (*++p) {
        case 'd':
            num = GPOINTER_TO_INT (args->pdata[i++]);
            op += sprintf (op, "%d", num);
            break;

        case 's':
            string = args->pdata[i++];
            op += sprintf (op, "%s", string);
            break;

        case 'S':
            string = args->pdata[i++];
            if (store->capabilities & IMAP_CAPABILITY_LITERALPLUS) {
                op += sprintf (op, "{%d+}\r\n%s",
                           strlen (string), string);
            } else {
                char *quoted = imap_quote_string (string);
                op += sprintf (op, "%s", quoted);
                g_free (quoted);
            }
            break;

        default:
            *op++ = '%';
            *op++ = *p;
        }

        start = *p ? p + 1 : p;
    }

    return out;
}