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
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
|
# mime.tcl - MIME body parts
#
# (c) 1999-2000 Marshall T. Rose
# (c) 2000 Brent Welch
# (c) 2000 Sandeep Tamhankar
# (c) 2000 Dan Kuchler
# (c) 2000-2001 Eric Melski
# (c) 2001 Jeff Hobbs
# (c) 2001-2008 Andreas Kupries
# (c) 2002-2003 David Welton
# (c) 2003-2008 Pat Thoyts
# (c) 2005 Benjamin Riefenstahl
# (c) 2013 PoorYorick
#
#
# See the file "license.terms" for information on usage and redistribution
# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
# Influenced by Borenstein's/Rose's safe-tcl (circa 1993) and Darren New's
# unpublished package of 1999.
#
# new string features and inline scan are used, requiring 8.3.
package require Tcl 8.5
package provide mime 1.6
if {[catch {package require Trf 2.0}]} {
# Fall-back to tcl-based procedures of base64 and quoted-printable encoders
# Warning!
# These are a fragile emulations of the more general calling sequence
# that appears to work with this code here.
package require base64 2.0
set ::major [lindex [split [package require md5] .] 0]
# Create these commands in the mime namespace so that they
# won't collide with things at the global namespace level
namespace eval ::mime {
proc base64 {-mode what -- chunk} {
return [base64::$what $chunk]
}
proc quoted-printable {-mode what -- chunk} {
return [mime::qp_$what $chunk]
}
if {$::major < 2} {
# md5 v1, result is hex string ready for use.
proc md5 {-- string} {
return [md5::md5 $string]
}
} else {
# md5 v2, need option to get hex string
proc md5 {-- string} {
return [md5::md5 -hex $string]
}
}
}
unset ::major
}
#
# state variables:
#
# canonicalP: input is in its canonical form
# content: type/subtype
# params: seralized array of key/value pairs (keys are lower-case)
# encoding: transfer encoding
# version: MIME-version
# header: serialized array of key/value pairs (keys are lower-case)
# lowerL: list of header keys, lower-case
# mixedL: list of header keys, mixed-case
# value: either "file", "parts", or "string"
#
# file: input file
# fd: cached file-descriptor, typically for root
# root: token for top-level part, for (distant) subordinates
# offset: number of octets from beginning of file/string
# count: length in octets of (encoded) content
#
# parts: list of bodies (tokens)
#
# string: input string
#
# cid: last child-id assigned
#
namespace eval ::mime {
variable mime
array set mime {uid 0 cid 0}
# RFC 822 lexemes
variable addrtokenL
lappend addrtokenL \; , < > : . ( ) @ \" \[ ] \\
variable addrlexemeL {
LX_SEMICOLON LX_COMMA
LX_LBRACKET LX_RBRACKET
LX_COLON LX_DOT
LX_LPAREN LX_RPAREN
LX_ATSIGN LX_QUOTE
LX_LSQUARE LX_RSQUARE
LX_QUOTE
}
# RFC 2045 lexemes
variable typetokenL
lappend typetokenL \; , < > : ? ( ) @ \" \[ \] = / \\
variable typelexemeL {
LX_SEMICOLON LX_COMMA
LX_LBRACKET LX_RBRACKET
LX_COLON LX_QUESTION
LX_LPAREN LX_RPAREN
LX_ATSIGN LX_QUOTE
LX_LSQUARE LX_RSQUARE
LX_EQUALS LX_SOLIDUS
LX_QUOTE
}
variable encList {
ascii US-ASCII
big5 Big5
cp1250 Windows-1250
cp1251 Windows-1251
cp1252 Windows-1252
cp1253 Windows-1253
cp1254 Windows-1254
cp1255 Windows-1255
cp1256 Windows-1256
cp1257 Windows-1257
cp1258 Windows-1258
cp437 IBM437
cp737 {}
cp775 IBM775
cp850 IBM850
cp852 IBM852
cp855 IBM855
cp857 IBM857
cp860 IBM860
cp861 IBM861
cp862 IBM862
cp863 IBM863
cp864 IBM864
cp865 IBM865
cp866 IBM866
cp869 IBM869
cp874 {}
cp932 {}
cp936 GBK
cp949 {}
cp950 {}
dingbats {}
ebcdic {}
euc-cn EUC-CN
euc-jp EUC-JP
euc-kr EUC-KR
gb12345 GB12345
gb1988 GB1988
gb2312 GB2312
iso2022 ISO-2022
iso2022-jp ISO-2022-JP
iso2022-kr ISO-2022-KR
iso8859-1 ISO-8859-1
iso8859-2 ISO-8859-2
iso8859-3 ISO-8859-3
iso8859-4 ISO-8859-4
iso8859-5 ISO-8859-5
iso8859-6 ISO-8859-6
iso8859-7 ISO-8859-7
iso8859-8 ISO-8859-8
iso8859-9 ISO-8859-9
iso8859-10 ISO-8859-10
iso8859-13 ISO-8859-13
iso8859-14 ISO-8859-14
iso8859-15 ISO-8859-15
iso8859-16 ISO-8859-16
jis0201 JIS_X0201
jis0208 JIS_C6226-1983
jis0212 JIS_X0212-1990
koi8-r KOI8-R
koi8-u KOI8-U
ksc5601 KS_C_5601-1987
macCentEuro {}
macCroatian {}
macCyrillic {}
macDingbats {}
macGreek {}
macIceland {}
macJapan {}
macRoman {}
macRomania {}
macThai {}
macTurkish {}
macUkraine {}
shiftjis Shift_JIS
symbol {}
tis-620 TIS-620
unicode {}
utf-8 UTF-8
}
variable encodings
array set encodings $encList
variable reversemap
# Initialized at the bottom of the file
variable encAliasList {
ascii ANSI_X3.4-1968
ascii iso-ir-6
ascii ANSI_X3.4-1986
ascii ISO_646.irv:1991
ascii ASCII
ascii ISO646-US
ascii us
ascii IBM367
ascii cp367
cp437 cp437
cp437 437
cp775 cp775
cp850 cp850
cp850 850
cp852 cp852
cp852 852
cp855 cp855
cp855 855
cp857 cp857
cp857 857
cp860 cp860
cp860 860
cp861 cp861
cp861 861
cp861 cp-is
cp862 cp862
cp862 862
cp863 cp863
cp863 863
cp864 cp864
cp865 cp865
cp865 865
cp866 cp866
cp866 866
cp869 cp869
cp869 869
cp869 cp-gr
cp936 CP936
cp936 MS936
cp936 Windows-936
iso8859-1 ISO_8859-1:1987
iso8859-1 iso-ir-100
iso8859-1 ISO_8859-1
iso8859-1 latin1
iso8859-1 l1
iso8859-1 IBM819
iso8859-1 CP819
iso8859-2 ISO_8859-2:1987
iso8859-2 iso-ir-101
iso8859-2 ISO_8859-2
iso8859-2 latin2
iso8859-2 l2
iso8859-3 ISO_8859-3:1988
iso8859-3 iso-ir-109
iso8859-3 ISO_8859-3
iso8859-3 latin3
iso8859-3 l3
iso8859-4 ISO_8859-4:1988
iso8859-4 iso-ir-110
iso8859-4 ISO_8859-4
iso8859-4 latin4
iso8859-4 l4
iso8859-5 ISO_8859-5:1988
iso8859-5 iso-ir-144
iso8859-5 ISO_8859-5
iso8859-5 cyrillic
iso8859-6 ISO_8859-6:1987
iso8859-6 iso-ir-127
iso8859-6 ISO_8859-6
iso8859-6 ECMA-114
iso8859-6 ASMO-708
iso8859-6 arabic
iso8859-7 ISO_8859-7:1987
iso8859-7 iso-ir-126
iso8859-7 ISO_8859-7
iso8859-7 ELOT_928
iso8859-7 ECMA-118
iso8859-7 greek
iso8859-7 greek8
iso8859-8 ISO_8859-8:1988
iso8859-8 iso-ir-138
iso8859-8 ISO_8859-8
iso8859-8 hebrew
iso8859-9 ISO_8859-9:1989
iso8859-9 iso-ir-148
iso8859-9 ISO_8859-9
iso8859-9 latin5
iso8859-9 l5
iso8859-10 iso-ir-157
iso8859-10 l6
iso8859-10 ISO_8859-10:1992
iso8859-10 latin6
iso8859-14 iso-ir-199
iso8859-14 ISO_8859-14:1998
iso8859-14 ISO_8859-14
iso8859-14 latin8
iso8859-14 iso-celtic
iso8859-14 l8
iso8859-15 ISO_8859-15
iso8859-15 Latin-9
iso8859-16 iso-ir-226
iso8859-16 ISO_8859-16:2001
iso8859-16 ISO_8859-16
iso8859-16 latin10
iso8859-16 l10
jis0201 X0201
jis0208 iso-ir-87
jis0208 x0208
jis0208 JIS_X0208-1983
jis0212 x0212
jis0212 iso-ir-159
ksc5601 iso-ir-149
ksc5601 KS_C_5601-1989
ksc5601 KSC5601
ksc5601 korean
shiftjis MS_Kanji
utf-8 UTF8
}
namespace export initialize finalize getproperty \
getheader setheader \
getbody \
copymessage \
mapencoding \
reversemapencoding \
parseaddress \
parsedatetime \
uniqueID
}
# ::mime::initialize --
#
# Creates a MIME part, and returnes the MIME token for that part.
#
# Arguments:
# args Args can be any one of the following:
# ?-canonical type/subtype
# ?-param {key value}?...
# ?-encoding value?
# ?-header {key value}?... ?
# (-file name | -string value | -parts {token1 ... tokenN})
#
# If the -canonical option is present, then the body is in
# canonical (raw) form and is found by consulting either the -file,
# -string, or -parts option.
#
# In addition, both the -param and -header options may occur zero
# or more times to specify "Content-Type" parameters (e.g.,
# "charset") and header keyword/values (e.g.,
# "Content-Disposition"), respectively.
#
# Also, -encoding, if present, specifies the
# "Content-Transfer-Encoding" when copying the body.
#
# If the -canonical option is not present, then the MIME part
# contained in either the -file or the -string option is parsed,
# dynamically generating subordinates as appropriate.
#
# Results:
# An initialized mime token.
proc ::mime::initialize args {
global errorCode errorInfo
variable mime
set token [namespace current]::[incr mime(uid)]
# FRINK: nocheck
variable $token
upvar 0 $token state
if {[catch {{*}[list mime::initializeaux $token {*}$args]} result eopts]} {
catch {mime::finalize $token -subordinates dynamic}
return -options $eopts $result
}
return $token
}
# ::mime::initializeaux --
#
# Configures the MIME token created in mime::initialize based on
# the arguments that mime::initialize supports.
#
# Arguments:
# token The MIME token to configure.
# args Args can be any one of the following:
# ?-canonical type/subtype
# ?-param {key value}?...
# ?-encoding value?
# ?-header {key value}?... ?
# (-file name | -string value | -parts {token1 ... tokenN})
#
# Results:
# Either configures the mime token, or throws an error.
proc ::mime::initializeaux {token args} {
global errorCode errorInfo
# FRINK: nocheck
variable $token
upvar 0 $token state
array set params [set state(params) {}]
set state(encoding) {}
set state(version) 1.0
set state(header) {}
set state(lowerL) {}
set state(mixedL) {}
set state(cid) 0
set argc [llength $args]
for {set argx 0} {$argx < $argc} {incr argx} {
set option [lindex $args $argx]
if {[incr argx] >= $argc} {
error "missing argument to $option"
}
set value [lindex $args $argx]
switch -- $option {
-canonical {
set state(content) [string tolower $value]
}
-param {
if {[llength $value] != 2} {
error "-param expects a key and a value, not $value"
}
set lower [string tolower [set mixed [lindex $value 0]]]
if {[info exists params($lower)]} {
error "the $mixed parameter may be specified at most once"
}
set params($lower) [lindex $value 1]
set state(params) [array get params]
}
-encoding {
switch -- [set state(encoding) [string tolower $value]] {
7bit - 8bit - binary - quoted-printable - base64 {
}
default {
error "unknown value for -encoding $state(encoding)"
}
}
}
-header {
if {[llength $value] != 2} {
error "-header expects a key and a value, not $value"
}
set lower [string tolower [set mixed [lindex $value 0]]]
if {$lower eq "content-type"} {
error "use -canonical instead of -header $value"
}
if {$lower eq "content-transfer-encoding"} {
error "use -encoding instead of -header $value"
}
if {$lower in {content-md5 mime-version}} {
error "don't go there..."
}
if {$lower ni $state(lowerL)} {
lappend state(lowerL) $lower
lappend state(mixedL) $mixed
}
array set header $state(header)
lappend header($lower) [lindex $value 1]
set state(header) [array get header]
}
-file {
set state(file) $value
}
-parts {
set state(parts) $value
}
-string {
set state(string) $value
set state(lines) [split $value \n]
set state(lines.count) [llength $state(lines)]
set state(lines.current) 0
}
-root {
# the following are internal options
set state(root) $value
}
-offset {
set state(offset) $value
}
-count {
set state(count) $value
}
-lineslist {
set state(lines) $value
set state(lines.count) [llength $state(lines)]
set state(lines.current) 0
#state(string) is needed, but will be built when required
set state(string) {}
}
default {
error "unknown option $option"
}
}
}
#We only want one of -file, -parts or -string:
set valueN 0
foreach value {file parts string} {
if {[info exists state($value)]} {
set state(value) $value
incr valueN
}
}
if {$valueN != 1 && ![info exists state(lines)]} {
error "specify exactly one of -file, -parts, or -string"
}
if {[set state(canonicalP) [info exists state(content)]]} {
switch -- $state(value) {
file {
set state(offset) 0
}
parts {
switch -glob -- $state(content) {
text/*
-
image/*
-
audio/*
-
video/* {
error "-canonical $state(content) and -parts do not mix"
}
default {
if {$state(encoding) ne {}} {
error "-encoding and -parts do not mix"
}
}
}
}
default {# Go ahead}
}
if {[lsearch -exact $state(lowerL) content-id] < 0} {
lappend state(lowerL) content-id
lappend state(mixedL) Content-ID
array set header $state(header)
lappend header(content-id) [uniqueID]
set state(header) [array get header]
}
set state(version) 1.0
return
}
if {$state(params) ne {}} {
error "-param requires -canonical"
}
if {$state(encoding) ne {}} {
error "-encoding requires -canonical"
}
if {$state(header) ne {}} {
error "-header requires -canonical"
}
if {[info exists state(parts)]} {
error "-parts requires -canonical"
}
if {[set fileP [info exists state(file)]]} {
if {[set openP [info exists state(root)]]} {
# FRINK: nocheck
variable $state(root)
upvar 0 $state(root) root
set state(fd) $root(fd)
} else {
set state(root) $token
set state(fd) [open $state(file) RDONLY]
set state(offset) 0
seek $state(fd) 0 end
set state(count) [tell $state(fd)]
fconfigure $state(fd) -translation binary
}
}
set code [catch {mime::parsepart $token} result]
set ecode $errorCode
set einfo $errorInfo
if {$fileP} {
if {!$openP} {
unset state(root)
catch {close $state(fd)}
}
unset state(fd)
}
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
# ::mime::parsepart --
#
# Parses the MIME headers and attempts to break up the message
# into its various parts, creating a MIME token for each part.
#
# Arguments:
# token The MIME token to parse.
#
# Results:
# Throws an error if it has problems parsing the MIME token,
# otherwise it just sets up the appropriate variables.
proc ::mime::parsepart {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
if {[set fileP [info exists state(file)]]} {
seek $state(fd) [set pos $state(offset)] start
set last [expr {$state(offset) + $state(count) - 1}]
} else {
set string $state(string)
}
set vline {}
while 1 {
set blankP 0
if {$fileP} {
if {($pos > $last) || ([set x [gets $state(fd) line]] <= 0)} {
set blankP 1
} else {
incr pos [expr {$x + 1}]
}
} else {
if {$state(lines.current) >= $state(lines.count)} {
set blankP 1
set line {}
} else {
set line [lindex $state(lines) $state(lines.current)]
incr state(lines.current)
set x [string length $line]
if {$x == 0} {set blankP 1}
}
}
if {(!$blankP) && ([string last \r $line] == {$x - 1})} {
set line [string range $line 0 [expr {$x - 2}]]
if {$x == 1} {
set blankP 1
}
}
if {(!$blankP) && (([
string first { } $line] == 0) || ([
string first \t $line] == 0))} {
append vline \n $line
continue
}
if {$vline eq {}} {
if {$blankP} {
break
}
set vline $line
continue
}
if {([set x [string first : $vline]] <= 0) \
|| ([set mixed [ string trimright [
string range $vline 0 [expr {$x - 1}]]
]] eq {})
} {
error "improper line in header: $vline"
}
set value [string trim [string range $vline [expr {$x + 1}] end]]
switch -- [set lower [string tolower $mixed]] {
content-type {
if {[info exists state(content)]} {
error "multiple Content-Type fields starting with $vline"
}
if {![catch {set x [parsetype $token $value]}]} {
set state(content) [lindex $x 0]
set state(params) [lindex $x 1]
}
}
content-md5 {
}
content-transfer-encoding {
if {($state(encoding) ne {}) \
&& ($state(encoding) ne [
string tolower $value])} {
error "multiple Content-Transfer-Encoding fields starting with $vline"
}
set state(encoding) [string tolower $value]
}
mime-version {
set state(version) $value
}
default {
if {[lsearch -exact $state(lowerL) $lower] < 0} {
lappend state(lowerL) $lower
lappend state(mixedL) $mixed
}
array set header $state(header)
lappend header($lower) $value
set state(header) [array get header]
}
}
if {$blankP} {
break
}
set vline $line
}
if {![info exists state(content)]} {
set state(content) text/plain
set state(params) [list charset us-ascii]
}
if {![string match multipart/* $state(content)]} {
if {$fileP} {
set x [tell $state(fd)]
incr state(count) [expr {$state(offset) - $x}]
set state(offset) $x
} else {
# rebuild string, this is cheap and needed by other functions
set state(string) [join [
lrange $state(lines) $state(lines.current) end] \n]
}
if {[string match message/* $state(content)]} {
# FRINK: nocheck
variable [set child $token-[incr state(cid)]]
set state(value) parts
set state(parts) $child
if {$fileP} {
mime::initializeaux $child \
-file $state(file) -root $state(root) \
-offset $state(offset) -count $state(count)
} else {
if {[info exists state(encoding)]} {
set strng [join [
lrange $state(lines) $state(lines.current) end] \n]
switch -- $state(encoding) {
base64 -
quoted-printable {
set strng [$state(encoding) -mode decode -- $strng]
}
default {}
}
mime::initializeaux $child -string $strng
} else {
mime::initializeaux $child -lineslist [
lrange $state(lines) $state(lines.current) end]
}
}
}
return
}
set state(value) parts
set boundary {}
foreach {k v} $state(params) {
if {$k eq "boundary"} {
set boundary $v
break
}
}
if {$boundary eq {}} {
error "boundary parameter is missing in $state(content)"
}
if {[string trim $boundary] eq {}} {
error "boundary parameter is empty in $state(content)"
}
if {$fileP} {
set pos [tell $state(fd)]
# This variable is like 'start', for the reasons laid out
# below, in the other branch of this conditional.
set initialpos $pos
} else {
# This variable is like 'start', a list of lines in the
# part. This record is made even before we find a starting
# boundary and used if we run into the terminating boundary
# before a starting boundary was found. In that case the lines
# before the terminator as recorded by tracelines are seen as
# the part, or at least we attempt to parse them as a
# part. See the forceoctet and nochild flags later. We cannot
# use 'start' as that records lines only after the starting
# boundary was found.
set tracelines [list]
}
set inP 0
set moreP 1
set forceoctet 0
while {$moreP} {
if {$fileP} {
if {$pos > $last} {
# We have run over the end of the part per the outer
# information without finding a terminating boundary.
# We now fake the boundary and force the parser to
# give any new part coming of this a mime-type of
# application/octet-stream regardless of header
# information.
set line "--$boundary--"
set x [string length $line]
set forceoctet 1
} else {
if {[set x [gets $state(fd) line]] < 0} {
error "end-of-file encountered while parsing $state(content)"
}
}
incr pos [expr {$x + 1}]
} else {
if {$state(lines.current) >= $state(lines.count)} {
error "end-of-string encountered while parsing $state(content)"
} else {
set line [lindex $state(lines) $state(lines.current)]
incr state(lines.current)
set x [string length $line]
}
set x [string length $line]
}
if {[string last \r $line] == $x - 1} {
set line [string range $line 0 [expr {$x - 2}]]
set crlf 2
} else {
set crlf 1
}
if {[string first --$boundary $line] != 0} {
if {$inP && !$fileP} {
lappend start $line
}
continue
} else {
lappend tracelines $line
}
if {!$inP} {
# Haven't seen the starting boundary yet. Check if the
# current line contains this starting boundary.
if {$line eq "--$boundary"} {
# Yes. Switch parser state to now search for the
# terminating boundary of the part and record where
# the part begins (or initialize the recorder for the
# lines in the part).
set inP 1
if {$fileP} {
set start $pos
} else {
set start [list]
}
continue
} elseif {$line eq "--$boundary--"} {
# We just saw a terminating boundary before we ever
# saw the starting boundary of a part. This forces us
# to stop parsing, we do this by forcing the parser
# into an accepting state. We will try to create a
# child part based on faked start position or recorded
# lines, or, if that fails, let the current part have
# no children.
# As an example note the test case mime-3.7 and the
# referenced file "badmail1.txt".
set inP 1
if {$fileP} {
set start $initialpos
} else {
set start $tracelines
}
set forceoctet 1
# Fall through. This brings to the creation of the new
# part instead of searching further and possible
# running over the end.
} else {
continue
}
}
# Looking for the end of the current part. We accept both a
# terminating boundary and the starting boundary of the next
# part as the end of the current part.
if {[set moreP [string compare $line --$boundary--]] \
&& $line ne "--$boundary"} {
# The current part has not ended, so we record the line
# if we are inside a part and doing string parsing.
if {$inP && !$fileP} {
lappend start $line
}
continue
}
# The current part has ended. We now determine the exact
# boundaries, create a mime part object for it and recursively
# parse it deeper as part of that action.
# FRINK: nocheck
variable [set child $token-[incr state(cid)]]
lappend state(parts) $child
set nochild 0
if {$fileP} {
if {[set count [expr {$pos - ($start + $x + $crlf + 1)}]] < 0} {
set count 0
}
if {$forceoctet} {
set ::errorInfo {}
if {[catch {
mime::initializeaux $child \
-file $state(file) -root $state(root) \
-offset $start -count $count
}]} {
set nochild 1
set state(parts) [lrange $state(parts) 0 end-1]
} } else {
mime::initializeaux $child \
-file $state(file) -root $state(root) \
-offset $start -count $count
}
seek $state(fd) [set start $pos] start
} else {
if {$forceoctet} {
if {[catch {
mime::initializeaux $child -lineslist $start
}]} {
set nochild 1
set state(parts) [lrange $state(parts) 0 end-1]
}
} else {
mime::initializeaux $child -lineslist $start
}
set start {}
}
if {$forceoctet && !$nochild} {
variable $child
upvar 0 $child childstate
set childstate(content) application/octet-stream
}
set forceoctet 0
}
}
# ::mime::parsetype --
#
# Parses the string passed in and identifies the content-type and
# params strings.
#
# Arguments:
# token The MIME token to parse.
# string The content-type string that should be parsed.
#
# Results:
# Returns the content and params for the string as a two element
# tcl list.
proc ::mime::parsetype {token string} {
global errorCode errorInfo
# FRINK: nocheck
variable $token
upvar 0 $token state
variable typetokenL
variable typelexemeL
set state(input) $string
set state(buffer) {}
set state(lastC) LX_END
set state(comment) {}
set state(tokenL) $typetokenL
set state(lexemeL) $typelexemeL
set code [catch {mime::parsetypeaux $token $string} result]
set ecode $errorCode
set einfo $errorInfo
unset state(input) \
state(buffer) \
state(lastC) \
state(comment) \
state(tokenL) \
state(lexemeL)
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
# ::mime::parsetypeaux --
#
# A helper function for mime::parsetype. Parses the specified
# string looking for the content type and params.
#
# Arguments:
# token The MIME token to parse.
# string The content-type string that should be parsed.
#
# Results:
# Returns the content and params for the string as a two element
# tcl list.
proc ::mime::parsetypeaux {token string} {
# FRINK: nocheck
variable $token
upvar 0 $token state
if {[parselexeme $token] ne "LX_ATOM"} {
error [format "expecting type (found %s)" $state(buffer)]
}
set type [string tolower $state(buffer)]
switch -- [parselexeme $token] {
LX_SOLIDUS {
}
LX_END {
if {$type ne "message"} {
error "expecting type/subtype (found $type)"
}
return [list message/rfc822 {}]
}
default {
error [format "expecting \"/\" (found %s)" $state(buffer)]
}
}
if {[parselexeme $token] ne "LX_ATOM"} {
error [format "expecting subtype (found %s)" $state(buffer)]
}
append type [string tolower /$state(buffer)]
array set params {}
while {1} {
switch -- [parselexeme $token] {
LX_END {
return [list $type [array get params]]
}
LX_SEMICOLON {
}
default {
error [format "expecting \";\" (found %s)" $state(buffer)]
}
}
switch -- [parselexeme $token] {
LX_END {
return [list $type [array get params]]
}
LX_ATOM {
}
default {
error [format "expecting attribute (found %s)" $state(buffer)]
}
}
set attribute [string tolower $state(buffer)]
if {[parselexeme $token] ne "LX_EQUALS"} {
error [format "expecting \"=\" (found %s)" $state(buffer)]
}
switch -- [parselexeme $token] {
LX_ATOM {
}
LX_QSTRING {
set state(buffer) [
string range $state(buffer) 1 [
expr {[string length $state(buffer)] - 2}]]
}
default {
error [format "expecting value (found %s)" $state(buffer)]
}
}
set params($attribute) $state(buffer)
}
}
# ::mime::finalize --
#
# mime::finalize destroys a MIME part.
#
# If the -subordinates option is present, it specifies which
# subordinates should also be destroyed. The default value is
# "dynamic".
#
# Arguments:
# token The MIME token to parse.
# args Args can be optionally be of the following form:
# ?-subordinates "all" | "dynamic" | "none"?
#
# Results:
# Returns an empty string.
proc ::mime::finalize {token args} {
# FRINK: nocheck
variable $token
upvar 0 $token state
array set options [list -subordinates dynamic]
array set options $args
switch -- $options(-subordinates) {
all {
#TODO: this code path is untested
if {$state(value) eq "parts"} {
foreach part $state(parts) {
eval [linsert $args 0 mime::finalize $part]
}
}
}
dynamic {
for {set cid $state(cid)} {$cid > 0} {incr cid -1} {
eval [linsert $args 0 mime::finalize $token-$cid]
}
}
none {
}
default {
error "unknown value for -subordinates $options(-subordinates)"
}
}
foreach name [array names state] {
unset state($name)
}
# FRINK: nocheck
unset $token
}
# ::mime::getproperty --
#
# mime::getproperty returns the properties of a MIME part.
#
# The properties are:
#
# property value
# ======== =====
# content the type/subtype describing the content
# encoding the "Content-Transfer-Encoding"
# params a list of "Content-Type" parameters
# parts a list of tokens for the part's subordinates
# size the approximate size of the content (unencoded)
#
# The "parts" property is present only if the MIME part has
# subordinates.
#
# If mime::getproperty is invoked with the name of a specific
# property, then the corresponding value is returned; instead, if
# -names is specified, a list of all properties is returned;
# otherwise, a serialized array of properties and values is returned.
#
# Arguments:
# token The MIME token to parse.
# property One of 'content', 'encoding', 'params', 'parts', and
# 'size'. Defaults to returning a serialized array of
# properties and values.
#
# Results:
# Returns the properties of a MIME part
proc ::mime::getproperty {token {property {}}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
switch -- $property {
{} {
array set properties [list content $state(content) \
encoding $state(encoding) \
params $state(params) \
size [getsize $token]]
if {[info exists state(parts)]} {
set properties(parts) $state(parts)
}
return [array get properties]
}
-names {
set names [list content encoding params]
if {[info exists state(parts)]} {
lappend names parts
}
return $names
}
content
-
encoding
-
params {
return $state($property)
}
parts {
if {![info exists state(parts)]} {
error "MIME part is a leaf"
}
return $state(parts)
}
size {
return [getsize $token]
}
default {
error "unknown property $property"
}
}
}
# ::mime::getsize --
#
# Determine the size (in bytes) of a MIME part/token
#
# Arguments:
# token The MIME token to parse.
#
# Results:
# Returns the size in bytes of the MIME token.
proc ::mime::getsize {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
switch -- $state(value)/$state(canonicalP) {
file/0 {
set size $state(count)
}
file/1 {
return [file size $state(file)]
}
parts/0
-
parts/1 {
set size 0
foreach part $state(parts) {
incr size [getsize $part]
}
return $size
}
string/0 {
set size [string length $state(string)]
}
string/1 {
return [string length $state(string)]
}
default {
error "Unknown combination \"$state(value)/$state(canonicalP)\""
}
}
if {$state(encoding) eq "base64"} {
set size [expr {($size * 3 + 2) / 4}]
}
return $size
}
# ::mime::getheader --
#
# mime::getheader returns the header of a MIME part.
#
# A header consists of zero or more key/value pairs. Each value is a
# list containing one or more strings.
#
# If mime::getheader is invoked with the name of a specific key, then
# a list containing the corresponding value(s) is returned; instead,
# if -names is specified, a list of all keys is returned; otherwise, a
# serialized array of keys and values is returned. Note that when a
# key is specified (e.g., "Subject"), the list returned usually
# contains exactly one string; however, some keys (e.g., "Received")
# often occur more than once in the header, accordingly the list
# returned usually contains more than one string.
#
# Arguments:
# token The MIME token to parse.
# key Either a key or '-names'. If it is '-names' a list
# of all keys is returned.
#
# Results:
# Returns the header of a MIME part.
proc ::mime::getheader {token {key {}}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
array set header $state(header)
switch -- $key {
{} {
set result {}
foreach lower $state(lowerL) mixed $state(mixedL) {
lappend result $mixed $header($lower)
}
return $result
}
-names {
return $state(mixedL)
}
default {
set lower [string tolower [set mixed $key]]
if {![info exists header($lower)]} {
error "key $mixed not in header"
}
return $header($lower)
}
}
}
# ::mime::setheader --
#
# mime::setheader writes, appends to, or deletes the value associated
# with a key in the header.
#
# The value for -mode is one of:
#
# write: the key/value is either created or overwritten (the
# default);
#
# append: a new value is appended for the key (creating it as
# necessary); or,
#
# delete: all values associated with the key are removed (the
# "value" parameter is ignored).
#
# Regardless, mime::setheader returns the previous value associated
# with the key.
#
# Arguments:
# token The MIME token to parse.
# key The name of the key whose value should be set.
# value The value for the header key to be set to.
# args An optional argument of the form:
# ?-mode "write" | "append" | "delete"?
#
# Results:
# Returns previous value associated with the specified key.
proc ::mime::setheader {token key value args} {
# FRINK: nocheck
variable $token
upvar 0 $token state
array set options [list -mode write]
array set options $args
switch -- [set lower [string tolower $key]] {
content-md5
-
content-type
-
content-transfer-encoding
-
mime-version {
error "key $key may not be set"
}
default {# Skip key}
}
array set header $state(header)
if {[set x [lsearch -exact $state(lowerL) $lower]] < 0} {
#TODO: this code path is not tested
if {$options(-mode) eq "delete"} {
error "key $key not in header"
}
lappend state(lowerL) $lower
lappend state(mixedL) $key
set result {}
} else {
set result $header($lower)
}
switch -- $options(-mode) {
append {
lappend header($lower) $value
}
delete {
unset header($lower)
set state(lowerL) [lreplace $state(lowerL) $x $x]
set state(mixedL) [lreplace $state(mixedL) $x $x]
}
write {
set header($lower) [list $value]
}
default {
error "unknown value for -mode $options(-mode)"
}
}
set state(header) [array get header]
return $result
}
# ::mime::getbody --
#
# mime::getbody returns the body of a leaf MIME part in canonical form.
#
# If the -command option is present, then it is repeatedly invoked
# with a fragment of the body as this:
#
# uplevel #0 $callback [list "data" $fragment]
#
# (The -blocksize option, if present, specifies the maximum size of
# each fragment passed to the callback.)
# When the end of the body is reached, the callback is invoked as:
#
# uplevel #0 $callback "end"
#
# Alternatively, if an error occurs, the callback is invoked as:
#
# uplevel #0 $callback [list "error" reason]
#
# Regardless, the return value of the final invocation of the callback
# is propagated upwards by mime::getbody.
#
# If the -command option is absent, then the return value of
# mime::getbody is a string containing the MIME part's entire body.
#
# Arguments:
# token The MIME token to parse.
# args Optional arguments of the form:
# ?-decode? ?-command callback ?-blocksize octets? ?
#
# Results:
# Returns a string containing the MIME part's entire body, or
# if '-command' is specified, the return value of the command
# is returned.
proc ::mime::getbody {token args} {
global errorCode errorInfo
# FRINK: nocheck
variable $token
upvar 0 $token state
set decode 0
if {[set pos [lsearch -exact $args -decode]] >= 0} {
set decode 1
set args [lreplace $args $pos $pos]
}
array set options [list -command [
list mime::getbodyaux $token] -blocksize 4096]
array set options $args
if {$options(-blocksize) < 1} {
error "-blocksize expects a positive integer, not $options(-blocksize)"
}
set code 0
set ecode {}
set einfo {}
switch -- $state(value)/$state(canonicalP) {
file/0 {
set fd [open $state(file) RDONLY]
set code [catch {
fconfigure $fd -translation binary
seek $fd [set pos $state(offset)] start
set last [expr {$state(offset) + $state(count) - 1}]
set fragment {}
while {$pos <= $last} {
if {[set cc [
expr {($last - $pos) + 1}]] > $options(-blocksize)} {
set cc $options(-blocksize)
}
incr pos [set len [
string length [set chunk [read $fd $cc]]]]
switch -exact -- $state(encoding) {
base64
-
quoted-printable {
if {([set x [string last \n $chunk]] > 0) \
&& ($x + 1 != $len)} {
set chunk [string range $chunk 0 $x]
seek $fd [incr pos [expr {($x + 1) - $len}]] start
}
set chunk [
$state(encoding) -mode decode -- $chunk]
}
7bit - 8bit - binary - {} {
# Bugfix for [#477088]
# Go ahead, leave chunk alone
}
default {
error "Can't handle content encoding \"$state(encoding)\""
}
}
append fragment $chunk
set cc [expr {$options(-blocksize) - 1}]
while {[string length $fragment] > $options(-blocksize)} {
uplevel #0 $options(-command) [
list data [string range $fragment 0 $cc]]
set fragment [
string range $fragment $options(-blocksize) end]
}
}
if {[string length $fragment] > 0} {
uplevel #0 $options(-command) [list data $fragment]
}
} result]
set ecode $errorCode
set einfo $errorInfo
catch {close $fd}
}
file/1 {
set fd [open $state(file) RDONLY]
set code [catch {
fconfigure $fd -translation binary
while {[string length [
set fragment [read $fd $options(-blocksize)]]] > 0} {
uplevel #0 $options(-command) [list data $fragment]
}
} result]
set ecode $errorCode
set einfo $errorInfo
catch {close $fd}
}
parts/0
-
parts/1 {
error "MIME part isn't a leaf"
}
string/0
-
string/1 {
switch -- $state(encoding)/$state(canonicalP) {
base64/0
-
quoted-printable/0 {
set fragment [
$state(encoding) -mode decode -- $state(string)]
}
default {
# Not a bugfix for [#477088], but clarification
# This handles no-encoding, 7bit, 8bit, and binary.
set fragment $state(string)
}
}
set code [catch {
set cc [expr {$options(-blocksize) -1}]
while {[string length $fragment] > $options(-blocksize)} {
uplevel #0 $options(-command) [
list data [string range $fragment 0 $cc]]
set fragment [
string range $fragment $options(-blocksize) end]
}
if {[string length $fragment] > 0} {
uplevel #0 $options(-command) [list data $fragment]
}
} result]
set ecode $errorCode
set einfo $errorInfo
}
default {
error "Unknown combination \"$state(value)/$state(canonicalP)\""
}
}
set code [catch {
if {$code} {
uplevel #0 $options(-command) [list error $result]
} else {
uplevel #0 $options(-command) [list end]
}
} result]
set ecode $errorCode
set einfo $errorInfo
if {$code} {
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
if {$decode} {
array set params [mime::getproperty $token params]
if {[info exists params(charset)]} {
set charset $params(charset)
} else {
set charset US-ASCII
}
set enc [reversemapencoding $charset]
if {$enc ne {}} {
set result [::encoding convertfrom $enc $result]
} else {
return -code error "-decode failed: can't reversemap charset $charset"
}
}
return $result
}
# ::mime::getbodyaux --
#
# Builds up the body of the message, fragment by fragment. When
# the entire message has been retrieved, it is returned.
#
# Arguments:
# token The MIME token to parse.
# reason One of 'data', 'end', or 'error'.
# fragment The section of data data fragment to extract a
# string from.
#
# Results:
# Returns nothing, except when called with the 'end' argument
# in which case it returns a string that contains all of the
# data that 'getbodyaux' has been called with. Will throw an
# error if it is called with the reason of 'error'.
proc ::mime::getbodyaux {token reason {fragment {}}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
switch $reason {
data {
append state(getbody) $fragment
return {}
}
end {
if {[info exists state(getbody)]} {
set result $state(getbody)
unset state(getbody)
} else {
set result {}
}
return $result
}
error {
catch {unset state(getbody)}
error $reason
}
default {
error "Unknown reason \"$reason\""
}
}
}
# ::mime::copymessage --
#
# mime::copymessage copies the MIME part to the specified channel.
#
# mime::copymessage operates synchronously, and uses fileevent to
# allow asynchronous operations to proceed independently.
#
# Arguments:
# token The MIME token to parse.
# channel The channel to copy the message to.
#
# Results:
# Returns nothing unless an error is thrown while the message
# is being written to the channel.
proc ::mime::copymessage {token channel} {
global errorCode errorInfo
# FRINK: nocheck
variable $token
upvar 0 $token state
set openP [info exists state(fd)]
set code [catch {mime::copymessageaux $token $channel} result]
set ecode $errorCode
set einfo $errorInfo
if {(!$openP) && ([info exists state(fd)])} {
if {![info exists state(root)]} {
catch {close $state(fd)}
}
unset state(fd)
}
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
# ::mime::copymessageaux --
#
# mime::copymessageaux copies the MIME part to the specified channel.
#
# Arguments:
# token The MIME token to parse.
# channel The channel to copy the message to.
#
# Results:
# Returns nothing unless an error is thrown while the message
# is being written to the channel.
proc ::mime::copymessageaux {token channel} {
# FRINK: nocheck
variable $token
upvar 0 $token state
array set header $state(header)
if {$state(version) ne {}} {
puts $channel "MIME-Version: $state(version)"
}
foreach lower $state(lowerL) mixed $state(mixedL) {
foreach value $header($lower) {
puts $channel "$mixed: $value"
}
}
if {(!$state(canonicalP)) \
&& ([set encoding $state(encoding)] ne {})} {
puts $channel "Content-Transfer-Encoding: $encoding"
}
puts -nonewline $channel "Content-Type: $state(content)"
set boundary {}
foreach {k v} $state(params) {
if {$k eq "boundary"} {
set boundary $v
}
puts -nonewline $channel ";\n $k=\"$v\""
}
set converter {}
set encoding {}
if {$state(value) ne "parts"} {
puts $channel {}
if {$state(canonicalP)} {
if {[set encoding $state(encoding)] eq {}} {
set encoding [encoding $token]
}
if {$encoding ne {}} {
puts $channel "Content-Transfer-Encoding: $encoding"
}
switch -- $encoding {
base64
-
quoted-printable {
set converter $encoding
}
7bit - 8bit - binary - {} {
# Bugfix for [#477088], also [#539952]
# Go ahead
}
default {
error "Can't handle content encoding \"$encoding\""
}
}
}
} elseif {([string match multipart/* $state(content)]) \
&& ($boundary eq {})} {
# we're doing everything in one pass...
set key [clock seconds]$token[info hostname][array get state]
set seqno 8
while {[incr seqno -1] >= 0} {
set key [md5 -- $key]
}
set boundary "----- =_[string trim [base64 -mode encode -- $key]]"
puts $channel ";\n boundary=\"$boundary\""
} else {
puts $channel {}
}
if {[info exists state(error)]} {
unset state(error)
}
switch -- $state(value) {
file {
set closeP 1
if {[info exists state(root)]} {
# FRINK: nocheck
variable $state(root)
upvar 0 $state(root) root
if {[info exists root(fd)]} {
set fd $root(fd)
set closeP 0
} else {
set fd [set state(fd) [open $state(file) RDONLY]]
}
set size $state(count)
} else {
set fd [set state(fd) [open $state(file) RDONLY]]
# read until eof
set size -1
}
seek $fd $state(offset) start
if {$closeP} {
fconfigure $fd -translation binary
}
puts $channel {}
while {($size != 0) && (![eof $fd])} {
if {$size < 0 || $size > 32766} {
set X [read $fd 32766]
} else {
set X [read $fd $size]
}
if {$size > 0} {
set size [expr {$size - [string length $X]}]
}
if {$converter eq {}} {
puts -nonewline $channel $X
} else {
puts -nonewline $channel [$converter -mode encode -- $X]
}
}
if {$closeP} {
catch {close $state(fd)}
unset state(fd)
}
}
parts {
if {(![info exists state(root)]) \
&& ([info exists state(file)])} {
set state(fd) [open $state(file) RDONLY]
fconfigure $state(fd) -translation binary
}
switch -glob -- $state(content) {
message/* {
puts $channel {}
foreach part $state(parts) {
mime::copymessage $part $channel
break
}
}
default {
# Note RFC 2046: See buildmessageaux for details.
foreach part $state(parts) {
puts $channel \n--$boundary
mime::copymessage $part $channel
}
puts $channel \n--$boundary--
}
}
if {[info exists state(fd)]} {
catch {close $state(fd)}
unset state(fd)
}
}
string {
if {[catch {fconfigure $channel -buffersize} blocksize]} {
set blocksize 4096
} elseif {$blocksize < 512} {
set blocksize 512
}
set blocksize [expr {($blocksize / 4) * 3}]
# [893516]
fconfigure $channel -buffersize $blocksize
puts $channel {}
#TODO: tests don't cover these paths
if {$converter eq {}} {
puts -nonewline $channel $state(string)
} else {
puts -nonewline $channel [$converter -mode encode -- $state(string)]
}
}
default {
error "Unknown value \"$state(value)\""
}
}
flush $channel
if {[info exists state(error)]} {
error $state(error)
}
}
# ::mime::buildmessage --
#
# The following is a clone of the copymessage code to build up the
# result in memory, and, unfortunately, without using a memory channel.
# I considered parameterizing the "puts" calls in copy message, but
# the need for this procedure may go away, so I'm living with it for
# the moment.
#
# Arguments:
# token The MIME token to parse.
#
# Results:
# Returns the message that has been built up in memory.
proc ::mime::buildmessage {token} {
global errorCode errorInfo
# FRINK: nocheck
variable $token
upvar 0 $token state
set openP [info exists state(fd)]
set code [catch {mime::buildmessageaux $token} result]
if {![info exists errorCode]} {
set ecode {}
} else {
set ecode $errorCode
}
set einfo $errorInfo
if {(!$openP) && ([info exists state(fd)])} {
if {![info exists state(root)]} {
catch {close $state(fd)}
}
unset state(fd)
}
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
# ::mime::buildmessageaux --
#
# The following is a clone of the copymessageaux code to build up the
# result in memory, and, unfortunately, without using a memory channel.
# I considered parameterizing the "puts" calls in copy message, but
# the need for this procedure may go away, so I'm living with it for
# the moment.
#
# Arguments:
# token The MIME token to parse.
#
# Results:
# Returns the message that has been built up in memory.
proc ::mime::buildmessageaux {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
array set header $state(header)
set result {}
if {$state(version) ne {}} {
append result "MIME-Version: $state(version)\r\n"
}
foreach lower $state(lowerL) mixed $state(mixedL) {
foreach value $header($lower) {
append result "$mixed: $value\r\n"
}
}
if {(!$state(canonicalP)) \
&& ([set encoding $state(encoding)] ne {})} {
append result "Content-Transfer-Encoding: $encoding\r\n"
}
append result "Content-Type: $state(content)"
set boundary {}
foreach {k v} $state(params) {
if {$k eq "boundary"} {
set boundary $v
}
append result ";\r\n $k=\"$v\""
}
set converter {}
set encoding {}
if {$state(value) ne "parts"} {
#TODO: the path is not covered by tests
append result \r\n
if {$state(canonicalP)} {
if {[set encoding $state(encoding)] eq {}} {
set encoding [encoding $token]
}
if {$encoding ne {}} {
append result "Content-Transfer-Encoding: $encoding\r\n"
}
switch -- $encoding {
base64
-
quoted-printable {
set converter $encoding
}
7bit - 8bit - binary - {} {
# Bugfix for [#477088]
# Go ahead
}
default {
error "Can't handle content encoding \"$encoding\""
}
}
}
} elseif {([string match multipart/* $state(content)]) \
&& ($boundary eq {})} {
# we're doing everything in one pass...
set key [clock seconds]$token[info hostname][array get state]
set seqno 8
while {[incr seqno -1] >= 0} {
set key [md5 -- $key]
}
set boundary "----- =_[string trim [base64 -mode encode -- $key]]"
append result ";\r\n boundary=\"$boundary\"\r\n"
} else {
append result \r\n
}
if {[info exists state(error)]} {
unset state(error)
}
switch -- $state(value) {
file {
set closeP 1
if {[info exists state(root)]} {
# FRINK: nocheck
variable $state(root)
upvar 0 $state(root) root
if {[info exists root(fd)]} {
set fd $root(fd)
set closeP 0
} else {
set fd [set state(fd) [open $state(file) RDONLY]]
}
set size $state(count)
} else {
set fd [set state(fd) [open $state(file) RDONLY]]
set size -1 ;# Read until EOF
}
seek $fd $state(offset) start
if {$closeP} {
fconfigure $fd -translation binary
}
append result \r\n
while {($size != 0) && (![eof $fd])} {
if {$size < 0 || $size > 32766} {
set X [read $fd 32766]
} else {
set X [read $fd $size]
}
if {$size > 0} {
set size [expr {$size - [string length $X]}]
}
if {$converter ne {}} {
append result [$converter -mode encode -- $X]
} else {
append result $X
}
}
if {$closeP} {
catch {close $state(fd)}
unset state(fd)
}
}
parts {
if {(![info exists state(root)]) \
&& ([info exists state(file)])} {
set state(fd) [open $state(file) RDONLY]
fconfigure $state(fd) -translation binary
}
switch -glob -- $state(content) {
message/* {
append result "\r\n"
foreach part $state(parts) {
append result [buildmessage $part]
break
}
}
default {
# Note RFC 2046:
#
# The boundary delimiter MUST occur at the
# beginning of a line, i.e., following a CRLF, and
# the initial CRLF is considered to be attached to
# the boundary delimiter line rather than part of
# the preceding part.
#
# - The above means that the CRLF before $boundary
# is needed per the RFC, and the parts must not
# have a closing CRLF of their own. See Tcllib bug
# 1213527, and patch 1254934 for the problems when
# both file/string brnaches added CRLF after the
# body parts.
foreach part $state(parts) {
append result "\r\n--$boundary\r\n"
append result [buildmessage $part]
}
append result "\r\n--$boundary--\r\n"
}
}
if {[info exists state(fd)]} {
catch {close $state(fd)}
unset state(fd)
}
}
string {
append result "\r\n"
if {$converter ne {}} {
append result [$converter -mode encode -- $state(string)]
} else {
append result $state(string)
}
}
default {
error "Unknown value \"$state(value)\""
}
}
if {[info exists state(error)]} {
error $state(error)
}
return $result
}
# ::mime::encoding --
#
# Determines how a token is encoded.
#
# Arguments:
# token The MIME token to parse.
#
# Results:
# Returns the encoding of the message (the null string, base64,
# or quoted-printable).
proc ::mime::encoding {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
switch -glob -- $state(content) {
audio/*
-
image/*
-
video/* {
return base64
}
message/*
-
multipart/* {
return {}
}
default {# Skip}
}
set asciiP 1
set lineP 1
switch -- $state(value) {
file {
set fd [open $state(file) RDONLY]
fconfigure $fd -translation binary
while {[gets $fd line] >= 0} {
if {$asciiP} {
set asciiP [encodingasciiP $line]
}
if {$lineP} {
set lineP [encodinglineP $line]
}
if {(!$asciiP) && (!$lineP)} {
break
}
}
catch {close $fd}
}
parts {
return {}
}
string {
foreach line [split $state(string) "\n"] {
if {$asciiP} {
set asciiP [encodingasciiP $line]
}
if {$lineP} {
set lineP [encodinglineP $line]
}
if {(!$asciiP) && (!$lineP)} {
break
}
}
}
default {
error "Unknown value \"$state(value)\""
}
}
switch -glob -- $state(content) {
text/* {
if {!$asciiP} {
#TODO: this path is not covered by tests
foreach {k v} $state(params) {
if {$k eq "charset"} {
set v [string tolower $v]
if {($v ne "us-ascii") \
&& (![string match {iso-8859-[1-8]} $v])} {
return base64
}
break
}
}
}
if {!$lineP} {
return quoted-printable
}
}
default {
if {(!$asciiP) || (!$lineP)} {
return base64
}
}
}
return {}
}
# ::mime::encodingasciiP --
#
# Checks if a string is a pure ascii string, or if it has a non-standard
# form.
#
# Arguments:
# line The line to check.
#
# Results:
# Returns 1 if \r only occurs at the end of lines, and if all
# characters in the line are between the ASCII codes of 32 and 126.
proc ::mime::encodingasciiP {line} {
foreach c [split $line {}] {
switch -- $c {
{ } - \t - \r - \n {
}
default {
binary scan $c c c
if {($c < 32) || ($c > 126)} {
return 0
}
}
}
}
if {([set r [string first \r $line]] < 0) \
|| ($r == {[string length $line] - 1})} {
return 1
}
return 0
}
# ::mime::encodinglineP --
#
# Checks if a string is a line is valid to be processed.
#
# Arguments:
# line The line to check.
#
# Results:
# Returns 1 the line is less than 76 characters long, the line
# contains more characters than just whitespace, the line does
# not start with a '.', and the line does not start with 'From '.
proc ::mime::encodinglineP {line} {
if {([string length $line] > 76) \
|| ($line ne [string trimright $line]) \
|| ([string first . $line] == 0) \
|| ([string first {From } $line] == 0)} {
return 0
}
return 1
}
# ::mime::fcopy --
#
# Appears to be unused.
#
# Arguments:
#
# Results:
#
proc ::mime::fcopy {token count {error {}}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
if {$error ne {}} {
set state(error) $error
}
set state(doneP) 1
}
# ::mime::scopy --
#
# Copy a portion of the contents of a mime token to a channel.
#
# Arguments:
# token The token containing the data to copy.
# channel The channel to write the data to.
# offset The location in the string to start copying
# from.
# len The amount of data to write.
# blocksize The block size for the write operation.
#
# Results:
# The specified portion of the string in the mime token is
# copied to the specified channel.
proc ::mime::scopy {token channel offset len blocksize} {
# FRINK: nocheck
variable $token
upvar 0 $token state
if {$len <= 0} {
set state(doneP) 1
fileevent $channel writable {}
return
}
if {[set cc $len] > $blocksize} {
set cc $blocksize
}
if {[catch {
puts -nonewline $channel [
string range $state(string) $offset [expr {$offset + $cc - 1}]]
fileevent $channel writable [
list mime::scopy $token $channel [
incr offset $cc] [incr len -$cc] $blocksize]
} result]} {
set state(error) $result
set state(doneP) 1
fileevent $channel writable {}
}
return
}
# ::mime::qp_encode --
#
# Tcl version of quote-printable encode
#
# Arguments:
# string The string to quote.
# encoded_word Boolean value to determine whether or not encoded words
# (RFC 2047) should be handled or not. (optional)
#
# Results:
# The properly quoted string is returned.
proc ::mime::qp_encode {string {encoded_word 0} {no_softbreak 0}} {
# 8.1+ improved string manipulation routines used.
# Replace outlying characters, characters that would normally
# be munged by EBCDIC gateways, and special Tcl characters "[\]{}
# with =xx sequence
regsub -all -- \
{[\x00-\x08\x0B-\x1E\x21-\x24\x3D\x40\x5B-\x5E\x60\x7B-\xFF]} \
$string {[format =%02X [scan "\\&" %c]]} string
# Replace the format commands with their result
set string [subst -novariables $string]
# soft/hard newlines and other
# Funky cases for SMTP compatibility
set mapChars [
list " \n" =20\n \t\n =09\n \n\.\n \=2E\n "\nFrom " "\n=46rom "]
if {$encoded_word} {
# Special processing for encoded words (RFC 2047)
lappend mapChars { } _
}
set string [string map $mapChars $string]
# Break long lines - ugh
# Implementation of FR #503336
if {$no_softbreak} {
set result $string
} else {
set result {}
foreach line [split $string \n] {
while {[string length $line] > 72} {
set chunk [string range $line 0 72]
if {[regexp -- (=|=.)$ $chunk dummy end]} {
# Don't break in the middle of a code
set len [expr {72 - [string length $end]}]
set chunk [string range $line 0 $len]
incr len
set line [string range $line $len end]
} else {
set line [string range $line 73 end]
}
append result $chunk=\n
}
append result $line\n
}
# Trim off last \n, since the above code has the side-effect
# of adding an extra \n to the encoded string and return the
# result.
set result [string range $result 0 end-1]
}
# If the string ends in space or tab, replace with =xx
set lastChar [string index $result end]
if {$lastChar eq { }} {
set result [string replace $result end end =20]
} elseif {$lastChar eq "\t"} {
set result [string replace $result end end =09]
}
return $result
}
# ::mime::qp_decode --
#
# Tcl version of quote-printable decode
#
# Arguments:
# string The quoted-prinatble string to decode.
# encoded_word Boolean value to determine whether or not encoded words
# (RFC 2047) should be handled or not. (optional)
#
# Results:
# The decoded string is returned.
proc ::mime::qp_decode {string {encoded_word 0}} {
# 8.1+ improved string manipulation routines used.
# Special processing for encoded words (RFC 2047)
if {$encoded_word} {
# _ == \x20, even if SPACE occupies a different code position
set string [string map [list _ \u0020] $string]
}
# smash the white-space at the ends of lines since that must've been
# generated by an MUA.
regsub -all -- {[ \t]+\n} $string \n string
set string [string trimright $string " \t"]
# Protect the backslash for later subst and
# smash soft newlines, has to occur after white-space smash
# and any encoded word modification.
#TODO: codepath not tested
set string [string map [list \\ {\\} =\n {}] $string]
# Decode specials
regsub -all -nocase {=([a-f0-9][a-f0-9])} $string {\\u00\1} string
# process \u unicode mapped chars
return [subst -novariables -nocommands $string]
}
# ::mime::parseaddress --
#
# This was originally written circa 1982 in C. we're still using it
# because it recognizes virtually every buggy address syntax ever
# generated!
#
# mime::parseaddress takes a string containing one or more 822-style
# address specifications and returns a list of serialized arrays, one
# element for each address specified in the argument.
#
# Each serialized array contains these properties:
#
# property value
# ======== =====
# address local@domain
# comment 822-style comment
# domain the domain part (rhs)
# error non-empty on a parse error
# group this address begins a group
# friendly user-friendly rendering
# local the local part (lhs)
# memberP this address belongs to a group
# phrase the phrase part
# proper 822-style address specification
# route 822-style route specification (obsolete)
#
# Note that one or more of these properties may be empty.
#
# Arguments:
# string The address string to parse
#
# Results:
# Returns a list of serialized arrays, one element for each address
# specified in the argument.
proc ::mime::parseaddress {string} {
global errorCode errorInfo
variable mime
set token [namespace current]::[incr mime(uid)]
# FRINK: nocheck
variable $token
upvar 0 $token state
set code [catch {mime::parseaddressaux $token $string} result]
set ecode $errorCode
set einfo $errorInfo
foreach name [array names state] {
unset state($name)
}
# FRINK: nocheck
catch {unset $token}
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
# ::mime::parseaddressaux --
#
# This was originally written circa 1982 in C. we're still using it
# because it recognizes virtually every buggy address syntax ever
# generated!
#
# mime::parseaddressaux does the actually parsing for mime::parseaddress
#
# Each serialized array contains these properties:
#
# property value
# ======== =====
# address local@domain
# comment 822-style comment
# domain the domain part (rhs)
# error non-empty on a parse error
# group this address begins a group
# friendly user-friendly rendering
# local the local part (lhs)
# memberP this address belongs to a group
# phrase the phrase part
# proper 822-style address specification
# route 822-style route specification (obsolete)
#
# Note that one or more of these properties may be empty.
#
# Arguments:
# token The MIME token to work from.
# string The address string to parse
#
# Results:
# Returns a list of serialized arrays, one element for each address
# specified in the argument.
proc ::mime::parseaddressaux {token string} {
# FRINK: nocheck
variable $token
upvar 0 $token state
variable addrtokenL
variable addrlexemeL
set state(input) $string
set state(glevel) 0
set state(buffer) {}
set state(lastC) LX_END
set state(tokenL) $addrtokenL
set state(lexemeL) $addrlexemeL
set result {}
while {[addr_next $token]} {
if {[set tail $state(domain)] ne {}} {
set tail @$state(domain)
} else {
set tail @[info hostname]
}
if {[set address $state(local)] ne {}} {
#TODO: this path is not covered by tests
append address $tail
}
if {$state(phrase) ne {}} {
#TODO: this path is not covered by tests
set state(phrase) [string trim $state(phrase) \"]
foreach t $state(tokenL) {
if {[string first $t $state(phrase)] >= 0} {
#TODO: is this quoting robust enough?
set state(phrase) \"$state(phrase)\"
break
}
}
set proper "$state(phrase) <$address>"
} else {
set proper $address
}
if {[set friendly $state(phrase)] eq {}} {
#TODO: this path is not covered by tests
if {[set note $state(comment)] ne {}} {
if {[string first ( $note] == 0} {
set note [string trimleft [string range $note 1 end]]
}
if {[string last ) $note] \
== [set len [expr {[string length $note] - 1}]]} {
set note [string range $note 0 [expr {$len - 1}]]
}
set friendly $note
}
if {($friendly eq {}) \
&& ([set mbox $state(local)] ne {})} {
#TODO: this path is not covered by tests
set mbox [string trim $mbox \"]
if {[string first / $mbox] != 0} {
set friendly $mbox
} elseif {[set friendly [addr_x400 $mbox PN]] ne {}} {
} elseif {([set friendly [addr_x400 $mbox S]] ne {}) \
&& ([set g [addr_x400 $mbox G]] ne {})} {
set friendly "$g $friendly"
}
if {$friendly eq {}} {
set friendly $mbox
}
}
}
set friendly [string trim $friendly \"]
lappend result [list address $address \
comment $state(comment) \
domain $state(domain) \
error $state(error) \
friendly $friendly \
group $state(group) \
local $state(local) \
memberP $state(memberP) \
phrase $state(phrase) \
proper $proper \
route $state(route)]
}
unset state(input) \
state(glevel) \
state(buffer) \
state(lastC) \
state(tokenL) \
state(lexemeL)
return $result
}
# ::mime::addr_next --
#
# Locate the next address in a mime token.
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns 1 if there is another address, and 0 if there is not.
proc ::mime::addr_next {token} {
global errorCode errorInfo
# FRINK: nocheck
variable $token
upvar 0 $token state
set nocomplain [package vsatisfies [package provide Tcl] 8.4]
foreach prop {comment domain error group local memberP phrase route} {
if {$nocomplain} {
unset -nocomplain state($prop)
} else {
if {[catch {unset state($prop)}]} {set ::errorInfo {}}
}
}
switch -- [set code [catch {mime::addr_specification $token} result]] {
0 {
if {!$result} {
return 0
}
switch -- $state(lastC) {
LX_COMMA
-
LX_END {
}
default {
# catch trailing comments...
set lookahead $state(input)
mime::parselexeme $token
set state(input) $lookahead
}
}
}
7 {
set state(error) $result
while {1} {
switch -- $state(lastC) {
LX_COMMA
-
LX_END {
break
}
default {
mime::parselexeme $token
}
}
}
}
default {
set ecode $errorCode
set einfo $errorInfo
return -code $code -errorinfo $einfo -errorcode $ecode $result
}
}
foreach prop {comment domain error group local memberP phrase route} {
if {![info exists state($prop)]} {
set state($prop) {}
}
}
return 1
}
# ::mime::addr_specification --
#
# Uses lookahead parsing to determine whether there is another
# valid e-mail address or not. Throws errors if unrecognized
# or invalid e-mail address syntax is used.
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns 1 if there is another address, and 0 if there is not.
proc ::mime::addr_specification {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set lookahead $state(input)
switch -- [parselexeme $token] {
LX_ATOM
-
LX_QSTRING {
set state(phrase) $state(buffer)
}
LX_SEMICOLON {
if {[incr state(glevel) -1] < 0} {
return -code 7 "extraneous semi-colon"
}
catch {unset state(comment)}
return [addr_specification $token]
}
LX_COMMA {
catch {unset state(comment)}
return [addr_specification $token]
}
LX_END {
return 0
}
LX_LBRACKET {
return [addr_routeaddr $token]
}
LX_ATSIGN {
set state(input) $lookahead
return [addr_routeaddr $token 0]
}
default {
return -code 7 \
[format "unexpected character at beginning (found %s)" \
$state(buffer)]
}
}
switch -- [parselexeme $token] {
LX_ATOM
-
LX_QSTRING {
append state(phrase) " " $state(buffer)
return [addr_phrase $token]
}
LX_LBRACKET {
return [addr_routeaddr $token]
}
LX_COLON {
return [addr_group $token]
}
LX_DOT {
set state(local) "$state(phrase)$state(buffer)"
unset state(phrase)
mime::addr_routeaddr $token 0
mime::addr_end $token
}
LX_ATSIGN {
set state(memberP) $state(glevel)
set state(local) $state(phrase)
unset state(phrase)
mime::addr_domain $token
mime::addr_end $token
}
LX_SEMICOLON
-
LX_COMMA
-
LX_END {
set state(memberP) $state(glevel)
if {($state(lastC) eq "LX_SEMICOLON") \
&& ([incr state(glevel) -1] < 0)} {
#TODO: this path is not covered by tests
return -code 7 "extraneous semi-colon"
}
set state(local) $state(phrase)
unset state(phrase)
}
default {
return -code 7 [
format "expecting mailbox (found %s)" $state(buffer)]
}
}
return 1
}
# ::mime::addr_routeaddr --
#
# Parses the domain portion of an e-mail address. Finds the '@'
# sign and then calls mime::addr_route to verify the domain.
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns 1 if there is another address, and 0 if there is not.
proc ::mime::addr_routeaddr {token {checkP 1}} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set lookahead $state(input)
if {[parselexeme $token] eq "LX_ATSIGN"} {
#TODO: this path is not covered by tests
mime::addr_route $token
} else {
set state(input) $lookahead
}
mime::addr_local $token
switch -- $state(lastC) {
LX_ATSIGN {
mime::addr_domain $token
}
LX_SEMICOLON
-
LX_RBRACKET
-
LX_COMMA
-
LX_END {
}
default {
return -code 7 [
format "expecting at-sign after local-part (found %s)" \
$state(buffer)]
}
}
if {($checkP) && ($state(lastC) ne "LX_RBRACKET")} {
return -code 7 [
format "expecting right-bracket (found %s)" $state(buffer)]
}
return 1
}
# ::mime::addr_route --
#
# Attempts to parse the portion of the e-mail address after the @.
# Tries to verify that the domain definition has a valid form.
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_route {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set state(route) @
while {1} {
switch -- [parselexeme $token] {
LX_ATOM
-
LX_DLITERAL {
append state(route) $state(buffer)
}
default {
return -code 7 \
[format "expecting sub-route in route-part (found %s)" \
$state(buffer)]
}
}
switch -- [parselexeme $token] {
LX_COMMA {
append state(route) $state(buffer)
while {1} {
switch -- [parselexeme $token] {
LX_COMMA {
}
LX_ATSIGN {
append state(route) $state(buffer)
break
}
default {
return -code 7 \
[format "expecting at-sign in route (found %s)" \
$state(buffer)]
}
}
}
}
LX_ATSIGN
-
LX_DOT {
append state(route) $state(buffer)
}
LX_COLON {
append state(route) $state(buffer)
return
}
default {
return -code 7 \
[format "expecting colon to terminate route (found %s)" \
$state(buffer)]
}
}
}
}
# ::mime::addr_domain --
#
# Attempts to parse the portion of the e-mail address after the @.
# Tries to verify that the domain definition has a valid form.
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_domain {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
while {1} {
switch -- [parselexeme $token] {
LX_ATOM
-
LX_DLITERAL {
append state(domain) $state(buffer)
}
default {
return -code 7 \
[format "expecting sub-domain in domain-part (found %s)" \
$state(buffer)]
}
}
switch -- [parselexeme $token] {
LX_DOT {
append state(domain) $state(buffer)
}
LX_ATSIGN {
append state(local) % $state(domain)
unset state(domain)
}
default {
return
}
}
}
}
# ::mime::addr_local --
#
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_local {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set state(memberP) $state(glevel)
while {1} {
switch -- [parselexeme $token] {
LX_ATOM
-
LX_QSTRING {
append state(local) $state(buffer)
}
default {
return -code 7 \
[format "expecting mailbox in local-part (found %s)" \
$state(buffer)]
}
}
switch -- [parselexeme $token] {
LX_DOT {
append state(local) $state(buffer)
}
default {
return
}
}
}
}
# ::mime::addr_phrase --
#
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_phrase {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
while {1} {
switch -- [parselexeme $token] {
LX_ATOM
-
LX_QSTRING {
append state(phrase) " " $state(buffer)
}
default {
break
}
}
}
switch -- $state(lastC) {
LX_LBRACKET {
return [addr_routeaddr $token]
}
LX_COLON {
return [addr_group $token]
}
LX_DOT {
append state(phrase) $state(buffer)
return [addr_phrase $token]
}
default {
return -code 7 \
[format "found phrase instead of mailbox (%s%s)" \
$state(phrase) $state(buffer)]
}
}
}
# ::mime::addr_group --
#
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_group {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
if {[incr state(glevel)] > 1} {
return -code 7 [format "nested groups not allowed (found %s)" \
$state(phrase)]
}
set state(group) $state(phrase)
unset state(phrase)
set lookahead $state(input)
while {1} {
switch -- [parselexeme $token] {
LX_SEMICOLON
-
LX_END {
set state(glevel) 0
return 1
}
LX_COMMA {
}
default {
set state(input) $lookahead
return [addr_specification $token]
}
}
}
}
# ::mime::addr_end --
#
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_end {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
switch -- $state(lastC) {
LX_SEMICOLON {
if {[incr state(glevel) -1] < 0} {
return -code 7 "extraneous semi-colon"
}
}
LX_COMMA
-
LX_END {
}
default {
return -code 7 [format "junk after local@domain (found %s)" \
$state(buffer)]
}
}
}
# ::mime::addr_x400 --
#
#
# Arguments:
# token The MIME token to work from.
#
# Results:
# Returns nothing if successful, and throws an error if invalid
# syntax is found.
proc ::mime::addr_x400 {mbox key} {
if {[set x [string first /$key= [string toupper $mbox]]] < 0} {
return {}
}
set mbox [string range $mbox [expr {$x + [string length $key] + 2}] end]
if {[set x [string first / $mbox]] > 0} {
set mbox [string range $mbox 0 [expr {$x - 1}]]
}
return [string trim $mbox \"]
}
# ::mime::parsedatetime --
#
# Fortunately the clock command in the Tcl 8.x core does all the heavy
# lifting for us (except for timezone calculations).
#
# mime::parsedatetime takes a string containing an 822-style date-time
# specification and returns the specified property.
#
# The list of properties and their ranges are:
#
# property range
# ======== =====
# clock raw result of "clock scan"
# hour 0 .. 23
# lmonth January, February, ..., December
# lweekday Sunday, Monday, ... Saturday
# mday 1 .. 31
# min 0 .. 59
# mon 1 .. 12
# month Jan, Feb, ..., Dec
# proper 822-style date-time specification
# rclock elapsed seconds between then and now
# sec 0 .. 59
# wday 0 .. 6 (Sun .. Mon)
# weekday Sun, Mon, ..., Sat
# yday 1 .. 366
# year 1900 ...
# zone -720 .. 720 (minutes east of GMT)
#
# Arguments:
# value Either a 822-style date-time specification or '-now'
# if the current date/time should be used.
# property The property (from the list above) to return
#
# Results:
# Returns the string value of the 'property' for the date/time that was
# specified in 'value'.
namespace eval ::mime {
variable WDAYS_SHORT [list Sun Mon Tue Wed Thu Fri Sat]
variable WDAYS_LONG [list Sunday Monday Tuesday Wednesday Thursday \
Friday Saturday]
# Counting months starts at 1, so just insert a dummy element
# at index 0.
variable MONTHS_SHORT [list {} \
Jan Feb Mar Apr May Jun \
Jul Aug Sep Oct Nov Dec]
variable MONTHS_LONG [list {} \
January February March April May June July \
August Sepember October November December]
}
proc ::mime::parsedatetime {value property} {
if {$value eq "-now"} {
set clock [clock seconds]
} elseif {[regexp {^(.*) ([+-])([0-9][0-9])([0-9][0-9])$} $value \
-> value zone_sign zone_hour zone_min]} {
set clock [clock scan $value -gmt 1]
if {[info exists zone_min]} {
set zone_min [scan $zone_min %d]
set zone_hour [scan $zone_hour %d]
set zone [expr {60 * ($zone_min + 60 * $zone_hour)}]
if {$zone_sign eq "+"} {
set zone -$zone
}
incr clock $zone
}
} else {
set clock [clock scan $value]
}
switch -- $property {
clock {
return $clock
}
hour {
set value [clock format $clock -format %H]
}
lmonth {
variable MONTHS_LONG
return [lindex $MONTHS_LONG \
[scan [clock format $clock -format %m] %d]]
}
lweekday {
variable WDAYS_LONG
return [lindex $WDAYS_LONG [clock format $clock -format %w]]
}
mday {
set value [clock format $clock -format %d]
}
min {
set value [clock format $clock -format %M]
}
mon {
set value [clock format $clock -format %m]
}
month {
variable MONTHS_SHORT
return [lindex $MONTHS_SHORT \
[scan [clock format $clock -format %m] %d]]
}
proper {
set gmt [clock format $clock -format "%Y-%m-%d %H:%M:%S" \
-gmt true]
if {[set diff [expr {($clock-[clock scan $gmt]) / 60}]] < 0} {
set s -
set diff [expr {-($diff)}]
} else {
set s +
}
set zone [format %s%02d%02d $s [
expr {$diff / 60}] [expr {$diff % 60}]]
variable WDAYS_SHORT
set wday [lindex $WDAYS_SHORT [clock format $clock -format %w]]
variable MONTHS_SHORT
set mon [lindex $MONTHS_SHORT \
[scan [clock format $clock -format %m] %d]]
return [clock format $clock \
-format "$wday, %d $mon %Y %H:%M:%S $zone"]
}
rclock {
#TODO: these paths are not covered by tests
if {$value eq "-now"} {
return 0
} else {
return [expr {[clock seconds] - $clock}]
}
}
sec {
set value [clock format $clock -format %S]
}
wday {
return [clock format $clock -format %w]
}
weekday {
variable WDAYS_SHORT
return [lindex $WDAYS_SHORT [clock format $clock -format %w]]
}
yday {
set value [clock format $clock -format %j]
}
year {
set value [clock format $clock -format %Y]
}
zone {
set value [string trim [string map [list \t { }] $value]]
if {[set x [string last { } $value]] < 0} {
return 0
}
set value [string range $value [expr {$x + 1}] end]
switch -- [set s [string index $value 0]] {
+ - - {
if {$s eq "+"} {
#TODO: This path is not covered by tests
set s {}
}
set value [string trim [string range $value 1 end]]
if {([string length $value] != 4) \
|| ([scan $value %2d%2d h m] != 2) \
|| ($h > 12) \
|| ($m > 59) \
|| (($h == 12) && ($m > 0))} {
error "malformed timezone-specification: $value"
}
set value $s[expr {$h * 60 + $m}]
}
default {
set value [string toupper $value]
set z1 [list UT GMT EST EDT CST CDT MST MDT PST PDT]
set z2 [list 0 0 -5 -4 -6 -5 -7 -6 -8 -7]
if {[set x [lsearch -exact $z1 $value]] < 0} {
error "unrecognized timezone-mnemonic: $value"
}
set value [expr {[lindex $z2 $x] * 60}]
}
}
}
date2gmt
-
date2local
-
dst
-
sday
-
szone
-
tzone
-
default {
error "unknown property $property"
}
}
if {[set value [string trimleft $value 0]] eq {}} {
#TODO: this path is not covered by tests
set value 0
}
return $value
}
# ::mime::uniqueID --
#
# Used to generate a 'globally unique identifier' for the content-id.
# The id is built from the pid, the current time, the hostname, and
# a counter that is incremented each time a message is sent.
#
# Arguments:
#
# Results:
# Returns the a string that contains the globally unique identifier
# that should be used for the Content-ID of an e-mail message.
proc ::mime::uniqueID {} {
variable mime
return "<[pid].[clock seconds].[incr mime(cid)]@[info hostname]>"
}
# ::mime::parselexeme --
#
# Used to implement a lookahead parser.
#
# Arguments:
# token The MIME token to operate on.
#
# Results:
# Returns the next token found by the parser.
proc ::mime::parselexeme {token} {
# FRINK: nocheck
variable $token
upvar 0 $token state
set state(input) [string trimleft $state(input)]
set state(buffer) {}
if {$state(input) eq {}} {
set state(buffer) end-of-input
return [set state(lastC) LX_END]
}
set c [string index $state(input) 0]
set state(input) [string range $state(input) 1 end]
if {$c eq "("} {
set noteP 0
set quoteP 0
while 1 {
append state(buffer) $c
#TODO: some of these paths are not covered by tests
switch -- $c/$quoteP {
(/0 {
incr noteP
}
\\/0 {
set quoteP 1
}
)/0 {
if {[incr noteP -1] < 1} {
if {[info exists state(comment)]} {
append state(comment) { }
}
append state(comment) $state(buffer)
return [parselexeme $token]
}
}
default {
set quoteP 0
}
}
if {[set c [string index $state(input) 0]] eq {}} {
set state(buffer) "end-of-input during comment"
return [set state(lastC) LX_ERR]
}
set state(input) [string range $state(input) 1 end]
}
}
if {$c eq "\""} {
set firstP 1
set quoteP 0
while 1 {
append state(buffer) $c
switch -- $c/$quoteP {
"\\/0" {
set quoteP 1
}
"\"/0" {
if {!$firstP} {
return [set state(lastC) LX_QSTRING]
}
set firstP 0
}
default {
set quoteP 0
}
}
if {[set c [string index $state(input) 0]] eq {}} {
set state(buffer) "end-of-input during quoted-string"
return [set state(lastC) LX_ERR]
}
set state(input) [string range $state(input) 1 end]
}
}
if {$c eq {[}} {
set quoteP 0
while 1 {
append state(buffer) $c
switch -- $c/$quoteP {
\\/0 {
set quoteP 1
}
]/0 {
return [set state(lastC) LX_DLITERAL]
}
default {
set quoteP 0
}
}
if {[set c [string index $state(input) 0]] eq {}} {
set state(buffer) "end-of-input during domain-literal"
return [set state(lastC) LX_ERR]
}
set state(input) [string range $state(input) 1 end]
}
}
if {[set x [lsearch -exact $state(tokenL) $c]] >= 0} {
append state(buffer) $c
return [set state(lastC) [lindex $state(lexemeL) $x]]
}
while {1} {
append state(buffer) $c
switch -- [set c [string index $state(input) 0]] {
{} - " " - "\t" - "\n" {
break
}
default {
if {[lsearch -exact $state(tokenL) $c] >= 0} {
break
}
}
}
set state(input) [string range $state(input) 1 end]
}
return [set state(lastC) LX_ATOM]
}
# ::mime::mapencoding --
#
# mime::mapencodings maps tcl encodings onto the proper names for their
# MIME charset type. This is only done for encodings whose charset types
# were known. The remaining encodings return {} for now.
#
# Arguments:
# enc The tcl encoding to map.
#
# Results:
# Returns the MIME charset type for the specified tcl encoding, or {}
# if none is known.
proc ::mime::mapencoding {enc} {
variable encodings
if {[info exists encodings($enc)]} {
return $encodings($enc)
}
return {}
}
# ::mime::reversemapencoding --
#
# mime::reversemapencodings maps MIME charset types onto tcl encoding names.
# Those that are unknown return {}.
#
# Arguments:
# mimeType The MIME charset to convert into a tcl encoding type.
#
# Results:
# Returns the tcl encoding name for the specified mime charset, or {}
# if none is known.
proc ::mime::reversemapencoding {mimeType} {
variable reversemap
set lmimeType [string tolower $mimeType]
if {[info exists reversemap($lmimeType)]} {
return $reversemap($lmimeType)
}
return {}
}
# ::mime::word_encode --
#
# Word encodes strings as per RFC 2047.
#
# Arguments:
# charset The character set to encode the message to.
# method The encoding method (base64 or quoted-printable).
# string The string to encode.
# ?-charset_encoded 0 or 1 Whether the data is already encoded
# in the specified charset (default 1)
# ?-maxlength maxlength The maximum length of each encoded
# word to return (default 66)
#
# Results:
# Returns a word encoded string.
proc ::mime::word_encode {charset method string {args}} {
variable encodings
if {![info exists encodings($charset)]} {
error "unknown charset '$charset'"
}
if {$encodings($charset) eq {}} {
error "invalid charset '$charset'"
}
if {$method ne "base64" && $method ne "quoted-printable"} {
error "unknown method '$method', must be base64 or quoted-printable"
}
# default to encoded and a length that won't make the Subject header to long
array set options [list -charset_encoded 1 -maxlength 66]
array set options $args
if {$options(-charset_encoded)} {
set unencoded_string [::encoding convertfrom $charset $string]
} else {
set unencoded_string $string
}
set string_length [string length $unencoded_string]
if {!$string_length} {
return {}
}
set string_bytelength [string bytelength $unencoded_string]
# the 7 is for =?, ?Q?, ?= delimiters of the encoded word
set maxlength [expr {$options(-maxlength) - [string length $encodings($charset)] - 7}]
switch -exact -- $method {
base64 {
if {$maxlength < 4} {
error "maxlength $options(-maxlength) too short for chosen charset and encoding"
}
set count 0
set maxlength [expr {($maxlength / 4) * 3}]
while {$count < $string_length} {
set length 0
set enc_string {}
while {($length < $maxlength) && ($count < $string_length)} {
set char [string range $unencoded_string $count $count]
set enc_char [::encoding convertto $charset $char]
if {($length + [string length $enc_char]) > $maxlength} {
set length $maxlength
} else {
append enc_string $enc_char
incr count
incr length [string length $enc_char]
}
}
set encoded_word [string map [
list \n {}] [base64 -mode encode -- $enc_string]]
append result "=?$encodings($charset)?B?$encoded_word?=\n "
}
# Trim off last "\n ", since the above code has the side-effect
# of adding an extra "\n " to the encoded string.
set result [string range $result 0 end-2]
}
quoted-printable {
if {$maxlength < 1} {
error "maxlength $options(-maxlength) too short for chosen charset and encoding"
}
set count 0
while {$count < $string_length} {
set length 0
set encoded_word {}
while {($length < $maxlength) && ($count < $string_length)} {
set char [string range $unencoded_string $count $count]
set enc_char [::encoding convertto $charset $char]
set qp_enc_char [qp_encode $enc_char 1]
set qp_enc_char_length [string length $qp_enc_char]
if {$qp_enc_char_length > $maxlength} {
error "maxlength $options(-maxlength) too short for chosen charset and encoding"
}
if {($length + [
string length $qp_enc_char]) > $maxlength} {
set length $maxlength
} else {
append encoded_word $qp_enc_char
incr count
incr length [string length $qp_enc_char]
}
}
append result "=?$encodings($charset)?Q?$encoded_word?=\n "
}
# Trim off last "\n ", since the above code has the side-effect
# of adding an extra "\n " to the encoded string.
set result [string range $result 0 end-2]
}
{} {
# Go ahead
}
default {
error "Can't handle content encoding \"$method\""
}
}
return $result
}
# ::mime::word_decode --
#
# Word decodes strings that have been word encoded as per RFC 2047.
#
# Arguments:
# encoded The word encoded string to decode.
#
# Results:
# Returns the string that has been decoded from the encoded message.
proc ::mime::word_decode {encoded} {
variable reversemap
if {[regexp -- {=\?([^?]+)\?(.)\?([^?]*)\?=} $encoded \
- charset method string] != 1} {
error "malformed word-encoded expression '$encoded'"
}
set enc [reversemapencoding $charset]
if {$enc eq {}} {
error "unknown charset '$charset'"
}
switch -exact -- $method {
b -
B {
set method base64
}
q -
Q {
set method quoted-printable
}
default {
error "unknown method '$method', must be B or Q"
}
}
switch -exact -- $method {
base64 {
set result [base64 -mode decode -- $string]
}
quoted-printable {
set result [qp_decode $string 1]
}
{} {
# Go ahead
}
default {
error "Can't handle content encoding \"$method\""
}
}
return [list $enc $method $result]
}
# ::mime::field_decode --
#
# Word decodes strings that have been word encoded as per RFC 2047
# and converts the string from the original encoding/charset to UTF.
#
# Arguments:
# field The string to decode
#
# Results:
# Returns the decoded string in UTF.
proc ::mime::field_decode {field} {
# ::mime::field_decode is broken. Here's a new version.
# This code is in the public domain. Don Libes <don@libes.com>
# Step through a field for mime-encoded words, building a new
# version with unencoded equivalents.
# Sorry about the grotesque regexp. Most of it is sensible. One
# notable fudge: the final $ is needed because of an apparent bug
# in the regexp engine where the preceding .* otherwise becomes
# non-greedy - perhaps because of the earlier ".*?", sigh.
while {[regexp {(.*?)(=\?(?:[^?]+)\?(?:.)\?(?:[^?]*)\?=)(.*)$} $field ignore prefix encoded field]} {
# don't allow whitespace between encoded words per RFC 2047
if {{} != $prefix} {
if {![string is space $prefix]} {
append result $prefix
}
}
set decoded [word_decode $encoded]
foreach {charset - string} $decoded break
append result [::encoding convertfrom $charset $string]
}
append result $field
return $result
}
## One-Shot Initialization
::apply {{} {
variable encList
variable encAliasList
variable reversemap
foreach {enc mimeType} $encList {
if {$mimeType eq {}} continue
set reversemap([string tolower $mimeType]) $enc
}
foreach {enc mimeType} $encAliasList {
set reversemap([string tolower $mimeType]) $enc
}
# Drop the helper variables
unset encList encAliasList
} ::mime}
|