folder.c
65.1 KB
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
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
/* GNU Mailutils -- a suite of utilities for electronic mail
Copyright (C) 1999, 2000, 2001, 2003, 2004,
2005, 2006, 2007 Free Software Foundation, Inc.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General
Public License along with this library; if not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301 USA */
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#ifdef ENABLE_IMAP
#include <stdlib.h>
#include <ctype.h>
#include <stdarg.h>
#include <errno.h>
#include <string.h>
#include <assert.h>
#include <fnmatch.h>
#ifdef HAVE_STRINGS_H
# include <strings.h>
#endif
#include <imap0.h>
#include <url0.h>
#include <mailutils/auth.h>
#include <mailutils/attribute.h>
#include <mailutils/debug.h>
#include <mailutils/error.h>
#include <mailutils/errno.h>
#include <mailutils/header.h>
#include <mailutils/observer.h>
#include <mailutils/stream.h>
#include <mailutils/iterator.h>
#include <mailutils/argcv.h>
#include <mailutils/tls.h>
#include <mailutils/nls.h>
#include <mu_umaxtostr.h>
/* For dbg purposes set to one to see different level of traffic. */
/* Print to stderr the command sent to the IMAP server. */
#define DEBUG_SHOW_COMMAND 0
/* Print to stderr the responses received from the IMAP server. */
#define DEBUG_SHOW_RESPONSE 0
/* Print to stderr the literal/quoted string received from the IMAP server. */
#define DEBUG_SHOW_DATA 0
/* Variable use for the registrar. */
static struct _mu_record _imap_record =
{
MU_IMAP_PRIO,
MU_IMAP_SCHEME,
_url_imap_init, /* url entry. */
_mailbox_imap_init, /* Mailbox entry. */
NULL, /* Mailer entry. */
_folder_imap_init, /* Folder entry. */
NULL, /* No need for a back pointer. */
NULL, /* _is_scheme method. */
NULL, /* _get_url method. */
NULL, /* _get_mailbox method. */
NULL, /* _get_mailer method. */
NULL /* _get_folder method. */
};
/* We export this variable: url parsing and the initialisation of the mailbox,
via the register entry/record. */
mu_record_t mu_imap_record = &_imap_record;
#ifdef WITH_TLS
static struct _mu_record _imaps_record =
{
MU_IMAP_PRIO,
MU_IMAPS_SCHEME,
_url_imaps_init, /* url entry. */
_mailbox_imaps_init, /* Mailbox entry. */
NULL, /* Mailer entry. */
_folder_imap_init, /* Folder entry. */
NULL, /* No need for a back pointer. */
NULL, /* _is_scheme method. */
NULL, /* _get_url method. */
NULL, /* _get_mailbox method. */
NULL, /* _get_mailer method. */
NULL /* _get_folder method. */
};
mu_record_t mu_imaps_record = &_imaps_record;
#else
mu_record_t mu_imaps_record = NULL;
#endif /* WITH_TLS */
#ifndef HAVE_STRTOK_R
char *strtok_r (char *, const char *, char **);
#endif
/* Concrete mu_folder_t IMAP implementation. */
static int folder_imap_open (mu_folder_t, int);
static int folder_imap_close (mu_folder_t);
static void folder_imap_destroy (mu_folder_t);
static int folder_imap_delete (mu_folder_t, const char *);
static int folder_imap_list (mu_folder_t, const char *, const char *,
size_t,
mu_list_t);
static int folder_imap_lsub (mu_folder_t, const char *, const char *,
mu_list_t);
static int folder_imap_rename (mu_folder_t, const char *,
const char *);
static int folder_imap_subscribe (mu_folder_t, const char *);
static int folder_imap_unsubscribe (mu_folder_t, const char *);
static int folder_imap_get_authority (mu_folder_t, mu_authority_t *);
/* FETCH */
static int imap_fetch (f_imap_t);
static int imap_rfc822 (f_imap_t, char **);
static int imap_rfc822_size (f_imap_t, char **);
static int imap_rfc822_header (f_imap_t, char **);
static int imap_rfc822_text (f_imap_t, char **);
static int imap_fetch_flags (f_imap_t, char **);
static int imap_permanentflags (f_imap_t, char **);
static int imap_flags (char **, int *);
static int imap_bodystructure (f_imap_t, char **);
static int imap_body (f_imap_t, char **);
static int imap_internaldate (f_imap_t, char **);
static int imap_uid (f_imap_t, char **);
static int imap_status (f_imap_t);
static int imap_expunge (f_imap_t, unsigned int);
static int imap_search (f_imap_t);
/* String. */
static int imap_literal_string (f_imap_t, char **);
static int imap_string (f_imap_t, char **);
static int imap_quoted_string (f_imap_t, char **);
static int imap_mailbox_name_match (const char* pattern, const char* mailbox);
static int imap_token (char *, size_t, char **);
/* Capability */
static int parse_capa (f_imap_t f_imap, char *str);
static int read_capa (f_imap_t f_imap, int force);
static int check_capa (f_imap_t f_imap, char *capa);
/* Authentication methods */
typedef int (*auth_method_t) (mu_authority_t);
/* Simple User/pass authentication for imap. */
static int
authenticate_imap_login (mu_authority_t auth)
{
mu_folder_t folder = mu_authority_get_owner (auth);
f_imap_t f_imap = folder->data;
mu_ticket_t ticket;
int status = 0;
if (check_capa (f_imap, "LOGINDISABLED") == 0)
{
MU_DEBUG (folder->debug, MU_DEBUG_TRACE, "LOGIN command disabled\n");
return ENOSYS;
}
switch (f_imap->state)
{
case IMAP_AUTH:
{
/* Grab the User and Passwd information. */
mu_authority_get_ticket (auth, &ticket);
if (f_imap->user)
free (f_imap->user);
if (f_imap->passwd)
free (f_imap->passwd);
/* Was it in the URL? */
status = mu_url_aget_user (folder->url, &f_imap->user);
if (status == MU_ERR_NOENT)
mu_ticket_pop (ticket, folder->url, "Imap User: ", &f_imap->user);
else if (status)
return status;
status = mu_url_aget_passwd (folder->url, &f_imap->passwd);
if (status == MU_ERR_NOENT)
mu_ticket_pop (ticket, folder->url, "Imap Passwd: ",
&f_imap->passwd);
else if (status)
return status;
if (f_imap->user == NULL)
return MU_ERR_NOUSERNAME;
if (f_imap->passwd == NULL)
return MU_ERR_NOPASSWORD;
status = imap_writeline (f_imap, "g%u LOGIN \"%s\" \"%s\"\r\n",
f_imap->seq, f_imap->user, f_imap->passwd);
CHECK_ERROR_CLOSE (folder, f_imap, status);
MU_DEBUG2 (folder->debug, MU_DEBUG_TRACE, "g%u LOGIN %s *\n",
f_imap->seq, f_imap->user);
f_imap->seq++;
free (f_imap->user);
f_imap->user = NULL;
/* We have to nuke the passwd. */
memset (f_imap->passwd, '\0', strlen (f_imap->passwd));
free (f_imap->passwd);
f_imap->passwd = NULL;
f_imap->state = IMAP_LOGIN;
}
case IMAP_LOGIN:
/* Send it across. */
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
/* Clear the buffer it contains the passwd. */
memset (f_imap->buffer, '\0', f_imap->buflen);
f_imap->state = IMAP_LOGIN_ACK;
case IMAP_LOGIN_ACK:
/* Get the login ack. */
status = imap_parse (f_imap);
if (status)
return status;
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_AUTH_DONE;
default:
break; /* We're outta here. */
}
CLEAR_STATE (f_imap);
return 0;
}
/*
The anonymous SASL mechanism is defined in rfc2245.txt as a single
message from client to server:
message = [email / token]
So the message is optional.
The command is:
C: <tag> authenticate anonymous
The server responds with a request for continuation data (the "message"
in the SASL syntax). We respond with no data, which is legal.
S: +
C:
The server should then respond with OK on success, or else a failure
code (NO or BAD).
If OK, then we are authenticated!
So, states are:
AUTH_ANON_REQ
> g%u AUTHENTICATE ANONYMOUS
AUTH_ANON_WAIT_CONT
< +
AUTH_ANON_MSG
>
AUTH_ANON_WAIT_RESP
< NO/BAD/OK
*/
static int
authenticate_imap_sasl_anon (mu_authority_t auth)
{
mu_folder_t folder = mu_authority_get_owner (auth);
f_imap_t f_imap = folder->data;
int status = 0;
assert (f_imap->state == IMAP_AUTH);
if (check_capa (f_imap, "AUTH=ANONYMOUS"))
{
MU_DEBUG (folder->debug, MU_DEBUG_PROT,
"ANONYMOUS capability not present\n");
return ENOSYS;
}
/* FIXME: auth_state is never set explicitely before this function */
switch (f_imap->auth_state)
{
case IMAP_AUTH_ANON_REQ_WRITE:
{
MU_DEBUG1 (folder->debug, MU_DEBUG_PROT,
"g%u AUTHENTICATE ANONYMOUS\n",
f_imap->seq);
status = imap_writeline (f_imap, "g%u AUTHENTICATE ANONYMOUS\r\n",
f_imap->seq);
f_imap->seq++;
CHECK_ERROR_CLOSE (folder, f_imap, status);
f_imap->auth_state = IMAP_AUTH_ANON_REQ_SEND;
}
case IMAP_AUTH_ANON_REQ_SEND:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->auth_state = IMAP_AUTH_ANON_WAIT_CONT;
case IMAP_AUTH_ANON_WAIT_CONT:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
if (strncmp ("+", f_imap->buffer, 2) == 0)
{
f_imap->auth_state = IMAP_AUTH_ANON_MSG;
}
else
{
/* Something is wrong! */
}
f_imap->auth_state = IMAP_AUTH_ANON_MSG;
case IMAP_AUTH_ANON_MSG:
MU_DEBUG (folder->debug, MU_DEBUG_PROT, "\n");
status = imap_writeline (f_imap, "\r\n");
CHECK_ERROR_CLOSE (folder, f_imap, status);
f_imap->auth_state = IMAP_AUTH_ANON_MSG_SEND;
case IMAP_AUTH_ANON_MSG_SEND:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->auth_state = IMAP_AUTH_ANON_WAIT_RESP;
case IMAP_AUTH_ANON_WAIT_RESP:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break; /* We're outta here. */
}
CLEAR_STATE (f_imap);
return 0;
}
struct auth_tab
{
char *name;
auth_method_t method;
};
/* NOTE: The ordering of methods in this table is from most secure
to less secure. */
static struct auth_tab auth_tab[] = {
{ "login", authenticate_imap_login },
{ "anon", authenticate_imap_sasl_anon },
{ NULL }
};
static auth_method_t
find_auth_method (const char *name)
{
struct auth_tab *p;
for (p = auth_tab; p->name; p++)
if (strcasecmp (p->name, name) == 0)
return p->method;
return NULL;
}
static int
authenticate_imap_select (mu_authority_t auth)
{
mu_folder_t folder = mu_authority_get_owner (auth);
f_imap_t f_imap = folder->data;
struct auth_tab *p;
int status = ENOSYS;
for (p = auth_tab; status == ENOSYS && p->name; p++)
{
f_imap->state = IMAP_AUTH;
status = p->method (auth);
}
return status;
}
/* Initialize the concrete IMAP mailbox: overload the folder functions */
int
_folder_imap_init (mu_folder_t folder)
{
int status;
f_imap_t f_imap;
/* Set the authority early:
(1) so we can check for errors.
(2) allow the client to get the authority for setting the ticket
before the open. */
status = folder_imap_get_authority (folder, NULL);
if (status != 0)
return status;
f_imap = folder->data = calloc (1, sizeof (*f_imap));
if (f_imap == NULL)
return ENOMEM;
f_imap->folder = folder;
f_imap->state = IMAP_NO_STATE;
folder->_destroy = folder_imap_destroy;
folder->_open = folder_imap_open;
folder->_close = folder_imap_close;
folder->_list = folder_imap_list;
folder->_lsub = folder_imap_lsub;
folder->_subscribe = folder_imap_subscribe;
folder->_unsubscribe = folder_imap_unsubscribe;
folder->_delete = folder_imap_delete;
folder->_rename = folder_imap_rename;
return 0;
}
/* Destroy the folder resources. */
static void
folder_imap_destroy (mu_folder_t folder)
{
if (folder->data)
{
f_imap_t f_imap = folder->data;
if (f_imap->buffer)
free (f_imap->buffer);
if (f_imap->capav)
mu_argcv_free (f_imap->capac, f_imap->capav);
free (f_imap);
folder->data = NULL;
}
}
static int
folder_set_auth_method (mu_folder_t folder, auth_method_t method)
{
if (!folder->authority)
{
int status = mu_authority_create (&folder->authority, NULL, folder);
if (status)
return status;
}
return mu_authority_set_authenticate (folder->authority, method, folder);
}
static int
folder_imap_get_authority (mu_folder_t folder, mu_authority_t *pauth)
{
int status = 0;
if (folder->authority == NULL)
{
/* assert (folder->url); */
if (folder->url == NULL)
return EINVAL;
if (folder->url->auth == NULL
|| strcasecmp (folder->url->auth, "*") == 0)
{
status = folder_set_auth_method (folder, authenticate_imap_select);
}
else
{
char *p, *sp;
for (p = strtok_r (folder->url->auth, ",", &sp);
status == 0 && p;
p = strtok_r (NULL, ",", &sp))
{
auth_method_t method = find_auth_method (p);
if (method)
status = folder_set_auth_method (folder, method);
else
status = MU_ERR_BAD_AUTH_SCHEME;
}
}
}
if (status)
return status;
if (pauth)
*pauth = folder->authority;
return status;
}
/* Capability handling */
static int
parse_capa (f_imap_t f_imap, char *str)
{
if (f_imap->capav)
mu_argcv_free (f_imap->capac, f_imap->capav);
return mu_argcv_get (str, "", NULL, &f_imap->capac, &f_imap->capav);
}
static int
read_capa (f_imap_t f_imap, int force)
{
int status = 0;
if (force)
{
mu_argcv_free (f_imap->capac, f_imap->capav);
f_imap->capac = 0;
f_imap->capav = NULL;
}
if (!f_imap->capav)
{
status = imap_writeline (f_imap, "g%u CAPABILITY\r\n",
f_imap->seq++);
status = imap_send (f_imap);
status = imap_parse (f_imap);
}
return status;
}
static int
check_capa (f_imap_t f_imap, char *capa)
{
int i;
read_capa (f_imap, 0);
for (i = 0; i < f_imap->capac; i++)
if (strcasecmp (f_imap->capav[i], capa) == 0)
return 0;
return 1;
}
static int
imap_reader (void *iodata)
{
f_imap_t iop = iodata;
int status = imap_parse (iop);
CHECK_EAGAIN (iop, status);
MU_DEBUG (iop->folder->debug, MU_DEBUG_PROT, iop->buffer);
return status;
}
static int
imap_writer (void *iodata, char *buf)
{
f_imap_t iop = iodata;
MU_DEBUG2 (iop->folder->debug, MU_DEBUG_PROT, "g%s %s\n",
mu_umaxtostr (0, iop->seq), buf);
int status = imap_writeline (iop, "g%s %s\r\n",
mu_umaxtostr (0, iop->seq++), buf);
CHECK_ERROR (iop, status);
status = imap_send (iop);
CHECK_ERROR (iop, status);
return status;
}
static void
imap_stream_ctl (void *iodata, mu_stream_t *pold, mu_stream_t new)
{
f_imap_t iop = iodata;
if (pold)
*pold = iop->folder->stream;
if (new)
iop->folder->stream = new;
}
static int
tls (mu_folder_t folder)
{
#ifdef WITH_TLS
int status;
f_imap_t f_imap = folder->data;
char *keywords[] = { "STARTTLS", "CAPABILITY", NULL };
if (!mu_tls_enable || check_capa (f_imap, "STARTTLS"))
return -1;
status = mu_tls_begin (f_imap, imap_reader, imap_writer,
imap_stream_ctl, keywords);
MU_DEBUG1 (folder->debug, MU_DEBUG_PROT, "TLS negotiation %s\n",
status == 0 ? "succeeded" : "failed");
return status;
#else
return -1;
#endif /* WITH_TLS */
}
/* Create/Open the stream for IMAP. */
static int
folder_imap_open (mu_folder_t folder, int flags)
{
f_imap_t f_imap = folder->data;
const char *host;
long port = f_imap->imaps ? MU_IMAPS_PORT : MU_IMAP_PORT;
int status = 0;
/* If we are already open for business, noop. */
mu_monitor_wrlock (folder->monitor);
if (f_imap->isopen)
{
mu_monitor_unlock (folder->monitor);
return 0;
}
mu_monitor_unlock (folder->monitor);
/* Fetch the server name and the port in the mu_url_t. */
status = mu_url_sget_host (folder->url, &host);
if (status != 0)
return status;
mu_url_get_port (folder->url, &port);
folder->flags = flags;
switch (f_imap->state)
{
case IMAP_NO_STATE:
/* allocate working io buffer. */
if (f_imap->buffer == NULL)
{
/* There is no particular limit on the length of a command/response
in IMAP. We start with 255, which is quite reasonnable and grow
as we go along. */
f_imap->buflen = 255;
f_imap->buffer = calloc (f_imap->buflen + 1, 1);
if (f_imap->buffer == NULL)
{
CHECK_ERROR (f_imap, ENOMEM);
}
status = mu_memory_stream_create (&f_imap->string.stream, NULL, MU_STREAM_RDWR);
CHECK_ERROR (f_imap, status);
mu_stream_open (f_imap->string.stream);
}
else
{
/* Clear from any residue. */
memset (f_imap->buffer, '\0', f_imap->buflen);
mu_stream_truncate (f_imap->string.stream, 0);
f_imap->string.offset = 0;
f_imap->string.nleft = 0;
}
f_imap->ptr = f_imap->buffer;
/* Create the networking stack. */
if (folder->stream == NULL)
{
status = mu_tcp_stream_create (&folder->stream, host, port, folder->flags);
CHECK_ERROR (f_imap, status);
#ifdef WITH_TLS
if (f_imap->imaps)
{
mu_stream_t newstr;
status = mu_stream_open (folder->stream);
CHECK_EAGAIN (f_imap, status);
CHECK_ERROR_CLOSE (folder, f_imap, status);
status = mu_tls_stream_create_client_from_tcp (&newstr, folder->stream, 0);
if (status != 0)
{
mu_error ("folder_imap_open: mu_tls_stream_create_client_from_tcp: %s",
mu_strerror (status));
return status;
}
folder->stream = newstr;
}
#endif /* WITH_TLS */
/* Ask for the stream internal buffering mechanism scheme. */
mu_stream_setbufsiz (folder->stream, BUFSIZ);
}
else
mu_stream_close (folder->stream);
MU_DEBUG2 (folder->debug, MU_DEBUG_PROT, "imap_open (%s:%ld)\n",
host, port);
f_imap->state = IMAP_OPEN_CONNECTION;
case IMAP_OPEN_CONNECTION:
/* Establish the connection. */
status = mu_stream_open (folder->stream);
CHECK_EAGAIN (f_imap, status);
/* Can't recover bailout. */
CHECK_ERROR_CLOSE (folder, f_imap, status);
f_imap->state = IMAP_GREETINGS;
case IMAP_GREETINGS:
{
/* Swallow the greetings. */
status = imap_readline (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->ptr = f_imap->buffer;
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
/* Are they open for business ? The server send an untagged response
for greeting. Tecnically it can be OK/PREAUTH/BYE. The BYE is
the one that we do not want, server being unfriendly. */
if (strncasecmp (f_imap->buffer, "* PREAUTH", 9) == 0)
{
f_imap->state = IMAP_AUTH_DONE;
}
else
{
if (strncasecmp (f_imap->buffer, "* OK", 4) != 0)
CHECK_ERROR_CLOSE (folder, f_imap, EACCES);
f_imap->state = IMAP_AUTH;
}
}
if (!f_imap->imaps)
tls (folder);
case IMAP_AUTH:
case IMAP_LOGIN:
case IMAP_LOGIN_ACK:
assert (folder->authority);
{
status = mu_authority_authenticate (folder->authority);
if (status)
{
/* Fake folder_imap_close into closing the folder.
FIXME: The entire state machine should probably
be revised... */
f_imap->isopen++;
f_imap->state = IMAP_NO_STATE;
folder_imap_close (folder);
return status;
}
}
case IMAP_AUTH_DONE:
default:
break;
}
f_imap->state = IMAP_NO_STATE;
mu_monitor_wrlock (folder->monitor);
f_imap->isopen++;
mu_monitor_unlock (folder->monitor);
return 0;
}
/* Shutdown the connection. */
static int
folder_imap_close (mu_folder_t folder)
{
f_imap_t f_imap = folder->data;
int status = 0;
mu_monitor_wrlock (folder->monitor);
f_imap->isopen--;
if (f_imap->isopen)
{
mu_monitor_unlock (folder->monitor);
return 0;
}
mu_monitor_unlock (folder->monitor);
switch (f_imap->state)
{
case IMAP_NO_STATE:
status = imap_writeline (f_imap, "g%u LOGOUT\r\n", f_imap->seq++);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_LOGOUT;
case IMAP_LOGOUT:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_LOGOUT_ACK;
case IMAP_LOGOUT_ACK:
/* Check for "* Bye" from the imap server. */
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
/* This is done when we received the BYE in the parser code. */
/* mu_stream_close (folder->stream); */
/* f_imap->isopen = 0 ; */
default:
break;
}
f_imap->state = IMAP_NO_STATE;
f_imap->selected = NULL;
return 0;
}
/* Remove a mailbox. */
static int
folder_imap_delete (mu_folder_t folder, const char *name)
{
f_imap_t f_imap = folder->data;
int status = 0;
if (name == NULL)
return EINVAL;
status = mu_folder_open (folder, folder->flags);
if (status != 0)
return status;
switch (f_imap->state)
{
case IMAP_NO_STATE:
status = imap_writeline (f_imap, "g%u DELETE %s\r\n", f_imap->seq++,
name);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_DELETE;
case IMAP_DELETE:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_DELETE_ACK;
case IMAP_DELETE_ACK:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break;
}
f_imap->state = IMAP_NO_STATE;
return status;
}
void
guess_level (struct mu_list_response *resp, size_t prefix_len)
{
size_t lev = 0;
if (!resp->separator)
lev = 0;
else
{
char *p = resp->name + prefix_len;
if (p[0] == resp->separator)
for ( ; p; p = strchr (p + 1, resp->separator))
lev++;
}
resp->level = lev;
}
/* Moves all matching items from list DST to SRC.
Items are moved verbatim (i.e. pointers are moved). Non-matching
items are deleted. After calling this function, SRC must be
destroyed.
While moving, this function also computes the recursion level.
Matching is determined based on PATTERN, by NAMECMP function,
and MAX_LEVEL. Both can be zero. */
static void
list_copy (mu_list_t dst, mu_list_t src,
size_t prefix_len,
int (*namecmp) (const char* pattern, const char* mailbox),
const char *pattern, size_t max_level)
{
mu_iterator_t itr;
if (!src)
return;
mu_list_get_iterator (src, &itr);
for (mu_iterator_first (itr); !mu_iterator_is_done (itr);
mu_iterator_next (itr))
{
char *name;
struct mu_list_response *p;
mu_iterator_current (itr, (void **)&p);
guess_level (p, prefix_len);
name = p->name + prefix_len;
if (name[0] == p->separator && pattern[0] != p->separator)
name++;
if ((max_level == 0 || p->level <= max_level)
&& (!namecmp || namecmp (pattern, name) == 0))
mu_list_append (dst, p);
else
free (p);
}
mu_iterator_destroy (&itr);
mu_list_set_destroy_item (src, NULL);
}
/* Convert glob(3)-style pattern to IMAP one
Rules:
Wildcard Replace with
-------- ------------
* * for recursive searches, % otherwise
? %
[..] %
NOTE:
1. The '*' can be made more selective by taking into account the
required maximum recursion level and counting directory separators
('/') in the input pattern.
2. The resulting pattern matches, in general, a wider set of strings, so
each matched string should be additionally compared against the
original pattern.
*/
char *
glob_to_imap (const char *pat, int recursive)
{
char *p, *q;
char *ret = strdup (pat);
if (!ret)
return NULL;
for (p = q = ret; *q; )
{
switch (*q)
{
case '?':
*p++ = '%';
q++;
break;
case '*':
*p++ = recursive ? '*' : '%';
q++;
break;
case '[':
for (; *q; q++)
if (*q == '\\')
q++;
else if (*q == ']')
{
q++;
break;
}
*p++ = '%';
break;
case '\\':
q++;
if (*q)
*p++ = *q++;
break;
default:
*p++ = *q++;
break;
}
}
*p = 0;
return ret;
}
static int
folder_imap_list (mu_folder_t folder, const char *ref, const char *name,
size_t max_level,
mu_list_t flist)
{
f_imap_t f_imap = folder->data;
int status = 0;
char *path = NULL;
status = mu_folder_open (folder, folder->flags);
if (status != 0)
return status;
if (ref == NULL)
ref = "";
if (name == NULL)
name = "";
switch (f_imap->state)
{
case IMAP_NO_STATE:
path = glob_to_imap (name, max_level != 1);
status = imap_writeline (f_imap, "g%u LIST \"%s\" \"%s\"\r\n",
f_imap->seq++, ref, path);
free (path);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_LIST;
case IMAP_LIST:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_LIST_ACK;
case IMAP_LIST_ACK:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break;
}
list_copy (flist, f_imap->flist, strlen (ref),
imap_mailbox_name_match, name, max_level);
mu_list_destroy (&f_imap->flist);
f_imap->state = IMAP_NO_STATE;
return status;
}
static int
folder_imap_lsub (mu_folder_t folder, const char *ref, const char *name,
mu_list_t flist)
{
f_imap_t f_imap = folder->data;
int status = 0;
status = mu_folder_open (folder, folder->flags);
if (status != 0)
return status;
if (ref == NULL)
ref = "";
if (name == NULL)
name = "";
switch (f_imap->state)
{
case IMAP_NO_STATE:
status = imap_writeline (f_imap, "g%u LSUB \"%s\" \"%s\"\r\n",
f_imap->seq++, ref, name);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_LSUB;
case IMAP_LSUB:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_LSUB_ACK;
case IMAP_LSUB_ACK:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break;
}
/* Build the folder list. */
list_copy (flist, f_imap->flist, strlen (ref), NULL, NULL, 0);
mu_list_destroy (&f_imap->flist);
f_imap->state = IMAP_NO_STATE;
return 0;
}
static int
folder_imap_rename (mu_folder_t folder, const char *oldpath,
const char *newpath)
{
f_imap_t f_imap = folder->data;
int status = 0;
if (oldpath == NULL || newpath == NULL)
return EINVAL;
status = mu_folder_open (folder, folder->flags);
if (status != 0)
return status;
switch (f_imap->state)
{
case IMAP_NO_STATE:
status = imap_writeline (f_imap, "g%u RENAME %s %s\r\n",
f_imap->seq++, oldpath, newpath);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_RENAME;
case IMAP_RENAME:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_RENAME_ACK;
case IMAP_RENAME_ACK:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break;
}
f_imap->state = IMAP_NO_STATE;
return status;
}
static int
folder_imap_subscribe (mu_folder_t folder, const char *name)
{
f_imap_t f_imap = folder->data;
int status = 0;
status = mu_folder_open (folder, folder->flags);
if (status != 0)
return status;
if (name == NULL)
return EINVAL;
switch (f_imap->state)
{
case IMAP_NO_STATE:
status = imap_writeline (f_imap, "g%u SUBSCRIBE %s\r\n",
f_imap->seq++, name);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_SUBSCRIBE;
case IMAP_SUBSCRIBE:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_SUBSCRIBE_ACK;
case IMAP_SUBSCRIBE_ACK:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break;
}
f_imap->state = IMAP_NO_STATE;
return status;
}
static int
folder_imap_unsubscribe (mu_folder_t folder, const char *name)
{
f_imap_t f_imap = folder->data;
int status = 0;
status = mu_folder_open (folder, folder->flags);
if (status != 0)
return status;
if (name == NULL)
return EINVAL;
switch (f_imap->state)
{
case IMAP_NO_STATE:
status = imap_writeline (f_imap, "g%u UNSUBSCRIBE %s\r\n",
f_imap->seq++, name);
CHECK_ERROR (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
f_imap->state = IMAP_UNSUBSCRIBE;
case IMAP_UNSUBSCRIBE:
status = imap_send (f_imap);
CHECK_EAGAIN (f_imap, status);
f_imap->state = IMAP_UNSUBSCRIBE_ACK;
case IMAP_UNSUBSCRIBE_ACK:
status = imap_parse (f_imap);
CHECK_EAGAIN (f_imap, status);
MU_DEBUG (folder->debug, MU_DEBUG_PROT, f_imap->buffer);
default:
break;
}
f_imap->state = IMAP_NO_STATE;
return status;
}
/* A literal is a sequence of zero or more octets (including CR and LF),
prefix-quoted with an octet count in the form of an open brace ("{"),
the number of octets, close brace ("}"), and CRLF. The sequence is read
and put in the string buffer. */
static int
imap_literal_string (f_imap_t f_imap, char **ptr)
{
size_t len, len0, total;
int status = 0;
int nl;
if (f_imap->string.nleft==0)
{
status = imap_readline (f_imap);
*ptr = f_imap->buffer;
return status;
}
/* The (len + 1) in the for is to count the strip '\r' by imap_readline. */
for (len0 = len = total = 0; total < f_imap->string.nleft; total += len + 1)
{
status = imap_readline (f_imap);
if (DEBUG_SHOW_DATA)
fprintf (stderr, "%s", f_imap->buffer);
if (status != 0)
{
/* Return what we got so far. */
break;
}
f_imap->ptr = f_imap->buffer;
/* How much ? */
len0 = len = f_imap->nl - f_imap->buffer;
/* Check if the last read did not finish on a line, if yes do not copy in
string buffer the terminating sequence ")\r\n". We are doing this
by checking if the amount(total) we got so far + the len of the line
+1 (taking to account the strip '\r') goes behond the request. */
if ((total + len + 1) > f_imap->string.nleft)
{
len0 = len = f_imap->string.nleft - total;
/* ALERT: if we ask for a substring, for example we have :
"123456\n", and ask for body[]<0.7> the server will send
body[] {7} --> "123456\r". There was not enough space
to fit the nl .. annoying. Take care of this here. */
if (f_imap->buffer[len - 1] == '\r')
len0--;
}
mu_stream_write (f_imap->string.stream, f_imap->buffer,
len0, f_imap->string.offset, NULL);
f_imap->string.offset += len0;
/* Depending on the type of request we incremente the xxxx_lines
and xxxx_sizes. */
nl = (memchr (f_imap->buffer, '\n', len0)) ? 1 : 0;
if (f_imap->string.msg_imap)
{
switch (f_imap->string.type)
{
case IMAP_HEADER:
f_imap->string.msg_imap->header_lines += nl;
f_imap->string.msg_imap->header_size += len0;
break;
case IMAP_BODY:
f_imap->string.msg_imap->body_lines += nl;
f_imap->string.msg_imap->body_size += len0;
break;
case IMAP_MESSAGE:
f_imap->string.msg_imap->mu_message_lines += nl;
/* The message size is known by sending RFC822.SIZE. */
default:
break;
}
}
}
f_imap->string.nleft -= total;
/* We may have trailing junk like the closing ")\r\n" from a literal string
glob it by moving the command buffer, or doing a full readline. */
if (len == (size_t)(f_imap->nl - f_imap->buffer))
{
len = 0;
status = imap_readline (f_imap);
}
*ptr = f_imap->buffer + len;
return status;
}
/* A quoted string is a sequence of zero or more 7-bit characters,
excluding CR and LF, with double quote (<">) characters at each end.
Same thing as the literal, diferent format the result is put in the
string buffer for the mailbox/callee. */
static int
imap_quoted_string (f_imap_t f_imap, char **ptr)
{
char *bquote;
int escaped = 0;
int len;
(*ptr)++;
bquote = *ptr;
while (**ptr && (**ptr != '"' || escaped))
{
escaped = (**ptr == '\\') ? 1 : 0;
(*ptr)++;
}
len = *ptr - bquote;
mu_stream_write (f_imap->string.stream, bquote, len,
f_imap->string.offset, NULL);
f_imap->string.offset += len;
if (**ptr == '"')
(*ptr)++;
if (DEBUG_SHOW_DATA)
fprintf (stderr, "%.*s", len, bquote);
return 0;
}
/* A number consists of one or more digit characters, and represents a
numeric value. */
static int
imap_digits (f_imap_t f_imap, char **ptr)
{
char *start = *ptr;
int len;
for (++*ptr; **ptr && isdigit(**ptr); ++*ptr)
;
len = *ptr - start;
mu_stream_write (f_imap->string.stream, start, len,
f_imap->string.offset, NULL);
f_imap->string.offset += len;
return 0;
}
/* Find which type of string the response is: literal or quoted and let the
function fill the string buffer. */
static int
imap_string (f_imap_t f_imap, char **ptr)
{
int status = 0;
/* Skip whites. */
while (**ptr == ' ')
(*ptr)++;
switch (**ptr)
{
case '{':
f_imap->string.nleft = strtol ((*ptr) + 1, ptr, 10);
if (**ptr == '}')
{
(*ptr)++;
/* Reset the buffer to the beginning. */
f_imap->ptr = f_imap->buffer;
status = imap_literal_string (f_imap, ptr);
}
break;
case '"':
status = imap_quoted_string (f_imap, ptr);
break;
/* NIL */
case 'N':
case 'n':
(*ptr)++; /* N|n */
(*ptr)++; /* I|i */
(*ptr)++; /* L|l */
break;
default:
if (isdigit (**ptr))
status = imap_digits (f_imap, ptr);
else
/* Problem. FIXME: Return a more appropriate error code */
status = MU_ERR_FAILURE;
break;
}
return status;
}
/* FIXME: does not work for nonblocking. */
static int
imap_list (f_imap_t f_imap)
{
char *tok;
char *sp = NULL;
size_t len = f_imap->nl - f_imap->buffer - 1;
char *buffer;
struct mu_list_response *lr;
int status = 0;
int argc;
char **argv;
buffer = malloc (len);
if (!buffer)
return ENOMEM;
memcpy (buffer, f_imap->buffer, len);
buffer[len] = '\0';
lr = malloc (sizeof (*lr));
if (!lr)
return ENOMEM;
if (!f_imap->flist)
{
mu_list_create (&f_imap->flist);
mu_list_set_destroy_item (f_imap->flist, mu_list_response_free);
}
mu_list_append (f_imap->flist, lr);
/* Glob untag. */
tok = strtok_r (buffer, " ", &sp);
/* Glob LIST. */
tok = strtok_r (NULL, " ", &sp);
/* Get the attibutes. */
tok = strtok_r (NULL, ")", &sp);
if (tok)
{
char *s = NULL;
char *p = tok;
while ((tok = strtok_r (p, " ()", &s)) != NULL)
{
if (strcasecmp (tok, "\\Noselect") == 0)
lr->type |= MU_FOLDER_ATTRIBUTE_DIRECTORY;
else if (strcasecmp (tok, "\\Noinferiors") == 0)
lr->type |= MU_FOLDER_ATTRIBUTE_FILE;
else if (strcasecmp (tok, "\\Marked") == 0
|| strcasecmp (tok, "\\Unmarked") == 0)
/* nothing */;
else
lr->type |= MU_FOLDER_ATTRIBUTE_DIRECTORY;
p = NULL;
}
}
status = mu_argcv_get (sp, "", NULL, &argc, &argv);
if (status == 0)
{
char *s;
/* Hiearchy delimeter. */
tok = argv[0];
if (tok && tok[1] == 0 && strcasecmp (tok, "NIL"))
lr->separator = tok[0];
/* The path. */
tok = argv[1];
s = strchr (tok, '{');
if (s)
{
size_t n = strtoul (s + 1, NULL, 10);
lr->name = calloc (n + 1, 1);
if (!lr->name)
status = ENOMEM;
else
{
f_imap->ptr = f_imap->buffer;
imap_readline (f_imap);
memcpy (lr->name, f_imap->buffer, n);
}
}
else if ((status = imap_string (f_imap, &tok)) == 0)
{
mu_off_t sz = 0;
mu_stream_size (f_imap->string.stream, &sz);
lr->name = calloc (sz + 1, 1);
if (!lr->name)
status = ENOMEM;
else
mu_stream_read (f_imap->string.stream, lr->name, sz, 0, NULL);
mu_stream_truncate (f_imap->string.stream, 0);
f_imap->string.offset = 0;
f_imap->string.nleft = 0;
}
else
{
lr->name = strdup (tok);
if (!lr->name)
status = ENOMEM;
}
}
mu_argcv_free (argc, argv);
free (buffer);
return status;
}
/* Helping function to figure out the section name of the message: for example
a 2 part message with the first part being sub in two will be:
{1}, {1,1} {1,2} The first subpart of the message and its sub parts
{2} The second subpar of the message. */
char *
section_name (msg_imap_t msg_imap)
{
size_t sectionlen = 0;
char *section = strdup ("");
/* Build the section name, but it is in reverse. */
for (; msg_imap; msg_imap = msg_imap->parent)
{
if (msg_imap->part != 0)
{
char *tmp;
char part[64];
size_t partlen;
snprintf (part, sizeof part, "%lu", (unsigned long) msg_imap->part);
partlen = strlen (part);
tmp = realloc (section, sectionlen + partlen + 2);
if (tmp == NULL)
break;
section = tmp;
memset (section + sectionlen, '\0', partlen + 2);
if (sectionlen != 0)
strcat (section, ".");
strcat (section, part);
sectionlen = strlen (section);
}
}
/* Reverse the string. */
if (section)
{
char *begin, *last;
char c;
for (begin = section, last = section + sectionlen - 1; begin < last;
begin++, last--)
{
c = *begin;
*begin = *last;
*last = c;
}
}
return section;
}
/* We do not pay particular attention to the content of the bodystructure
but rather to the paremetized list layout to discover how many messages
the originial message is composed of. The information is later retrieve
when needed via the body[header.fields] command. Note that this function
is recursive. */
static int
imap_bodystructure0 (msg_imap_t msg_imap, char **ptr)
{
int paren = 0;
int no_arg = 0;
int status = 0;
int have_size = 0;
/* Skip space. */
while (**ptr == ' ')
(*ptr)++;
/* Pass lparen. */
if (**ptr == '(')
{
++(*ptr);
paren++;
no_arg++;
}
/* NOTE : this loop has side effects in strtol() and imap_string(), the
order of the if's are important. */
while (**ptr)
{
/* Skip the string argument. */
if (**ptr != '(' && **ptr != ')')
{
char *start = *ptr;
/* FIXME: set the command callback if EAGAIN to resume. */
status = imap_string (msg_imap->m_imap->f_imap, ptr);
if (status != 0)
return status;
if (start != *ptr)
no_arg = 0;
}
if (isdigit ((unsigned)**ptr))
{
char *start = *ptr;
size_t size = strtoul (*ptr, ptr, 10);
if (start != *ptr)
{
if (!have_size && msg_imap && msg_imap->parent)
msg_imap->mu_message_size = size;
have_size = 1;
no_arg = 0;
}
}
if (**ptr == '(')
{
if (no_arg)
{
msg_imap_t new_part;
msg_imap_t *tmp;
tmp = realloc (msg_imap->parts,
((msg_imap->num_parts + 1) * sizeof (*tmp)));
if (tmp)
{
new_part = calloc (1, sizeof (*new_part));
if (new_part)
{
msg_imap->parts = tmp;
msg_imap->parts[msg_imap->num_parts] = new_part;
new_part->part = ++(msg_imap->num_parts);
new_part->parent = msg_imap;
new_part->num = msg_imap->num;
new_part->m_imap = msg_imap->m_imap;
new_part->flags = msg_imap->flags;
status = imap_bodystructure0 (new_part, ptr);
/* Jump up, the rparen been swallen already. */
continue;
}
else
{
status = ENOMEM;
free (tmp);
break;
}
}
else
{
status = ENOMEM;
break;
}
}
paren++;
}
if (**ptr == ')')
{
no_arg = 1;
paren--;
/* Did we reach the same number of close paren ? */
if (paren <= 0)
{
/* Swallow the rparen. */
(*ptr)++;
break;
}
}
if (**ptr == '\0')
break;
(*ptr)++;
}
return status;
}
static int
imap_bodystructure (f_imap_t f_imap, char **ptr)
{
return imap_bodystructure0 (f_imap->string.msg_imap, ptr);
}
/* The Format for a FLAG response is :
mailbox_data ::= "FLAGS" SPACE flag_list
flag_list ::= "(" #flag ")"
flag ::= "\Answered" / "\Flagged" / "\Deleted" /
"\Seen" / "\Draft" / flag_keyword / flag_extension
flag_extension ::= "\" atom
;; Future expansion. Client implementations
;; MUST accept flag_extension flags. Server
;; implementations MUST NOT generate
;; flag_extension flags except as defined by
;; future standard or standards-track
;; revisions of this specification.
flag_keyword ::= atom
S: * 14 FETCH (FLAGS (\Seen \Deleted))
S: * FLAGS (\Answered \Flagged \Deleted \Seen \Draft)
We assume that the '*' or the FLAGS keyword are strip.
FIXME: User flags are not take to account. */
static int
imap_fetch_flags (f_imap_t f_imap, char **ptr)
{
msg_imap_t msg_imap = f_imap->string.msg_imap;
if (msg_imap)
imap_flags (ptr, &msg_imap->flags);
return 0;
}
static int
imap_permanentflags (f_imap_t f_imap, char **ptr)
{
imap_flags (ptr, &f_imap->flags);
return 0;
}
static int
imap_flags (char **ptr, int *pflags)
{
char *start;
char *end;
int flags = 0;
/* Skip space. */
while (**ptr == ' ')
(*ptr)++;
/* Skip LPAREN. */
if (**ptr == '(')
(*ptr)++;
/* Go through the list and break on ')' */
do
{
/* Skip space before next word. */
while (**ptr == ' ')
(*ptr)++;
/* Save the beginning of the word. */
start = *ptr;
/* Get the next word boundary. */
while (**ptr && **ptr != ' ' && **ptr != ')')
++(*ptr);
/* Save the end for the strcasecmp. */
end = *ptr;
/* Bail out. */
if (*start == '\0')
break;
/* Guess the flag. */
if (end == start)
flags |= MU_ATTRIBUTE_SEEN;
else
{
if (strncasecmp (start, "\\Seen", end - start) == 0)
{
flags |= MU_ATTRIBUTE_READ;
}
else if (strncasecmp (start, "\\Answered", end - start) == 0)
{
flags |= MU_ATTRIBUTE_ANSWERED;
}
else if (strncasecmp (start, "\\Flagged", end - start) == 0)
{
flags |= MU_ATTRIBUTE_FLAGGED;
}
else if (strncasecmp (start, "\\Deleted", end - start) == 0)
{
flags |= MU_ATTRIBUTE_DELETED;
}
else if (strncasecmp (start, "\\Draft", end - start) == 0)
{
flags |= MU_ATTRIBUTE_DRAFT;
}
else if (strncasecmp (start, "\\Recent", end - start))
flags |= MU_ATTRIBUTE_SEEN;
}
}
while (**ptr && **ptr != ')'); /* do {} */
/* Skip the last rparen. */
if (**ptr == ')')
(*ptr)++;
if (pflags)
*pflags = flags;
return 0;
}
static int
imap_body (f_imap_t f_imap, char **ptr)
{
int status;
/* Skip leading spaces. */
while (**ptr && **ptr == ' ')
(*ptr)++;
if (**ptr == '[')
{
char *sep = strchr (*ptr, ']');
(*ptr)++; /* Move past the '[' */
if (sep)
{
size_t len = sep - *ptr;
char *section = malloc (len + 1);
char *p;
if (!section)
return ENOMEM;
strncpy (section, *ptr, len);
section[len] = '\0';
/* strupper. */
for (p = section; *p; p++)
*p = toupper ((unsigned)*p);
/* Set the string type to update the correct line count. */
/*if (!strstr (section, "FIELD"))*/
{
if (strstr (section, "MIME") || (strstr (section, "HEADER")))
{
f_imap->string.type = IMAP_HEADER;
}
else if (strstr (section, "TEXT") || len > 0)
{
f_imap->string.type = IMAP_BODY;
}
else if (len == 0) /* body[] */
{
f_imap->string.type = IMAP_MESSAGE;
}
}
free (section);
sep++; /* Move past the ']' */
*ptr = sep;
}
}
while (**ptr && **ptr == ' ')
(*ptr)++;
if (**ptr == '<')
{
char *sep = strchr (*ptr, '>');
if (sep)
{
sep++;
*ptr = sep;
}
}
status = imap_string (f_imap, ptr);
/* If the state scan. Catch it here. */
if (f_imap->state == IMAP_SCAN_ACK)
{
char *buffer;
mu_off_t total = 0;
if (f_imap->string.msg_imap && f_imap->string.msg_imap->fheader)
mu_header_destroy (&f_imap->string.msg_imap->fheader, NULL);
mu_stream_size (f_imap->string.stream, &total);
buffer = malloc (total + 1);
mu_stream_read (f_imap->string.stream, buffer, total, 0, NULL);
status = mu_header_create (&f_imap->string.msg_imap->fheader,
buffer, total, NULL);
free (buffer);
mu_stream_truncate (f_imap->string.stream, 0);
f_imap->string.offset = 0;
f_imap->string.nleft = 0;
}
return status;
}
static int
imap_internaldate (f_imap_t f_imap, char **ptr)
{
return imap_string (f_imap, ptr);
}
static int
imap_uid (f_imap_t f_imap, char **ptr)
{
char token[128];
imap_token (token, sizeof token, ptr);
if (f_imap->string.msg_imap)
f_imap->string.msg_imap->uid = strtoul (token, NULL, 10);
return 0;
}
static int
imap_rfc822 (f_imap_t f_imap, char **ptr)
{
int status;
f_imap->string.type = IMAP_MESSAGE;
status = imap_body (f_imap, ptr);
f_imap->string.type = 0;
return status;
}
static int
imap_rfc822_size (f_imap_t f_imap, char **ptr)
{
char token[128];
imap_token (token, sizeof token, ptr);
if (f_imap->string.msg_imap)
f_imap->string.msg_imap->mu_message_size = strtoul (token, NULL, 10);
return 0;
}
static int
imap_rfc822_header (f_imap_t f_imap, char **ptr)
{
int status;
f_imap->string.type = IMAP_HEADER;
status = imap_string (f_imap, ptr);
f_imap->string.type = 0;
return status;
}
static int
imap_rfc822_text (f_imap_t f_imap, char **ptr)
{
int status;
f_imap->string.type = IMAP_HEADER;
status = imap_string (f_imap, ptr);
f_imap->string.type = 0;
return status;
}
/* Parse imap unfortunately FETCH is use as response for many commands.
We just use a small set an ignore the other ones :
not use : ALL
use : BODY
not use : BODY[<section>]<<partial>>
use : BODY.PEEK[<section>]<<partial>>
not use : BODYSTRUCTURE
not use : ENVELOPE
not use : FAST
use : FLAGS
not use : FULL
use : INTERNALDATE
not use : RFC822
not use : RFC822.HEADER
use : RFC822.SIZE
not use : RFC822.TEXT
not use : UID
*/
static int
imap_fetch (f_imap_t f_imap)
{
char token[128];
size_t msgno = 0;
m_imap_t m_imap = f_imap->selected;
int status = 0;
char *sp = NULL;
/* We should have a mailbox selected. */
assert (m_imap != NULL);
/* Parse the FETCH respones to extract the pieces. */
sp = f_imap->buffer;
/* Skip untag '*'. */
imap_token (token, sizeof token, &sp);
/* Get msgno. */
imap_token (token, sizeof token, &sp);
msgno = strtol (token, NULL, 10);
/* Skip FETCH . */
imap_token (token, sizeof token, &sp);
/* It is actually possible, but higly unlikely that we do not have the
message yet, for example a "FETCH (FLAGS (\Recent))" notification
for a newly messsage. */
if (f_imap->string.msg_imap == NULL
|| f_imap->string.msg_imap->num != msgno)
{
/* Find the imap mesg struct. */
size_t i;
mu_message_t msg = NULL;
mu_mailbox_get_message (m_imap->mailbox, msgno, &msg);
for (i = 0; i < m_imap->imessages_count; i++)
{
if (m_imap->imessages[i] && m_imap->imessages[i]->num == msgno)
{
f_imap->string.msg_imap = m_imap->imessages[i];
break;
}
}
/* mu_message_destroy (&msg); */
}
while (*sp && *sp != ')')
{
/* Get the token. */
imap_token (token, sizeof token, &sp);
if (strncmp (token, "FLAGS", 5) == 0)
{
status = imap_fetch_flags (f_imap, &sp);
}
else if (strcasecmp (token, "BODY") == 0)
{
if (*sp == '[')
status = imap_body (f_imap, &sp);
else
status = imap_bodystructure (f_imap, &sp);
}
else if (strcasecmp (token, "BODYSTRUCTURE") == 0)
{
status = imap_bodystructure (f_imap, &sp);
}
else if (strncmp (token, "INTERNALDATE", 12) == 0)
{
status = imap_internaldate (f_imap, &sp);
}
else if (strncmp (token, "RFC822", 10) == 0)
{
if (*sp == '.')
{
sp++;
imap_token (token, sizeof token, &sp);
if (strcasecmp (token, "SIZE") == 0)
{
status = imap_rfc822_size (f_imap, &sp);
}
else if (strcasecmp (token, "TEXT") == 0)
{
status = imap_rfc822_text (f_imap, &sp);
}
else if (strcasecmp (token, "HEADER") == 0)
{
status = imap_rfc822_header (f_imap, &sp);
}
/* else mu_error (_("not supported RFC822 option")); */
}
else
{
status = imap_rfc822 (f_imap, &sp);
}
}
else if (strncmp (token, "UID", 3) == 0)
{
status = imap_uid (f_imap, &sp);
}
/* else mu_error (_("not supported FETCH command")); */
}
return status;
}
static int
imap_search (f_imap_t f_imap MU_ARG_UNUSED)
{
/* Not implemented. No provision for this in the API, yet. */
return 0;
}
static int
imap_status (f_imap_t f_imap MU_ARG_UNUSED)
{
/* Not implemented. No provision for this in the API, yet. */
return 0;
}
static int
imap_expunge (f_imap_t f_imap MU_ARG_UNUSED, unsigned msgno MU_ARG_UNUSED)
{
/* We should not have this, since do not send the expunge, but rather
use SELECT/CLOSE. */
return 0;
}
/* This function will advance ptr to the next character that IMAP
recognise as special: " .()[]<>" and put the result in buf which
is of size len. */
static int
imap_token (char *buf, size_t len, char **ptr)
{
char *start = *ptr;
size_t i;
/* Skip leading space. */
while (**ptr && **ptr == ' ')
(*ptr)++;
/* Break the string by token, when we recognise Atoms we stop. */
for (i = 1; **ptr && i < len; (*ptr)++, buf++, i++)
{
if (**ptr == ' ' || **ptr == '.'
|| **ptr == '(' || **ptr == ')'
|| **ptr == '[' || **ptr == ']'
|| **ptr == '<' || **ptr == '>')
{
/* Advance. */
if (start == (*ptr))
(*ptr)++;
break;
}
*buf = **ptr;
}
*buf = '\0';
/* Skip trailing space. */
while (**ptr && **ptr == ' ')
(*ptr)++;
return *ptr - start;;
}
/* Checks to see if a mailbox name matches a pattern, treating
INBOX case insensitively, as required (INBOX is a special
name no matter what the case is).
*/
static int
imap_mailbox_name_match(const char* pattern, const char* mailbox)
{
if(strcasecmp(pattern, "inbox") == 0)
{
return strcasecmp(pattern, mailbox);
}
return fnmatch(pattern, mailbox, 0);
}
/* C99 says that a conforming implementations of snprintf () should return the
number of char that would have been call but many GNU/Linux && BSD
implementations return -1 on error. Worse QnX/Neutrino actually does not
put the terminal null char. So let's try to cope. */
int
imap_writeline (f_imap_t f_imap, const char *format, ...)
{
int len;
va_list ap;
int done = 1;
va_start(ap, format);
do
{
len = vsnprintf (f_imap->buffer, f_imap->buflen, format, ap);
if (len < 0 || len >= (int)f_imap->buflen
|| !memchr (f_imap->buffer, '\0', len + 1))
{
f_imap->buflen *= 2;
f_imap->buffer = realloc (f_imap->buffer, f_imap->buflen);
if (f_imap->buffer == NULL)
return ENOMEM;
done = 0;
}
else
done = 1;
}
while (!done);
va_end(ap);
f_imap->ptr = f_imap->buffer + len;
if (DEBUG_SHOW_COMMAND)
fprintf (stderr, "%s", f_imap->buffer);
return 0;
}
/* Cover to send requests. */
int
imap_send (f_imap_t f_imap)
{
int status = 0;
if (f_imap->ptr > f_imap->buffer)
{
size_t len;
size_t n = 0;
len = f_imap->ptr - f_imap->buffer;
status = mu_stream_write (f_imap->folder->stream, f_imap->buffer, len,
0, &n);
if (status == 0)
{
memmove (f_imap->buffer, f_imap->buffer + n, len - n);
f_imap->ptr -= n;
}
}
else
f_imap->ptr = f_imap->buffer;
return status;
}
/* Read a complete line form the imap server. Transform CRLF to LF, put a null
in the buffer when done. Note f_imap->offset is not really of any use
but rather to keep the stream internal buffer scheme happy, so we have to
be in sync with the stream. */
int
imap_readline (f_imap_t f_imap)
{
size_t n = 0;
size_t total = f_imap->ptr - f_imap->buffer;
int status;
/* Must get a full line before bailing out. */
do
{
status = mu_stream_readline (f_imap->folder->stream, f_imap->buffer + total,
f_imap->buflen - total, f_imap->offset, &n);
if (status != 0)
return status;
/* The server went away: It maybe a timeout and some imap server
does not send the BYE. Consider like an error. */
if (n == 0)
return EIO;
total += n;
f_imap->offset += n;
f_imap->nl = memchr (f_imap->buffer, '\n', total);
if (f_imap->nl == NULL) /* Do we have a full line. */
{
/* Allocate a bigger buffer ? */
if (total >= f_imap->buflen -1)
{
f_imap->buflen *= 2;
f_imap->buffer = realloc (f_imap->buffer, f_imap->buflen + 1);
if (f_imap->buffer == NULL)
return ENOMEM;
}
}
f_imap->ptr = f_imap->buffer + total;
}
while (f_imap->nl == NULL);
/* Conversion \r\n --> \n\0 */
/* FIXME: This should be done transparently by the TCP stream */
if (f_imap->nl > f_imap->buffer && f_imap->nl[-1] == '\r')
{
*(f_imap->nl - 1) = '\n';
*(f_imap->nl) = '\0';
f_imap->ptr = f_imap->nl;
}
return 0;
}
/*
The parsing was inspired by this article form the BeNews channel: "BE
ENGINEERING INSIGHTS: IMAP for the Masses." By Adam Haberlach adam@be.com
The server responses are in three forms: status responses, server data,
and command continuation request, ...
An untagged response is indicated by the token "*" instead of a tag.
Untagged status responses indicate server greeting, or server status
that does not indicate the completion of a command (for example, an
impending system shutdown alert).
....
The client MUST be prepared to accept any response at all times.
Status responses are OK, NO, BAD, PREAUTH and BYE. OK, NO, and BAD
may be tagged or untagged. PREAUTH and BYE are always untagged.
Server Responses - Status Responses
BAD *|tag
BYE *
NO *|tag
OK *|tag
PREAUTH *
The code for status responses are
ALERT
BADCHARSET(IMAPV)
CAPABILITY(IMAPV)
NEWNAME
PARSE
PERMANENTFLAGS
READ-ONLY
READ-WRITE
TRYCREATE
UIDNEXT
UIDVALIDITY
UNSEEN
Server Responses - Server and Mailbox Status.
These responses are always untagged.
CAPABILITY *
EXISTS *
EXPUNGE *
FLAGS *
FETCH *
LIST *
LSUB *
RECENT *
SEARCH *
STATUS *
Server Responses - Command Continuation Request
+
*/
int
imap_parse (f_imap_t f_imap)
{
int done = 0;
int status = 0;
char empty[2];
char *buffer = NULL;
mu_folder_t folder = f_imap->folder;
/* We use that moronic hack to not check null for the tockenize strings. */
empty[0] = '\0';
empty[1] = '\0';
while (! done)
{
char *tag, *response, *remainder;
status = imap_readline (f_imap);
if (status != 0)
{
break;
}
/* Comment out to see all reading traffic. */
if (DEBUG_SHOW_RESPONSE)
mu_error ("\t\t%s", f_imap->buffer);
/* We do not want to step over f_imap->buffer since it can be use
further down the chain. */
if (buffer)
{
free (buffer);
buffer = NULL;
}
buffer = calloc ((f_imap->ptr - f_imap->buffer) + 1, 1);
memcpy (buffer, f_imap->buffer, (f_imap->ptr - f_imap->buffer));
/* Tokenize the string. */
{
char *sp = NULL;
tag = strtok_r (buffer, " ", &sp);
response = strtok_r (NULL, " ", &sp);
if (!response)
response = empty;
remainder = strtok_r (NULL, "\n", &sp);
if (!remainder)
remainder = empty;
}
if (!tag)
{
/* Just in case */
mu_error (_("No tag in response: %s %s"), response, remainder);
status = MU_ERR_FAILURE;
}
/* Is the response untagged ? */
else if (tag[0] == '*')
{
MU_DEBUG2 (folder->debug, MU_DEBUG_PROT, "* %s %s\n",
response, remainder);
/* Is it a Status Response. */
if (strcasecmp (response, "OK") == 0)
{
/* Check for status response [code]. */
if (*remainder == '[')
{
char *cruft, *subtag;
char *sp = NULL, *sp1;
remainder++;
cruft = strtok_r (remainder, "]", &sp);
if (!cruft) cruft = empty;
subtag = strtok_r (cruft, " ", &sp1);
if (!subtag) subtag = empty;
if (strcasecmp (subtag, "ALERT") == 0)
{
/* The human-readable text contains a special alert that
MUST be presented to the user in a fashion that calls
the user's attention to the message. */
mu_error (_("ALERT: %s"), (sp) ? sp : "");
}
else if (strcasecmp (subtag, "BADCHARSET") == 0)
{
/* Optionally followed by a parenthesized list of
charsets. A SEARCH failed because the given charset
is not supported by this implementation. If the
optional list of charsets is given, this lists the
charsets that are supported by this implementation. */
mu_error (_("BAD CHARSET: %s"), (sp) ? sp : "");
}
else if (strcasecmp (subtag, "CAPABILITY") == 0)
{
/* Followed by a list of capabilities. This can appear
in the initial OK or PREAUTH response to transmit an
initial capabilities list. This makes it unnecessary
for a client to send a separate CAPABILITY command if
it recognizes this response. */
parse_capa (f_imap, cruft);
}
else if (strcasecmp (subtag, "NEWNAME") == 0)
{
/* Followed by a mailbox name and a new mailbox name. A
SELECT or EXAMINE failed because the target mailbox
name (which once existed) was renamed to the new
mailbox name. This is a hint to the client that the
operation can succeed if the SELECT or EXAMINE is
reissued with the new mailbox name. */
mu_error ("NEWNAME: %s", (sp) ? sp : "");
}
else if (strcasecmp (subtag, "PARSE") == 0)
{
/* The human-readable text represents an error in
parsing the [RFC-822] header or [MIME-IMB] headers
of a message in the mailbox. */
mu_error ("PARSE: %s", (sp) ? sp : "");
}
else if (strcasecmp (subtag, "PERMANENTFLAGS") == 0)
{
/* Followed by a parenthesized list of flags, indicates
which of the known flags that the client can change
permanently. Any flags that are in the FLAGS
untagged response, but not the PERMANENTFLAGS list,
can not be set permanently. If the client attempts
to STORE a flag that is not in the PERMANENTFLAGS
list, the server will either ignore the change or
store the state change for the remainder of the
current session only. The PERMANENTFLAGS list can
also include the special flag \*, which indicates
that it is possible to create new keywords by
attempting to store those flags in the mailbox. */
}
else if (strcasecmp (subtag, "READ-ONLY") == 0)
{
/* The mailbox is selected read-only, or its access
while selected has changed from read-write to
read-only. */
}
else if (strcasecmp (subtag, "READ-WRITE") == 0)
{
/* The mailbox is selected read-write, or its access
while selected has changed from read-only to
read-write. */
}
else if (strcasecmp (subtag, "TRYCREATE") == 0)
{
/* An APPEND or COPY attempt is failing because the
target mailbox does not exist (as opposed to some
other reason). This is a hint to the client that
the operation can succeed if the mailbox is first
created by the CREATE command. */
mu_error ("TRYCREATE: %s", (sp) ? sp : "");
}
else if (strcasecmp (subtag, "UIDNEXT") == 0)
{
/* Followed by a decimal number, indicates the next
unique identifier value. Refer to section 2.3.1.1
for more information. */
char *value = strtok_r (NULL, " ", &sp);
f_imap->selected->uidnext = strtol (value, NULL, 10);
}
else if (strcasecmp (subtag, "UIDVALIDITY") == 0)
{
/* Followed by a decimal number, indicates the unique
identifier validity value. Refer to section 2.3.1.1
for more information. */
char *value = strtok_r (NULL, " ", &sp);
f_imap->selected->uidvalidity = strtol (value, NULL, 10);
}
else if (strcasecmp (subtag, "UNSEEN") == 0)
{
/* Followed by a decimal number, indicates the number of
the first message without the \Seen flag set. */
char *value = strtok_r (NULL, " ", &sp);
f_imap->selected->unseen = strtol (value, NULL, 10);
}
else
{
/* Additional response codes defined by particular
client or server implementations SHOULD be prefixed
with an "X" until they are added to a revision of
this protocol. Client implementations SHOULD ignore
response codes that they do not recognize. */
}
} /* End of code. */
else
{
/* Not sure why we would get an untagged ok...but we do... */
/* Still should we be verbose about is ? */
mu_error (_("Untagged OK: %s"), remainder);
}
}
else if (strcasecmp (response, "NO") == 0)
{
/* This does not mean failure but rather a strong warning. */
mu_error (_("Untagged NO: %s"), remainder);
}
else if (strcasecmp (response, "BAD") == 0)
{
/* We're dead, protocol/syntax error. */
mu_error (_("Untagged BAD: %s"), remainder);
}
else if (strcasecmp (response, "PREAUTH") == 0)
{
/* Should we be dealing with this? */
}
else if (strcasecmp (response, "BYE") == 0)
{
/* We should close the stream. This is not recoverable. */
done = 1;
mu_monitor_wrlock (f_imap->folder->monitor);
f_imap->isopen = 0;
f_imap->selected = NULL;
mu_monitor_unlock (f_imap->folder->monitor);
mu_stream_close (f_imap->folder->stream);
}
else if (strcasecmp (response, "CAPABILITY") == 0)
{
parse_capa (f_imap, remainder);
}
else if (strcasecmp (remainder, "EXISTS") == 0)
{
f_imap->selected->messages_count = strtol (response, NULL, 10);
}
else if (strcasecmp (remainder, "EXPUNGE") == 0)
{
unsigned int msgno = strtol (response, NULL, 10);
status = imap_expunge (f_imap, msgno);
}
else if (strncasecmp (remainder, "FETCH", 5) == 0)
{
status = imap_fetch (f_imap);
if (status != 0)
break;
}
else if (strcasecmp (response, "FLAGS") == 0)
{
/* Flags define on the mailbox not a message flags. */
status = imap_permanentflags (f_imap, &remainder);
}
else if (strcasecmp (response, "LIST") == 0)
{
status = imap_list (f_imap);
}
else if (strcasecmp (response, "LSUB") == 0)
{
status = imap_list (f_imap);
}
else if (strcasecmp (remainder, "RECENT") == 0)
{
f_imap->selected->recent = strtol (response, NULL, 10);
}
else if (strcasecmp (response, "SEARCH") == 0)
{
status = imap_search (f_imap);
}
else if (strcasecmp (response, "STATUS") == 0)
{
status = imap_status (f_imap);
}
else
{
/* Once again, check for something strange. */
mu_error (_("unknown untagged response: \"%s\" %s"),
response, remainder);
}
}
/* Continuation token ???. */
else if (tag[0] == '+')
{
done = 1;
}
else
{
/* Every transaction ends with a tagged response. */
done = 1;
if (strcasecmp (response, "OK") == 0)
{
/* Cool we are doing ok. */
}
else if (strcasecmp (response, "NO") == 0)
{
if (strncasecmp (remainder, "LOGIN", 5) == 0)
{
mu_observable_t observable = NULL;
mu_folder_get_observable (f_imap->folder, &observable);
mu_observable_notify (observable, MU_EVT_AUTHORITY_FAILED,
NULL);
status = MU_ERR_AUTH_FAILURE;
}
else if (strncasecmp (remainder, "LIST", 4) == 0)
status = MU_ERR_NOENT;
else
status = MU_ERR_FAILURE;
}
else /* NO and BAD */
{
status = EINVAL;
mu_error (_("NO/Bad Tagged: %s %s %s"),
tag, response, remainder);
}
}
f_imap->ptr = f_imap->buffer;
}
if (buffer)
free (buffer);
return status;
}
#else
#include <stdio.h>
#include <registrar0.h>
mu_record_t mu_imap_record = NULL;
mu_record_t mu_imaps_record = NULL;
#endif /* ENABLE_IMAP */