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
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
|
/*-
* Copyright 2016 Vsevolod Stakhov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include "lua_common.h"
#include "message.h"
#include "images.h"
#include "archives.h"
#include "utlist.h"
#include "unix-std.h"
#include "libmime/smtp_parsers.h"
#include "libserver/mempool_vars_internal.h"
#include "libserver/dkim.h"
#include "libserver/task.h"
#include "libserver/cfg_file_private.h"
#include "libmime/scan_result_private.h"
#include "libstat/stat_api.h"
#include "libutil/map_helpers.h"
#include <math.h>
/***
* @module rspamd_task
* This module provides routines for tasks manipulation in rspamd. Tasks usually
* represent messages being scanned, and this API provides access to such elements
* as headers, symbols, metrics and so on and so forth. Normally, task objects
* are passed to the lua callbacks allowing to check specific properties of messages
* and add the corresponding symbols to the scan's results.
@example
rspamd_config.DATE_IN_PAST = function(task)
local dm = task:get_date{format = 'message', gmt = true}
local dt = task:get_date{format = 'connect', gmt = true}
-- A day
if dt - dm > 86400 then
return true
end
return false
end
*/
/* Task methods */
/***
* @function rspamd_task.create([cfg])
* Create a new empty task
* @return {rspamd_task} new task
*/
LUA_FUNCTION_DEF (task, create);
/***
* @function rspamd_task.load_from_file(filename[, cfg])
* Loads a message from specific file
* @return {boolean,rspamd_task|error} status + new task or error message
*/
LUA_FUNCTION_DEF (task, load_from_file);
/***
* @function rspamd_task.load_from_string(message[, cfg])
* Loads a message from specific file
* @return {boolean,rspamd_task|error} status + new task or error message
*/
LUA_FUNCTION_DEF (task, load_from_string);
/***
* @method task:get_message()
* Returns task raw message content as opaque text
* @return {rspamd_text} task raw content
*/
LUA_FUNCTION_DEF (task, get_message);
/***
* @method task:set_message(msg)
* Updates task message with another message; It also parses a message to
* fill the internal structures.
* Input might be a string, a lua_text or a table of the former stuff.
* @param {string/text/table} msg new message to set
* @return {boolean,number} if a message has been set + its raw size
*/
LUA_FUNCTION_DEF (task, set_message);
/***
* @method task:process_message()
* Parses message
*/
LUA_FUNCTION_DEF (task, process_message);
/***
* @method task:get_cfg()
* Get configuration object for a task.
* @return {rspamd_config} (config.md)[configuration object] for the task
*/
LUA_FUNCTION_DEF (task, get_cfg);
LUA_FUNCTION_DEF (task, set_cfg);
LUA_FUNCTION_DEF (task, destroy);
/***
* @method task:get_mempool()
* Returns memory pool valid for a lifetime of task. It is used internally by
* many rspamd routines.
* @return {rspamd_mempool} memory pool object
*/
LUA_FUNCTION_DEF (task, get_mempool);
/***
* @method task:get_session()
* Returns asynchronous session object that is used by many rspamd asynchronous
* utilities internally.
* @return {rspamd_session} session object
*/
LUA_FUNCTION_DEF (task, get_session);
/***
* @method task:set_session(session)
* Sets new async session for a task
*/
LUA_FUNCTION_DEF (task, set_session);
/***
* @method task:get_ev_base()
* Return asynchronous event base for using in callbacks and resolver.
* @return {rspamd_ev_base} event base
*/
LUA_FUNCTION_DEF (task, get_ev_base);
/***
* @method task:get_worker()
* Returns a worker object associated with the task
* @return {rspamd_worker} worker object
*/
LUA_FUNCTION_DEF (task, get_worker);
/***
* @method task:insert_result([enforce_symbol,]symbol, weight[, option1, ...])
* Insert specific symbol to the tasks scanning results assigning the initial
* weight to it.
* @param {boolean} enforce_symbol if represented and true, then insert symbol even if it is not registered in the metric
* @param {string} symbol symbol to insert
* @param {number} weight initial weight (this weight is multiplied by the metric weight)
* @param {string} options list of optional options attached to a symbol inserted
@example
local function cb(task)
if task:get_header('Some header') then
task:insert_result('SOME_HEADER', 1.0, 'Got some header')
end
end
*/
LUA_FUNCTION_DEF (task, insert_result);
/***
* @method task:adjust_result(symbol, score[, option1, ...])
* Alters the existing symbol's score to a new score. It is not affected by
* metric score or grow factor. You can also add new options
* using this method. Symbol must be already inserted into metric or an error
* will be emitted.
* @param {string} symbol symbol to adjust
* @param {number} score this value is NOT multiplied by the metric score
* @param {string/table} options list of optional options attached to a symbol adjusted
*/
LUA_FUNCTION_DEF (task, adjust_result);
/***
* @method task:set_pre_result(action, description)
* Sets pre-result for a task. It is used in pre-filters to specify early result
* of the task scanned. If a pre-filter sets some result, then further processing
* may be skipped. For selecting action it is possible to use global table
* `rspamd_actions` or a string value:
*
* - `reject`: reject message permanently
* - `add header`: add spam header
* - `rewrite subject`: rewrite subject to spam subject
* - `greylist`: greylist message
* - `accept` or `no action`: whitelist message
* @param {rspamd_action or string} action a numeric or string action value
* @param {string} description optional description
@example
local function cb(task)
local gr = task:get_header('Greylist')
if gr and gr == 'greylist' then
task:set_pre_result(rspamd_actions['greylist'], 'Greylisting required')
end
end
*/
LUA_FUNCTION_DEF (task, set_pre_result);
/***
* @method task:has_pre_result()
* Returns true if task has some pre-result being set
*
* @return {boolean} true if task has some pre-result being set
*/
LUA_FUNCTION_DEF (task, has_pre_result);
/***
* @method task:append_message(message, [category])
* Adds a message to scanning output.
* @param {string} message
* @param {category} message category
@example
local function cb(task)
task:append_message('Example message')
end
*/
LUA_FUNCTION_DEF (task, append_message);
/***
* @method task:get_urls([need_emails|list_protos][, need_images])
* Get all URLs found in a message. Telephone urls and emails are not included unless explicitly asked in `list_protos`
* @param {boolean} need_emails if `true` then reutrn also email urls, this can be a comma separated string of protocols desired or a table (e.g. `mailto` or `telephone`)
* @param {boolean} need_images return urls from images (<img src=...>) as well
* @return {table rspamd_url} list of all urls found
@example
local function phishing_cb(task)
local urls = task:get_urls({'https', 'http'});
if urls then
for _,url in ipairs(urls) do
if url:is_phished() then
return true
end
end
end
return false
end
*/
LUA_FUNCTION_DEF (task, get_urls);
/***
* @method task:has_urls([need_emails])
* Returns 'true' if a task has urls listed
* @param {boolean} need_emails if `true` then reutrn also email urls
* @return {boolean} true if a task has urls (urls or emails if `need_emails` is true)
*/
LUA_FUNCTION_DEF (task, has_urls);
/***
* @method task:inject_url(url)
* Inserts an url into a task (useful for redirected urls)
* @param {lua_url} url url to inject
*/
LUA_FUNCTION_DEF (task, inject_url);
/***
* @method task:get_content()
* Get raw content for the specified task
* @return {text} the data contained in the task
*/
LUA_FUNCTION_DEF (task, get_content);
/***
* @method task:get_filename()
* Returns filename for a specific task
* @return {string|nil} filename or nil if unknown
*/
LUA_FUNCTION_DEF (task, get_filename);
/***
* @method task:get_rawbody()
* Get raw body for the specified task
* @return {text} the data contained in the task
*/
LUA_FUNCTION_DEF (task, get_rawbody);
/***
* @method task:get_emails()
* Get all email addresses found in a message.
* @return {table rspamd_url} list of all email addresses found
*/
LUA_FUNCTION_DEF (task, get_emails);
/***
* @method task:get_text_parts()
* Get all text (and HTML) parts found in a message
* @return {table rspamd_text_part} list of text parts
*/
LUA_FUNCTION_DEF (task, get_text_parts);
/***
* @method task:get_parts()
* Get all mime parts found in a message
* @return {table rspamd_mime_part} list of mime parts
*/
LUA_FUNCTION_DEF (task, get_parts);
/***
* @method task:get_meta_words([how='stem'])
* Get meta words from task (subject and displayed names)
* - `stem`: stemmed words (default)
* - `norm`: normalised words (utf normalised + lowercased)
* - `raw`: raw words in utf (if possible)
* - `full`: list of tables, each table has the following fields:
* - [1] - stemmed word
* - [2] - normalised word
* - [3] - raw word
* - [4] - flags (table of strings)
*/
LUA_FUNCTION_DEF (task, get_meta_words);
/***
* @method task:get_request_header(name)
* Get value of a HTTP request header.
* @param {string} name name of header to get
* @return {rspamd_text} value of an HTTP header
*/
LUA_FUNCTION_DEF (task, get_request_header);
/***
* @method task:set_request_header(name, value)
* Set value of a HTTP request header. If value is omitted, then a header is removed
* @param {string} name name of header to get
* @param {rspamd_text/string} value new header's value
*/
LUA_FUNCTION_DEF (task, set_request_header);
/***
* @method task:get_subject()
* Returns task subject (either from the protocol override or from a header)
* @return {string} value of a subject (decoded)
*/
LUA_FUNCTION_DEF (task, get_subject);
/***
* @method task:get_header(name[, case_sensitive])
* Get decoded value of a header specified with optional case_sensitive flag.
* By default headers are searched in caseless matter.
* @param {string} name name of header to get
* @param {boolean} case_sensitive case sensitiveness flag to search for a header
* @return {string} decoded value of a header
*/
LUA_FUNCTION_DEF (task, get_header);
/***
* @method task:get_header_raw(name[, case_sensitive])
* Get raw value of a header specified with optional case_sensitive flag.
* By default headers are searched in caseless matter.
* @param {string} name name of header to get
* @param {boolean} case_sensitive case sensitiveness flag to search for a header
* @return {string} raw value of a header
*/
LUA_FUNCTION_DEF (task, get_header_raw);
/***
* @method task:get_header_full(name[, case_sensitive])
* Get raw value of a header specified with optional case_sensitive flag.
* By default headers are searched in caseless matter. This method returns more
* information about the header as a list of tables with the following structure:
*
* - `name` - name of a header
* - `value` - raw value of a header
* - `decoded` - decoded value of a header
* - `tab_separated` - `true` if a header and a value are separated by `tab` character
* - `empty_separator` - `true` if there are no separator between a header and a value
* @param {string} name name of header to get
* @param {boolean} case_sensitive case sensitiveness flag to search for a header
* @return {list of tables} all values of a header as specified above
@example
function check_header_delimiter_tab(task, header_name)
for _,rh in ipairs(task:get_header_full(header_name)) do
if rh['tab_separated'] then return true end
end
return false
end
*/
LUA_FUNCTION_DEF (task, get_header_full);
/***
* @method task:get_header_count(name[, case_sensitive])
* Lightweight version if you need just a header's count
* * By default headers are searched in caseless matter.
* @param {string} name name of header to get
* @param {boolean} case_sensitive case sensitiveness flag to search for a header
* @return {number} number of header's occurrencies or 0 if not found
*/
LUA_FUNCTION_DEF (task, get_header_count);
/***
* @method task:get_raw_headers()
* Get all undecoded headers of a message as a string
* @return {rspamd_text} all raw headers for a message as opaque text
*/
LUA_FUNCTION_DEF (task, get_raw_headers);
/***
* @method task:get_received_headers()
* Returns a list of tables of parsed received headers. A tables returned have
* the following structure:
*
* - `from_hostname` - string that represents hostname provided by a peer
* - `from_ip` - string representation of IP address as provided by a peer
* - `real_hostname` - hostname as resolved by MTA
* - `real_ip` - string representation of IP as resolved by PTR request of MTA
* - `by_hostname` - MTA hostname
* - `proto` - protocol, e.g. ESMTP or ESMTPS
* - `timestamp` - received timestamp
* - `for` - for value (unparsed mailbox)
*
* Please note that in some situations rspamd cannot parse all the fields of received headers.
* In that case you should check all strings for validity.
* @return {table of tables} list of received headers described above
*/
LUA_FUNCTION_DEF (task, get_received_headers);
/***
* @method task:get_queue_id()
* Returns queue ID of the message being processed.
*/
LUA_FUNCTION_DEF (task, get_queue_id);
/***
* @method task:get_uid()
* Returns ID of the task being processed.
*/
LUA_FUNCTION_DEF (task, get_uid);
/***
* @method task:get_resolver()
* Returns ready to use rspamd_resolver object suitable for making asynchronous DNS requests.
* @return {rspamd_resolver} resolver object associated with the task's session
* @example
local logger = require "rspamd_logger"
local function task_cb(task)
local function dns_cb(resolver, to_resolve, results, err)
-- task object is available due to closure
task:inc_dns_req()
if results then
logger.info(string.format('<%s> [%s] resolved for symbol: %s',
task:get_message_id(), to_resolve, 'EXAMPLE_SYMBOL'))
task:insert_result('EXAMPLE_SYMBOL', 1)
end
end
local r = task:get_resolver()
r:resolve_a(task:get_session(), task:get_mempool(), 'example.com', dns_cb)
end
*/
LUA_FUNCTION_DEF (task, get_resolver);
/***
* @method task:set_resolver(resolver)
* Sets rspamd_resolver for a specified task.
*/
LUA_FUNCTION_DEF (task, set_resolver);
/***
* @method task:inc_dns_req()
* Increment number of DNS requests for the task. Is used just for logging purposes.
*/
LUA_FUNCTION_DEF (task, inc_dns_req);
/***
* @method task:get_dns_req()
* Get number of dns requests being sent in the task
* @return {number} number of DNS requests
*/
LUA_FUNCTION_DEF (task, get_dns_req);
/***
* @method task:has_recipients([type])
* Return true if there are SMTP or MIME recipients for a task.
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
* @return {bool} `true` if there are recipients of the following type
*/
LUA_FUNCTION_DEF (task, has_recipients);
/***
* @method task:get_recipients([type])
* Return SMTP or MIME recipients for a task. This function returns list of internet addresses each one is a table with the following structure:
*
* - `name` - name of internet address in UTF8, e.g. for `Vsevolod Stakhov <blah@foo.com>` it returns `Vsevolod Stakhov`
* - `addr` - address part of the address
* - `user` - user part (if present) of the address, e.g. `blah`
* - `domain` - domain part (if present), e.g. `foo.com`
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
* @return {list of addresses} list of recipients or `nil`
*/
LUA_FUNCTION_DEF (task, get_recipients);
/***
* @method task:get_principal_recipient()
* Returns a single string with so called `principal recipient` for a message. The order
* of check is the following:
*
* - deliver-to request header
* - the first recipient (envelope)
* - the first recipient (mime)
* @return {string} principal recipient
*/
LUA_FUNCTION_DEF (task, get_principal_recipient);
/***
* @method task:get_reply_sender()
* Returns a single string with address that should be used to reply on a message
*
* - reply-to header
* - from header
* - smtp from as a last resort
* @return {address} email address
*/
LUA_FUNCTION_DEF (task, get_reply_sender);
/***
* @method task:set_recipients([type], {rcpt1, rcpt2...})
* Sets sender for a task. This function accepts table that will be converted to the address.
* If some fields are missing they are subsequently reconstructed by this function. E.g. if you
* specify 'user' and 'domain', then address and raw string will be reconstructed
*
* - `name` - name of internet address in UTF8, e.g. for `Vsevolod Stakhov <blah@foo.com>` it returns `Vsevolod Stakhov`
* - `addr` - address part of the address
* - `user` - user part (if present) of the address, e.g. `blah`
* - `domain` - domain part (if present), e.g. `foo.com`
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
* @param {list of tables} recipients recipients to set
* @return {boolean} result of the operation
*/
LUA_FUNCTION_DEF (task, set_recipients);
/***
* @method task:has_from([type])
* Return true if there is SMTP or MIME sender for a task.
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP recipients and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP recipients and `2` or `mime` means MIME recipients only
* @return {bool} `true` if there is sender of the following type
*/
LUA_FUNCTION_DEF (task, has_from);
/***
* @method task:get_from([type])
* Return SMTP or MIME sender for a task. This function returns an internet address which one is a table with the following structure:
*
* - `name` - name of internet address in UTF8, e.g. for `Vsevolod Stakhov <blah@foo.com>` it returns `Vsevolod Stakhov`
* - `addr` - address part of the address
* - `user` - user part (if present) of the address, e.g. `blah`
* - `domain` - domain part (if present), e.g. `foo.com`
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP sender and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP sender and `2` or `mime` means MIME `From:` only
* @return {address} sender or `nil`
*/
LUA_FUNCTION_DEF (task, get_from);
/***
* @method task:set_from(type, addr)
* Sets sender for a task. This function accepts table that will be converted to the address.
* If some fields are missing they are subsequently reconstructed by this function. E.g. if you
* specify 'user' and 'domain', then address and raw string will be reconstructed
*
* - `name` - name of internet address in UTF8, e.g. for `Vsevolod Stakhov <blah@foo.com>` it returns `Vsevolod Stakhov`
* - `addr` - address part of the address
* - `user` - user part (if present) of the address, e.g. `blah`
* - `domain` - domain part (if present), e.g. `foo.com`
* @param {integer|string} type if specified has the following meaning: `0` or `any` means try SMTP sender and fallback to MIME if failed, `1` or `smtp` means checking merely SMTP sender and `2` or `mime` means MIME `From:` only
* @param {table
* @return {boolean} success or not
*/
LUA_FUNCTION_DEF (task, set_from);
/***
* @method task:get_user()
* Returns authenticated user name for this task if specified by an MTA.
* @return {string} username or nil
*/
LUA_FUNCTION_DEF (task, get_user);
/***
* @method task:set_user([username])
* Sets or resets (if username is not specified) authenticated user name for this task.
* @return {string} the previously set username or nil
*/
LUA_FUNCTION_DEF (task, set_user);
/***
* @method task:get_from_ip()
* Returns [ip_addr](ip.md) object of a sender that is provided by MTA
* @return {rspamd_ip} ip address object
*/
LUA_FUNCTION_DEF (task, get_from_ip);
/***
* @method task:set_from_ip(str)
* Set tasks's IP address based on the passed string
* @param {string} str string representation of ip
*/
LUA_FUNCTION_DEF (task, set_from_ip);
LUA_FUNCTION_DEF (task, get_from_ip_num);
/***
* @method task:get_client_ip()
* Returns [ip_addr](ip.md) object of a client connected to rspamd (normally, it is an IP address of MTA)
* @return {rspamd_ip} ip address object
*/
LUA_FUNCTION_DEF (task, get_client_ip);
/***
* @method task:get_helo()
* Returns the value of SMTP helo provided by MTA.
* @return {string} HELO value
*/
LUA_FUNCTION_DEF (task, get_helo);
LUA_FUNCTION_DEF (task, set_helo);
/***
* @method task:get_hostname()
* Returns the value of sender's hostname provided by MTA
* @return {string} hostname value
*/
LUA_FUNCTION_DEF (task, get_hostname);
LUA_FUNCTION_DEF (task, set_hostname);
/***
* @method task:get_images()
* Returns list of all images found in a task as a table of `rspamd_image`.
* Each image has the following methods:
*
* * `get_width` - return width of an image in pixels
* * `get_height` - return height of an image in pixels
* * `get_type` - return string representation of image's type (e.g. 'jpeg')
* * `get_filename` - return string with image's file name
* * `get_size` - return size in bytes
* @return {list of rspamd_image} images found in a message
*/
LUA_FUNCTION_DEF (task, get_images);
/***
* @method task:get_archives()
* Returns list of all archives found in a task as a table of `rspamd_archive`.
* Each archive has the following methods available:
*
* * `get_files` - return list of strings with filenames inside archive
* * `get_files_full` - return list of tables with all information about files
* * `is_encrypted` - return true if an archive is encrypted
* * `get_type` - return string representation of image's type (e.g. 'zip')
* * `get_filename` - return string with archive's file name
* * `get_size` - return size in bytes
* @return {list of rspamd_archive} archives found in a message
*/
LUA_FUNCTION_DEF (task, get_archives);
/***
* @method task:get_dkim_results()
* Returns list of all dkim check results as table of maps. Callee must ensure that
* dkim checks have been completed by adding dependency on `DKIM_TRACE` symbol.
* Fields in map:
*
* * `result` - string result of check:
* - `reject`
* - `allow`
* - `tempfail`
* - `permfail`
* - `not found`
* - `bad record`
* * `domain` - dkim domain
* * `selector` - dkim selector
* * `bhash` - short version of b tag (8 base64 symbols)
* * `fail_reason` - reason of failure (if applicable)
* @return {list of maps} dkim check results
*/
LUA_FUNCTION_DEF (task, get_dkim_results);
/***
* @method task:get_symbol(name)
* Searches for a symbol `name` in all metrics results and returns a list of tables
* one per metric that describes the symbol inserted. Please note that this function
* is intended to return values for **inserted** symbols, so if this symbol was not
* inserted it won't be in the function's output. This method is useful for post-filters mainly.
* The symbols are returned as the list of the following tables:
*
* - `metric` - name of metric
* - `score` - score of a symbol in that metric
* - `options` - a table of strings representing options of a symbol
* - `group` - a group of symbol (or 'ungrouped')
* @param {string} name symbol's name
* @return {list of tables} list of tables or nil if symbol was not found in any metric
*/
LUA_FUNCTION_DEF (task, get_symbol);
/***
* @method task:get_symbols_all()
* Returns array of symbols matched in default metric with all metadata
* @return {table} table of tables formatted as in `task:get_symbol()` except that `metric` is absent and `name` is added
*/
LUA_FUNCTION_DEF (task, get_symbols_all);
/***
* @method task:get_symbols()
* Returns array of all symbols matched for this task
* @return {table, table} table of strings with symbols names + table of theirs scores
*/
LUA_FUNCTION_DEF (task, get_symbols);
/***
* @method task:get_groups([need_private])
* Returns a map [group -> group_score] for matched group. If `need_private` is
* unspecified, then the global option `public_groups_only` is used for default.
* @return {table, number} a map [group -> group_score]
*/
LUA_FUNCTION_DEF (task, get_groups);
/***
* @method task:get_symbols_numeric()
* Returns array of all symbols matched for this task
* @return {table|number, table|number} table of numbers with symbols ids + table of theirs scores
*/
LUA_FUNCTION_DEF (task, get_symbols_numeric);
/***
* @method task:get_symbols_tokens()
* Returns array of all symbols as statistical tokens
* @return {table|number} table of numbers
*/
LUA_FUNCTION_DEF (task, get_symbols_tokens);
/***
* @method task:process_ann_tokens(symbols, ann_tokens, offset)
* Processes ann tokens
* @param {table|string} symbols list of symbols in this profile
* @param {table|number} ann_tokens list of tokens (including metatokens)
* @param {integer} offset offset for symbols token (#metatokens)
* @return nothing
*/
LUA_FUNCTION_DEF (task, process_ann_tokens);
/***
* @method task:has_symbol(name)
* Fast path to check if a specified symbol is in the task's results
* @param {string} name symbol's name
* @return {boolean} `true` if symbol has been found
*/
LUA_FUNCTION_DEF (task, has_symbol);
/***
* @method task:enable_symbol(name)
* Enable specified symbol for this particular task
* @param {string} name symbol's name
* @return {boolean} `true` if symbol has been found
*/
LUA_FUNCTION_DEF (task, enable_symbol);
/***
* @method task:disable_symbol(name)
* Disable specified symbol for this particular task
* @param {string} name symbol's name
* @return {boolean} `true` if symbol has been found
*/
LUA_FUNCTION_DEF (task, disable_symbol);
/***
* @method task:get_date(type[, gmt])
* Returns timestamp for a connection or for a MIME message. This function can be called with a
* single table arguments with the following fields:
*
* * `format` - a format of date returned:
* - `message` - returns a mime date as integer (unix timestamp)
* - `message_str` - returns a mime date as string (UTC format)
* - `connect` - returns a unix timestamp of a connection to rspamd
* - `connect_str` - returns connection time in UTC format
* * `gmt` - returns date in `GMT` timezone (normal for unix timestamps)
*
* By default this function returns connection time in numeric format.
* @param {string} type date format as described above
* @param {boolean} gmt gmt flag as described above
* @return {string/number} date representation according to format
* @example
rspamd_config.DATE_IN_PAST = function(task)
local dm = task:get_date{format = 'message', gmt = true}
local dt = task:get_date{format = 'connect', gmt = true}
-- A day
if dt - dm > 86400 then
return true
end
return false
end
*/
LUA_FUNCTION_DEF (task, get_date);
/***
* @method task:get_message_id()
* Returns message id of the specified task
* @return {string} if of a message
*/
LUA_FUNCTION_DEF (task, get_message_id);
/***
* @method task:get_timeval()
* Returns the timestamp for a task start processing time.
* @return {table} table with fields as described in `struct timeval` in C
*/
LUA_FUNCTION_DEF (task, get_timeval);
/***
* @method task:get_scan_time([set])
* Returns 2 floating point numbers: scan real time and scan virtual time.
* If `set` is `true`, then the finishing time is also set (enabled by default).
* This function should be normally called on idempotent phase.
* @return {number,number} real and virtual times in seconds with floating point
*/
LUA_FUNCTION_DEF (task, get_scan_time);
/***
* @method task:get_metric_result()
* Get full result of a metric as a table:
* - `score`: current score
* - `action`: current action as a string
* - `nnegative`: number of negative rules matched
* - `npositive`: number of positive rules matched
* - `positive_score`: total score for positive rules
* - `negative_score`: total score for negative rules
* - `passthrough`: set to true if message has a passthrough result
* @return {table} metric result
*/
LUA_FUNCTION_DEF (task, get_metric_result);
/***
* @method task:get_metric_score(name)
* Get the current score of metric `name` (must be nil or 'default') . Should be used in idempotent filters only.
* @param {string} name name of a metric
* @return {number,number} 2 numbers containing the current score and required score of the metric
*/
LUA_FUNCTION_DEF (task, get_metric_score);
/***
* @method task:get_metric_action(name)
* Get the current action of metric `name` (must be nil or 'default'). Should be used in idempotent filters only.
* @param {string} name name of a metric
* @return {string} the current action of the metric as a string
*/
LUA_FUNCTION_DEF (task, get_metric_action);
/***
* @method task:set_metric_score(name, score)
* Set the current score of metric `name`. Should be used in post-filters only.
* @param {string} name name of a metric
* @param {number} score the current score of the metric
*/
LUA_FUNCTION_DEF (task, set_metric_score);
/***
* @method task:set_metric_subject(subject)
* Set the subject in the default metric
* @param {string} subject subject to set
*/
LUA_FUNCTION_DEF (task, set_metric_subject);
/***
* @method task:learn(is_spam[, classifier)
* Learn classifier `classifier` with the task. If `is_spam` is true then message
* is learnt as spam. Otherwise HAM is learnt. By default, this function learns
* `bayes` classifier.
* @param {boolean} is_spam learn spam or ham
* @param {string} classifier classifier's name
* @return {boolean} `true` if classifier has been learnt successfully
*/
LUA_FUNCTION_DEF (task, learn);
/***
* @method task:set_settings(obj)
* Set users settings object for a task. The format of this object is described
* [here](https://rspamd.com/doc/configuration/settings.html).
* @param {any} obj any lua object that corresponds to the settings format
*/
LUA_FUNCTION_DEF (task, set_settings);
/***
* @method task:set_settings_id(id)
* Set users settings id for a task (must be registered previously)
* @available 2.0+
* @param {number} id numeric id
* @return {boolean} true if settings id has been set
*/
LUA_FUNCTION_DEF (task, set_settings_id);
/***
* @method task:get_settings()
* Gets users settings object for a task. The format of this object is described
* [here](https://rspamd.com/doc/configuration/settings.html).
* @return {lua object} lua object generated from UCL
*/
LUA_FUNCTION_DEF (task, get_settings);
/***
* @method task:lookup_settings(key)
* Gets users settings object with the specified key for a task.
* @param {string} key key to lookup
* @return {lua object} lua object generated from UCL
*/
LUA_FUNCTION_DEF (task, lookup_settings);
/***
* @method task:get_settings_id()
* Get numeric hash of settings id if specified for this task. 0 is returned otherwise.
* @return {number} settings-id hash
*/
LUA_FUNCTION_DEF (task, get_settings_id);
/***
* @method task:set_milter_reply(obj)
* Set special reply for milter
* @param {any} obj any lua object that corresponds to the settings format
* @example
task:set_milter_reply({
add_headers = {['X-Lua'] = 'test'},
-- 1 is the position of header to remove
remove_headers = {['DKIM-Signature'] = 1},
})
*/
LUA_FUNCTION_DEF (task, set_milter_reply);
/***
* @method task:process_re(params)
* Processes the specified regexp and returns number of captures (cached or new)
* Params is the table with the following fields (mandatory fields are marked with `*`):
* - `re`* : regular expression object
* - `type`*: type of regular expression:
* + `mime`: mime regexp
* + `header`: header regexp
* + `rawheader`: raw header expression
* + `rawmime`: raw mime regexp
* + `body`: raw body regexp
* + `url`: url regexp
* - `header`: for header and rawheader regexp means the name of header
* - `strong`: case sensitive match for headers
* @return {number} number of regexp occurrences in the task (limited by 255 so far)
*/
LUA_FUNCTION_DEF (task, process_regexp);
/***
* @method task:cache_set(key, value)
* Store some value to the task cache
* @param {string} key key to use
* @param {any} value any value (including functions and tables)
*/
LUA_FUNCTION_DEF (task, cache_set);
/***
* @method task:cache_get(key)
* Returns cached value or nil if nothing is cached
* @param {string} key key to use
* @return {any} cached value
*/
LUA_FUNCTION_DEF (task, cache_get);
/***
* @method task:get_size()
* Returns size of the task in bytes (that includes headers + parts size)
* @return {number} size in bytes
*/
LUA_FUNCTION_DEF (task, get_size);
/***
* @method task:set_flag(flag_name[, set])
* Set specific flag for task:
*
* - `no_log`: do not log task summary
* - `no_stat`: do not include task into scanned stats
* - `pass_all`: check all filters for task
* - `extended_urls`: output extended info about urls
* - `skip`: skip task processing
* - `learn_spam`: learn message as spam
* - `learn_ham`: learn message as ham
* - `broken_headers`: header data is broken for a message
* @param {string} flag to set
* @param {boolean} set set or clear flag (default is set)
@example
--[[
For messages with undefined queue ID (scanned with rspamc or WebUI)
do not include results into statistics and do not log task summary
(it will not appear in the WebUI history as well).
]]--
-- Callback function to set flags
local function no_log_stat_cb(task)
if not task:get_queue_id() then
task:set_flag('no_log')
task:set_flag('no_stat')
end
end
rspamd_config:register_symbol({
name = 'LOCAL_NO_LOG_STAT',
type = 'postfilter',
callback = no_log_stat_cb
})
*/
LUA_FUNCTION_DEF (task, set_flag);
/***
* @method task:has_flag(flag_name)
* Checks for a specific flag in task:
*
* - `no_log`: do not log task summary
* - `no_stat`: do not include task into scanned stats
* - `pass_all`: check all filters for task
* - `extended_urls`: output extended info about urls
* - `skip`: skip task processing
* - `learn_spam`: learn message as spam
* - `learn_ham`: learn message as ham
* - `broken_headers`: header data is broken for a message
* @param {string} flag to check
* @return {boolean} true if flags is set
*/
LUA_FUNCTION_DEF (task, has_flag);
/***
* @method task:get_flags()
* Get list of flags for task:
*
* - `no_log`: do not log task summary
* - `no_stat`: do not include task into scanned stats
* - `pass_all`: check all filters for task
* - `extended_urls`: output extended info about urls
* - `skip`: skip task processing
* - `learn_spam`: learn message as spam
* - `learn_ham`: learn message as ham
* - `broken_headers`: header data is broken for a message
* - `milter`: task is initiated by milter connection
* @return {array of strings} table with all flags as strings
*/
LUA_FUNCTION_DEF (task, get_flags);
/***
* @method task:get_digest()
* Returns message's unique digest (32 hex symbols)
* @return {string} hex digest
*/
LUA_FUNCTION_DEF (task, get_digest);
/***
* @method task:store_in_file([mode|table])
* If task was loaded using file scan, then this method just returns its name,
* otherwise, a fresh temporary file is created and its name is returned. Default
* mode is 0600. To convert lua number to the octal mode you can use the following
* trick: `tonumber("0644", 8)`. The file is automatically removed when task is
* destroyed.
*
* If table argument is specified, the following extra fields are allowed:
*
* - `mode`: same as mode argument
* - `force_new`: always create a new file
* - `filename`: use specific filename instead of a temporary one
* - `tmpmask`: use specific tempmask, e.g. '/tmp/file-XXXXX', where XXXX will be replaced by some random letters
* - `keep`: do not remove file after task is processed
*
* @param {number} mode mode for new file
* @return {string} file name with task content
*/
LUA_FUNCTION_DEF (task, store_in_file);
/***
* @method task:get_protocol_reply([flags])
* This method being called from a **postfilter** will return reply for a message
* as it is returned to a client. This method returns the Lua table corresponding
* to the UCL object. Flags is a table that specify which information should be
* there in a reply:
*
* - `basic`: basic info, such as message-id
* - `metrics`: metrics and symbols
* - `messages`: messages
* - `dkim`: dkim signature
* - `milter`: milter control block
* - `extra`: extra data, such as profiling
* - `urls`: list of all urls in a message
*
* @param {table} flags table of flags (default is all flags but `urls`)
* @return {table} ucl object corresponding to the reply
*/
LUA_FUNCTION_DEF (task, get_protocol_reply);
/***
* @method task:headers_foreach(callback, [params])
* This method calls `callback` for each header that satisfies some condition.
* By default, all headers are iterated unless `callback` returns `true`. Nil or
* false means continue of iterations.
* Params could be as following:
*
* - `full`: header value is full table of all attributes @see task:get_header_full for details
* - `regexp`: return headers that satisfies the specified regexp
* @param {function} callback function from header name and header value
* @param {table} params optional parameters
*/
LUA_FUNCTION_DEF (task, headers_foreach);
/***
* @method task:disable_action(action)
* Disables some action for this task (e.g. 'greylist')
*
* @param {string} action action to disable
* @return {boolean} true if an action was enabled and is disabled after the method call
*/
LUA_FUNCTION_DEF (task, disable_action);
/***
* @method task:get_newlines_type()
* Returns the most frequent newlines type met in a task
*
* @return {string} "cr" for \r, "lf" for \n, "crlf" for \r\n
*/
LUA_FUNCTION_DEF (task, get_newlines_type);
/***
* @method task:get_stat_tokens()
* Returns list of tables the statistical tokens:
* - `data`: 64 bit number encoded as a string
* - `t1`: the first token (if any)
* - `t2`: the second token (if any)
* - `win`: window index
* - `flag`: table of strings:
* - `text`: text token
* - `meta`: meta token
* - `lua`: lua meta token
* - `exception`: exception
* - `subject`: subject token
* - `unigram`: unigram token
*
* @return {table of tables}
*/
LUA_FUNCTION_DEF (task, get_stat_tokens);
/***
* @method task:lookup_words(map, function({o, n, s, f}) ... end)
* Matches words in a task (including meta words) against some map (set, regexp and so on)
* and call the specified function with a table containing 4 values:
* - [1] - stemmed word
* - [2] - normalised word
* - [3] - raw word
* - [4] - flags (table of strings)
*/
LUA_FUNCTION_DEF (task, lookup_words);
/**
* @method task:topointer()
*
* Returns raw C pointer (lightuserdata) associated with task
*/
LUA_FUNCTION_DEF (task, topointer);
static const struct luaL_reg tasklib_f[] = {
LUA_INTERFACE_DEF (task, create),
LUA_INTERFACE_DEF (task, load_from_file),
LUA_INTERFACE_DEF (task, load_from_string),
{NULL, NULL}
};
static const struct luaL_reg tasklib_m[] = {
LUA_INTERFACE_DEF (task, get_message),
LUA_INTERFACE_DEF (task, set_message),
LUA_INTERFACE_DEF (task, destroy),
LUA_INTERFACE_DEF (task, process_message),
LUA_INTERFACE_DEF (task, set_cfg),
LUA_INTERFACE_DEF (task, get_cfg),
LUA_INTERFACE_DEF (task, get_mempool),
LUA_INTERFACE_DEF (task, get_session),
LUA_INTERFACE_DEF (task, set_session),
LUA_INTERFACE_DEF (task, get_ev_base),
LUA_INTERFACE_DEF (task, get_worker),
LUA_INTERFACE_DEF (task, insert_result),
LUA_INTERFACE_DEF (task, adjust_result),
LUA_INTERFACE_DEF (task, set_pre_result),
LUA_INTERFACE_DEF (task, has_pre_result),
LUA_INTERFACE_DEF (task, append_message),
LUA_INTERFACE_DEF (task, has_urls),
LUA_INTERFACE_DEF (task, get_urls),
LUA_INTERFACE_DEF (task, inject_url),
LUA_INTERFACE_DEF (task, get_content),
LUA_INTERFACE_DEF (task, get_filename),
LUA_INTERFACE_DEF (task, get_rawbody),
LUA_INTERFACE_DEF (task, get_emails),
LUA_INTERFACE_DEF (task, get_text_parts),
LUA_INTERFACE_DEF (task, get_parts),
LUA_INTERFACE_DEF (task, get_request_header),
LUA_INTERFACE_DEF (task, set_request_header),
LUA_INTERFACE_DEF (task, get_header),
LUA_INTERFACE_DEF (task, get_header_raw),
LUA_INTERFACE_DEF (task, get_header_full),
LUA_INTERFACE_DEF (task, get_header_count),
LUA_INTERFACE_DEF (task, get_raw_headers),
LUA_INTERFACE_DEF (task, get_received_headers),
LUA_INTERFACE_DEF (task, get_queue_id),
LUA_INTERFACE_DEF (task, get_uid),
LUA_INTERFACE_DEF (task, get_resolver),
LUA_INTERFACE_DEF (task, set_resolver),
LUA_INTERFACE_DEF (task, inc_dns_req),
LUA_INTERFACE_DEF (task, get_dns_req),
LUA_INTERFACE_DEF (task, has_recipients),
LUA_INTERFACE_DEF (task, get_recipients),
LUA_INTERFACE_DEF (task, set_recipients),
LUA_INTERFACE_DEF (task, get_principal_recipient),
LUA_INTERFACE_DEF (task, get_reply_sender),
LUA_INTERFACE_DEF (task, has_from),
LUA_INTERFACE_DEF (task, get_from),
LUA_INTERFACE_DEF (task, set_from),
LUA_INTERFACE_DEF (task, get_user),
LUA_INTERFACE_DEF (task, set_user),
{"get_addr", lua_task_get_from_ip},
{"get_ip", lua_task_get_from_ip},
{"get_from_addr", lua_task_get_from_ip},
LUA_INTERFACE_DEF (task, get_from_ip),
LUA_INTERFACE_DEF (task, set_from_ip),
LUA_INTERFACE_DEF (task, get_from_ip_num),
LUA_INTERFACE_DEF (task, get_client_ip),
LUA_INTERFACE_DEF (task, get_subject),
LUA_INTERFACE_DEF (task, get_helo),
LUA_INTERFACE_DEF (task, set_helo),
LUA_INTERFACE_DEF (task, get_hostname),
LUA_INTERFACE_DEF (task, set_hostname),
LUA_INTERFACE_DEF (task, get_images),
LUA_INTERFACE_DEF (task, get_archives),
LUA_INTERFACE_DEF (task, get_dkim_results),
LUA_INTERFACE_DEF (task, get_symbol),
LUA_INTERFACE_DEF (task, get_symbols),
LUA_INTERFACE_DEF (task, get_symbols_all),
LUA_INTERFACE_DEF (task, get_symbols_numeric),
LUA_INTERFACE_DEF (task, get_symbols_tokens),
LUA_INTERFACE_DEF (task, get_groups),
LUA_INTERFACE_DEF (task, process_ann_tokens),
LUA_INTERFACE_DEF (task, has_symbol),
LUA_INTERFACE_DEF (task, enable_symbol),
LUA_INTERFACE_DEF (task, disable_symbol),
LUA_INTERFACE_DEF (task, get_date),
LUA_INTERFACE_DEF (task, get_message_id),
LUA_INTERFACE_DEF (task, get_timeval),
LUA_INTERFACE_DEF (task, get_scan_time),
LUA_INTERFACE_DEF (task, get_metric_result),
LUA_INTERFACE_DEF (task, get_metric_score),
LUA_INTERFACE_DEF (task, get_metric_action),
LUA_INTERFACE_DEF (task, set_metric_score),
LUA_INTERFACE_DEF (task, set_metric_subject),
LUA_INTERFACE_DEF (task, learn),
LUA_INTERFACE_DEF (task, set_settings),
LUA_INTERFACE_DEF (task, get_settings),
LUA_INTERFACE_DEF (task, lookup_settings),
LUA_INTERFACE_DEF (task, get_settings_id),
LUA_INTERFACE_DEF (task, set_settings_id),
LUA_INTERFACE_DEF (task, cache_get),
LUA_INTERFACE_DEF (task, cache_set),
LUA_INTERFACE_DEF (task, process_regexp),
LUA_INTERFACE_DEF (task, get_size),
LUA_INTERFACE_DEF (task, set_flag),
LUA_INTERFACE_DEF (task, get_flags),
LUA_INTERFACE_DEF (task, has_flag),
{"set_rmilter_reply", lua_task_set_milter_reply},
LUA_INTERFACE_DEF (task, set_milter_reply),
LUA_INTERFACE_DEF (task, get_digest),
LUA_INTERFACE_DEF (task, store_in_file),
LUA_INTERFACE_DEF (task, get_protocol_reply),
LUA_INTERFACE_DEF (task, headers_foreach),
LUA_INTERFACE_DEF (task, disable_action),
LUA_INTERFACE_DEF (task, get_newlines_type),
LUA_INTERFACE_DEF (task, get_stat_tokens),
LUA_INTERFACE_DEF (task, get_meta_words),
LUA_INTERFACE_DEF (task, lookup_words),
LUA_INTERFACE_DEF (task, topointer),
{"__tostring", rspamd_lua_class_tostring},
{NULL, NULL}
};
/* Image methods */
LUA_FUNCTION_DEF (image, get_width);
LUA_FUNCTION_DEF (image, get_height);
LUA_FUNCTION_DEF (image, get_type);
LUA_FUNCTION_DEF (image, get_filename);
LUA_FUNCTION_DEF (image, get_size);
static const struct luaL_reg imagelib_m[] = {
LUA_INTERFACE_DEF (image, get_width),
LUA_INTERFACE_DEF (image, get_height),
LUA_INTERFACE_DEF (image, get_type),
LUA_INTERFACE_DEF (image, get_filename),
LUA_INTERFACE_DEF (image, get_size),
{"__tostring", rspamd_lua_class_tostring},
{NULL, NULL}
};
/* Archive methods */
LUA_FUNCTION_DEF (archive, get_type);
LUA_FUNCTION_DEF (archive, get_files);
LUA_FUNCTION_DEF (archive, get_files_full);
LUA_FUNCTION_DEF (archive, is_encrypted);
LUA_FUNCTION_DEF (archive, is_unreadable);
LUA_FUNCTION_DEF (archive, get_filename);
LUA_FUNCTION_DEF (archive, get_size);
static const struct luaL_reg archivelib_m[] = {
LUA_INTERFACE_DEF (archive, get_type),
LUA_INTERFACE_DEF (archive, get_files),
LUA_INTERFACE_DEF (archive, get_files_full),
LUA_INTERFACE_DEF (archive, is_encrypted),
LUA_INTERFACE_DEF (archive, is_unreadable),
LUA_INTERFACE_DEF (archive, get_filename),
LUA_INTERFACE_DEF (archive, get_size),
{"__tostring", rspamd_lua_class_tostring},
{NULL, NULL}
};
/* Utility functions */
struct rspamd_task *
lua_check_task (lua_State * L, gint pos)
{
void *ud = rspamd_lua_check_udata (L, pos, "rspamd{task}");
luaL_argcheck (L, ud != NULL, pos, "'task' expected");
return ud ? *((struct rspamd_task **)ud) : NULL;
}
struct rspamd_task *
lua_check_task_maybe (lua_State * L, gint pos)
{
void *ud = rspamd_lua_check_udata_maybe (L, pos, "rspamd{task}");
return ud ? *((struct rspamd_task **)ud) : NULL;
}
static struct rspamd_image *
lua_check_image (lua_State * L)
{
void *ud = rspamd_lua_check_udata (L, 1, "rspamd{image}");
luaL_argcheck (L, ud != NULL, 1, "'image' expected");
return ud ? *((struct rspamd_image **)ud) : NULL;
}
static struct rspamd_archive *
lua_check_archive (lua_State * L)
{
void *ud = rspamd_lua_check_udata (L, 1, "rspamd{archive}");
luaL_argcheck (L, ud != NULL, 1, "'archive' expected");
return ud ? *((struct rspamd_archive **)ud) : NULL;
}
static void
lua_task_set_cached (lua_State *L, struct rspamd_task *task, const gchar *key,
gint pos)
{
LUA_TRACE_POINT;
struct rspamd_lua_cached_entry *entry;
lua_pushvalue (L, pos);
entry = g_hash_table_lookup (task->lua_cache, key);
if (G_UNLIKELY (entry != NULL)) {
/* Unref previous value */
luaL_unref (L, LUA_REGISTRYINDEX, entry->ref);
}
else {
entry = rspamd_mempool_alloc (task->task_pool, sizeof (*entry));
g_hash_table_insert (task->lua_cache,
rspamd_mempool_strdup (task->task_pool, key), entry);
}
entry->ref = luaL_ref (L, LUA_REGISTRYINDEX);
if (task->message) {
memcpy (entry->id, MESSAGE_FIELD (task, digest), sizeof (entry->id));
}
}
static gboolean
lua_task_get_cached (lua_State *L, struct rspamd_task *task, const gchar *key)
{
LUA_TRACE_POINT;
struct rspamd_lua_cached_entry *entry;
entry = g_hash_table_lookup (task->lua_cache, key);
if (entry != NULL && (task->message &&
memcmp (entry->id, MESSAGE_FIELD (task, digest),
sizeof (entry->id)) == 0)) {
lua_rawgeti (L, LUA_REGISTRYINDEX, entry->ref);
return TRUE;
}
return FALSE;
}
/* Task methods */
static int
lua_task_process_message (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean enforce = FALSE;
if (task != NULL) {
if (task->msg.len > 0) {
if (lua_isboolean (L, 2)) {
enforce = lua_toboolean (L, 2);
}
if (rspamd_message_parse (task)) {
if (enforce ||
(!(task->flags & RSPAMD_TASK_FLAG_SKIP_PROCESS) &&
!(task->processed_stages & RSPAMD_TASK_STAGE_PROCESS_MESSAGE))) {
lua_pushboolean (L, TRUE);
rspamd_message_process (task);
task->processed_stages |= RSPAMD_TASK_STAGE_PROCESS_MESSAGE;
}
else {
lua_pushboolean (L, FALSE);
}
}
else {
lua_pushboolean (L, FALSE);
}
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_get_cfg (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_config **pcfg;
if (task) {
pcfg = lua_newuserdata (L, sizeof (gpointer));
rspamd_lua_setclass (L, "rspamd{config}", -1);
*pcfg = task->cfg;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_set_cfg (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
void *ud = rspamd_lua_check_udata (L, 2, "rspamd{config}");
if (task) {
luaL_argcheck (L, ud != NULL, 1, "'config' expected");
task->cfg = ud ? *((struct rspamd_config **)ud) : NULL;
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static int
lua_task_destroy (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
rspamd_task_free (task);
}
return 0;
}
static int
lua_task_get_message (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_lua_text *t;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
t = lua_newuserdata (L, sizeof (*t));
rspamd_lua_setclass (L, "rspamd{text}", -1);
t->flags = 0;
t->start = task->msg.begin;
t->len = task->msg.len;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_set_message (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_lua_text *t;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean message_set = FALSE;
if (task) {
gsize final_len = 0;
gchar *buf = NULL;
if (lua_type (L, 2) == LUA_TTABLE) {
/* Piecewise construct */
guint vec_len = rspamd_lua_table_size (L, 2);
for (guint i = 0; i < vec_len; i ++) {
lua_rawgeti (L, 2, i + 1);
if (lua_type (L, -1) == LUA_TSTRING) {
gsize l;
(void)lua_tolstring (L, -1, &l);
final_len += l;
}
else {
t = lua_check_text (L, -1);
if (t) {
final_len += t->len;
}
}
lua_pop (L, 1);
}
if (final_len > 0) {
gchar *pos;
buf = rspamd_mempool_alloc (task->task_pool, final_len);
pos = buf;
for (guint i = 0; i < vec_len; i ++) {
lua_rawgeti (L, 2, i + 1);
if (lua_type (L, -1) == LUA_TSTRING) {
gsize l;
const gchar *s;
s = lua_tolstring (L, -1, &l);
memcpy (pos, s, l);
pos += l;
}
else {
t = lua_check_text (L, -1);
if (t) {
memcpy (pos, t->start, t->len);
pos += t->len;
}
}
lua_pop (L, 1);
}
task->flags |= RSPAMD_TASK_FLAG_MESSAGE_REWRITE;
task->msg.begin = buf;
task->msg.len = final_len;
message_set = TRUE;
}
}
else {
if (lua_type (L, 2) == LUA_TSTRING) {
const gchar *s;
s = lua_tolstring (L, -1, &final_len);
buf = rspamd_mempool_alloc (task->task_pool, final_len);
memcpy (buf, s, final_len);
}
else {
t = lua_check_text (L, -1);
if (t) {
final_len = t->len;
buf = rspamd_mempool_alloc (task->task_pool, final_len);
memcpy (buf, t->start, final_len);
}
}
if (buf) {
task->msg.begin = buf;
task->msg.len = final_len;
task->flags |= RSPAMD_TASK_FLAG_MESSAGE_REWRITE;
message_set = TRUE;
}
}
if (message_set) {
if (rspamd_message_parse (task)) {
rspamd_message_process (task);
lua_pushboolean (L, TRUE);
lua_pushinteger (L, final_len);
return 2;
}
else {
lua_pushboolean (L, FALSE);
}
}
else {
lua_pushboolean (L, FALSE);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static void
lua_task_unmap_dtor (gpointer p)
{
struct rspamd_task *task = (struct rspamd_task *)p;
if (task->msg.begin) {
munmap ((gpointer)task->msg.begin, task->msg.len);
}
}
static void
lua_task_free_dtor (gpointer p)
{
g_free (p);
}
static gint
lua_task_load_from_file (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = NULL, **ptask;
const gchar *fname = luaL_checkstring (L, 1), *err = NULL;
struct rspamd_config *cfg = NULL;
gboolean res = FALSE;
gpointer map;
gsize sz;
if (fname) {
if (lua_type (L, 2) == LUA_TUSERDATA) {
gpointer p;
p = rspamd_lua_check_udata_maybe (L, 2, "rspamd{config}");
if (p) {
cfg = *(struct rspamd_config **)p;
}
}
if (strcmp (fname, "-") == 0) {
/* Read from stdin */
gint fd = STDIN_FILENO;
GString *data = g_string_sized_new (BUFSIZ);
gchar buf[BUFSIZ];
gssize r;
for (;;) {
r = read (fd, buf, sizeof (buf));
if (r == -1) {
err = strerror (errno);
break;
}
else if (r == 0) {
break;
}
else {
g_string_append_len (data, buf, r);
}
}
task = rspamd_task_new (NULL, cfg, NULL, NULL, NULL, FALSE);
task->msg.begin = data->str;
task->msg.len = data->len;
rspamd_mempool_add_destructor (task->task_pool,
lua_task_free_dtor, data->str);
res = TRUE;
g_string_free (data, FALSE); /* Buffer is still valid */
}
else {
map = rspamd_file_xmap (fname, PROT_READ, &sz, TRUE);
if (!map) {
err = strerror (errno);
} else {
task = rspamd_task_new (NULL, cfg, NULL, NULL, NULL, FALSE);
task->msg.begin = map;
task->msg.len = sz;
rspamd_mempool_add_destructor (task->task_pool,
lua_task_unmap_dtor, task);
res = TRUE;
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
lua_pushboolean (L, res);
if (res) {
ptask = lua_newuserdata (L, sizeof (*ptask));
*ptask = task;
rspamd_lua_setclass (L, "rspamd{task}", -1);
}
else {
if (err) {
lua_pushstring (L, err);
}
else {
lua_pushnil (L);
}
}
return 2;
}
static gint
lua_task_load_from_string (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = NULL, **ptask;
const gchar *str_message;
gsize message_len;
struct rspamd_config *cfg = NULL;
str_message = luaL_checklstring (L, 1, &message_len);
if (str_message) {
if (lua_type (L, 2) == LUA_TUSERDATA) {
gpointer p;
p = rspamd_lua_check_udata_maybe (L, 2, "rspamd{config}");
if (p) {
cfg = *(struct rspamd_config **)p;
}
}
task = rspamd_task_new (NULL, cfg, NULL, NULL, NULL, FALSE);
task->msg.begin = g_malloc (message_len);
memcpy ((gchar *)task->msg.begin, str_message, message_len);
task->msg.len = message_len;
rspamd_mempool_add_destructor (task->task_pool, lua_task_free_dtor,
(gpointer)task->msg.begin);
}
else {
return luaL_error (L, "invalid arguments");
}
lua_pushboolean (L, true);
ptask = lua_newuserdata (L, sizeof (*ptask));
*ptask = task;
rspamd_lua_setclass (L, "rspamd{task}", -1);
return 2;
}
static gint
lua_task_create (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = NULL, **ptask;
struct rspamd_config *cfg = NULL;
struct ev_loop *ev_base = NULL;
if (lua_type (L, 1) == LUA_TUSERDATA) {
gpointer p;
p = rspamd_lua_check_udata_maybe (L, 2, "rspamd{config}");
if (p) {
cfg = *(struct rspamd_config **)p;
}
}
if (lua_type (L, 2) == LUA_TUSERDATA) {
gpointer p;
p = rspamd_lua_check_udata_maybe (L, 2, "rspamd{ev_base}");
if (p) {
ev_base = *(struct ev_loop **)p;
}
}
task = rspamd_task_new (NULL, cfg, NULL, NULL, ev_base, FALSE);
task->flags |= RSPAMD_TASK_FLAG_EMPTY;
ptask = lua_newuserdata (L, sizeof (*ptask));
*ptask = task;
rspamd_lua_setclass (L, "rspamd{task}", -1);
return 1;
}
static int
lua_task_get_mempool (lua_State * L)
{
LUA_TRACE_POINT;
rspamd_mempool_t **ppool;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
ppool = lua_newuserdata (L, sizeof (rspamd_mempool_t *));
rspamd_lua_setclass (L, "rspamd{mempool}", -1);
*ppool = task->task_pool;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_get_session (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_async_session **psession;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
psession = lua_newuserdata (L, sizeof (void *));
rspamd_lua_setclass (L, "rspamd{session}", -1);
*psession = task->s;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_set_session (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_async_session *session = lua_check_session (L, 2);
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL && session != NULL) {
task->s = session;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_get_ev_base (lua_State * L)
{
LUA_TRACE_POINT;
struct ev_loop **pbase;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
pbase = lua_newuserdata (L, sizeof (struct ev_loop *));
rspamd_lua_setclass (L, "rspamd{ev_base}", -1);
*pbase = task->event_loop;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static int
lua_task_get_worker (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_worker **pworker;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
if (task->worker) {
pworker = lua_newuserdata (L, sizeof (struct rspamd_worker *));
rspamd_lua_setclass (L, "rspamd{worker}", -1);
*pworker = task->worker;
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_insert_result (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *symbol_name, *param;
double weight;
struct rspamd_symbol_result *s;
enum rspamd_symbol_insert_flags flags = RSPAMD_SYMBOL_INSERT_DEFAULT;
gint i, top, args_start;
if (task != NULL) {
if (lua_isboolean (L, 2)) {
args_start = 3;
if (lua_toboolean (L, 2)) {
flags |= RSPAMD_SYMBOL_INSERT_ENFORCE;
}
}
else {
args_start = 2;
}
symbol_name = rspamd_mempool_strdup (task->task_pool,
luaL_checkstring (L, args_start));
weight = luaL_checknumber (L, args_start + 1);
top = lua_gettop (L);
s = rspamd_task_insert_result_full (task, symbol_name, weight,
NULL, flags);
/* Get additional options */
if (s) {
for (i = args_start + 2; i <= top; i++) {
gint ltype = lua_type (L, i);
if (ltype == LUA_TSTRING) {
param = luaL_checkstring (L, i);
rspamd_task_add_result_option (task, s, param);
}
else if (ltype == LUA_TTABLE) {
lua_pushvalue (L, i);
lua_pushnil (L);
while (lua_next (L, -2)) {
if (lua_isstring (L, -1)) {
param = lua_tostring (L, -1);
rspamd_task_add_result_option (task, s, param);
}
else {
const gchar *tname = lua_typename (L, lua_type (L, -1));
lua_pop (L, 2);
return luaL_error (L, "not a string option in a table "
"when adding symbol %s: %s type",
s->name, tname);
}
lua_pop (L, 1);
}
lua_pop (L, 1);
}
else if (ltype == LUA_TNIL) {
/* We have received a NULL option, it is not good but not a fatal error */
msg_info_task ("nil option when adding symbol %s at pos %d",
s->name, i);
continue;
}
else {
const gchar *tname = lua_typename (L, ltype);
return luaL_error (L, "not a string/table option "
"when adding symbol %s: %s type",
s->name, tname);
}
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_adjust_result (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *symbol_name, *param;
struct rspamd_scan_result *metric_res;
struct rspamd_symbol_result *s = NULL;
double weight;
gint i, top;
if (task != NULL) {
symbol_name = luaL_checkstring (L, 2);
weight = luaL_checknumber (L, 3);
top = lua_gettop (L);
metric_res = task->result;
if (metric_res) {
s = rspamd_task_find_symbol_result (task, symbol_name);
}
else {
return luaL_error (L, "no metric result");
}
if (s) {
metric_res->score -= s->score;
s->score = weight;
metric_res->score += s->score;
}
else {
return luaL_error (L, "symbol not found: %s", symbol_name);
}
/* Get additional options */
if (s) {
for (i = 4; i <= top; i++) {
if (lua_type (L, i) == LUA_TSTRING) {
param = luaL_checkstring (L, i);
rspamd_task_add_result_option (task, s, param);
}
else if (lua_type (L, i) == LUA_TTABLE) {
lua_pushvalue (L, i);
lua_pushnil (L);
while (lua_next (L, -2)) {
param = lua_tostring (L, -1);
rspamd_task_add_result_option (task, s, param);
lua_pop (L, 1);
}
lua_pop (L, 1);
}
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_set_pre_result (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *message = NULL, *module = NULL;
gdouble score = NAN;
struct rspamd_action *action;
guint priority = RSPAMD_PASSTHROUGH_NORMAL, flags = 0;
if (task != NULL) {
if (RSPAMD_TASK_IS_SKIPPED (task)) {
/* Do not set pre-result for a skipped task */
return 0;
}
if (lua_type (L, 2) == LUA_TSTRING) {
const gchar *act_name = lua_tostring (L, 2);
gint internal_type;
if (strcmp (act_name, "accept") == 0) {
/* Compatibility! */
act_name = "no action";
}
else if (rspamd_action_from_str (act_name, &internal_type)) {
/* Compatibility! */
act_name = rspamd_action_to_str (internal_type);
}
action = rspamd_config_get_action (task->cfg, act_name);
}
else {
return luaL_error (L, "invalid arguments");
}
if (action == NULL) {
struct rspamd_action *tmp;
HASH_ITER (hh, task->cfg->actions, action, tmp) {
msg_err_task ("known defined action: %s = %f",
action->name, action->threshold);
}
return luaL_error (L, "unknown action %s", lua_tostring (L, 2));
}
if (lua_type (L, 3) == LUA_TSTRING) {
message = lua_tostring (L, 3);
if (lua_type (L, 7) != LUA_TSTRING) {
/* Keep compatibility here :( */
ucl_object_replace_key (task->messages,
ucl_object_fromstring_common (message, 0, UCL_STRING_RAW),
"smtp_message", 0,
false);
}
}
else {
message = "unknown reason";
}
if (lua_type (L, 4) == LUA_TSTRING) {
module = lua_tostring (L, 4);
}
else {
module = "Unknown lua";
}
if (lua_type (L, 5) == LUA_TNUMBER) {
score = lua_tonumber (L, 5);
}
if (lua_type (L, 6) == LUA_TNUMBER) {
priority = lua_tonumber (L, 6);
}
if (lua_type (L, 7) == LUA_TSTRING) {
const gchar *fl_str = lua_tostring (L, 7);
if (strstr (fl_str, "least") != NULL) {
flags |= RSPAMD_PASSTHROUGH_LEAST;
}
}
rspamd_add_passthrough_result (task,
action,
priority,
score,
rspamd_mempool_strdup (task->task_pool, message),
rspamd_mempool_strdup (task->task_pool, module),
flags);
/* Don't classify or filter message if pre-filter sets results */
if (!(flags & RSPAMD_PASSTHROUGH_LEAST)) {
task->processed_stages |= (RSPAMD_TASK_STAGE_CLASSIFIERS |
RSPAMD_TASK_STAGE_CLASSIFIERS_PRE |
RSPAMD_TASK_STAGE_CLASSIFIERS_POST);
rspamd_symcache_disable_all_symbols (task, task->cfg->cache,
SYMBOL_TYPE_IDEMPOTENT | SYMBOL_TYPE_IGNORE_PASSTHROUGH);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_has_pre_result (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
lua_pushboolean (L, task->result->passthrough_result != NULL);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_append_message (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *category;
if (task != NULL) {
if (lua_type (L, 3) == LUA_TSTRING) {
category = luaL_checkstring (L, 3);
}
else {
category = "unknown";
}
ucl_object_insert_key (task->messages,
ucl_object_lua_import (L, 2),
category, 0,
true);
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
struct lua_tree_cb_data {
lua_State *L;
int i;
gint mask;
gint need_images;
gdouble skip_prob;
guint64 xoroshiro_state[4];
};
static void
lua_tree_url_callback (gpointer key, gpointer value, gpointer ud)
{
struct rspamd_lua_url *lua_url;
struct rspamd_url *url = (struct rspamd_url *)value;
struct lua_tree_cb_data *cb = ud;
if (url->protocol & cb->mask) {
if (!cb->need_images && (url->flags & RSPAMD_URL_FLAG_IMAGE)) {
return;
}
if (cb->skip_prob > 0) {
gdouble coin = rspamd_random_double_fast_seed (cb->xoroshiro_state);
if (coin < cb->skip_prob) {
return;
}
}
lua_url = lua_newuserdata (cb->L, sizeof (struct rspamd_lua_url));
rspamd_lua_setclass (cb->L, "rspamd{url}", -1);
lua_url->url = url;
lua_rawseti (cb->L, -2, cb->i++);
}
}
static inline gsize
lua_task_urls_adjust_skip_prob (struct rspamd_task *task,
struct lua_tree_cb_data *cb, gsize sz, gsize max_urls)
{
if (max_urls > 0 && sz > max_urls) {
cb->skip_prob = 1.0 - ((gdouble)max_urls) / (gdouble)sz;
/*
* Use task dependent probabilistic seed to ensure that
* consequent task:get_urls return the same list of urls
*/
memcpy (&cb->xoroshiro_state[0], &task->task_timestamp,
MIN (sizeof (cb->xoroshiro_state[0]), sizeof (task->task_timestamp)));
memcpy (&cb->xoroshiro_state[1], MESSAGE_FIELD (task, digest),
sizeof (cb->xoroshiro_state[1]) * 3);
sz = max_urls;
}
return sz;
}
static gint
lua_task_get_urls (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct lua_tree_cb_data cb;
gint protocols_mask = 0;
static const gint default_mask = PROTOCOL_HTTP|PROTOCOL_HTTPS|
PROTOCOL_FILE|PROTOCOL_FTP;
const gchar *cache_name = "emails+urls";
gboolean need_images = FALSE;
gsize sz, max_urls = 0;
if (task) {
if (task->cfg) {
max_urls = task->cfg->max_lua_urls;
}
if (task->message == NULL) {
lua_newtable (L);
return 1;
}
if (lua_gettop (L) >= 2) {
if (lua_type (L, 2) == LUA_TBOOLEAN) {
protocols_mask = default_mask;
if (lua_toboolean (L, 2)) {
protocols_mask |= PROTOCOL_MAILTO;
}
}
else if (lua_type (L, 2) == LUA_TTABLE) {
for (lua_pushnil (L); lua_next (L, 2); lua_pop (L, 1)) {
int nmask;
const gchar *pname = lua_tostring (L, -1);
nmask = rspamd_url_protocol_from_string (pname);
if (nmask != PROTOCOL_UNKNOWN) {
protocols_mask |= nmask;
}
else {
msg_info ("bad url protocol: %s", pname);
}
}
}
else if (lua_type (L, 2) == LUA_TSTRING) {
const gchar *plist = lua_tostring (L, 2);
gchar **strvec;
gchar * const *cvec;
strvec = g_strsplit_set (plist, ",;", -1);
cvec = strvec;
while (*cvec) {
int nmask;
nmask = rspamd_url_protocol_from_string (*cvec);
if (nmask != PROTOCOL_UNKNOWN) {
protocols_mask |= nmask;
}
else {
msg_info ("bad url protocol: %s", *cvec);
}
cvec ++;
}
g_strfreev (strvec);
}
else {
protocols_mask = default_mask;
}
if (lua_type (L, 3) == LUA_TBOOLEAN) {
need_images = lua_toboolean (L, 3);
}
}
else {
protocols_mask = default_mask;
}
memset (&cb, 0, sizeof (cb));
cb.i = 1;
cb.L = L;
cb.mask = protocols_mask;
cb.need_images = need_images;
if (protocols_mask & PROTOCOL_MAILTO) {
if (need_images) {
cache_name = "emails+urls+img";
}
else {
cache_name = "emails+urls";
}
sz = g_hash_table_size (MESSAGE_FIELD (task, urls)) +
g_hash_table_size (MESSAGE_FIELD (task, emails));
sz = lua_task_urls_adjust_skip_prob (task, &cb, sz, max_urls);
if (protocols_mask == (default_mask|PROTOCOL_MAILTO)) {
/* Can use cached version */
if (!lua_task_get_cached (L, task, cache_name)) {
lua_createtable (L, sz, 0);
g_hash_table_foreach (MESSAGE_FIELD (task, urls),
lua_tree_url_callback, &cb);
g_hash_table_foreach (MESSAGE_FIELD (task, emails),
lua_tree_url_callback, &cb);
lua_task_set_cached (L, task, cache_name, -1);
}
}
else {
lua_createtable (L, sz, 0);
g_hash_table_foreach (MESSAGE_FIELD (task, urls),
lua_tree_url_callback, &cb);
g_hash_table_foreach (MESSAGE_FIELD (task, emails),
lua_tree_url_callback, &cb);
}
}
else {
if (need_images) {
cache_name = "urls+img";
}
else {
cache_name = "urls";
}
sz = g_hash_table_size (MESSAGE_FIELD (task, urls));
sz = lua_task_urls_adjust_skip_prob (task, &cb, sz, max_urls);
if (protocols_mask == (default_mask)) {
if (!lua_task_get_cached (L, task, cache_name)) {
lua_createtable (L, sz, 0);
g_hash_table_foreach (MESSAGE_FIELD (task, urls),
lua_tree_url_callback, &cb);
lua_task_set_cached (L, task, cache_name, -1);
}
}
else {
lua_createtable (L, sz, 0);
g_hash_table_foreach (MESSAGE_FIELD (task, urls),
lua_tree_url_callback, &cb);
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_has_urls (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean need_emails = FALSE, ret = FALSE;
gsize sz = 0;
if (task) {
if (task->message) {
if (lua_gettop (L) >= 2) {
need_emails = lua_toboolean (L, 2);
}
if (g_hash_table_size (MESSAGE_FIELD (task, urls)) > 0) {
sz += g_hash_table_size (MESSAGE_FIELD (task, urls));
ret = TRUE;
}
if (need_emails && g_hash_table_size (MESSAGE_FIELD (task, emails)) > 0) {
sz += g_hash_table_size (MESSAGE_FIELD (task, emails));
ret = TRUE;
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
lua_pushboolean (L, ret);
lua_pushinteger (L, sz);
return 2;
}
static gint
lua_task_inject_url (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_lua_url *url = lua_check_url (L, 2);
if (task && task->message && url && url->url) {
struct rspamd_url *existing;
if ((existing = g_hash_table_lookup (MESSAGE_FIELD (task, urls),
url->url)) == NULL) {
g_hash_table_insert (MESSAGE_FIELD (task, urls), url->url, url->url);
}
else {
existing->count ++;
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_get_content (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_lua_text *t;
if (task) {
t = lua_newuserdata (L, sizeof (*t));
rspamd_lua_setclass (L, "rspamd{text}", -1);
t->len = task->msg.len;
t->start = task->msg.begin;
t->flags = 0;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_filename (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->msg.fpath) {
lua_pushstring (L, task->msg.fpath);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_rawbody (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_lua_text *t;
if (task) {
if (task->message != NULL) {
t = lua_newuserdata (L, sizeof (*t));
rspamd_lua_setclass (L, "rspamd{text}", -1);
if (MESSAGE_FIELD (task, raw_headers_content).len > 0) {
g_assert (MESSAGE_FIELD (task, raw_headers_content).len <= task->msg.len);
t->start = task->msg.begin + MESSAGE_FIELD (task, raw_headers_content).len;
t->len = task->msg.len - MESSAGE_FIELD (task, raw_headers_content).len;
}
else {
t->len = task->msg.len;
t->start = task->msg.begin;
}
t->flags = 0;
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_emails (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct lua_tree_cb_data cb;
if (task) {
if (task->message) {
lua_createtable (L, g_hash_table_size (MESSAGE_FIELD (task, emails)), 0);
memset (&cb, 0, sizeof (cb));
cb.i = 1;
cb.L = L;
cb.mask = PROTOCOL_MAILTO;
g_hash_table_foreach (MESSAGE_FIELD (task, emails),
lua_tree_url_callback, &cb);
}
else {
lua_newtable (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_text_parts (lua_State * L)
{
LUA_TRACE_POINT;
guint i;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_mime_text_part *part, **ppart;
if (task != NULL) {
if (task->message) {
if (!lua_task_get_cached (L, task, "text_parts")) {
lua_createtable (L, MESSAGE_FIELD (task, text_parts)->len, 0);
PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, text_parts), i, part) {
ppart = lua_newuserdata (L, sizeof (struct rspamd_mime_text_part *));
*ppart = part;
rspamd_lua_setclass (L, "rspamd{textpart}", -1);
/* Make it array */
lua_rawseti (L, -2, i + 1);
}
lua_task_set_cached (L, task, "text_parts", -1);
}
}
else {
lua_newtable (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_parts (lua_State * L)
{
LUA_TRACE_POINT;
guint i;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_mime_part *part, **ppart;
if (task != NULL) {
if (task->message) {
if (!lua_task_get_cached (L, task, "mime_parts")) {
lua_createtable (L, MESSAGE_FIELD (task, parts)->len, 0);
PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, parts), i, part) {
ppart = lua_newuserdata (L, sizeof (struct rspamd_mime_part *));
*ppart = part;
rspamd_lua_setclass (L, "rspamd{mimepart}", -1);
/* Make it array */
lua_rawseti (L, -2, i + 1);
}
lua_task_set_cached (L, task, "mime_parts", -1);
}
}
else {
lua_newtable (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_request_header (lua_State *L)
{
LUA_TRACE_POINT;
rspamd_ftok_t *hdr;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *s;
struct rspamd_lua_text *t;
s = luaL_checkstring (L, 2);
if (s && task) {
hdr = rspamd_task_get_request_header (task, s);
if (hdr) {
t = lua_newuserdata (L, sizeof (*t));
rspamd_lua_setclass (L, "rspamd{text}", -1);
t->start = hdr->begin;
t->len = hdr->len;
t->flags = 0;
return 1;
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_request_header (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *s, *v = NULL;
rspamd_fstring_t *buf;
struct rspamd_lua_text *t;
rspamd_ftok_t *hdr, *new_name;
gsize len, vlen = 0;
s = luaL_checklstring (L, 2, &len);
if (s && task) {
if (lua_type (L, 3) == LUA_TSTRING) {
v = luaL_checklstring (L, 3, &vlen);
}
else if (lua_type (L, 3) == LUA_TUSERDATA) {
t = lua_check_text (L, 3);
if (t != NULL) {
v = t->start;
vlen = t->len;
}
}
if (v != NULL) {
buf = rspamd_fstring_new_init (v, vlen);
hdr = rspamd_ftok_map (buf);
buf = rspamd_fstring_new_init (s, len);
new_name = rspamd_ftok_map (buf);
rspamd_task_add_request_header (task, new_name, hdr);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
gint
rspamd_lua_push_header (lua_State *L, struct rspamd_mime_header *rh,
enum rspamd_lua_task_header_type how)
{
LUA_TRACE_POINT;
switch (how) {
case RSPAMD_TASK_HEADER_PUSH_FULL:
/* Create new associated table for a header */
lua_createtable (L, 0, 7);
rspamd_lua_table_set (L, "name", rh->name);
if (rh->value) {
rspamd_lua_table_set (L, "value", rh->value);
}
if (rh->raw_len > 0) {
lua_pushstring (L, "raw");
lua_pushlstring (L, rh->raw_value, rh->raw_len);
lua_settable (L, -3);
}
if (rh->decoded) {
rspamd_lua_table_set (L, "decoded", rh->decoded);
}
lua_pushstring (L, "tab_separated");
lua_pushboolean (L, rh->flags & RSPAMD_HEADER_TAB_SEPARATED);
lua_settable (L, -3);
lua_pushstring (L, "empty_separator");
lua_pushboolean (L, rh->flags & RSPAMD_HEADER_EMPTY_SEPARATOR);
lua_settable (L, -3);
rspamd_lua_table_set (L, "separator", rh->separator);
lua_pushstring (L, "order");
lua_pushinteger (L, rh->order);
lua_settable (L, -3);
break;
case RSPAMD_TASK_HEADER_PUSH_RAW:
if (rh->value) {
lua_pushstring (L, rh->value);
}
else {
lua_pushnil (L);
}
break;
case RSPAMD_TASK_HEADER_PUSH_SIMPLE:
if (rh->decoded) {
lua_pushstring (L, rh->decoded);
}
else {
lua_pushnil (L);
}
break;
case RSPAMD_TASK_HEADER_PUSH_COUNT:
default:
g_assert_not_reached ();
break;
}
return 1;
}
gint
rspamd_lua_push_header_array (lua_State *L,
const gchar *name,
struct rspamd_mime_header *rh,
enum rspamd_lua_task_header_type how,
gboolean strong)
{
LUA_TRACE_POINT;
struct rspamd_mime_header *cur;
guint i;
if (rh == NULL) {
if (how == RSPAMD_TASK_HEADER_PUSH_COUNT) {
lua_pushnumber (L, 0);
}
else {
lua_pushnil (L);
}
return 1;
}
if (how == RSPAMD_TASK_HEADER_PUSH_FULL) {
lua_createtable (L, 0, 0);
i = 0;
DL_FOREACH (rh, cur) {
if (!strong || strcmp (name, cur->name) == 0) {
rspamd_lua_push_header (L, cur, how);
lua_rawseti (L, -2, ++i);
}
}
}
else if (how == RSPAMD_TASK_HEADER_PUSH_COUNT) {
i = 0;
DL_FOREACH (rh, cur) {
if (!strong || strcmp (name, cur->name) == 0) {
i++;
}
}
lua_pushinteger (L, i);
}
else {
DL_FOREACH (rh, cur) {
if (!strong || strcmp (name, cur->name) == 0) {
return rspamd_lua_push_header (L, cur, how);
}
}
/* Not found with this case */
lua_pushnil (L);
}
return 1;
}
static gint
lua_task_get_header_common (lua_State *L, enum rspamd_lua_task_header_type how)
{
LUA_TRACE_POINT;
gboolean strong = FALSE;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_mime_header *rh;
const gchar *name;
name = luaL_checkstring (L, 2);
if (name && task) {
if (lua_gettop (L) == 3) {
strong = lua_toboolean (L, 3);
}
rh = rspamd_message_get_header_array (task, name);
return rspamd_lua_push_header_array (L, name, rh, how, strong);
}
else {
return luaL_error (L, "invalid arguments");
}
}
static gint
lua_task_get_header_full (lua_State * L)
{
return lua_task_get_header_common (L, RSPAMD_TASK_HEADER_PUSH_FULL);
}
static gint
lua_task_get_header (lua_State * L)
{
return lua_task_get_header_common (L, RSPAMD_TASK_HEADER_PUSH_SIMPLE);
}
static gint
lua_task_get_header_raw (lua_State * L)
{
return lua_task_get_header_common (L, RSPAMD_TASK_HEADER_PUSH_RAW);
}
static gint
lua_task_get_header_count (lua_State * L)
{
return lua_task_get_header_common (L, RSPAMD_TASK_HEADER_PUSH_COUNT);
}
static gint
lua_task_get_raw_headers (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_lua_text *t;
if (task && task->message) {
t = lua_newuserdata (L, sizeof (*t));
rspamd_lua_setclass (L, "rspamd{text}", -1);
t->start = MESSAGE_FIELD (task, raw_headers_content).begin;
t->len = MESSAGE_FIELD (task, raw_headers_content).len;
t->flags = 0;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_received_headers (lua_State * L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_received_header *rh;
const gchar *proto;
guint k = 1;
if (task) {
if (!task->message) {
/* No message - no received */
lua_newtable (L);
return 1;
}
if (!lua_task_get_cached (L, task, "received")) {
lua_createtable (L, 0, 0);
DL_FOREACH (MESSAGE_FIELD (task, received), rh) {
lua_createtable (L, 0, 10);
if (rh->hdr && rh->hdr->decoded) {
rspamd_lua_table_set (L, "raw", rh->hdr->decoded);
}
lua_pushstring (L, "flags");
lua_createtable (L, 0, 3);
lua_pushstring (L, "artificial");
if (rh->flags & RSPAMD_RECEIVED_FLAG_ARTIFICIAL) {
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
lua_settable (L, -3);
lua_pushstring (L, "authenticated");
if (rh->flags & RSPAMD_RECEIVED_FLAG_AUTHENTICATED) {
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
lua_settable (L, -3);
lua_pushstring (L, "ssl");
if (rh->flags & RSPAMD_RECEIVED_FLAG_SSL) {
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
lua_settable (L, -3);
lua_settable (L, -3);
if (G_UNLIKELY (rh->from_ip == NULL &&
rh->real_ip == NULL &&
rh->real_hostname == NULL &&
rh->by_hostname == NULL && rh->timestamp == 0 &&
rh->for_mbox == NULL)) {
lua_rawseti (L, -2, k ++);
continue;
}
rspamd_lua_table_set (L, "from_hostname", rh->from_hostname);
rspamd_lua_table_set (L, "from_ip", rh->from_ip);
rspamd_lua_table_set (L, "real_hostname", rh->real_hostname);
lua_pushstring (L, "real_ip");
rspamd_lua_ip_push (L, rh->addr);
lua_settable (L, -3);
lua_pushstring (L, "proto");
switch (rh->flags & RSPAMD_RECEIVED_FLAG_TYPE_MASK) {
case RSPAMD_RECEIVED_SMTP:
proto = "smtp";
break;
case RSPAMD_RECEIVED_ESMTP:
proto = "esmtp";
break;
case RSPAMD_RECEIVED_ESMTPS:
proto = "esmtps";
break;
case RSPAMD_RECEIVED_ESMTPA:
proto = "esmtpa";
break;
case RSPAMD_RECEIVED_ESMTPSA:
proto = "esmtpsa";
break;
case RSPAMD_RECEIVED_LMTP:
proto = "lmtp";
break;
case RSPAMD_RECEIVED_IMAP:
proto = "imap";
break;
case RSPAMD_RECEIVED_HTTP:
proto = "http";
break;
case RSPAMD_RECEIVED_LOCAL:
proto = "local";
break;
case RSPAMD_RECEIVED_MAPI:
proto = "mapi";
break;
case RSPAMD_RECEIVED_UNKNOWN:
default:
proto = "unknown";
break;
}
lua_pushstring (L, proto);
lua_settable (L, -3);
lua_pushstring (L, "timestamp");
lua_pushinteger (L, rh->timestamp);
lua_settable (L, -3);
rspamd_lua_table_set (L, "by_hostname", rh->by_hostname);
rspamd_lua_table_set (L, "for", rh->for_mbox);
lua_rawseti (L, -2, k ++);
}
lua_task_set_cached (L, task, "received", -1);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_queue_id (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->queue_id != NULL && strcmp (task->queue_id, "undef") != 0) {
lua_pushstring (L, task->queue_id);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_uid (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
lua_pushstring (L, task->task_pool->tag.uid);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_resolver (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_dns_resolver **presolver;
if (task != NULL && task->resolver != NULL) {
presolver = lua_newuserdata (L, sizeof (void *));
rspamd_lua_setclass (L, "rspamd{resolver}", -1);
*presolver = task->resolver;
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_resolver (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_dns_resolver *resolver = lua_check_dns_resolver (L, 2);
if (task != NULL && resolver != NULL) {
task->resolver = resolver;
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_inc_dns_req (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
static guint warning_shown = 0;
if (warning_shown < 100) {
warning_shown ++;
msg_warn_task_check ("task:inc_dns_req is deprecated and should not be used");
}
if (task != NULL) {
/* Deprecation: already done in rspamd_dns_resolver_request */
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_get_dns_req (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
lua_pushinteger (L, task->dns_requests);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
enum rspamd_address_type {
RSPAMD_ADDRESS_ANY = 0u,
RSPAMD_ADDRESS_SMTP = 1,
RSPAMD_ADDRESS_MIME = 2,
RSPAMD_ADDRESS_MASK = 0x3FF,
RSPAMD_ADDRESS_RAW = (1u << 10),
RSPAMD_ADDRESS_ORIGINAL = (1u << 11),
RSPAMD_ADDRESS_MAX = RSPAMD_ADDRESS_MASK,
};
/*
* Convert element at the specified position to the type
* for get_from/get_recipients
*/
static enum rspamd_address_type
lua_task_str_to_get_type (lua_State *L, struct rspamd_task *task, gint pos)
{
const gchar *type = NULL;
gint ret = RSPAMD_ADDRESS_ANY;
guint64 h;
gsize sz;
/* Get what value */
if (lua_type (L, pos) == LUA_TNUMBER) {
ret = lua_tonumber (L, pos);
if (ret >= RSPAMD_ADDRESS_ANY && ret < RSPAMD_ADDRESS_MAX) {
return ret;
}
return RSPAMD_ADDRESS_ANY;
}
else if (lua_type (L, pos) == LUA_TSTRING) {
type = lua_tolstring (L, pos, &sz);
if (type && sz > 0) {
h = rspamd_cryptobox_fast_hash_specific (RSPAMD_CRYPTOBOX_XXHASH64,
type, sz, 0xdeadbabe);
switch (h) {
case 0xDA081341FB600389ULL: /* mime */
ret = RSPAMD_ADDRESS_MIME;
break;
case 0xEEC8A7832F8C43ACULL: /* any */
ret = RSPAMD_ADDRESS_ANY;
break;
case 0x472274D5193B2A80ULL: /* smtp */
case 0xEFE0F586CC9F14A9ULL: /* envelope */
ret = RSPAMD_ADDRESS_SMTP;
break;
default:
msg_err_task ("invalid email type: %*s", (gint)sz, type);
break;
}
}
}
else if (lua_type (L, pos) == LUA_TTABLE) {
for (lua_pushnil (L); lua_next (L, pos); lua_pop (L, 1)) {
type = lua_tolstring (L, -1, &sz);
if (type && sz > 0) {
h = rspamd_cryptobox_fast_hash_specific (RSPAMD_CRYPTOBOX_XXHASH64,
type, sz, 0xdeadbabe);
switch (h) {
case 0xDA081341FB600389ULL: /* mime */
ret |= RSPAMD_ADDRESS_MIME;
break;
case 0xEEC8A7832F8C43ACULL: /* any */
ret |= RSPAMD_ADDRESS_ANY;
break;
case 0x472274D5193B2A80ULL: /* smtp */
case 0xEFE0F586CC9F14A9ULL: /* envelope */
ret |= RSPAMD_ADDRESS_SMTP;
break;
case 0xAF4DE083D9AD0132: /* raw */
ret |= RSPAMD_ADDRESS_RAW;
break;
case 0xC7AB6C7B7B0F5A8A: /* orig */
case 0x1778AE905589E431: /* original */
ret |= RSPAMD_ADDRESS_ORIGINAL;
break;
default:
msg_err_task ("invalid email type: %*s", (gint)sz, type);
break;
}
}
}
}
return ret;
}
#define EMAIL_CHECK_FLAG(fl, str) do { \
if (addr->flags & (fl)) { \
lua_pushstring (L, (str)); \
lua_pushboolean (L, true); \
lua_settable (L, -3); \
} \
} while(0)
static void
lua_push_email_address (lua_State *L, struct rspamd_email_address *addr)
{
if (addr) {
lua_createtable (L, 0, 4);
if (addr->addr_len > 0) {
lua_pushstring (L, "addr");
lua_pushlstring (L, addr->addr, addr->addr_len);
lua_settable (L, -3);
}
else {
lua_pushstring (L, "addr");
lua_pushstring (L, "");
lua_settable (L, -3);
}
if (addr->domain_len > 0) {
lua_pushstring (L, "domain");
lua_pushlstring (L, addr->domain, addr->domain_len);
lua_settable (L, -3);
}
else {
lua_pushstring (L, "domain");
lua_pushstring (L, "");
lua_settable (L, -3);
}
if (addr->user_len > 0) {
lua_pushstring (L, "user");
lua_pushlstring (L, addr->user, addr->user_len);
lua_settable (L, -3);
}
else {
lua_pushstring (L, "user");
lua_pushstring (L, "");
lua_settable (L, -3);
}
if (addr->name) {
lua_pushstring (L, "name");
lua_pushstring (L, addr->name);
lua_settable (L, -3);
}
else {
lua_pushstring (L, "name");
lua_pushstring (L, "");
lua_settable (L, -3);
}
lua_pushstring (L, "flags");
lua_createtable (L, 0, 7);
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_VALID, "valid");
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_IP, "ip");
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_BRACED, "braced");
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_QUOTED, "quoted");
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_EMPTY, "empty");
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_HAS_BACKSLASH, "backslash");
EMAIL_CHECK_FLAG (RSPAMD_EMAIL_ADDR_HAS_8BIT, "8bit");
lua_settable (L, -3);
}
}
void
lua_push_emails_address_list (lua_State *L, GPtrArray *addrs, int flags)
{
struct rspamd_email_address *addr;
guint i, pos = 1;
lua_createtable (L, addrs->len, 0);
for (i = 0; i < addrs->len; i ++) {
addr = g_ptr_array_index (addrs, i);
if (addr->flags & RSPAMD_EMAIL_ADDR_ORIGINAL) {
if (flags & RSPAMD_ADDRESS_ORIGINAL) {
lua_push_email_address (L, addr);
lua_rawseti (L, -2, pos);
pos++;
}
}
else {
lua_push_email_address (L, addr);
lua_rawseti (L, -2, pos);
pos++;
}
}
}
static gboolean
lua_import_email_address (lua_State *L, struct rspamd_task *task,
gint pos,
struct rspamd_email_address **paddr)
{
struct rspamd_email_address *addr;
const gchar *p;
gchar *dst;
gsize len;
g_assert (paddr != NULL);
if (!lua_istable (L, pos)) {
return FALSE;
}
addr = g_malloc0 (sizeof (*addr));
lua_pushstring (L, "name");
lua_gettable (L, pos);
if (lua_type (L, -1) == LUA_TSTRING) {
p = lua_tolstring (L, -1, &len);
dst = rspamd_mempool_alloc (task->task_pool, len + 1);
rspamd_strlcpy (dst, p, len + 1);
addr->name = dst;
}
lua_pop (L, 1);
lua_pushstring (L, "user");
lua_gettable (L, pos);
if (lua_type (L, -1) == LUA_TSTRING) {
p = lua_tolstring (L, -1, &len);
addr->user = (const gchar *)rspamd_mempool_alloc (task->task_pool, len);
memcpy ((gchar *)addr->user, p, len);
addr->user_len = len;
}
lua_pop (L, 1);
lua_pushstring (L, "domain");
lua_gettable (L, pos);
if (lua_type (L, -1) == LUA_TSTRING) {
p = lua_tolstring (L, -1, &len);
addr->domain = (const gchar *)rspamd_mempool_alloc (task->task_pool, len);
memcpy ((gchar *)addr->domain, p, len);
addr->domain_len = len;
}
lua_pop (L, 1);
lua_pushstring (L, "addr");
lua_gettable (L, pos);
if (lua_type (L, -1) == LUA_TSTRING) {
p = lua_tolstring (L, -1, &len);
addr->addr = (const gchar *)rspamd_mempool_alloc (task->task_pool, len);
memcpy ((gchar *)addr->addr, p, len);
addr->addr_len = len;
}
else {
/* Construct addr */
len = addr->domain_len + addr->user_len + 1;
addr->addr = (const gchar *)rspamd_mempool_alloc (task->task_pool, len);
addr->addr_len = rspamd_snprintf ((gchar *)addr->addr, len, "%*s@%*s",
(int)addr->user_len, addr->user,
(int)addr->domain_len, addr->domain);
}
lua_pop (L, 1);
lua_pushstring (L, "raw");
lua_gettable (L, pos);
if (lua_type (L, -1) == LUA_TSTRING) {
gchar *cpy;
p = lua_tolstring (L, -1, &len);
cpy = rspamd_mempool_alloc (task->task_pool, len + 1);
memcpy (cpy, p, len);
cpy[len] = '\0';
addr->raw_len = len;
addr->raw = cpy;
}
else {
/* Construct raw addr */
len = addr->addr_len + 3;
if (addr->name) {
len += strlen (addr->name) + 1;
dst = rspamd_mempool_alloc (task->task_pool, len + 1);
addr->raw_len = rspamd_snprintf (dst, len, "%s <%*s>",
addr->name,
(int)addr->addr_len, addr->addr);
}
else {
dst = rspamd_mempool_alloc (task->task_pool, len + 1);
addr->raw_len = rspamd_snprintf (dst, len, "<%*s@%*s>",
(int)addr->user_len, addr->user,
(int)addr->domain_len, addr->domain);
}
addr->raw = dst;
}
lua_pop (L, 1);
addr->flags = RSPAMD_EMAIL_ADDR_VALID;
*paddr = addr;
return TRUE;
}
static gint
lua_task_get_recipients (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
GPtrArray *ptrs = NULL;
gint what = 0;
if (task) {
if (lua_gettop (L) == 2) {
/* Get what value */
what = lua_task_str_to_get_type (L, task, 2);
}
switch (what & RSPAMD_ADDRESS_MASK) {
case RSPAMD_ADDRESS_SMTP:
/* Here we check merely envelope rcpt */
ptrs = task->rcpt_envelope;
break;
case RSPAMD_ADDRESS_MIME:
/* Here we check merely mime rcpt */
ptrs = MESSAGE_FIELD_CHECK (task, rcpt_mime);
break;
case RSPAMD_ADDRESS_ANY:
default:
if (task->rcpt_envelope) {
ptrs = task->rcpt_envelope;
}
else {
ptrs = MESSAGE_FIELD_CHECK (task, rcpt_mime);
}
break;
}
if (ptrs) {
lua_push_emails_address_list (L, ptrs, what & ~RSPAMD_ADDRESS_MASK);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_recipients (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
GPtrArray *ptrs = NULL;
struct rspamd_email_address *addr = NULL;
gint what = 0, pos = 3;
const gchar *how = "rewrite";
gboolean need_update_digest = FALSE;
if (task && lua_gettop (L) >= 3) {
/* Get what value */
what = lua_task_str_to_get_type (L, task, 2);
if (lua_isstring (L, 4)) {
how = lua_tostring (L, 4);
}
switch (what) {
case RSPAMD_ADDRESS_SMTP:
/* Here we check merely envelope rcpt */
ptrs = task->rcpt_envelope;
break;
case RSPAMD_ADDRESS_MIME:
/* Here we check merely mime rcpt */
ptrs = MESSAGE_FIELD_CHECK (task, rcpt_mime);
need_update_digest = TRUE;
break;
case RSPAMD_ADDRESS_ANY:
default:
if (task->rcpt_envelope) {
ptrs = task->rcpt_envelope;
}
else {
ptrs = MESSAGE_FIELD_CHECK (task, rcpt_mime);
need_update_digest = TRUE;
}
break;
}
if (ptrs) {
guint i, flags_add = RSPAMD_EMAIL_ADDR_ORIGINAL;
struct rspamd_email_address *tmp;
if (strcmp (how, "alias") == 0) {
flags_add |= RSPAMD_EMAIL_ADDR_ALIASED;
}
PTR_ARRAY_FOREACH (ptrs, i, tmp) {
tmp->flags |= flags_add;
}
lua_pushvalue (L, pos);
for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) {
if (lua_import_email_address (L, task, lua_gettop (L), &addr)) {
if (need_update_digest) {
rspamd_message_update_digest (task->message,
addr->addr, addr->addr_len);
}
g_ptr_array_add (ptrs, addr);
}
}
lua_pop (L, 1);
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
#define CHECK_EMAIL_ADDR(addr) do { \
if (addr == NULL) { \
ret = 0; \
} \
else { \
ret = addr->flags & RSPAMD_EMAIL_ADDR_VALID; \
} \
} while (0)
#define CHECK_EMAIL_ADDR_LIST(addr) do { \
if (addr == NULL) { \
ret = 0; \
} \
else { \
ret = addr->len > 0; \
nrcpt = addr->len; \
} \
} while (0)
static gint
lua_task_has_from (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gint what = 0, nrcpt = 0;
gboolean ret = FALSE;
if (task) {
if (lua_gettop (L) == 2) {
/* Get what value */
what = lua_task_str_to_get_type (L, task, 2);
}
switch (what & RSPAMD_ADDRESS_MASK) {
case RSPAMD_ADDRESS_SMTP:
/* Here we check merely envelope rcpt */
CHECK_EMAIL_ADDR (task->from_envelope);
break;
case RSPAMD_ADDRESS_MIME:
/* Here we check merely mime rcpt */
CHECK_EMAIL_ADDR_LIST (MESSAGE_FIELD_CHECK (task, from_mime));
break;
case RSPAMD_ADDRESS_ANY:
default:
CHECK_EMAIL_ADDR (task->from_envelope);
if (!ret) {
CHECK_EMAIL_ADDR_LIST (MESSAGE_FIELD_CHECK (task, from_mime));
}
break;
}
}
else {
return luaL_error (L, "invalid arguments");
}
lua_pushboolean (L, ret);
(void)nrcpt; /* Silence warning */
return 1;
}
static gint
lua_task_has_recipients (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gint what = 0, nrcpt = 0;
gboolean ret = FALSE;
if (task) {
if (lua_gettop (L) == 2) {
/* Get what value */
what = lua_task_str_to_get_type (L, task, 2);
}
switch (what & RSPAMD_ADDRESS_MASK) {
case RSPAMD_ADDRESS_SMTP:
/* Here we check merely envelope rcpt */
CHECK_EMAIL_ADDR_LIST (task->rcpt_envelope);
break;
case RSPAMD_ADDRESS_MIME:
/* Here we check merely mime rcpt */
CHECK_EMAIL_ADDR_LIST (MESSAGE_FIELD_CHECK (task, rcpt_mime));
break;
case RSPAMD_ADDRESS_ANY:
default:
CHECK_EMAIL_ADDR_LIST (task->rcpt_envelope);
if (!ret) {
CHECK_EMAIL_ADDR_LIST (MESSAGE_FIELD_CHECK (task, rcpt_mime));
}
break;
}
}
else {
return luaL_error (L, "invalid arguments");
}
lua_pushboolean (L, ret);
if (ret) {
lua_pushinteger (L, nrcpt);
return 2;
}
return 1;
}
static gint
lua_task_get_from (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
GPtrArray *addrs = NULL;
struct rspamd_email_address *addr = NULL;
gint what = 0;
if (task) {
if (lua_gettop (L) == 2) {
/* Get what value */
what = lua_task_str_to_get_type (L, task, 2);
}
switch (what & RSPAMD_ADDRESS_MASK) {
case RSPAMD_ADDRESS_SMTP:
/* Here we check merely envelope rcpt */
addr = task->from_envelope;
break;
case RSPAMD_ADDRESS_MIME:
/* Here we check merely mime rcpt */
addrs = MESSAGE_FIELD_CHECK (task, from_mime);
break;
case RSPAMD_ADDRESS_ANY:
default:
if (task->from_envelope) {
addr = task->from_envelope;
}
else {
addrs = MESSAGE_FIELD_CHECK (task, from_mime);
}
break;
}
if (addrs) {
lua_push_emails_address_list (L, addrs, what & ~RSPAMD_ADDRESS_MASK);
}
else if (addr) {
/* Create table to preserve compatibility */
if (addr->addr) {
lua_createtable (L, 1, 0);
lua_push_email_address (L, addr);
lua_rawseti (L, -2, 1);
}
else {
lua_pushnil (L);
}
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_from (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *how = "rewrite";
GPtrArray *addrs = NULL;
struct rspamd_email_address **paddr = NULL, *addr;
gboolean need_update_digest = FALSE;
gint what = 0;
if (task && lua_gettop (L) >= 3) {
what = lua_task_str_to_get_type (L, task, 2);
if (lua_isstring (L, 4)) {
how = lua_tostring (L, 4);
}
switch (what & RSPAMD_ADDRESS_MASK) {
case RSPAMD_ADDRESS_SMTP:
/* Here we check merely envelope rcpt */
paddr = &task->from_envelope;
break;
case RSPAMD_ADDRESS_MIME:
/* Here we check merely mime rcpt */
addrs = MESSAGE_FIELD_CHECK (task, from_mime);
need_update_digest = TRUE;
break;
case RSPAMD_ADDRESS_ANY:
default:
if (task->from_envelope) {
paddr = &task->from_envelope;
}
else {
addrs = MESSAGE_FIELD_CHECK (task, from_mime);
need_update_digest = TRUE;
}
break;
}
if (addrs) {
if (lua_import_email_address (L, task, 3, &addr)) {
guint i, flags_add = RSPAMD_EMAIL_ADDR_ORIGINAL;
struct rspamd_email_address *tmp;
if (strcmp (how, "alias") == 0) {
flags_add |= RSPAMD_EMAIL_ADDR_ALIASED;
}
PTR_ARRAY_FOREACH (addrs, i, tmp) {
tmp->flags |= flags_add;
}
if (need_update_digest) {
rspamd_message_update_digest (task->message,
addr->addr, addr->addr_len);
}
g_ptr_array_add (addrs, addr);
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
}
else if (paddr) {
if (lua_import_email_address (L, task, 3, &addr)) {
if (paddr) {
rspamd_email_address_free (*paddr);
}
*paddr = addr;
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
}
else {
lua_pushboolean (L, false);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_principal_recipient (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *r;
if (task) {
r = rspamd_task_get_principal_recipient (task);
if (r != NULL) {
lua_pushstring (L, r);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_reply_sender (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_mime_header *rh;
if (task) {
rh = rspamd_message_get_header_array (task, "Reply-To");
if (rh) {
lua_pushstring (L, rh->decoded);
}
else if (MESSAGE_FIELD_CHECK (task, from_mime) &&
MESSAGE_FIELD (task, from_mime)->len == 1) {
struct rspamd_email_address *addr;
addr = (struct rspamd_email_address *)g_ptr_array_index (
MESSAGE_FIELD (task, from_mime), 0);
lua_pushlstring (L, addr->addr, addr->addr_len);
}
else if (task->from_envelope) {
lua_pushlstring (L, task->from_envelope->addr,
task->from_envelope->addr_len);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_user (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->user != NULL) {
lua_pushstring (L, task->user);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_user (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *new_user;
if (task) {
if (lua_type (L, 2) == LUA_TSTRING) {
new_user = lua_tostring (L, 2);
if (task->user) {
/* Push old user */
lua_pushstring (L, task->user);
}
else {
lua_pushnil (L);
}
task->user = rspamd_mempool_strdup (task->task_pool, new_user);
}
else {
/* Reset user */
if (task->user) {
/* Push old user */
lua_pushstring (L, task->user);
}
else {
lua_pushnil (L);
}
task->user = NULL;
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_from_ip (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->from_addr) {
rspamd_lua_ip_push (L, task->from_addr);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_from_ip (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
rspamd_inet_addr_t *addr = NULL;
if (!task) {
return luaL_error (L, "no task");
}
else {
if (lua_type (L, 2) == LUA_TSTRING) {
gsize len;
const gchar *ip_str = lua_tolstring (L, 2, &len);
if (!rspamd_parse_inet_address (&addr,
ip_str,
len,
RSPAMD_INET_ADDRESS_PARSE_DEFAULT)) {
return luaL_error (L, "invalid IP string: %s", ip_str);
}
else {
if (task->from_addr) {
rspamd_inet_address_free (task->from_addr);
}
task->from_addr = addr;
}
}
else if (lua_type (L, 2) == LUA_TUSERDATA) {
struct rspamd_lua_ip *ip = lua_check_ip (L, 2);
if (ip && ip->addr) {
if (task->from_addr) {
rspamd_inet_address_free (task->from_addr);
}
task->from_addr = rspamd_inet_address_copy (ip->addr);
}
else {
return luaL_error (L, "invalid IP object");
}
}
else {
return luaL_error (L, "invalid IP argument type: %s", lua_typename (L,
lua_type (L, 2)));
}
}
return 0;
}
static gint
lua_task_get_from_ip_num (lua_State *L)
{
LUA_TRACE_POINT;
msg_err ("this function is deprecated and should no longer be used");
lua_pushnil (L);
return 1;
}
static gint
lua_task_get_client_ip (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->client_addr) {
rspamd_lua_ip_push (L, task->client_addr);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_helo (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->helo != NULL) {
lua_pushstring (L, task->helo);
return 1;
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_subject (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (MESSAGE_FIELD_CHECK (task, subject) != NULL) {
lua_pushstring (L, MESSAGE_FIELD (task, subject));
return 1;
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_helo (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *new_helo;
if (task) {
new_helo = luaL_checkstring (L, 2);
if (new_helo) {
task->helo = rspamd_mempool_strdup (task->task_pool, new_helo);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_get_hostname (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->hostname != NULL) {
/* Check whether it looks like an IP address */
if (*task->hostname == '[') {
/*
* From the milter documentation:
* If the reverse lookup fails or if none of the IP
* addresses of the resolved host name matches the
* original IP address, hostname will contain the
* message sender's IP address enclosed in square
* brackets (e.g. `[a.b.c.d]')
*/
lua_pushnil (L);
}
else {
lua_pushstring (L, task->hostname);
}
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_hostname (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *new_hostname;
if (task) {
new_hostname = luaL_checkstring (L, 2);
if (new_hostname) {
task->hostname = rspamd_mempool_strdup (task->task_pool,
new_hostname);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_get_images (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
guint nelt = 0, i;
struct rspamd_mime_part *part;
struct rspamd_image **pimg;
if (task) {
if (task->message) {
if (!lua_task_get_cached (L, task, "images")) {
lua_createtable (L, MESSAGE_FIELD (task, parts)->len, 0);
PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, parts), i, part) {
if (part->part_type == RSPAMD_MIME_PART_IMAGE) {
pimg = lua_newuserdata (L, sizeof (struct rspamd_image *));
rspamd_lua_setclass (L, "rspamd{image}", -1);
*pimg = part->specific.img;
lua_rawseti (L, -2, ++nelt);
}
}
lua_task_set_cached (L, task, "images", -1);
}
}
else {
lua_newtable (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_archives (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
guint nelt = 0, i;
struct rspamd_mime_part *part;
struct rspamd_archive **parch;
if (task) {
if (task->message) {
if (!lua_task_get_cached (L, task, "archives")) {
lua_createtable (L, MESSAGE_FIELD (task, parts)->len, 0);
PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, parts), i, part) {
if (part->part_type == RSPAMD_MIME_PART_ARCHIVE) {
parch = lua_newuserdata (L, sizeof (struct rspamd_archive *));
rspamd_lua_setclass (L, "rspamd{archive}", -1);
*parch = part->specific.arch;
lua_rawseti (L, -2, ++nelt);
}
}
lua_task_set_cached (L, task, "archives", -1);
}
}
else {
lua_newtable (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_dkim_results (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
guint nelt = 0, i;
struct rspamd_dkim_check_result **pres, **cur;
if (task) {
if (!lua_task_get_cached (L, task, "dkim_results")) {
pres = rspamd_mempool_get_variable (task->task_pool,
RSPAMD_MEMPOOL_DKIM_CHECK_RESULTS);
if (pres == NULL) {
lua_newtable (L);
}
else {
for (cur = pres; *cur != NULL; cur ++) {
nelt ++;
}
lua_createtable (L, nelt, 0);
for (i = 0; i < nelt; i ++) {
struct rspamd_dkim_check_result *res = pres[i];
const gchar *result_str = "unknown";
lua_createtable (L, 0, 4);
switch (res->rcode) {
case DKIM_CONTINUE:
result_str = "allow";
break;
case DKIM_REJECT:
result_str = "reject";
break;
case DKIM_TRYAGAIN:
result_str = "tempfail";
break;
case DKIM_NOTFOUND:
result_str = "not found";
break;
case DKIM_RECORD_ERROR:
result_str = "bad record";
break;
case DKIM_PERM_ERROR:
result_str = "permanent error";
break;
default:
break;
}
rspamd_lua_table_set (L, "result", result_str);
if (res->domain) {
rspamd_lua_table_set (L, "domain", res->domain);
}
if (res->selector) {
rspamd_lua_table_set (L, "selector", res->selector);
}
if (res->short_b) {
rspamd_lua_table_set (L, "bhash", res->short_b);
}
if (res->fail_reason) {
rspamd_lua_table_set (L, "fail_reason", res->fail_reason);
}
lua_rawseti (L, -2, i + 1);
}
}
lua_task_set_cached (L, task, "dkim_results", -1);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static inline gboolean
lua_push_symbol_result (lua_State *L,
struct rspamd_task *task,
const gchar *symbol,
struct rspamd_symbol_result *symbol_result,
gboolean add_metric,
gboolean add_name)
{
struct rspamd_scan_result *metric_res;
struct rspamd_symbol_result *s = NULL;
struct rspamd_symbol_option *opt;
struct rspamd_symbols_group *sym_group;
guint i;
gint j = 1, e = 4;
if (!symbol_result) {
metric_res = task->result;
if (metric_res) {
s = rspamd_task_find_symbol_result (task, symbol);
}
}
else {
s = symbol_result;
}
if (s) {
if (add_metric) {
e++;
}
if (add_name) {
e++;
}
lua_createtable (L, 0, e);
if (add_name) {
lua_pushstring (L, "name");
lua_pushstring (L, symbol);
lua_settable (L, -3);
}
lua_pushstring (L, "score");
lua_pushnumber (L, s->score);
lua_settable (L, -3);
if (s->sym && s->sym->gr) {
lua_pushstring (L, "group");
lua_pushstring (L, s->sym->gr->name);
lua_settable (L, -3);
lua_pushstring (L, "groups");
lua_createtable (L, s->sym->groups->len, 0);
PTR_ARRAY_FOREACH (s->sym->groups, i, sym_group) {
lua_pushstring (L, sym_group->name);
lua_rawseti (L, -2, i + 1);
}
lua_settable (L, -3);
}
else {
lua_pushstring (L, "group");
lua_pushstring (L, "ungrouped");
lua_settable (L, -3);
}
if (s->options) {
lua_pushstring (L, "options");
lua_createtable (L, kh_size (s->options), 0);
DL_FOREACH (s->opts_head, opt) {
lua_pushstring (L, (const char*)opt->option);
lua_rawseti (L, -2, j++);
}
lua_settable (L, -3);
}
return TRUE;
}
return FALSE;
}
static gint
lua_task_get_symbol (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *symbol;
gboolean found = FALSE;
gint i = 1;
symbol = luaL_checkstring (L, 2);
if (task && symbol) {
lua_createtable (L, 1, 0);
if ((found = lua_push_symbol_result (L, task, symbol,
NULL, TRUE, FALSE))) {
lua_rawseti (L, -2, i++);
}
else {
/* Pop table */
lua_pop (L, 1);
}
}
else {
return luaL_error (L, "invalid arguments");
}
if (!found) {
lua_pushnil (L);
}
return 1;
}
static gint
lua_task_has_symbol (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *symbol;
gboolean found = FALSE;
symbol = luaL_checkstring (L, 2);
if (task && symbol) {
found = (rspamd_task_find_symbol_result (task, symbol) != NULL);
lua_pushboolean (L, found);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_enable_symbol (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *symbol;
gboolean found = FALSE;
symbol = luaL_checkstring (L, 2);
if (task && symbol) {
found = rspamd_symcache_enable_symbol (task, task->cfg->cache, symbol);
lua_pushboolean (L, found);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_disable_symbol (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *symbol;
gboolean found = FALSE;
symbol = luaL_checkstring (L, 2);
if (task && symbol) {
found = rspamd_symcache_disable_symbol (task, task->cfg->cache, symbol);
lua_pushboolean (L, found);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_symbols (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_scan_result *mres;
gint i = 1;
struct rspamd_symbol_result *s;
if (task) {
mres = task->result;
if (mres) {
lua_createtable (L, kh_size (mres->symbols), 0);
lua_createtable (L, kh_size (mres->symbols), 0);
kh_foreach_value_ptr (mres->symbols, s, {
if (!(s->flags & RSPAMD_SYMBOL_RESULT_IGNORED)) {
lua_pushstring (L, s->name);
lua_rawseti (L, -3, i);
lua_pushnumber (L, s->score);
lua_rawseti (L, -2, i);
i++;
}
});
}
else {
lua_createtable (L, 0, 0);
lua_createtable (L, 0, 0);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 2;
}
static gint
lua_task_get_symbols_all (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_scan_result *mres;
struct rspamd_symbol_result *s;
gboolean found = FALSE;
gint i = 1;
if (task) {
mres = task->result;
if (mres) {
found = TRUE;
lua_createtable (L, kh_size (mres->symbols), 0);
kh_foreach_value_ptr (mres->symbols, s, {
lua_push_symbol_result (L, task, s->name, s, FALSE, TRUE);
lua_rawseti (L, -2, i++);
});
}
}
else {
return luaL_error (L, "invalid arguments");
}
if (!found) {
lua_pushnil (L);
}
return 1;
}
static gint
lua_task_get_symbols_numeric (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_scan_result *mres;
gint i = 1, id;
struct rspamd_symbol_result *s;
if (task) {
mres = task->result;
if (mres) {
lua_createtable (L, kh_size (mres->symbols), 0);
lua_createtable (L, kh_size (mres->symbols), 0);
lua_createtable (L, kh_size (mres->symbols), 0);
kh_foreach_value_ptr (mres->symbols, s, {
if (!(s->flags & RSPAMD_SYMBOL_RESULT_IGNORED)) {
id = rspamd_symcache_find_symbol (task->cfg->cache,
s->name);
lua_pushinteger (L, id);
lua_rawseti (L, -3, i);
lua_pushnumber (L, s->score);
lua_rawseti (L, -2, i);
i++;
}
});
}
else {
lua_createtable (L, 0, 0);
lua_createtable (L, 0, 0);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 2;
}
static gint
lua_task_get_groups (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean need_private;
struct rspamd_scan_result *mres;
struct rspamd_symbols_group *gr;
gdouble gr_score;
if (task) {
mres = task->result;
if (lua_isboolean (L, 2)) {
need_private = lua_toboolean (L, 2);
}
else {
need_private = !(task->cfg->public_groups_only);
}
lua_createtable (L, 0, kh_size (mres->sym_groups));
kh_foreach (mres->sym_groups, gr, gr_score, {
if (!(gr->flags & RSPAMD_SYMBOL_GROUP_PUBLIC)) {
if (!need_private) {
continue;
}
}
lua_pushnumber (L, gr_score);
lua_setfield (L, -2, gr->name);
});
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
struct tokens_foreach_cbdata {
struct rspamd_task *task;
lua_State *L;
gint idx;
gboolean normalize;
};
static void
tokens_foreach_cb (struct rspamd_symcache_item *item, gpointer ud)
{
struct tokens_foreach_cbdata *cbd = ud;
struct rspamd_symbol_result *s;
gint flags;
const gchar *sym;
sym = rspamd_symcache_item_name (item);
flags = rspamd_symcache_item_flags (item);
if (flags & SYMBOL_TYPE_NOSTAT) {
return;
}
if ((s = rspamd_task_find_symbol_result (cbd->task, sym)) != NULL) {
if (cbd->normalize) {
lua_pushnumber (cbd->L, tanh (s->score));
}
else {
lua_pushnumber (cbd->L, s->score);
}
}
else {
lua_pushnumber (cbd->L, 0.0);
}
lua_rawseti (cbd->L, -2, cbd->idx++);
}
static gint
lua_task_get_symbols_tokens (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct tokens_foreach_cbdata cbd;
cbd.task = task;
cbd.L = L;
cbd.idx = 1;
cbd.normalize = TRUE;
if (lua_type (L, 2) == LUA_TBOOLEAN) {
cbd.normalize = lua_toboolean (L, 2);
}
else {
cbd.normalize = TRUE;
}
lua_createtable (L,
rspamd_symcache_stats_symbols_count (task->cfg->cache), 0);
rspamd_symcache_foreach (task->cfg->cache, tokens_foreach_cb, &cbd);
return 1;
}
static gint
lua_task_process_ann_tokens (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gint offset = luaL_checkinteger (L, 4);
if (task && lua_istable (L, 2) && lua_istable (L, 3)) {
guint symlen = rspamd_lua_table_size (L, 2);
for (guint i = 1; i <= symlen; i ++, offset ++) {
const gchar *sym;
struct rspamd_symbol_result *sres;
lua_rawgeti (L, 2, i);
sym = lua_tostring (L, -1);
sres = rspamd_task_find_symbol_result (task, sym);
if (sres && !(sres->flags & RSPAMD_SYMBOL_RESULT_IGNORED)) {
if (!isnan (sres->score) && !isinf (sres->score) &&
!(rspamd_symcache_item_flags (sres->sym->cache_item) &
SYMBOL_TYPE_NOSTAT)) {
lua_pushnumber (L, fabs (tanh (sres->score)));
lua_rawseti (L, 3, offset + 1);
}
}
lua_pop (L, 1); /* Symbol name */
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
enum lua_date_type {
DATE_CONNECT = 0,
DATE_MESSAGE,
DATE_CONNECT_STRING,
DATE_MESSAGE_STRING
};
static enum lua_date_type
lua_task_detect_date_type (struct rspamd_task *task,
lua_State *L, gint idx, gboolean *gmt)
{
enum lua_date_type type = DATE_CONNECT;
if (lua_type (L, idx) == LUA_TNUMBER) {
gint num = lua_tonumber (L, idx);
if (num >= DATE_CONNECT && num <= DATE_MESSAGE_STRING) {
return num;
}
}
else if (lua_type (L, idx) == LUA_TTABLE) {
const gchar *str;
lua_pushvalue (L, idx);
lua_pushstring (L, "format");
lua_gettable (L, -2);
str = lua_tostring (L, -1);
if (str) {
if (g_ascii_strcasecmp (str, "message") == 0) {
type = DATE_MESSAGE;
} else if (g_ascii_strcasecmp (str, "connect_str") == 0) {
type = DATE_CONNECT_STRING;
} else if (g_ascii_strcasecmp (str, "message_str") == 0) {
type = DATE_MESSAGE_STRING;
}
}
else {
msg_warn_task ("date format has not been specified");
}
lua_pop (L, 1);
lua_pushstring (L, "gmt");
lua_gettable (L, -2);
if (lua_type (L, -1) == LUA_TBOOLEAN) {
*gmt = lua_toboolean (L, -1);
}
/* Value and table */
lua_pop (L, 2);
}
return type;
}
static gint
lua_task_get_date (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_mime_header *h;
gdouble tim;
enum lua_date_type type = DATE_CONNECT;
gboolean gmt = TRUE;
if (task != NULL) {
if (lua_gettop (L) > 1) {
type = lua_task_detect_date_type (task, L, 2, &gmt);
}
/* Get GMT date and store it to time_t */
if (type == DATE_CONNECT || type == DATE_CONNECT_STRING) {
tim = task->task_timestamp;
if (!gmt) {
struct tm t;
time_t tt;
tt = tim;
rspamd_localtime (tt, &t);
#if !defined(__sun)
t.tm_gmtoff = 0;
#endif
t.tm_isdst = 0;
tim = mktime (&t);
}
}
else {
h = rspamd_message_get_header_array (task, "Date");
if (h) {
time_t tt;
struct tm t;
tt = rspamd_parse_smtp_date (h->decoded, strlen (h->decoded));
if (!gmt) {
rspamd_localtime (tt, &t);
#if !defined(__sun)
t.tm_gmtoff = 0;
#endif
t.tm_isdst = 0;
tim = mktime (&t);
}
else {
tim = tt;
}
}
else {
tim = 0.0;
}
}
if (type == DATE_CONNECT || type == DATE_MESSAGE) {
lua_pushnumber (L, tim);
}
else {
GTimeVal tv;
gchar *out;
double_to_tv (tim, &tv);
out = g_time_val_to_iso8601 (&tv);
lua_pushstring (L, out);
g_free (out);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_message_id (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
if (MESSAGE_FIELD_CHECK (task, message_id) != NULL) {
lua_pushstring (L, MESSAGE_FIELD (task, message_id));
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_timeval (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct timeval tv;
if (task != NULL) {
if (lua_isboolean (L, 2) && !!lua_toboolean (L, 2)) {
lua_pushnumber (L, task->task_timestamp);
}
else {
double_to_tv (task->task_timestamp, &tv);
lua_createtable (L, 0, 2);
lua_pushstring (L, "tv_sec");
lua_pushinteger (L, (lua_Integer) tv.tv_sec);
lua_settable (L, -3);
lua_pushstring (L, "tv_usec");
lua_pushinteger (L, (lua_Integer) tv.tv_usec);
lua_settable (L, -3);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_scan_time (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean set = TRUE;
if (task != NULL) {
if (lua_isboolean (L, 2)) {
set = lua_toboolean (L, 2);
}
rspamd_task_set_finish_time (task);
gdouble diff = task->time_real_finish - task->task_timestamp;
lua_pushnumber (L, diff);
lua_pushnumber (L, diff);
if (!set) {
/* Reset to nan to allow further calcs in rspamd_task_set_finish_time */
task->time_real_finish = NAN;
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 2;
}
static gint
lua_task_get_size (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
lua_pushinteger (L, task->msg.len);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
/**
* - `no_log`: do not log task summary
* - `no_stat`: do not include task into scanned stats
* - `pass_all`: check all filters for task
* - `extended_urls`: output extended info about urls
* - `skip`: skip task processing
*/
#define LUA_TASK_FLAG_WRITE(flag, set) do { \
task->flags = (set) ? (task->flags | (flag)) : (task->flags & ~(flag)); \
} while(0)
#define LUA_TASK_SET_FLAG(flag, strname, macro, set) do { \
if (!found && strcmp ((flag), strname) == 0) { \
LUA_TASK_FLAG_WRITE((macro), set); \
found = TRUE; \
} \
} while(0)
#define LUA_TASK_FLAG_READ(flag) do { \
lua_pushboolean(L, !!(task->flags & (flag))); \
} while(0)
#define LUA_TASK_GET_FLAG(flag, strname, macro) do { \
if (!found && strcmp ((flag), strname) == 0) { \
LUA_TASK_FLAG_READ((macro)); \
found = TRUE; \
} \
} while(0)
#define LUA_TASK_PROTOCOL_FLAG_READ(flag) do { \
lua_pushboolean(L, !!(task->protocol_flags & (flag))); \
} while(0)
#define LUA_TASK_GET_PROTOCOL_FLAG(flag, strname, macro) do { \
if (!found && strcmp ((flag), strname) == 0) { \
LUA_TASK_PROTOCOL_FLAG_READ((macro)); \
found = TRUE; \
} \
} while(0)
static gint
lua_task_set_flag (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *flag = luaL_checkstring (L, 2);
gboolean set = TRUE, found = FALSE;
if (lua_gettop (L) >= 3) {
set = lua_toboolean (L, 3);
}
if (task != NULL && flag != NULL) {
LUA_TASK_SET_FLAG (flag, "pass_all", RSPAMD_TASK_FLAG_PASS_ALL, set);
LUA_TASK_SET_FLAG (flag, "no_log", RSPAMD_TASK_FLAG_NO_LOG, set);
LUA_TASK_SET_FLAG (flag, "no_stat", RSPAMD_TASK_FLAG_NO_STAT, set);
LUA_TASK_SET_FLAG (flag, "skip", RSPAMD_TASK_FLAG_SKIP, set);
LUA_TASK_SET_FLAG (flag, "learn_spam", RSPAMD_TASK_FLAG_LEARN_SPAM, set);
LUA_TASK_SET_FLAG (flag, "learn_ham", RSPAMD_TASK_FLAG_LEARN_HAM, set);
LUA_TASK_SET_FLAG (flag, "broken_headers",
RSPAMD_TASK_FLAG_BROKEN_HEADERS, set);
LUA_TASK_SET_FLAG (flag, "greylisted", RSPAMD_TASK_FLAG_GREYLISTED, set);
LUA_TASK_SET_FLAG (flag, "skip_process", RSPAMD_TASK_FLAG_SKIP_PROCESS, set);
LUA_TASK_SET_FLAG (flag, "message_rewrite", RSPAMD_TASK_FLAG_MESSAGE_REWRITE, set);
if (!found) {
msg_warn_task ("unknown flag requested: %s", flag);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_has_flag (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *flag = luaL_checkstring (L, 2);
gboolean found = FALSE;
if (task != NULL && flag != NULL) {
LUA_TASK_GET_FLAG (flag, "pass_all", RSPAMD_TASK_FLAG_PASS_ALL);
LUA_TASK_GET_FLAG (flag, "no_log", RSPAMD_TASK_FLAG_NO_LOG);
LUA_TASK_GET_FLAG (flag, "no_stat", RSPAMD_TASK_FLAG_NO_STAT);
LUA_TASK_GET_FLAG (flag, "skip", RSPAMD_TASK_FLAG_SKIP);
LUA_TASK_GET_FLAG (flag, "learn_spam", RSPAMD_TASK_FLAG_LEARN_SPAM);
LUA_TASK_GET_FLAG (flag, "learn_ham", RSPAMD_TASK_FLAG_LEARN_HAM);
LUA_TASK_GET_FLAG (flag, "greylisted", RSPAMD_TASK_FLAG_GREYLISTED);
LUA_TASK_GET_FLAG (flag, "broken_headers",
RSPAMD_TASK_FLAG_BROKEN_HEADERS);
LUA_TASK_GET_FLAG (flag, "skip_process",
RSPAMD_TASK_FLAG_SKIP_PROCESS);
LUA_TASK_GET_FLAG (flag, "bad_unicode",
RSPAMD_TASK_FLAG_BAD_UNICODE);
LUA_TASK_GET_FLAG (flag, "mime",
RSPAMD_TASK_FLAG_MIME);
LUA_TASK_GET_FLAG (flag, "message_rewrite",
RSPAMD_TASK_FLAG_MESSAGE_REWRITE);
LUA_TASK_GET_PROTOCOL_FLAG (flag, "milter",
RSPAMD_TASK_PROTOCOL_FLAG_MILTER);
if (!found) {
msg_warn_task ("unknown flag requested: %s", flag);
lua_pushboolean (L, 0);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_flags (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gint idx = 1;
guint flags, bit, i;
if (task) {
lua_createtable (L, 8, 0);
flags = task->flags;
for (i = 0; i <= RSPAMD_TASK_FLAG_MAX_SHIFT; i ++) {
bit = (1U << i);
if (flags & bit) {
switch (bit) {
case RSPAMD_TASK_FLAG_PASS_ALL:
lua_pushstring (L, "pass_all");
lua_rawseti (L, -2, idx ++);
break;
case RSPAMD_TASK_FLAG_NO_LOG:
lua_pushstring (L, "no_log");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_NO_STAT:
lua_pushstring (L, "no_stat");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_SKIP:
lua_pushstring (L, "skip");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_BROKEN_HEADERS:
lua_pushstring (L, "broken_headers");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_LEARN_SPAM:
lua_pushstring (L, "learn_spam");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_LEARN_HAM:
lua_pushstring (L, "learn_ham");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_GREYLISTED:
lua_pushstring (L, "greylisted");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_SKIP_PROCESS:
lua_pushstring (L, "skip_process");
lua_rawseti (L, -2, idx++);
break;
case RSPAMD_TASK_FLAG_MESSAGE_REWRITE:
lua_pushstring (L, "message_rewrite");
lua_rawseti (L, -2, idx++);
break;
default:
break;
}
}
}
if (task->protocol_flags & RSPAMD_TASK_PROTOCOL_FLAG_MILTER) {
lua_pushstring (L, "milter");
lua_rawseti (L, -2, idx++);
}
if (task->protocol_flags & RSPAMD_TASK_PROTOCOL_FLAG_BODY_BLOCK) {
lua_pushstring (L, "body_block");
lua_rawseti (L, -2, idx++);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_digest (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gchar hexbuf[sizeof(MESSAGE_FIELD (task, digest)) * 2 + 1];
gint r;
if (task) {
if (task->message) {
r = rspamd_encode_hex_buf (MESSAGE_FIELD (task, digest),
sizeof (MESSAGE_FIELD (task, digest)),
hexbuf, sizeof (hexbuf) - 1);
if (r > 0) {
hexbuf[r] = '\0';
lua_pushstring (L, hexbuf);
}
else {
lua_pushnil (L);
}
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_learn (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean is_spam = FALSE;
const gchar *clname = NULL;
GError *err = NULL;
int ret = 1;
if (task == NULL) {
return luaL_error (L, "invalid arguments");
}
is_spam = lua_toboolean(L, 2);
if (lua_gettop (L) > 2) {
clname = luaL_checkstring (L, 3);
}
if (!rspamd_learn_task_spam (task, is_spam, clname, &err)) {
lua_pushboolean (L, FALSE);
if (err != NULL) {
lua_pushstring (L, err->message);
ret = 2;
}
}
else {
lua_pushboolean (L, TRUE);
}
return ret;
}
static gint
lua_task_set_settings (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
ucl_object_t *settings;
const ucl_object_t *act, *metric_elt, *vars, *cur;
ucl_object_iter_t it = NULL;
struct rspamd_scan_result *mres;
guint i;
settings = ucl_object_lua_import (L, 2);
if (settings != NULL && task != NULL) {
metric_elt = ucl_object_lookup (settings, DEFAULT_METRIC);
if (metric_elt) {
task->settings = ucl_object_ref (metric_elt);
ucl_object_unref (settings);
}
else {
task->settings = settings;
}
act = ucl_object_lookup (task->settings, "actions");
if (act && ucl_object_type (act) == UCL_OBJECT) {
/* Adjust desired actions */
mres = task->result;
it = NULL;
while ((cur = ucl_object_iterate (act, &it, true)) != NULL) {
const gchar *act_name = ucl_object_key (cur);
double act_score = ucl_object_type (cur) == UCL_NULL ?
NAN : ucl_object_todouble (cur), old_score = NAN;
int act_type;
gboolean found = FALSE;
if (!rspamd_action_from_str (act_name, &act_type)) {
act_type = -1;
}
for (i = 0; i < mres->nactions; i++) {
struct rspamd_action_result *act_res = &mres->actions_limits[i];
if (act_res->action->action_type == METRIC_ACTION_CUSTOM &&
act_type == -1) {
/* Compare by name */
if (g_ascii_strcasecmp (act_name, act_res->action->name) == 0) {
old_score = act_res->cur_limit;
act_res->cur_limit = act_score;
found = TRUE;
break;
}
}
else {
if (act_res->action->action_type == act_type) {
old_score = act_res->cur_limit;
act_res->cur_limit = act_score;
found = TRUE;
break;
}
}
}
if (!found) {
if (!isnan (act_score)) {
struct rspamd_action *new_act;
HASH_FIND_PTR (task->cfg->actions, act_name, new_act);
if (new_act == NULL) {
/* New action! */
msg_info_task ("added new action %s with threshold %.2f "
"due to settings",
act_name,
act_score);
new_act = rspamd_mempool_alloc0 (task->task_pool,
sizeof (*new_act));
new_act->name = rspamd_mempool_strdup (task->task_pool, act_name);
new_act->action_type = METRIC_ACTION_CUSTOM;
new_act->threshold = act_score;
}
else {
/* A disabled action that is enabled */
msg_info_task ("enabled disabled action %s with threshold %.2f "
"due to settings",
act_name,
act_score);
}
/* Insert it to the mres structure */
gsize new_actions_cnt = mres->nactions + 1;
struct rspamd_action_result *old_actions = mres->actions_limits;
mres->actions_limits = rspamd_mempool_alloc (task->task_pool,
sizeof (struct rspamd_action_result) * new_actions_cnt);
memcpy (mres->actions_limits, old_actions,
sizeof (struct rspamd_action_result) * mres->nactions);
mres->actions_limits[mres->nactions].action = new_act;
mres->actions_limits[mres->nactions].cur_limit = act_score;
mres->nactions ++;
}
/* Disabled/missing action is disabled one more time, not an error */
}
else {
if (isnan (act_score)) {
msg_info_task ("disabled action %s due to settings",
act_name);
}
else {
msg_debug_task ("adjusted action %s: %.2f -> %.2f",
act_name,
old_score,
act_score);
}
}
}
}
vars = ucl_object_lookup (task->settings, "variables");
if (vars && ucl_object_type (vars) == UCL_OBJECT) {
/* Set memory pool variables */
it = NULL;
while ((cur = ucl_object_iterate (vars, &it, true)) != NULL) {
if (ucl_object_type (cur) == UCL_STRING) {
rspamd_mempool_set_variable (task->task_pool,
ucl_object_key (cur), rspamd_mempool_strdup (
task->task_pool,
ucl_object_tostring (cur)
), NULL);
}
}
}
rspamd_symcache_process_settings (task, task->cfg->cache);
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_set_milter_reply (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
ucl_object_t *reply, *prev;
reply = ucl_object_lua_import (L, 2);
if (reply != NULL && task != NULL) {
prev = rspamd_mempool_get_variable (task->task_pool,
RSPAMD_MEMPOOL_MILTER_REPLY);
if (prev) {
ucl_object_merge (prev, reply, false);
ucl_object_unref (reply);
}
else {
rspamd_mempool_set_variable (task->task_pool,
RSPAMD_MEMPOOL_MILTER_REPLY,
reply, (rspamd_mempool_destruct_t) ucl_object_unref);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_get_settings (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
if (task->settings) {
return ucl_object_push_lua (L, task->settings, true);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_lookup_settings (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *key = NULL;
const ucl_object_t *elt;
if (task != NULL) {
if (lua_isstring (L, 2)) {
key = lua_tostring (L, 2);
}
if (task->settings) {
if (key == NULL) {
return ucl_object_push_lua (L, task->settings, true);
}
else {
elt = ucl_object_lookup (task->settings, key);
if (elt) {
return ucl_object_push_lua (L, elt, true);
}
else {
lua_pushnil (L);
}
}
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_settings_id (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task != NULL) {
if (task->settings_elt) {
lua_pushinteger (L, task->settings_elt->id);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_settings_id (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
guint32 id = lua_tointeger (L, 2);
if (task != NULL && id != 0) {
if (task->settings_elt) {
if (task->settings_elt->id != id) {
return luaL_error (L, "settings id has been already set to %d (%s)",
task->settings_elt->id, task->settings_elt->name);
}
}
else {
task->settings_elt = rspamd_config_find_settings_id_ref (task->cfg,
id);
if (!task->settings_elt) {
return luaL_error (L, "settings id %u is unknown", id);
}
}
lua_pushboolean (L, true);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_cache_get (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *key = luaL_checkstring (L, 2);
if (task && key) {
if (!lua_task_get_cached (L, task, key)) {
lua_pushnil (L);
}
}
else {
luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_cache_set (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *key = luaL_checkstring (L, 2);
if (task && key && lua_gettop (L) >= 3) {
lua_task_set_cached (L, task, key, 3);
}
else {
luaL_error (L, "invalid arguments");
}
return 0;
}
struct lua_file_cbdata {
gchar *fname;
gint fd;
gboolean keep;
};
static void
lua_tmp_file_dtor (gpointer p)
{
struct lua_file_cbdata *cbdata = p;
if (!cbdata->keep) {
unlink (cbdata->fname);
}
close (cbdata->fd);
}
static gint
lua_task_store_in_file (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gboolean force_new = FALSE, keep = FALSE;
gchar fpath[PATH_MAX];
const gchar *tmpmask = NULL, *fname = NULL;
guint64 mode = 00600;
gint fd;
struct lua_file_cbdata *cbdata;
GError *err = NULL;
if (task) {
if (lua_istable (L, 2)) {
if (!rspamd_lua_parse_table_arguments (L, 2, &err,
RSPAMD_LUA_PARSE_ARGUMENTS_DEFAULT,
"filename=S;tmpmask=S;mode=I;force_new=B;keep=B",
&fname, &tmpmask, &mode, &force_new, &keep)) {
msg_err_task ("cannot get parameters list: %e", err);
if (err) {
g_error_free (err);
}
return luaL_error (L, "invalid arguments");
}
}
else if (lua_isnumber (L, 2)) {
mode = lua_tointeger (L, 2);
}
if (!force_new && (task->flags & RSPAMD_TASK_FLAG_FILE) &&
task->msg.fpath) {
lua_pushstring (L, task->msg.fpath);
}
else {
if (fname == NULL) {
if (tmpmask == NULL) {
rspamd_snprintf (fpath, sizeof (fpath), "%s%c%s",
task->cfg->temp_dir,
G_DIR_SEPARATOR, "rmsg-XXXXXXXXXX");
}
else {
rspamd_snprintf (fpath, sizeof (fpath), "%s", tmpmask);
}
fd = mkstemp (fpath);
fname = fpath;
if (fd != -1) {
fchmod (fd, mode);
}
}
else {
fd = rspamd_file_xopen (fname, O_WRONLY|O_CREAT|O_EXCL,
(guint)mode, FALSE);
}
if (fd == -1) {
msg_err_task ("cannot save file: %s", strerror (errno));
lua_pushnil (L);
}
else {
if (write (fd, task->msg.begin, task->msg.len) == -1) {
msg_err_task ("cannot write file %s: %s", fpath,
strerror (errno));
unlink (fname);
close (fd);
lua_pushnil (L);
return 1;
}
cbdata = rspamd_mempool_alloc (task->task_pool, sizeof (*cbdata));
cbdata->fd = fd;
cbdata->fname = rspamd_mempool_strdup (task->task_pool, fname);
cbdata->keep = keep;
lua_pushstring (L, cbdata->fname);
rspamd_mempool_add_destructor (task->task_pool,
lua_tmp_file_dtor, cbdata);
}
}
}
else {
luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_process_regexp (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_lua_regexp *re = NULL;
gboolean strong = FALSE;
const gchar *type_str = NULL, *header_str = NULL;
gsize header_len = 0;
GError *err = NULL;
gint ret = 0;
enum rspamd_re_type type = RSPAMD_RE_BODY;
/*
* - `re`* : regular expression object
* - `type`*: type of regular expression:
* + `mime`: mime regexp
* + `rawmime`: raw mime regexp
* + `header`: header regexp
* + `rawheader`: raw header expression
* + `body`: raw body regexp
* + `url`: url regexp
* - `header`: for header and rawheader regexp means the name of header
* - `strong`: case sensitive match for headers
*/
if (task != NULL) {
if (!rspamd_lua_parse_table_arguments (L, 2, &err,
RSPAMD_LUA_PARSE_ARGUMENTS_DEFAULT,
"*re=U{regexp};*type=S;header=V;strong=B",
&re, &type_str, &header_len, &header_str,
&strong)) {
msg_err_task ("cannot get parameters list: %e", err);
if (err) {
g_error_free (err);
}
return luaL_error (L, "invalid arguments");
}
else {
type = rspamd_re_cache_type_from_string (type_str);
if ((type == RSPAMD_RE_HEADER || type == RSPAMD_RE_RAWHEADER)
&& header_str == NULL) {
msg_err_task (
"header argument is mandatory for header/rawheader regexps");
}
else {
ret = rspamd_re_cache_process (task, re->re, type,
(gpointer) header_str, header_len, strong);
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
lua_pushinteger (L, ret);
return 1;
}
static gint
lua_task_get_metric_result (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_scan_result *metric_res;
struct rspamd_action *action;
if (task) {
metric_res = task->result;
/* Fields added:
* - `score`: current score
* - `action`: current action as a string
* - `nnegative`: number of negative rules matched
* - `npositive`: number of positive rules matched
* - `positive_score`: total score for positive rules
* - `negative_score`: total score for negative rules
* - `passthrough`: set to true if message has a passthrough result
*/
lua_createtable (L, 0, 7);
lua_pushstring (L, "score");
lua_pushnumber (L, metric_res->score);
lua_settable (L, -3);
action = rspamd_check_action_metric (task);
if (action) {
lua_pushstring (L, "action");
lua_pushstring (L, action->name);
lua_settable (L, -3);
}
lua_pushstring (L, "nnegative");
lua_pushnumber (L, metric_res->nnegative);
lua_settable (L, -3);
lua_pushstring (L, "npositive");
lua_pushnumber (L, metric_res->npositive);
lua_settable (L, -3);
lua_pushstring (L, "positive_score");
lua_pushnumber (L, metric_res->positive_score);
lua_settable (L, -3);
lua_pushstring (L, "negative_score");
lua_pushnumber (L, metric_res->negative_score);
lua_settable (L, -3);
lua_pushstring (L, "passthrough");
lua_pushboolean (L, !!(metric_res->passthrough_result != NULL));
lua_settable (L, -3);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_metric_score (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
gdouble rs;
struct rspamd_scan_result *metric_res;
if (task) {
if ((metric_res = task->result) != NULL) {
lua_createtable (L, 2, 0);
lua_pushnumber (L, isnan (metric_res->score) ? 0.0 : metric_res->score);
rs = rspamd_task_get_required_score (task, metric_res);
lua_rawseti (L, -2, 1);
lua_pushnumber (L, rs);
lua_rawseti (L, -2, 2);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_metric_action (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_action *action;
if (task) {
action = rspamd_check_action_metric (task);
lua_pushstring (L, action->name);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_metric_score (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_scan_result *metric_res;
gdouble nscore;
if (lua_isnumber (L, 2)) {
nscore = luaL_checknumber (L, 2);
}
else {
nscore = luaL_checknumber (L, 3);
}
if (task) {
if ((metric_res = task->result) != NULL) {
msg_debug_task ("set metric score from %.2f to %.2f",
metric_res->score, nscore);
metric_res->score = nscore;
lua_pushboolean (L, true);
}
else {
lua_pushboolean (L, false);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_disable_action (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *action_name;
struct rspamd_action_result *action_res;
action_name = luaL_checkstring (L, 2);
if (task && action_name) {
for (guint i = 0; i < task->result->nactions; i ++) {
action_res = &task->result->actions_limits[i];
if (strcmp (action_name, action_res->action->name) == 0) {
if (isnan (action_res->cur_limit)) {
lua_pushboolean (L, false);
}
else {
action_res->cur_limit = NAN;
lua_pushboolean (L, true);
}
break;
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_newlines_type (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
if (task->message) {
switch (MESSAGE_FIELD (task, nlines_type)) {
case RSPAMD_TASK_NEWLINES_CR:
lua_pushstring (L, "cr");
break;
case RSPAMD_TASK_NEWLINES_LF:
lua_pushstring (L, "lf");
break;
case RSPAMD_TASK_NEWLINES_CRLF:
default:
lua_pushstring (L, "crlf");
break;
}
}
else {
lua_pushstring (L, "crlf");
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static void
lua_push_stat_token (lua_State *L, rspamd_token_t *tok)
{
gchar numbuf[64];
/* Table values
* - `data`: 64 bit number encoded as a string
* - `t1`: the first token (if any)
* - `t2`: the second token (if any)
* - `win`: window index
* - `flag`: table of strings:
* - `text`: text token
* - `meta`: meta token
* - `lua`: lua meta token
* - `exception`: exception
* - `subject`: subject token
* - `unigram`: unigram token
*/
lua_createtable (L, 0, 5);
rspamd_snprintf (numbuf, sizeof (numbuf), "%uL", tok->data);
lua_pushstring (L, "data");
lua_pushstring (L, numbuf);
lua_settable (L, -3);
if (tok->t1) {
lua_pushstring (L, "t1");
lua_pushlstring (L, tok->t1->stemmed.begin, tok->t1->stemmed.len);
lua_settable (L, -3);
}
if (tok->t2) {
lua_pushstring (L, "t2");
lua_pushlstring (L, tok->t2->stemmed.begin, tok->t2->stemmed.len);
lua_settable (L, -3);
}
lua_pushstring (L, "win");
lua_pushinteger (L, tok->window_idx);
lua_settable (L, -3);
lua_pushstring (L, "flags");
lua_createtable (L, 0, 5);
/* Flags */
{
if (tok->flags & RSPAMD_STAT_TOKEN_FLAG_TEXT) {
lua_pushstring (L, "text");
lua_pushboolean (L, true);
lua_settable (L, -3);
}
if (tok->flags & RSPAMD_STAT_TOKEN_FLAG_META) {
lua_pushstring (L, "meta");
lua_pushboolean (L, true);
lua_settable (L, -3);
}
if (tok->flags & RSPAMD_STAT_TOKEN_FLAG_LUA_META) {
lua_pushstring (L, "lua");
lua_pushboolean (L, true);
lua_settable (L, -3);
}
if (tok->flags & RSPAMD_STAT_TOKEN_FLAG_EXCEPTION) {
lua_pushstring (L, "exception");
lua_pushboolean (L, true);
lua_settable (L, -3);
}
if (tok->flags & RSPAMD_STAT_TOKEN_FLAG_HEADER) {
lua_pushstring (L, "header");
lua_pushboolean (L, true);
lua_settable (L, -3);
}
}
lua_settable (L, -3);
}
static gint
lua_task_get_stat_tokens (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
guint i;
rspamd_token_t *tok;
if (task) {
if (!task->tokens) {
rspamd_stat_process_tokenize (NULL, task);
}
if (!task->tokens) {
lua_pushnil (L);
}
else {
lua_createtable (L, task->tokens->len, 0);
PTR_ARRAY_FOREACH (task->tokens, i, tok) {
lua_push_stat_token (L, tok);
lua_rawseti (L, -2, i + 1);
}
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_set_metric_subject (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
const gchar *subject;
subject = luaL_checkstring (L, 2);
if (task && subject) {
rspamd_mempool_set_variable (task->task_pool, "metric_subject",
rspamd_mempool_strdup(task->task_pool, subject), NULL);
lua_pushboolean (L, true);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_task_get_protocol_reply (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
guint flags = 0;
ucl_object_t *obj;
if (!task) {
return luaL_error (L, "invalid arguments");
}
if (!(task->processed_stages & (RSPAMD_TASK_STAGE_POST_FILTERS >> 1))) {
return luaL_error (L, "must not be called before post-filters");
}
if (lua_istable (L, 2)) {
for (lua_pushnil (L); lua_next (L, 2); lua_pop (L, 1)) {
if (lua_isstring (L, -1)) {
const gchar *str = lua_tostring (L, -1);
if (strcmp (str, "default") == 0) {
flags |= RSPAMD_PROTOCOL_DEFAULT;
}
else if (strcmp (str, "basic") == 0) {
flags |= RSPAMD_PROTOCOL_BASIC;
}
else if (strcmp (str, "metrics") == 0) {
flags |= RSPAMD_PROTOCOL_METRICS;
}
else if (strcmp (str, "messages") == 0) {
flags |= RSPAMD_PROTOCOL_MESSAGES;
}
else if (strcmp (str, "rmilter") == 0) {
flags |= RSPAMD_PROTOCOL_RMILTER;
}
else if (strcmp (str, "dkim") == 0) {
flags |= RSPAMD_PROTOCOL_DKIM;
}
else if (strcmp (str, "extra") == 0) {
flags |= RSPAMD_PROTOCOL_EXTRA;
}
else {
msg_err_task ("invalid protocol flag: %s", str);
}
}
}
}
else {
flags = RSPAMD_PROTOCOL_DEFAULT;
}
obj = rspamd_protocol_write_ucl (task, flags);
if (obj) {
ucl_object_push_lua (L, obj, true);
}
else {
lua_pushnil (L);
}
return 1;
}
static gint
lua_task_headers_foreach (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
enum rspamd_lua_task_header_type how = RSPAMD_TASK_HEADER_PUSH_SIMPLE;
struct rspamd_lua_regexp *re = NULL;
struct rspamd_mime_header *hdr, *cur;
gint old_top;
if (task && lua_isfunction (L, 2)) {
if (task->message) {
if (lua_istable (L, 3)) {
lua_pushstring (L, "full");
lua_gettable (L, 3);
if (lua_isboolean (L, -1) && lua_toboolean (L, -1)) {
how = RSPAMD_TASK_HEADER_PUSH_FULL;
}
lua_pop (L, 1);
lua_pushstring (L, "raw");
lua_gettable (L, 3);
if (lua_isboolean (L, -1) && lua_toboolean (L, -1)) {
how = RSPAMD_TASK_HEADER_PUSH_RAW;
}
lua_pop (L, 1);
lua_pushstring (L, "regexp");
lua_gettable (L, 3);
if (lua_isuserdata (L, -1)) {
re = *(struct rspamd_lua_regexp **)
rspamd_lua_check_udata (L, -1, "rspamd{regexp}");
}
lua_pop (L, 1);
}
if (MESSAGE_FIELD (task, headers_order)) {
hdr = MESSAGE_FIELD (task, headers_order);
LL_FOREACH (hdr, cur) {
if (re && re->re) {
if (!rspamd_regexp_match (re->re, cur->name,
strlen (cur->name), FALSE)) {
continue;
}
}
old_top = lua_gettop (L);
lua_pushvalue (L, 2);
lua_pushstring (L, cur->name);
rspamd_lua_push_header (L, cur, how);
if (lua_pcall (L, 2, LUA_MULTRET, 0) != 0) {
msg_err ("call to header_foreach failed: %s",
lua_tostring (L, -1));
lua_settop (L, old_top);
break;
}
else {
if (lua_gettop (L) > old_top) {
if (lua_isboolean (L, old_top + 1)) {
if (lua_toboolean (L, old_top + 1)) {
lua_settop (L, old_top);
break;
}
}
}
}
lua_settop (L, old_top);
}
}
} /* if (task->message) */
}
else {
return luaL_error (L, "invalid arguments");
}
return 0;
}
static gint
lua_task_get_meta_words (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
enum rspamd_lua_words_type how = RSPAMD_LUA_WORDS_STEM;
if (task == NULL) {
return luaL_error (L, "invalid arguments");
}
if (task->meta_words == NULL) {
lua_createtable (L, 0, 0);
}
else {
if (lua_type (L, 2) == LUA_TSTRING) {
const gchar *how_str = lua_tostring (L, 2);
if (strcmp (how_str, "stem") == 0) {
how = RSPAMD_LUA_WORDS_STEM;
}
else if (strcmp (how_str, "norm") == 0) {
how = RSPAMD_LUA_WORDS_NORM;
}
else if (strcmp (how_str, "raw") == 0) {
how = RSPAMD_LUA_WORDS_RAW;
}
else if (strcmp (how_str, "full") == 0) {
how = RSPAMD_LUA_WORDS_FULL;
}
else {
return luaL_error (L, "unknown words type: %s", how_str);
}
}
return rspamd_lua_push_words (L, task->meta_words, how);
}
return 1;
}
static guint
lua_lookup_words_array (lua_State *L,
gint cbpos,
struct rspamd_task *task,
struct rspamd_lua_map *map,
GArray *words)
{
rspamd_stat_token_t *tok;
guint i, nmatched = 0;
gint err_idx;
gboolean matched;
const gchar *key;
gsize keylen;
for (i = 0; i < words->len; i ++) {
tok = &g_array_index (words, rspamd_stat_token_t, i);
matched = FALSE;
if (tok->normalized.len == 0) {
continue;
}
key = tok->normalized.begin;
keylen = tok->normalized.len;
switch (map->type) {
case RSPAMD_LUA_MAP_SET:
case RSPAMD_LUA_MAP_HASH:
/* We know that tok->normalized is zero terminated in fact */
if (rspamd_match_hash_map (map->data.hash, key)) {
matched = TRUE;
}
break;
case RSPAMD_LUA_MAP_REGEXP:
case RSPAMD_LUA_MAP_REGEXP_MULTIPLE:
if (rspamd_match_regexp_map_single (map->data.re_map, key,
keylen)) {
matched = TRUE;
}
break;
default:
g_assert_not_reached ();
break;
}
if (matched) {
nmatched ++;
lua_pushcfunction (L, &rspamd_lua_traceback);
err_idx = lua_gettop (L);
lua_pushvalue (L, cbpos); /* Function */
rspamd_lua_push_full_word (L, tok);
if (lua_pcall (L, 1, 0, err_idx) != 0) {
msg_err_task ("cannot call callback function for lookup words: %s",
lua_tostring (L, -1));
}
lua_settop (L, err_idx - 1);
}
}
return nmatched;
}
static gint
lua_task_lookup_words (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
struct rspamd_lua_map *map = lua_check_map (L, 2);
struct rspamd_mime_text_part *tp;
guint i, matches = 0;
if (task == NULL || map == NULL || task->message == NULL
|| lua_type (L, 3) != LUA_TFUNCTION) {
return luaL_error (L, "invalid arguments");
}
if (map->type != RSPAMD_LUA_MAP_SET &&
map->type != RSPAMD_LUA_MAP_REGEXP &&
map->type != RSPAMD_LUA_MAP_HASH &&
map->type != RSPAMD_LUA_MAP_REGEXP_MULTIPLE) {
return luaL_error (L, "invalid map type");
}
PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, text_parts), i, tp) {
if (tp->utf_words) {
matches += lua_lookup_words_array (L, 3, task, map, tp->utf_words);
}
}
if (task->meta_words) {
matches += lua_lookup_words_array (L, 3, task, map, task->meta_words);
}
lua_pushinteger (L, matches);
return 1;
}
static gint
lua_task_topointer (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_task *task = lua_check_task (L, 1);
if (task) {
/* XXX: this might cause issues on arm64 and LuaJIT */
lua_pushlightuserdata (L, task);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
/* Image functions */
static gint
lua_image_get_width (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_image *img = lua_check_image (L);
if (img != NULL) {
lua_pushinteger (L, img->width);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_image_get_height (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_image *img = lua_check_image (L);
if (img != NULL) {
lua_pushinteger (L, img->height);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_image_get_type (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_image *img = lua_check_image (L);
if (img != NULL) {
lua_pushstring (L, rspamd_image_type_str (img->type));
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_image_get_size (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_image *img = lua_check_image (L);
if (img != NULL) {
lua_pushinteger (L, img->data->len);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_image_get_filename (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_image *img = lua_check_image (L);
if (img != NULL) {
if (img->filename != NULL) {
lua_pushlstring (L, img->filename->begin, img->filename->len);
}
else {
lua_pushnil (L);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
/* Arvhive methods */
static gint
lua_archive_get_type (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
if (arch != NULL) {
lua_pushstring (L, rspamd_archive_type_str (arch->type));
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_archive_get_files (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
guint i;
struct rspamd_archive_file *f;
if (arch != NULL) {
lua_createtable (L, arch->files->len, 0);
for (i = 0; i < arch->files->len; i ++) {
f = g_ptr_array_index (arch->files, i);
lua_pushlstring (L, f->fname->str, f->fname->len);
lua_rawseti (L, -2, i + 1);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_archive_get_files_full (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
guint i;
struct rspamd_archive_file *f;
if (arch != NULL) {
lua_createtable (L, arch->files->len, 0);
for (i = 0; i < arch->files->len; i ++) {
f = g_ptr_array_index (arch->files, i);
lua_createtable (L, 0, 4);
lua_pushstring (L, "name");
lua_pushlstring (L, f->fname->str, f->fname->len);
lua_settable (L, -3);
lua_pushstring (L, "compressed_size");
lua_pushinteger (L, f->compressed_size);
lua_settable (L, -3);
lua_pushstring (L, "uncompressed_size");
lua_pushinteger (L, f->uncompressed_size);
lua_settable (L, -3);
lua_pushstring (L, "encrypted");
lua_pushboolean (L, (f->flags & RSPAMD_ARCHIVE_FILE_ENCRYPTED) ? true : false);
lua_settable (L, -3);
lua_rawseti (L, -2, i + 1);
}
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_archive_is_encrypted (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
if (arch != NULL) {
lua_pushboolean (L, (arch->flags & RSPAMD_ARCHIVE_ENCRYPTED) ? true : false);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_archive_is_unreadable (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
if (arch != NULL) {
lua_pushboolean (L, (arch->flags & RSPAMD_ARCHIVE_CANNOT_READ) ? true : false);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_archive_get_size (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
if (arch != NULL) {
lua_pushinteger (L, arch->size);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
static gint
lua_archive_get_filename (lua_State *L)
{
LUA_TRACE_POINT;
struct rspamd_archive *arch = lua_check_archive (L);
if (arch != NULL) {
lua_pushlstring (L, arch->archive_name->begin, arch->archive_name->len);
}
else {
return luaL_error (L, "invalid arguments");
}
return 1;
}
/* Init part */
static gint
lua_load_task (lua_State * L)
{
lua_newtable (L);
luaL_register (L, NULL, tasklib_f);
return 1;
}
static void
luaopen_archive (lua_State * L)
{
rspamd_lua_new_class (L, "rspamd{archive}", archivelib_m);
lua_pop (L, 1);
}
void
luaopen_task (lua_State * L)
{
rspamd_lua_new_class (L, "rspamd{task}", tasklib_m);
lua_pop (L, 1);
rspamd_lua_add_preload (L, "rspamd_task", lua_load_task);
luaopen_archive (L);
}
void
luaopen_image (lua_State * L)
{
rspamd_lua_new_class (L, "rspamd{image}", imagelib_m);
lua_pop (L, 1);
}
void
rspamd_lua_task_push (lua_State *L, struct rspamd_task *task)
{
struct rspamd_task **ptask;
ptask = lua_newuserdata (L, sizeof (gpointer));
rspamd_lua_setclass (L, "rspamd{task}", -1);
*ptask = task;
}
|