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
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#include "mongo/platform/basic.h"
#include "mongo/db/pipeline/expression.h"
#include <algorithm>
#include <boost/algorithm/string.hpp>
#include <cstdio>
#include <pcrecpp.h>
#include <utility>
#include <vector>
#include "mongo/db/commands/feature_compatibility_version_documentation.h"
#include "mongo/db/exec/document_value/document.h"
#include "mongo/db/exec/document_value/value.h"
#include "mongo/db/hasher.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/pipeline/expression_context.h"
#include "mongo/db/pipeline/variable_validation.h"
#include "mongo/db/query/datetime/date_time_support.h"
#include "mongo/db/query/sort_pattern.h"
#include "mongo/db/stats/counters.h"
#include "mongo/platform/bits.h"
#include "mongo/platform/decimal128.h"
#include "mongo/util/regex_util.h"
#include "mongo/util/str.h"
#include "mongo/util/string_map.h"
#include "mongo/util/summation.h"
namespace mongo {
using Parser = Expression::Parser;
using boost::intrusive_ptr;
using std::move;
using std::pair;
using std::string;
using std::vector;
/// Helper function to easily wrap constants with $const.
static Value serializeConstant(Value val) {
if (val.missing()) {
return Value("$$REMOVE"_sd);
}
return Value(DOC("$const" << val));
}
/* --------------------------- Expression ------------------------------ */
string Expression::removeFieldPrefix(const string& prefixedField) {
uassert(16419,
str::stream() << "field path must not contain embedded null characters",
prefixedField.find('\0') == string::npos);
const char* pPrefixedField = prefixedField.c_str();
uassert(15982,
str::stream() << "field path references must be prefixed with a '$' ('" << prefixedField
<< "'",
pPrefixedField[0] == '$');
return string(pPrefixedField + 1);
}
intrusive_ptr<Expression> Expression::parseObject(ExpressionContext* const expCtx,
BSONObj obj,
const VariablesParseState& vps) {
if (obj.isEmpty()) {
return ExpressionObject::create(expCtx, {});
}
if (obj.firstElementFieldName()[0] == '$') {
// Assume this is an expression like {$add: [...]}.
return parseExpression(expCtx, obj, vps);
}
return ExpressionObject::parse(expCtx, obj, vps);
}
namespace {
struct ParserRegistration {
Parser parser;
AllowedWithApiStrict allowedWithApiStrict;
AllowedWithClientType allowedWithClientType;
boost::optional<multiversion::FeatureCompatibilityVersion> requiredMinVersion;
};
/**
* Converts 'value' to TimeUnit for an expression named 'expressionName'. It assumes that the
* parameter is named "unit". Throws an AssertionException if 'value' contains an invalid value.
*/
TimeUnit parseTimeUnit(const Value& value, StringData expressionName) {
uassert(5439013,
str::stream() << expressionName << " requires 'unit' to be a string, but got "
<< typeName(value.getType()),
BSONType::String == value.getType());
uassert(5439014,
str::stream() << expressionName
<< " parameter 'unit' value cannot be recognized as a time unit: "
<< value.getStringData(),
isValidTimeUnit(value.getStringData()));
return parseTimeUnit(value.getStringData());
}
/**
* Converts 'value' to DayOfWeek for an expression named 'expressionName' with parameter named as
* 'parameterName'. Throws an AssertionException if 'value' contains an invalid value.
*/
DayOfWeek parseDayOfWeek(const Value& value, StringData expressionName, StringData parameterName) {
uassert(5439015,
str::stream() << expressionName << " requires '" << parameterName
<< "' to be a string, but got " << typeName(value.getType()),
BSONType::String == value.getType());
uassert(5439016,
str::stream() << expressionName << " parameter '" << parameterName
<< "' value cannot be recognized as a day of a week: "
<< value.getStringData(),
isValidDayOfWeek(value.getStringData()));
return parseDayOfWeek(value.getStringData());
}
bool isTimeUnitWeek(const Value& unit) {
return BSONType::String == unit.getType() && unit.getStringData() == "week"_sd;
}
/**
* Calls function 'function' with zero parameters and returns the result. If AssertionException is
* raised during the call of 'function', adds a context 'errorContext' to the exception.
*/
template <typename F>
auto addContextToAssertionException(F&& function, StringData errorContext) {
try {
return function();
} catch (AssertionException& exception) {
exception.addContext(str::stream() << errorContext);
throw;
}
}
StringMap<ParserRegistration> parserMap;
} // namespace
void Expression::registerExpression(
string key,
Parser parser,
AllowedWithApiStrict allowedWithApiStrict,
AllowedWithClientType allowedWithClientType,
boost::optional<multiversion::FeatureCompatibilityVersion> requiredMinVersion) {
auto op = parserMap.find(key);
massert(17064,
str::stream() << "Duplicate expression (" << key << ") registered.",
op == parserMap.end());
parserMap[key] =
ParserRegistration{parser, allowedWithApiStrict, allowedWithClientType, requiredMinVersion};
// Add this expression to the global map of operator counters for expressions.
operatorCountersExpressions.addExpressionCounter(key);
}
intrusive_ptr<Expression> Expression::parseExpression(ExpressionContext* const expCtx,
BSONObj obj,
const VariablesParseState& vps) {
uassert(15983,
str::stream() << "An object representing an expression must have exactly one "
"field: "
<< obj.toString(),
obj.nFields() == 1);
// Look up the parser associated with the expression name.
const char* opName = obj.firstElementFieldName();
auto it = parserMap.find(opName);
uassert(ErrorCodes::InvalidPipelineOperator,
str::stream() << "Unrecognized expression '" << opName << "'",
it != parserMap.end());
// Make sure we are allowed to use this expression under the current feature compatibility
// version.
auto& entry = it->second;
uassert(ErrorCodes::QueryFeatureNotAllowed,
// We would like to include the current version and the required minimum version in this
// error message, but using FeatureCompatibilityVersion::toString() would introduce a
// dependency cycle (see SERVER-31968).
str::stream() << opName
<< " is not allowed in the current feature compatibility version. See "
<< feature_compatibility_version_documentation::kCompatibilityLink
<< " for more information.",
!expCtx->maxFeatureCompatibilityVersion || !entry.requiredMinVersion ||
(*entry.requiredMinVersion <= *expCtx->maxFeatureCompatibilityVersion));
if (expCtx->opCtx) {
// Only confirm API versioning if in a user operation, and not parsing a collection
// validator. Instead we perform checks for validators at time of access in subsequent
// insert/update.
assertLanguageFeatureIsAllowed(
expCtx->opCtx, opName, entry.allowedWithApiStrict, entry.allowedWithClientType);
}
// Increment the global counter for this expression.
operatorCountersExpressions.incrementExpressionCounter(opName);
return entry.parser(expCtx, obj.firstElement(), vps);
}
Expression::ExpressionVector ExpressionNary::parseArguments(ExpressionContext* const expCtx,
BSONElement exprElement,
const VariablesParseState& vps) {
ExpressionVector out;
if (exprElement.type() == Array) {
BSONForEach(elem, exprElement.Obj()) {
out.push_back(Expression::parseOperand(expCtx, elem, vps));
}
} else { // Assume it's an operand that accepts a single argument.
out.push_back(Expression::parseOperand(expCtx, exprElement, vps));
}
return out;
}
intrusive_ptr<Expression> Expression::parseOperand(ExpressionContext* const expCtx,
BSONElement exprElement,
const VariablesParseState& vps) {
BSONType type = exprElement.type();
if (type == String && exprElement.valuestr()[0] == '$') {
/* if we got here, this is a field path expression */
return ExpressionFieldPath::parse(expCtx, exprElement.str(), vps);
} else if (type == Object) {
return Expression::parseObject(expCtx, exprElement.Obj(), vps);
} else if (type == Array) {
return ExpressionArray::parse(expCtx, exprElement, vps);
} else {
return ExpressionConstant::parse(expCtx, exprElement, vps);
}
}
bool Expression::isExpressionName(StringData name) {
return parserMap.find(name) != parserMap.end();
}
/* ------------------------- Register Date Expressions ----------------------------- */
REGISTER_STABLE_EXPRESSION(dayOfMonth, ExpressionDayOfMonth::parse);
REGISTER_STABLE_EXPRESSION(dayOfWeek, ExpressionDayOfWeek::parse);
REGISTER_STABLE_EXPRESSION(dayOfYear, ExpressionDayOfYear::parse);
REGISTER_STABLE_EXPRESSION(hour, ExpressionHour::parse);
REGISTER_STABLE_EXPRESSION(isoDayOfWeek, ExpressionIsoDayOfWeek::parse);
REGISTER_STABLE_EXPRESSION(isoWeek, ExpressionIsoWeek::parse);
REGISTER_STABLE_EXPRESSION(isoWeekYear, ExpressionIsoWeekYear::parse);
REGISTER_STABLE_EXPRESSION(millisecond, ExpressionMillisecond::parse);
REGISTER_STABLE_EXPRESSION(minute, ExpressionMinute::parse);
REGISTER_STABLE_EXPRESSION(month, ExpressionMonth::parse);
REGISTER_STABLE_EXPRESSION(second, ExpressionSecond::parse);
REGISTER_STABLE_EXPRESSION(week, ExpressionWeek::parse);
REGISTER_STABLE_EXPRESSION(year, ExpressionYear::parse);
/* ----------------------- ExpressionAbs ---------------------------- */
Value ExpressionAbs::evaluateNumericArg(const Value& numericArg) const {
BSONType type = numericArg.getType();
if (type == NumberDouble) {
return Value(std::abs(numericArg.getDouble()));
} else if (type == NumberDecimal) {
return Value(numericArg.getDecimal().toAbs());
} else {
long long num = numericArg.getLong();
uassert(28680,
"can't take $abs of long long min",
num != std::numeric_limits<long long>::min());
long long absVal = std::abs(num);
return type == NumberLong ? Value(absVal) : Value::createIntOrLong(absVal);
}
}
REGISTER_STABLE_EXPRESSION(abs, ExpressionAbs::parse);
const char* ExpressionAbs::getOpName() const {
return "$abs";
}
/* ------------------------- ExpressionAdd ----------------------------- */
StatusWith<Value> ExpressionAdd::apply(Value lhs, Value rhs) {
BSONType diffType = Value::getWidestNumeric(rhs.getType(), lhs.getType());
if (diffType == NumberDecimal) {
Decimal128 left = lhs.coerceToDecimal();
Decimal128 right = rhs.coerceToDecimal();
return Value(left.add(right));
} else if (diffType == NumberDouble) {
double right = rhs.coerceToDouble();
double left = lhs.coerceToDouble();
return Value(left + right);
} else if (diffType == NumberLong) {
long long result;
// If there is an overflow, convert the values to doubles.
if (overflow::add(lhs.coerceToLong(), rhs.coerceToLong(), &result)) {
return Value(lhs.coerceToDouble() + rhs.coerceToDouble());
}
return Value(result);
} else if (diffType == NumberInt) {
long long right = rhs.coerceToLong();
long long left = lhs.coerceToLong();
return Value::createIntOrLong(left + right);
} else if (lhs.nullish() || rhs.nullish()) {
return Value(BSONNULL);
} else {
return Status(ErrorCodes::TypeMismatch,
str::stream() << "cannot $add a" << typeName(rhs.getType()) << " from a "
<< typeName(lhs.getType()));
}
}
Value ExpressionAdd::evaluate(const Document& root, Variables* variables) const {
// We'll try to return the narrowest possible result value while avoiding overflow, loss
// of precision due to intermediate rounding or implicit use of decimal types. To do that,
// compute a compensated sum for non-decimal values and a separate decimal sum for decimal
// values, and track the current narrowest type.
DoubleDoubleSummation nonDecimalTotal;
Decimal128 decimalTotal;
BSONType totalType = NumberInt;
bool haveDate = false;
const size_t n = _children.size();
for (size_t i = 0; i < n; ++i) {
Value val = _children[i]->evaluate(root, variables);
switch (val.getType()) {
case NumberDecimal:
decimalTotal = decimalTotal.add(val.getDecimal());
totalType = NumberDecimal;
break;
case NumberDouble:
nonDecimalTotal.addDouble(val.getDouble());
if (totalType != NumberDecimal)
totalType = NumberDouble;
break;
case NumberLong:
nonDecimalTotal.addLong(val.getLong());
if (totalType == NumberInt)
totalType = NumberLong;
break;
case NumberInt:
nonDecimalTotal.addDouble(val.getInt());
break;
case Date:
uassert(16612, "only one date allowed in an $add expression", !haveDate);
haveDate = true;
nonDecimalTotal.addLong(val.getDate().toMillisSinceEpoch());
break;
default:
uassert(16554,
str::stream() << "$add only supports numeric or date types, not "
<< typeName(val.getType()),
val.nullish());
return Value(BSONNULL);
}
}
if (haveDate) {
int64_t longTotal;
if (totalType == NumberDecimal) {
longTotal = decimalTotal.add(nonDecimalTotal.getDecimal()).toLong();
} else {
uassert(ErrorCodes::Overflow, "date overflow in $add", nonDecimalTotal.fitsLong());
longTotal = nonDecimalTotal.getLong();
}
return Value(Date_t::fromMillisSinceEpoch(longTotal));
}
switch (totalType) {
case NumberDecimal:
return Value(decimalTotal.add(nonDecimalTotal.getDecimal()));
case NumberLong:
dassert(nonDecimalTotal.isInteger());
if (nonDecimalTotal.fitsLong())
return Value(nonDecimalTotal.getLong());
// Fallthrough.
case NumberInt:
if (nonDecimalTotal.fitsLong())
return Value::createIntOrLong(nonDecimalTotal.getLong());
// Fallthrough.
case NumberDouble:
return Value(nonDecimalTotal.getDouble());
default:
massert(16417, "$add resulted in a non-numeric type", false);
}
}
REGISTER_STABLE_EXPRESSION(add, ExpressionAdd::parse);
const char* ExpressionAdd::getOpName() const {
return "$add";
}
/* ------------------------- ExpressionAllElementsTrue -------------------------- */
Value ExpressionAllElementsTrue::evaluate(const Document& root, Variables* variables) const {
const Value arr = _children[0]->evaluate(root, variables);
uassert(17040,
str::stream() << getOpName() << "'s argument must be an array, but is "
<< typeName(arr.getType()),
arr.isArray());
const vector<Value>& array = arr.getArray();
for (vector<Value>::const_iterator it = array.begin(); it != array.end(); ++it) {
if (!it->coerceToBool()) {
return Value(false);
}
}
return Value(true);
}
REGISTER_STABLE_EXPRESSION(allElementsTrue, ExpressionAllElementsTrue::parse);
const char* ExpressionAllElementsTrue::getOpName() const {
return "$allElementsTrue";
}
/* ------------------------- ExpressionAnd ----------------------------- */
intrusive_ptr<Expression> ExpressionAnd::optimize() {
/* optimize the conjunction as much as possible */
intrusive_ptr<Expression> pE(ExpressionNary::optimize());
/* if the result isn't a conjunction, we can't do anything */
ExpressionAnd* pAnd = dynamic_cast<ExpressionAnd*>(pE.get());
if (!pAnd)
return pE;
/*
Check the last argument on the result; if it's not constant (as
promised by ExpressionNary::optimize(),) then there's nothing
we can do.
*/
const size_t n = pAnd->_children.size();
// ExpressionNary::optimize() generates an ExpressionConstant for {$and:[]}.
verify(n > 0);
intrusive_ptr<Expression> pLast(pAnd->_children[n - 1]);
const ExpressionConstant* pConst = dynamic_cast<ExpressionConstant*>(pLast.get());
if (!pConst)
return pE;
/*
Evaluate and coerce the last argument to a boolean. If it's false,
then we can replace this entire expression.
*/
bool last = pConst->getValue().coerceToBool();
if (!last) {
intrusive_ptr<ExpressionConstant> pFinal(
ExpressionConstant::create(getExpressionContext(), Value(false)));
return pFinal;
}
/*
If we got here, the final operand was true, so we don't need it
anymore. If there was only one other operand, we don't need the
conjunction either. Note we still need to keep the promise that
the result will be a boolean.
*/
if (n == 2) {
intrusive_ptr<Expression> pFinal(
ExpressionCoerceToBool::create(getExpressionContext(), std::move(pAnd->_children[0])));
return pFinal;
}
/*
Remove the final "true" value, and return the new expression.
CW TODO:
Note that because of any implicit conversions, we may need to
apply an implicit boolean conversion.
*/
pAnd->_children.resize(n - 1);
return pE;
}
Value ExpressionAnd::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
for (size_t i = 0; i < n; ++i) {
Value pValue(_children[i]->evaluate(root, variables));
if (!pValue.coerceToBool())
return Value(false);
}
return Value(true);
}
REGISTER_STABLE_EXPRESSION(and, ExpressionAnd::parse);
const char* ExpressionAnd::getOpName() const {
return "$and";
}
/* ------------------------- ExpressionAnyElementTrue -------------------------- */
Value ExpressionAnyElementTrue::evaluate(const Document& root, Variables* variables) const {
const Value arr = _children[0]->evaluate(root, variables);
uassert(17041,
str::stream() << getOpName() << "'s argument must be an array, but is "
<< typeName(arr.getType()),
arr.isArray());
const vector<Value>& array = arr.getArray();
for (vector<Value>::const_iterator it = array.begin(); it != array.end(); ++it) {
if (it->coerceToBool()) {
return Value(true);
}
}
return Value(false);
}
REGISTER_STABLE_EXPRESSION(anyElementTrue, ExpressionAnyElementTrue::parse);
const char* ExpressionAnyElementTrue::getOpName() const {
return "$anyElementTrue";
}
/* ---------------------- ExpressionArray --------------------------- */
Value ExpressionArray::evaluate(const Document& root, Variables* variables) const {
vector<Value> values;
values.reserve(_children.size());
for (auto&& expr : _children) {
Value elemVal = expr->evaluate(root, variables);
values.push_back(elemVal.missing() ? Value(BSONNULL) : std::move(elemVal));
}
return Value(std::move(values));
}
Value ExpressionArray::serialize(bool explain) const {
vector<Value> expressions;
expressions.reserve(_children.size());
for (auto&& expr : _children) {
expressions.push_back(expr->serialize(explain));
}
return Value(std::move(expressions));
}
intrusive_ptr<Expression> ExpressionArray::optimize() {
bool allValuesConstant = true;
for (auto&& expr : _children) {
expr = expr->optimize();
if (!dynamic_cast<ExpressionConstant*>(expr.get())) {
allValuesConstant = false;
}
}
// If all values in ExpressionArray are constant evaluate to ExpressionConstant.
if (allValuesConstant) {
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document(), &(getExpressionContext()->variables)));
}
return this;
}
const char* ExpressionArray::getOpName() const {
// This should never be called, but is needed to inherit from ExpressionNary.
return "$array";
}
/* ------------------------- ExpressionArrayElemAt -------------------------- */
namespace {
Value arrayElemAt(const ExpressionNary* self, Value array, Value indexArg) {
if (array.nullish() || indexArg.nullish()) {
return Value(BSONNULL);
}
size_t arity = self->getOperandList().size();
uassert(28689,
str::stream() << self->getOpName() << "'s "
<< (arity == 1 ? "argument" : "first argument")
<< " must be an array, but is " << typeName(array.getType()),
array.isArray());
uassert(28690,
str::stream() << self->getOpName() << "'s second argument must be a numeric value,"
<< " but is " << typeName(indexArg.getType()),
indexArg.numeric());
uassert(28691,
str::stream() << self->getOpName() << "'s second argument must be representable as"
<< " a 32-bit integer: " << indexArg.coerceToDouble(),
indexArg.integral());
long long i = indexArg.coerceToLong();
if (i < 0 && static_cast<size_t>(std::abs(i)) > array.getArrayLength()) {
// Positive indices that are too large are handled automatically by Value.
return Value();
} else if (i < 0) {
// Index from the back of the array.
i = array.getArrayLength() + i;
}
const size_t index = static_cast<size_t>(i);
return array[index];
}
} // namespace
Value ExpressionArrayElemAt::evaluate(const Document& root, Variables* variables) const {
const Value array = _children[0]->evaluate(root, variables);
const Value indexArg = _children[1]->evaluate(root, variables);
return arrayElemAt(this, array, indexArg);
}
REGISTER_STABLE_EXPRESSION(arrayElemAt, ExpressionArrayElemAt::parse);
const char* ExpressionArrayElemAt::getOpName() const {
return "$arrayElemAt";
}
/* ------------------------- ExpressionFirst -------------------------- */
Value ExpressionFirst::evaluate(const Document& root, Variables* variables) const {
const Value array = _children[0]->evaluate(root, variables);
return arrayElemAt(this, array, Value(0));
}
REGISTER_STABLE_EXPRESSION(first, ExpressionFirst::parse);
const char* ExpressionFirst::getOpName() const {
return "$first";
}
/* ------------------------- ExpressionLast -------------------------- */
Value ExpressionLast::evaluate(const Document& root, Variables* variables) const {
const Value array = _children[0]->evaluate(root, variables);
return arrayElemAt(this, array, Value(-1));
}
REGISTER_STABLE_EXPRESSION(last, ExpressionLast::parse);
const char* ExpressionLast::getOpName() const {
return "$last";
}
/* ------------------------- ExpressionObjectToArray -------------------------- */
Value ExpressionObjectToArray::evaluate(const Document& root, Variables* variables) const {
const Value targetVal = _children[0]->evaluate(root, variables);
if (targetVal.nullish()) {
return Value(BSONNULL);
}
uassert(40390,
str::stream() << "$objectToArray requires a document input, found: "
<< typeName(targetVal.getType()),
(targetVal.getType() == BSONType::Object));
vector<Value> output;
FieldIterator iter = targetVal.getDocument().fieldIterator();
while (iter.more()) {
Document::FieldPair pair = iter.next();
MutableDocument keyvalue;
keyvalue.addField("k", Value(pair.first));
keyvalue.addField("v", std::move(pair.second));
output.push_back(keyvalue.freezeToValue());
}
return Value(output);
}
REGISTER_STABLE_EXPRESSION(objectToArray, ExpressionObjectToArray::parse);
const char* ExpressionObjectToArray::getOpName() const {
return "$objectToArray";
}
/* ------------------------- ExpressionArrayToObject -------------------------- */
Value ExpressionArrayToObject::evaluate(const Document& root, Variables* variables) const {
const Value input = _children[0]->evaluate(root, variables);
if (input.nullish()) {
return Value(BSONNULL);
}
uassert(40386,
str::stream() << "$arrayToObject requires an array input, found: "
<< typeName(input.getType()),
input.isArray());
MutableDocument output;
const vector<Value>& array = input.getArray();
if (array.empty()) {
return output.freezeToValue();
}
// There are two accepted input formats in an array: [ [key, val] ] or [ {k:key, v:val} ]. The
// first array element determines the format for the rest of the array. Mixing input formats is
// not allowed.
bool inputArrayFormat;
if (array[0].isArray()) {
inputArrayFormat = true;
} else if (array[0].getType() == BSONType::Object) {
inputArrayFormat = false;
} else {
uasserted(40398,
str::stream() << "Unrecognised input type format for $arrayToObject: "
<< typeName(array[0].getType()));
}
for (auto&& elem : array) {
if (inputArrayFormat == true) {
uassert(
40396,
str::stream() << "$arrayToObject requires a consistent input format. Elements must"
"all be arrays or all be objects. Array was detected, now found: "
<< typeName(elem.getType()),
elem.isArray());
const vector<Value>& valArray = elem.getArray();
uassert(40397,
str::stream() << "$arrayToObject requires an array of size 2 arrays,"
"found array of size: "
<< valArray.size(),
(valArray.size() == 2));
uassert(40395,
str::stream() << "$arrayToObject requires an array of key-value pairs, where "
"the key must be of type string. Found key type: "
<< typeName(valArray[0].getType()),
(valArray[0].getType() == BSONType::String));
auto keyName = valArray[0].getStringData();
uassert(4940400,
"Key field cannot contain an embedded null byte",
keyName.find('\0') == std::string::npos);
output[keyName] = valArray[1];
} else {
uassert(
40391,
str::stream() << "$arrayToObject requires a consistent input format. Elements must"
"all be arrays or all be objects. Object was detected, now found: "
<< typeName(elem.getType()),
(elem.getType() == BSONType::Object));
uassert(40392,
str::stream() << "$arrayToObject requires an object keys of 'k' and 'v'. "
"Found incorrect number of keys:"
<< elem.getDocument().computeSize(),
(elem.getDocument().computeSize() == 2));
Value key = elem.getDocument().getField("k");
Value value = elem.getDocument().getField("v");
uassert(40393,
str::stream() << "$arrayToObject requires an object with keys 'k' and 'v'. "
"Missing either or both keys from: "
<< elem.toString(),
(!key.missing() && !value.missing()));
uassert(
40394,
str::stream() << "$arrayToObject requires an object with keys 'k' and 'v', where "
"the value of 'k' must be of type string. Found type: "
<< typeName(key.getType()),
(key.getType() == BSONType::String));
auto keyName = key.getStringData();
uassert(4940401,
"Key field cannot contain an embedded null byte",
keyName.find('\0') == std::string::npos);
output[keyName] = value;
}
}
return output.freezeToValue();
}
REGISTER_STABLE_EXPRESSION(arrayToObject, ExpressionArrayToObject::parse);
const char* ExpressionArrayToObject::getOpName() const {
return "$arrayToObject";
}
/* ------------------------- ExpressionBsonSize -------------------------- */
REGISTER_STABLE_EXPRESSION(bsonSize, ExpressionBsonSize::parse);
Value ExpressionBsonSize::evaluate(const Document& root, Variables* variables) const {
Value arg = _children[0]->evaluate(root, variables);
if (arg.nullish())
return Value(BSONNULL);
uassert(31393,
str::stream() << "$bsonSize requires a document input, found: "
<< typeName(arg.getType()),
arg.getType() == BSONType::Object);
return Value(arg.getDocument().toBson().objsize());
}
/* ------------------------- ExpressionCeil -------------------------- */
Value ExpressionCeil::evaluateNumericArg(const Value& numericArg) const {
// There's no point in taking the ceiling of integers or longs, it will have no effect.
switch (numericArg.getType()) {
case NumberDouble:
return Value(std::ceil(numericArg.getDouble()));
case NumberDecimal:
// Round toward the nearest decimal with a zero exponent in the positive direction.
return Value(numericArg.getDecimal().quantize(Decimal128::kNormalizedZero,
Decimal128::kRoundTowardPositive));
default:
return numericArg;
}
}
REGISTER_STABLE_EXPRESSION(ceil, ExpressionCeil::parse);
const char* ExpressionCeil::getOpName() const {
return "$ceil";
}
/* -------------------- ExpressionCoerceToBool ------------------------- */
intrusive_ptr<ExpressionCoerceToBool> ExpressionCoerceToBool::create(
ExpressionContext* const expCtx, intrusive_ptr<Expression> pExpression) {
return new ExpressionCoerceToBool(expCtx, std::move(pExpression));
}
ExpressionCoerceToBool::ExpressionCoerceToBool(ExpressionContext* const expCtx,
intrusive_ptr<Expression> pExpression)
: Expression(expCtx, {std::move(pExpression)}), pExpression(_children[0]) {
expCtx->sbeCompatible = false;
}
intrusive_ptr<Expression> ExpressionCoerceToBool::optimize() {
/* optimize the operand */
pExpression = pExpression->optimize();
/* if the operand already produces a boolean, then we don't need this */
/* LATER - Expression to support a "typeof" query? */
Expression* pE = pExpression.get();
if (dynamic_cast<ExpressionAnd*>(pE) || dynamic_cast<ExpressionOr*>(pE) ||
dynamic_cast<ExpressionNot*>(pE) || dynamic_cast<ExpressionCoerceToBool*>(pE))
return pExpression;
return intrusive_ptr<Expression>(this);
}
void ExpressionCoerceToBool::_doAddDependencies(DepsTracker* deps) const {
pExpression->addDependencies(deps);
}
Value ExpressionCoerceToBool::evaluate(const Document& root, Variables* variables) const {
Value pResult(pExpression->evaluate(root, variables));
bool b = pResult.coerceToBool();
if (b)
return Value(true);
return Value(false);
}
Value ExpressionCoerceToBool::serialize(bool explain) const {
// When not explaining, serialize to an $and expression. When parsed, the $and expression
// will be optimized back into a ExpressionCoerceToBool.
const char* name = explain ? "$coerceToBool" : "$and";
return Value(DOC(name << DOC_ARRAY(pExpression->serialize(explain))));
}
/* ----------------------- ExpressionCompare --------------------------- */
namespace {
struct BoundOp {
ExpressionCompare::CmpOp op;
auto operator()(ExpressionContext* const expCtx,
BSONElement bsonExpr,
const VariablesParseState& vps) const {
return ExpressionCompare::parse(expCtx, std::move(bsonExpr), vps, op);
}
};
} // namespace
REGISTER_STABLE_EXPRESSION(cmp, BoundOp{ExpressionCompare::CMP});
REGISTER_STABLE_EXPRESSION(eq, BoundOp{ExpressionCompare::EQ});
REGISTER_STABLE_EXPRESSION(gt, BoundOp{ExpressionCompare::GT});
REGISTER_STABLE_EXPRESSION(gte, BoundOp{ExpressionCompare::GTE});
REGISTER_STABLE_EXPRESSION(lt, BoundOp{ExpressionCompare::LT});
REGISTER_STABLE_EXPRESSION(lte, BoundOp{ExpressionCompare::LTE});
REGISTER_STABLE_EXPRESSION(ne, BoundOp{ExpressionCompare::NE});
intrusive_ptr<Expression> ExpressionCompare::parse(ExpressionContext* const expCtx,
BSONElement bsonExpr,
const VariablesParseState& vps,
CmpOp op) {
intrusive_ptr<ExpressionCompare> expr = new ExpressionCompare(expCtx, op);
ExpressionVector args = parseArguments(expCtx, bsonExpr, vps);
expr->validateArguments(args);
expr->_children = args;
return expr;
}
boost::intrusive_ptr<ExpressionCompare> ExpressionCompare::create(
ExpressionContext* const expCtx,
CmpOp cmpOp,
const boost::intrusive_ptr<Expression>& exprLeft,
const boost::intrusive_ptr<Expression>& exprRight) {
boost::intrusive_ptr<ExpressionCompare> expr = new ExpressionCompare(expCtx, cmpOp);
expr->_children = {exprLeft, exprRight};
return expr;
}
namespace {
// Lookup table for truth value returns
struct CmpLookup {
const bool truthValue[3]; // truth value for -1, 0, 1
const ExpressionCompare::CmpOp reverse; // reverse(b,a) returns the same as op(a,b)
const char name[5]; // string name with trailing '\0'
};
static const CmpLookup cmpLookup[7] = {
/* -1 0 1 reverse name */
/* EQ */ {{false, true, false}, ExpressionCompare::EQ, "$eq"},
/* NE */ {{true, false, true}, ExpressionCompare::NE, "$ne"},
/* GT */ {{false, false, true}, ExpressionCompare::LT, "$gt"},
/* GTE */ {{false, true, true}, ExpressionCompare::LTE, "$gte"},
/* LT */ {{true, false, false}, ExpressionCompare::GT, "$lt"},
/* LTE */ {{true, true, false}, ExpressionCompare::GTE, "$lte"},
// CMP is special. Only name is used.
/* CMP */ {{false, false, false}, ExpressionCompare::CMP, "$cmp"},
};
} // namespace
Value ExpressionCompare::evaluate(const Document& root, Variables* variables) const {
Value pLeft(_children[0]->evaluate(root, variables));
Value pRight(_children[1]->evaluate(root, variables));
int cmp = getExpressionContext()->getValueComparator().compare(pLeft, pRight);
// Make cmp one of 1, 0, or -1.
if (cmp == 0) {
// leave as 0
} else if (cmp < 0) {
cmp = -1;
} else if (cmp > 0) {
cmp = 1;
}
if (cmpOp == CMP)
return Value(cmp);
bool returnValue = cmpLookup[cmpOp].truthValue[cmp + 1];
return Value(returnValue);
}
const char* ExpressionCompare::getOpName() const {
return cmpLookup[cmpOp].name;
}
/* ------------------------- ExpressionConcat ----------------------------- */
Value ExpressionConcat::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
StringBuilder result;
for (size_t i = 0; i < n; ++i) {
Value val = _children[i]->evaluate(root, variables);
if (val.nullish())
return Value(BSONNULL);
uassert(16702,
str::stream() << "$concat only supports strings, not " << typeName(val.getType()),
val.getType() == String);
result << val.coerceToString();
}
return Value(result.str());
}
REGISTER_STABLE_EXPRESSION(concat, ExpressionConcat::parse);
const char* ExpressionConcat::getOpName() const {
return "$concat";
}
/* ------------------------- ExpressionConcatArrays ----------------------------- */
Value ExpressionConcatArrays::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
vector<Value> values;
for (size_t i = 0; i < n; ++i) {
Value val = _children[i]->evaluate(root, variables);
if (val.nullish()) {
return Value(BSONNULL);
}
uassert(28664,
str::stream() << "$concatArrays only supports arrays, not "
<< typeName(val.getType()),
val.isArray());
const auto& subValues = val.getArray();
values.insert(values.end(), subValues.begin(), subValues.end());
}
return Value(std::move(values));
}
REGISTER_STABLE_EXPRESSION(concatArrays, ExpressionConcatArrays::parse);
const char* ExpressionConcatArrays::getOpName() const {
return "$concatArrays";
}
/* ----------------------- ExpressionCond ------------------------------ */
Value ExpressionCond::evaluate(const Document& root, Variables* variables) const {
Value pCond(_children[0]->evaluate(root, variables));
int idx = pCond.coerceToBool() ? 1 : 2;
return _children[idx]->evaluate(root, variables);
}
boost::intrusive_ptr<Expression> ExpressionCond::optimize() {
for (auto&& child : _children) {
child = child->optimize();
}
if (auto ifOperand = dynamic_cast<ExpressionConstant*>(_children[0].get()); ifOperand) {
return ifOperand->getValue().coerceToBool() ? _children[1] : _children[2];
}
return this;
}
boost::intrusive_ptr<Expression> ExpressionCond::create(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> ifExp,
boost::intrusive_ptr<Expression> elseExpr,
boost::intrusive_ptr<Expression> thenExpr) {
intrusive_ptr<ExpressionCond> ret = new ExpressionCond(expCtx);
ret->_children.resize(3);
ret->_children[0] = ifExp;
ret->_children[1] = elseExpr;
ret->_children[2] = thenExpr;
return ret;
}
intrusive_ptr<Expression> ExpressionCond::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
if (expr.type() != Object) {
return Base::parse(expCtx, expr, vps);
}
verify(expr.fieldNameStringData() == "$cond");
intrusive_ptr<ExpressionCond> ret = new ExpressionCond(expCtx);
ret->_children.resize(3);
const BSONObj args = expr.embeddedObject();
BSONForEach(arg, args) {
if (arg.fieldNameStringData() == "if") {
ret->_children[0] = parseOperand(expCtx, arg, vps);
} else if (arg.fieldNameStringData() == "then") {
ret->_children[1] = parseOperand(expCtx, arg, vps);
} else if (arg.fieldNameStringData() == "else") {
ret->_children[2] = parseOperand(expCtx, arg, vps);
} else {
uasserted(17083,
str::stream() << "Unrecognized parameter to $cond: " << arg.fieldName());
}
}
uassert(17080, "Missing 'if' parameter to $cond", ret->_children[0]);
uassert(17081, "Missing 'then' parameter to $cond", ret->_children[1]);
uassert(17082, "Missing 'else' parameter to $cond", ret->_children[2]);
return ret;
}
REGISTER_STABLE_EXPRESSION(cond, ExpressionCond::parse);
const char* ExpressionCond::getOpName() const {
return "$cond";
}
/* ---------------------- ExpressionConstant --------------------------- */
intrusive_ptr<Expression> ExpressionConstant::parse(ExpressionContext* const expCtx,
BSONElement exprElement,
const VariablesParseState& vps) {
return new ExpressionConstant(expCtx, Value(exprElement));
}
intrusive_ptr<ExpressionConstant> ExpressionConstant::create(ExpressionContext* const expCtx,
const Value& value) {
intrusive_ptr<ExpressionConstant> pEC(new ExpressionConstant(expCtx, value));
return pEC;
}
ExpressionConstant::ExpressionConstant(ExpressionContext* const expCtx, const Value& value)
: Expression(expCtx), _value(value) {}
intrusive_ptr<Expression> ExpressionConstant::optimize() {
/* nothing to do */
return intrusive_ptr<Expression>(this);
}
void ExpressionConstant::_doAddDependencies(DepsTracker* deps) const {
/* nothing to do */
}
Value ExpressionConstant::evaluate(const Document& root, Variables* variables) const {
return _value;
}
Value ExpressionConstant::serialize(bool explain) const {
return serializeConstant(_value);
}
REGISTER_STABLE_EXPRESSION(const, ExpressionConstant::parse);
REGISTER_STABLE_EXPRESSION(literal, ExpressionConstant::parse); // alias
const char* ExpressionConstant::getOpName() const {
return "$const";
}
/* ---------------------- ExpressionDateFromParts ----------------------- */
/* Helper functions also shared with ExpressionDateToParts */
namespace {
boost::optional<TimeZone> makeTimeZone(const TimeZoneDatabase* tzdb,
const Document& root,
const Expression* timeZone,
Variables* variables) {
invariant(tzdb);
if (!timeZone) {
return mongo::TimeZoneDatabase::utcZone();
}
auto timeZoneId = timeZone->evaluate(root, variables);
if (timeZoneId.nullish()) {
return boost::none;
}
uassert(40517,
str::stream() << "timezone must evaluate to a string, found "
<< typeName(timeZoneId.getType()),
timeZoneId.getType() == BSONType::String);
return tzdb->getTimeZone(timeZoneId.getString());
}
} // namespace
REGISTER_STABLE_EXPRESSION(dateFromParts, ExpressionDateFromParts::parse);
intrusive_ptr<Expression> ExpressionDateFromParts::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(40519,
"$dateFromParts only supports an object as its argument",
expr.type() == BSONType::Object);
BSONElement yearElem;
BSONElement monthElem;
BSONElement dayElem;
BSONElement hourElem;
BSONElement minuteElem;
BSONElement secondElem;
BSONElement millisecondElem;
BSONElement isoWeekYearElem;
BSONElement isoWeekElem;
BSONElement isoDayOfWeekElem;
BSONElement timeZoneElem;
const BSONObj args = expr.embeddedObject();
for (auto&& arg : args) {
auto field = arg.fieldNameStringData();
if (field == "year"_sd) {
yearElem = arg;
} else if (field == "month"_sd) {
monthElem = arg;
} else if (field == "day"_sd) {
dayElem = arg;
} else if (field == "hour"_sd) {
hourElem = arg;
} else if (field == "minute"_sd) {
minuteElem = arg;
} else if (field == "second"_sd) {
secondElem = arg;
} else if (field == "millisecond"_sd) {
millisecondElem = arg;
} else if (field == "isoWeekYear"_sd) {
isoWeekYearElem = arg;
} else if (field == "isoWeek"_sd) {
isoWeekElem = arg;
} else if (field == "isoDayOfWeek"_sd) {
isoDayOfWeekElem = arg;
} else if (field == "timezone"_sd) {
timeZoneElem = arg;
} else {
uasserted(40518,
str::stream()
<< "Unrecognized argument to $dateFromParts: " << arg.fieldName());
}
}
if (!yearElem && !isoWeekYearElem) {
uasserted(40516, "$dateFromParts requires either 'year' or 'isoWeekYear' to be present");
}
if (yearElem && (isoWeekYearElem || isoWeekElem || isoDayOfWeekElem)) {
uasserted(40489, "$dateFromParts does not allow mixing natural dates with ISO dates");
}
if (isoWeekYearElem && (yearElem || monthElem || dayElem)) {
uasserted(40525, "$dateFromParts does not allow mixing ISO dates with natural dates");
}
return new ExpressionDateFromParts(
expCtx,
yearElem ? parseOperand(expCtx, yearElem, vps) : nullptr,
monthElem ? parseOperand(expCtx, monthElem, vps) : nullptr,
dayElem ? parseOperand(expCtx, dayElem, vps) : nullptr,
hourElem ? parseOperand(expCtx, hourElem, vps) : nullptr,
minuteElem ? parseOperand(expCtx, minuteElem, vps) : nullptr,
secondElem ? parseOperand(expCtx, secondElem, vps) : nullptr,
millisecondElem ? parseOperand(expCtx, millisecondElem, vps) : nullptr,
isoWeekYearElem ? parseOperand(expCtx, isoWeekYearElem, vps) : nullptr,
isoWeekElem ? parseOperand(expCtx, isoWeekElem, vps) : nullptr,
isoDayOfWeekElem ? parseOperand(expCtx, isoDayOfWeekElem, vps) : nullptr,
timeZoneElem ? parseOperand(expCtx, timeZoneElem, vps) : nullptr);
}
ExpressionDateFromParts::ExpressionDateFromParts(ExpressionContext* const expCtx,
intrusive_ptr<Expression> year,
intrusive_ptr<Expression> month,
intrusive_ptr<Expression> day,
intrusive_ptr<Expression> hour,
intrusive_ptr<Expression> minute,
intrusive_ptr<Expression> second,
intrusive_ptr<Expression> millisecond,
intrusive_ptr<Expression> isoWeekYear,
intrusive_ptr<Expression> isoWeek,
intrusive_ptr<Expression> isoDayOfWeek,
intrusive_ptr<Expression> timeZone)
: Expression(expCtx,
{std::move(year),
std::move(month),
std::move(day),
std::move(hour),
std::move(minute),
std::move(second),
std::move(millisecond),
std::move(isoWeekYear),
std::move(isoWeek),
std::move(isoDayOfWeek),
std::move(timeZone)}),
_year(_children[0]),
_month(_children[1]),
_day(_children[2]),
_hour(_children[3]),
_minute(_children[4]),
_second(_children[5]),
_millisecond(_children[6]),
_isoWeekYear(_children[7]),
_isoWeek(_children[8]),
_isoDayOfWeek(_children[9]),
_timeZone(_children[10]) {}
intrusive_ptr<Expression> ExpressionDateFromParts::optimize() {
if (_year) {
_year = _year->optimize();
}
if (_month) {
_month = _month->optimize();
}
if (_day) {
_day = _day->optimize();
}
if (_hour) {
_hour = _hour->optimize();
}
if (_minute) {
_minute = _minute->optimize();
}
if (_second) {
_second = _second->optimize();
}
if (_millisecond) {
_millisecond = _millisecond->optimize();
}
if (_isoWeekYear) {
_isoWeekYear = _isoWeekYear->optimize();
}
if (_isoWeek) {
_isoWeek = _isoWeek->optimize();
}
if (_isoDayOfWeek) {
_isoDayOfWeek = _isoDayOfWeek->optimize();
}
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (ExpressionConstant::allNullOrConstant({_year,
_month,
_day,
_hour,
_minute,
_second,
_millisecond,
_isoWeekYear,
_isoWeek,
_isoDayOfWeek,
_timeZone})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
}
Value ExpressionDateFromParts::serialize(bool explain) const {
return Value(Document{
{"$dateFromParts",
Document{{"year", _year ? _year->serialize(explain) : Value()},
{"month", _month ? _month->serialize(explain) : Value()},
{"day", _day ? _day->serialize(explain) : Value()},
{"hour", _hour ? _hour->serialize(explain) : Value()},
{"minute", _minute ? _minute->serialize(explain) : Value()},
{"second", _second ? _second->serialize(explain) : Value()},
{"millisecond", _millisecond ? _millisecond->serialize(explain) : Value()},
{"isoWeekYear", _isoWeekYear ? _isoWeekYear->serialize(explain) : Value()},
{"isoWeek", _isoWeek ? _isoWeek->serialize(explain) : Value()},
{"isoDayOfWeek", _isoDayOfWeek ? _isoDayOfWeek->serialize(explain) : Value()},
{"timezone", _timeZone ? _timeZone->serialize(explain) : Value()}}}});
}
bool ExpressionDateFromParts::evaluateNumberWithDefault(const Document& root,
const Expression* field,
StringData fieldName,
long long defaultValue,
long long* returnValue,
Variables* variables) const {
if (!field) {
*returnValue = defaultValue;
return true;
}
auto fieldValue = field->evaluate(root, variables);
if (fieldValue.nullish()) {
return false;
}
uassert(40515,
str::stream() << "'" << fieldName << "' must evaluate to an integer, found "
<< typeName(fieldValue.getType()) << " with value "
<< fieldValue.toString(),
fieldValue.integral64Bit());
*returnValue = fieldValue.coerceToLong();
return true;
}
bool ExpressionDateFromParts::evaluateNumberWithDefaultAndBounds(const Document& root,
const Expression* field,
StringData fieldName,
long long defaultValue,
long long* returnValue,
Variables* variables) const {
bool result =
evaluateNumberWithDefault(root, field, fieldName, defaultValue, returnValue, variables);
uassert(
31034,
str::stream() << "'" << fieldName << "'"
<< " must evaluate to a value in the range [" << kMinValueForDatePart << ", "
<< kMaxValueForDatePart << "]; value " << *returnValue << " is not in range",
!result || (*returnValue >= kMinValueForDatePart && *returnValue <= kMaxValueForDatePart));
return result;
}
Value ExpressionDateFromParts::evaluate(const Document& root, Variables* variables) const {
long long hour, minute, second, millisecond;
if (!evaluateNumberWithDefaultAndBounds(root, _hour.get(), "hour"_sd, 0, &hour, variables) ||
!evaluateNumberWithDefaultAndBounds(
root, _minute.get(), "minute"_sd, 0, &minute, variables) ||
!evaluateNumberWithDefault(root, _second.get(), "second"_sd, 0, &second, variables) ||
!evaluateNumberWithDefault(
root, _millisecond.get(), "millisecond"_sd, 0, &millisecond, variables)) {
// One of the evaluated inputs in nullish.
return Value(BSONNULL);
}
auto timeZone =
makeTimeZone(getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
if (!timeZone) {
return Value(BSONNULL);
}
if (_year) {
long long year, month, day;
if (!evaluateNumberWithDefault(root, _year.get(), "year"_sd, 1970, &year, variables) ||
!evaluateNumberWithDefaultAndBounds(
root, _month.get(), "month"_sd, 1, &month, variables) ||
!evaluateNumberWithDefaultAndBounds(root, _day.get(), "day"_sd, 1, &day, variables)) {
// One of the evaluated inputs in nullish.
return Value(BSONNULL);
}
uassert(40523,
str::stream() << "'year' must evaluate to an integer in the range " << 1 << " to "
<< 9999 << ", found " << year,
year >= 1 && year <= 9999);
return Value(
timeZone->createFromDateParts(year, month, day, hour, minute, second, millisecond));
}
if (_isoWeekYear) {
long long isoWeekYear, isoWeek, isoDayOfWeek;
if (!evaluateNumberWithDefault(
root, _isoWeekYear.get(), "isoWeekYear"_sd, 1970, &isoWeekYear, variables) ||
!evaluateNumberWithDefaultAndBounds(
root, _isoWeek.get(), "isoWeek"_sd, 1, &isoWeek, variables) ||
!evaluateNumberWithDefaultAndBounds(
root, _isoDayOfWeek.get(), "isoDayOfWeek"_sd, 1, &isoDayOfWeek, variables)) {
// One of the evaluated inputs in nullish.
return Value(BSONNULL);
}
uassert(31095,
str::stream() << "'isoWeekYear' must evaluate to an integer in the range " << 1
<< " to " << 9999 << ", found " << isoWeekYear,
isoWeekYear >= 1 && isoWeekYear <= 9999);
return Value(timeZone->createFromIso8601DateParts(
isoWeekYear, isoWeek, isoDayOfWeek, hour, minute, second, millisecond));
}
MONGO_UNREACHABLE;
}
void ExpressionDateFromParts::_doAddDependencies(DepsTracker* deps) const {
if (_year) {
_year->addDependencies(deps);
}
if (_month) {
_month->addDependencies(deps);
}
if (_day) {
_day->addDependencies(deps);
}
if (_hour) {
_hour->addDependencies(deps);
}
if (_minute) {
_minute->addDependencies(deps);
}
if (_second) {
_second->addDependencies(deps);
}
if (_millisecond) {
_millisecond->addDependencies(deps);
}
if (_isoWeekYear) {
_isoWeekYear->addDependencies(deps);
}
if (_isoWeek) {
_isoWeek->addDependencies(deps);
}
if (_isoDayOfWeek) {
_isoDayOfWeek->addDependencies(deps);
}
if (_timeZone) {
_timeZone->addDependencies(deps);
}
}
/* ---------------------- ExpressionDateFromString --------------------- */
REGISTER_STABLE_EXPRESSION(dateFromString, ExpressionDateFromString::parse);
intrusive_ptr<Expression> ExpressionDateFromString::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(40540,
str::stream() << "$dateFromString only supports an object as an argument, found: "
<< typeName(expr.type()),
expr.type() == BSONType::Object);
BSONElement dateStringElem, timeZoneElem, formatElem, onNullElem, onErrorElem;
const BSONObj args = expr.embeddedObject();
for (auto&& arg : args) {
auto field = arg.fieldNameStringData();
if (field == "format"_sd) {
formatElem = arg;
} else if (field == "dateString"_sd) {
dateStringElem = arg;
} else if (field == "timezone"_sd) {
timeZoneElem = arg;
} else if (field == "onNull"_sd) {
onNullElem = arg;
} else if (field == "onError"_sd) {
onErrorElem = arg;
} else {
uasserted(40541,
str::stream()
<< "Unrecognized argument to $dateFromString: " << arg.fieldName());
}
}
uassert(40542, "Missing 'dateString' parameter to $dateFromString", dateStringElem);
return new ExpressionDateFromString(
expCtx,
parseOperand(expCtx, dateStringElem, vps),
timeZoneElem ? parseOperand(expCtx, timeZoneElem, vps) : nullptr,
formatElem ? parseOperand(expCtx, formatElem, vps) : nullptr,
onNullElem ? parseOperand(expCtx, onNullElem, vps) : nullptr,
onErrorElem ? parseOperand(expCtx, onErrorElem, vps) : nullptr);
}
ExpressionDateFromString::ExpressionDateFromString(ExpressionContext* const expCtx,
intrusive_ptr<Expression> dateString,
intrusive_ptr<Expression> timeZone,
intrusive_ptr<Expression> format,
intrusive_ptr<Expression> onNull,
intrusive_ptr<Expression> onError)
: Expression(expCtx,
{std::move(dateString),
std::move(timeZone),
std::move(format),
std::move(onNull),
std::move(onError)}),
_dateString(_children[0]),
_timeZone(_children[1]),
_format(_children[2]),
_onNull(_children[3]),
_onError(_children[4]) {
expCtx->sbeCompatible = false;
}
intrusive_ptr<Expression> ExpressionDateFromString::optimize() {
_dateString = _dateString->optimize();
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (_format) {
_format = _format->optimize();
}
if (_onNull) {
_onNull = _onNull->optimize();
}
if (_onError) {
_onError = _onError->optimize();
}
if (ExpressionConstant::allNullOrConstant(
{_dateString, _timeZone, _format, _onNull, _onError})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
}
Value ExpressionDateFromString::serialize(bool explain) const {
return Value(
Document{{"$dateFromString",
Document{{"dateString", _dateString->serialize(explain)},
{"timezone", _timeZone ? _timeZone->serialize(explain) : Value()},
{"format", _format ? _format->serialize(explain) : Value()},
{"onNull", _onNull ? _onNull->serialize(explain) : Value()},
{"onError", _onError ? _onError->serialize(explain) : Value()}}}});
}
Value ExpressionDateFromString::evaluate(const Document& root, Variables* variables) const {
const Value dateString = _dateString->evaluate(root, variables);
Value formatValue;
// Eagerly validate the format parameter, ignoring if nullish since the input string nullish
// behavior takes precedence.
if (_format) {
formatValue = _format->evaluate(root, variables);
if (!formatValue.nullish()) {
uassert(40684,
str::stream() << "$dateFromString requires that 'format' be a string, found: "
<< typeName(formatValue.getType()) << " with value "
<< formatValue.toString(),
formatValue.getType() == BSONType::String);
TimeZone::validateFromStringFormat(formatValue.getStringData());
}
}
// Evaluate the timezone parameter before checking for nullish input, as this will throw an
// exception for an invalid timezone string.
auto timeZone =
makeTimeZone(getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
// Behavior for nullish input takes precedence over other nullish elements.
if (dateString.nullish()) {
return _onNull ? _onNull->evaluate(root, variables) : Value(BSONNULL);
}
try {
uassert(ErrorCodes::ConversionFailure,
str::stream() << "$dateFromString requires that 'dateString' be a string, found: "
<< typeName(dateString.getType()) << " with value "
<< dateString.toString(),
dateString.getType() == BSONType::String);
const auto dateTimeString = dateString.getStringData();
if (!timeZone) {
return Value(BSONNULL);
}
if (_format) {
if (formatValue.nullish()) {
return Value(BSONNULL);
}
return Value(getExpressionContext()->timeZoneDatabase->fromString(
dateTimeString, timeZone.get(), formatValue.getStringData()));
}
return Value(
getExpressionContext()->timeZoneDatabase->fromString(dateTimeString, timeZone.get()));
} catch (const ExceptionFor<ErrorCodes::ConversionFailure>&) {
if (_onError) {
return _onError->evaluate(root, variables);
}
throw;
}
}
void ExpressionDateFromString::_doAddDependencies(DepsTracker* deps) const {
_dateString->addDependencies(deps);
if (_timeZone) {
_timeZone->addDependencies(deps);
}
if (_format) {
_format->addDependencies(deps);
}
if (_onNull) {
_onNull->addDependencies(deps);
}
if (_onError) {
_onError->addDependencies(deps);
}
}
/* ---------------------- ExpressionDateToParts ----------------------- */
REGISTER_STABLE_EXPRESSION(dateToParts, ExpressionDateToParts::parse);
intrusive_ptr<Expression> ExpressionDateToParts::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(40524,
"$dateToParts only supports an object as its argument",
expr.type() == BSONType::Object);
BSONElement dateElem;
BSONElement timeZoneElem;
BSONElement isoDateElem;
const BSONObj args = expr.embeddedObject();
for (auto&& arg : args) {
auto field = arg.fieldNameStringData();
if (field == "date"_sd) {
dateElem = arg;
} else if (field == "timezone"_sd) {
timeZoneElem = arg;
} else if (field == "iso8601"_sd) {
isoDateElem = arg;
} else {
uasserted(40520,
str::stream()
<< "Unrecognized argument to $dateToParts: " << arg.fieldName());
}
}
uassert(40522, "Missing 'date' parameter to $dateToParts", dateElem);
return new ExpressionDateToParts(
expCtx,
parseOperand(expCtx, dateElem, vps),
timeZoneElem ? parseOperand(expCtx, timeZoneElem, vps) : nullptr,
isoDateElem ? parseOperand(expCtx, isoDateElem, vps) : nullptr);
}
ExpressionDateToParts::ExpressionDateToParts(ExpressionContext* const expCtx,
intrusive_ptr<Expression> date,
intrusive_ptr<Expression> timeZone,
intrusive_ptr<Expression> iso8601)
: Expression(expCtx, {std::move(date), std::move(timeZone), std::move(iso8601)}),
_date(_children[0]),
_timeZone(_children[1]),
_iso8601(_children[2]) {}
intrusive_ptr<Expression> ExpressionDateToParts::optimize() {
_date = _date->optimize();
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (_iso8601) {
_iso8601 = _iso8601->optimize();
}
if (ExpressionConstant::allNullOrConstant({_date, _iso8601, _timeZone})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
}
Value ExpressionDateToParts::serialize(bool explain) const {
return Value(
Document{{"$dateToParts",
Document{{"date", _date->serialize(explain)},
{"timezone", _timeZone ? _timeZone->serialize(explain) : Value()},
{"iso8601", _iso8601 ? _iso8601->serialize(explain) : Value()}}}});
}
boost::optional<int> ExpressionDateToParts::evaluateIso8601Flag(const Document& root,
Variables* variables) const {
if (!_iso8601) {
return false;
}
auto iso8601Output = _iso8601->evaluate(root, variables);
if (iso8601Output.nullish()) {
return boost::none;
}
uassert(40521,
str::stream() << "iso8601 must evaluate to a bool, found "
<< typeName(iso8601Output.getType()),
iso8601Output.getType() == BSONType::Bool);
return iso8601Output.getBool();
}
Value ExpressionDateToParts::evaluate(const Document& root, Variables* variables) const {
const Value date = _date->evaluate(root, variables);
auto timeZone =
makeTimeZone(getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
if (!timeZone) {
return Value(BSONNULL);
}
auto iso8601 = evaluateIso8601Flag(root, variables);
if (!iso8601) {
return Value(BSONNULL);
}
if (date.nullish()) {
return Value(BSONNULL);
}
auto dateValue = date.coerceToDate();
if (*iso8601) {
auto parts = timeZone->dateIso8601Parts(dateValue);
return Value(Document{{"isoWeekYear", parts.year},
{"isoWeek", parts.weekOfYear},
{"isoDayOfWeek", parts.dayOfWeek},
{"hour", parts.hour},
{"minute", parts.minute},
{"second", parts.second},
{"millisecond", parts.millisecond}});
} else {
auto parts = timeZone->dateParts(dateValue);
return Value(Document{{"year", parts.year},
{"month", parts.month},
{"day", parts.dayOfMonth},
{"hour", parts.hour},
{"minute", parts.minute},
{"second", parts.second},
{"millisecond", parts.millisecond}});
}
}
void ExpressionDateToParts::_doAddDependencies(DepsTracker* deps) const {
_date->addDependencies(deps);
if (_timeZone) {
_timeZone->addDependencies(deps);
}
if (_iso8601) {
_iso8601->addDependencies(deps);
}
}
/* ---------------------- ExpressionDateToString ----------------------- */
REGISTER_STABLE_EXPRESSION(dateToString, ExpressionDateToString::parse);
intrusive_ptr<Expression> ExpressionDateToString::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
verify(expr.fieldNameStringData() == "$dateToString");
uassert(18629,
"$dateToString only supports an object as its argument",
expr.type() == BSONType::Object);
BSONElement formatElem, dateElem, timeZoneElem, onNullElem;
for (auto&& arg : expr.embeddedObject()) {
auto field = arg.fieldNameStringData();
if (field == "format"_sd) {
formatElem = arg;
} else if (field == "date"_sd) {
dateElem = arg;
} else if (field == "timezone"_sd) {
timeZoneElem = arg;
} else if (field == "onNull"_sd) {
onNullElem = arg;
} else {
uasserted(18534,
str::stream()
<< "Unrecognized argument to $dateToString: " << arg.fieldName());
}
}
uassert(18628, "Missing 'date' parameter to $dateToString", !dateElem.eoo());
return new ExpressionDateToString(expCtx,
parseOperand(expCtx, dateElem, vps),
formatElem ? parseOperand(expCtx, formatElem, vps) : nullptr,
timeZoneElem ? parseOperand(expCtx, timeZoneElem, vps)
: nullptr,
onNullElem ? parseOperand(expCtx, onNullElem, vps) : nullptr);
}
ExpressionDateToString::ExpressionDateToString(ExpressionContext* const expCtx,
intrusive_ptr<Expression> date,
intrusive_ptr<Expression> format,
intrusive_ptr<Expression> timeZone,
intrusive_ptr<Expression> onNull)
: Expression(expCtx,
{std::move(format), std::move(date), std::move(timeZone), std::move(onNull)}),
_format(_children[0]),
_date(_children[1]),
_timeZone(_children[2]),
_onNull(_children[3]) {
expCtx->sbeCompatible = false;
}
intrusive_ptr<Expression> ExpressionDateToString::optimize() {
_date = _date->optimize();
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (_onNull) {
_onNull = _onNull->optimize();
}
if (_format) {
_format = _format->optimize();
}
if (ExpressionConstant::allNullOrConstant({_date, _format, _timeZone, _onNull})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
}
Value ExpressionDateToString::serialize(bool explain) const {
return Value(
Document{{"$dateToString",
Document{{"date", _date->serialize(explain)},
{"format", _format ? _format->serialize(explain) : Value()},
{"timezone", _timeZone ? _timeZone->serialize(explain) : Value()},
{"onNull", _onNull ? _onNull->serialize(explain) : Value()}}}});
}
Value ExpressionDateToString::evaluate(const Document& root, Variables* variables) const {
const Value date = _date->evaluate(root, variables);
Value formatValue;
// Eagerly validate the format parameter, ignoring if nullish since the input date nullish
// behavior takes precedence.
if (_format) {
formatValue = _format->evaluate(root, variables);
if (!formatValue.nullish()) {
uassert(18533,
str::stream() << "$dateToString requires that 'format' be a string, found: "
<< typeName(formatValue.getType()) << " with value "
<< formatValue.toString(),
formatValue.getType() == BSONType::String);
TimeZone::validateToStringFormat(formatValue.getStringData());
}
}
// Evaluate the timezone parameter before checking for nullish input, as this will throw an
// exception for an invalid timezone string.
auto timeZone =
makeTimeZone(getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
if (date.nullish()) {
return _onNull ? _onNull->evaluate(root, variables) : Value(BSONNULL);
}
if (!timeZone) {
return Value(BSONNULL);
}
if (_format) {
if (formatValue.nullish()) {
return Value(BSONNULL);
}
return Value(uassertStatusOK(
timeZone->formatDate(formatValue.getStringData(), date.coerceToDate())));
}
return Value(uassertStatusOK(timeZone->formatDate(kISOFormatString, date.coerceToDate())));
}
void ExpressionDateToString::_doAddDependencies(DepsTracker* deps) const {
_date->addDependencies(deps);
if (_timeZone) {
_timeZone->addDependencies(deps);
}
if (_onNull) {
_onNull->addDependencies(deps);
}
if (_format) {
_format->addDependencies(deps);
}
}
/* ----------------------- ExpressionDateDiff ---------------------------- */
REGISTER_EXPRESSION_WITH_MIN_VERSION(dateDiff,
ExpressionDateDiff::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
boost::none);
ExpressionDateDiff::ExpressionDateDiff(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> startDate,
boost::intrusive_ptr<Expression> endDate,
boost::intrusive_ptr<Expression> unit,
boost::intrusive_ptr<Expression> timezone,
boost::intrusive_ptr<Expression> startOfWeek)
: Expression{expCtx,
{std::move(startDate),
std::move(endDate),
std::move(unit),
std::move(timezone),
std::move(startOfWeek)}},
_startDate{_children[0]},
_endDate{_children[1]},
_unit{_children[2]},
_timeZone{_children[3]},
_startOfWeek{_children[4]} {}
boost::intrusive_ptr<Expression> ExpressionDateDiff::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
invariant(expr.fieldNameStringData() == "$dateDiff");
uassert(5166301,
"$dateDiff only supports an object as its argument",
expr.type() == BSONType::Object);
BSONElement startDateElement, endDateElement, unitElement, timezoneElement, startOfWeekElement;
for (auto&& element : expr.embeddedObject()) {
auto field = element.fieldNameStringData();
if ("startDate"_sd == field) {
startDateElement = element;
} else if ("endDate"_sd == field) {
endDateElement = element;
} else if ("unit"_sd == field) {
unitElement = element;
} else if ("timezone"_sd == field) {
timezoneElement = element;
} else if ("startOfWeek"_sd == field) {
startOfWeekElement = element;
} else {
uasserted(5166302,
str::stream()
<< "Unrecognized argument to $dateDiff: " << element.fieldName());
}
}
uassert(5166303, "Missing 'startDate' parameter to $dateDiff", startDateElement);
uassert(5166304, "Missing 'endDate' parameter to $dateDiff", endDateElement);
uassert(5166305, "Missing 'unit' parameter to $dateDiff", unitElement);
return make_intrusive<ExpressionDateDiff>(
expCtx,
parseOperand(expCtx, startDateElement, vps),
parseOperand(expCtx, endDateElement, vps),
parseOperand(expCtx, unitElement, vps),
timezoneElement ? parseOperand(expCtx, timezoneElement, vps) : nullptr,
startOfWeekElement ? parseOperand(expCtx, startOfWeekElement, vps) : nullptr);
}
boost::intrusive_ptr<Expression> ExpressionDateDiff::optimize() {
_startDate = _startDate->optimize();
_endDate = _endDate->optimize();
_unit = _unit->optimize();
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (_startOfWeek) {
_startOfWeek = _startOfWeek->optimize();
}
if (ExpressionConstant::allNullOrConstant(
{_startDate, _endDate, _unit, _timeZone, _startOfWeek})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
};
Value ExpressionDateDiff::serialize(bool explain) const {
return Value{Document{
{"$dateDiff"_sd,
Document{{"startDate"_sd, _startDate->serialize(explain)},
{"endDate"_sd, _endDate->serialize(explain)},
{"unit"_sd, _unit->serialize(explain)},
{"timezone"_sd, _timeZone ? _timeZone->serialize(explain) : Value{}},
{"startOfWeek"_sd, _startOfWeek ? _startOfWeek->serialize(explain) : Value{}}}}}};
};
Date_t ExpressionDateDiff::convertToDate(const Value& value, StringData parameterName) {
uassert(5166307,
str::stream() << "$dateDiff requires '" << parameterName << "' to be a date, but got "
<< typeName(value.getType()),
value.coercibleToDate());
return value.coerceToDate();
}
Value ExpressionDateDiff::evaluate(const Document& root, Variables* variables) const {
const Value startDateValue = _startDate->evaluate(root, variables);
if (startDateValue.nullish()) {
return Value(BSONNULL);
}
const Value endDateValue = _endDate->evaluate(root, variables);
if (endDateValue.nullish()) {
return Value(BSONNULL);
}
const Value unitValue = _unit->evaluate(root, variables);
if (unitValue.nullish()) {
return Value(BSONNULL);
}
const auto startOfWeekParameterActive = _startOfWeek && isTimeUnitWeek(unitValue);
Value startOfWeekValue{};
if (startOfWeekParameterActive) {
startOfWeekValue = _startOfWeek->evaluate(root, variables);
if (startOfWeekValue.nullish()) {
return Value(BSONNULL);
}
}
const auto timezone = addContextToAssertionException(
[&]() {
return makeTimeZone(
getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
},
"$dateDiff parameter 'timezone' value parsing failed"_sd);
if (!timezone) {
return Value(BSONNULL);
}
const Date_t startDate = convertToDate(startDateValue, "startDate"_sd);
const Date_t endDate = convertToDate(endDateValue, "endDate"_sd);
const TimeUnit unit = parseTimeUnit(unitValue, "$dateDiff"_sd);
const DayOfWeek startOfWeek = startOfWeekParameterActive
? parseDayOfWeek(startOfWeekValue, "$dateDiff"_sd, "startOfWeek"_sd)
: kStartOfWeekDefault;
return Value{dateDiff(startDate, endDate, unit, *timezone, startOfWeek)};
}
void ExpressionDateDiff::_doAddDependencies(DepsTracker* deps) const {
_startDate->addDependencies(deps);
_endDate->addDependencies(deps);
_unit->addDependencies(deps);
if (_timeZone) {
_timeZone->addDependencies(deps);
}
if (_startOfWeek) {
_startOfWeek->addDependencies(deps);
}
}
/* ----------------------- ExpressionDivide ---------------------------- */
Value ExpressionDivide::evaluate(const Document& root, Variables* variables) const {
return uassertStatusOK(
apply(_children[0]->evaluate(root, variables), _children[1]->evaluate(root, variables)));
}
StatusWith<Value> ExpressionDivide::apply(Value lhs, Value rhs) {
if (lhs.numeric() && rhs.numeric()) {
// If, and only if, either side is decimal, return decimal.
if (lhs.getType() == NumberDecimal || rhs.getType() == NumberDecimal) {
Decimal128 numer = lhs.coerceToDecimal();
Decimal128 denom = rhs.coerceToDecimal();
if (denom.isZero())
return Status(ErrorCodes::BadValue, "can't $divide by zero");
return Value(numer.divide(denom));
}
double numer = lhs.coerceToDouble();
double denom = rhs.coerceToDouble();
if (denom == 0.0)
return Status(ErrorCodes::BadValue, "can't $divide by zero");
return Value(numer / denom);
} else if (lhs.nullish() || rhs.nullish()) {
return Value(BSONNULL);
} else {
return Status(ErrorCodes::TypeMismatch,
str::stream()
<< "$divide only supports numeric types, not " << typeName(lhs.getType())
<< " and " << typeName(rhs.getType()));
}
}
REGISTER_STABLE_EXPRESSION(divide, ExpressionDivide::parse);
const char* ExpressionDivide::getOpName() const {
return "$divide";
}
/* ----------------------- ExpressionExp ---------------------------- */
Value ExpressionExp::evaluateNumericArg(const Value& numericArg) const {
// $exp always returns either a double or a decimal number, as e is irrational.
if (numericArg.getType() == NumberDecimal)
return Value(numericArg.coerceToDecimal().exponential());
return Value(exp(numericArg.coerceToDouble()));
}
REGISTER_STABLE_EXPRESSION(exp, ExpressionExp::parse);
const char* ExpressionExp::getOpName() const {
return "$exp";
}
/* ---------------------- ExpressionObject --------------------------- */
ExpressionObject::ExpressionObject(ExpressionContext* const expCtx,
std::vector<boost::intrusive_ptr<Expression>> _children,
vector<pair<string, intrusive_ptr<Expression>&>>&& expressions)
: Expression(expCtx, std::move(_children)), _expressions(std::move(expressions)) {
expCtx->sbeCompatible = false;
}
boost::intrusive_ptr<ExpressionObject> ExpressionObject::create(
ExpressionContext* const expCtx,
std::vector<std::pair<std::string, boost::intrusive_ptr<Expression>>>&&
expressionsWithChildrenInPlace) {
std::vector<boost::intrusive_ptr<Expression>> children;
std::vector<std::pair<std::string, boost::intrusive_ptr<Expression>&>> expressions;
for (auto& [unused, expression] : expressionsWithChildrenInPlace)
// These 'push_back's must complete before we insert references to the 'children' vector
// into the 'expressions' vector since 'push_back' invalidates references.
children.push_back(std::move(expression));
std::vector<boost::intrusive_ptr<Expression>>::size_type index = 0;
for (auto& [fieldName, unused] : expressionsWithChildrenInPlace) {
expressions.emplace_back(fieldName, children[index]);
++index;
}
// It is safe to 'std::move' 'children' since the standard guarantees the references are stable.
return new ExpressionObject(expCtx, std::move(children), std::move(expressions));
}
intrusive_ptr<ExpressionObject> ExpressionObject::parse(ExpressionContext* const expCtx,
BSONObj obj,
const VariablesParseState& vps) {
// Make sure we don't have any duplicate field names.
stdx::unordered_set<string> specifiedFields;
std::vector<boost::intrusive_ptr<Expression>> children;
vector<pair<string, intrusive_ptr<Expression>&>> expressions;
for (auto&& elem : obj) {
// Make sure this element has a valid field name. Use StringData here so that we can detect
// if the field name contains a null byte.
FieldPath::uassertValidFieldName(elem.fieldNameStringData());
auto fieldName = elem.fieldName();
uassert(16406,
str::stream() << "duplicate field name specified in object literal: "
<< obj.toString(),
specifiedFields.find(fieldName) == specifiedFields.end());
specifiedFields.insert(fieldName);
children.push_back(parseOperand(expCtx, elem, vps));
}
std::vector<boost::intrusive_ptr<Expression>>::size_type index = 0;
for (auto&& elem : obj) {
expressions.emplace_back(elem.fieldName(), children[index]);
++index;
}
return new ExpressionObject{expCtx, std::move(children), std::move(expressions)};
}
intrusive_ptr<Expression> ExpressionObject::optimize() {
bool allValuesConstant = true;
for (auto&& pair : _expressions) {
pair.second = pair.second->optimize();
if (!dynamic_cast<ExpressionConstant*>(pair.second.get())) {
allValuesConstant = false;
}
}
// If all values in ExpressionObject are constant evaluate to ExpressionConstant.
if (allValuesConstant) {
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document(), &(getExpressionContext()->variables)));
}
return this;
}
void ExpressionObject::_doAddDependencies(DepsTracker* deps) const {
for (auto&& child : _children) {
child->addDependencies(deps);
}
}
Value ExpressionObject::evaluate(const Document& root, Variables* variables) const {
MutableDocument outputDoc;
for (auto&& pair : _expressions) {
outputDoc.addField(pair.first, pair.second->evaluate(root, variables));
}
return outputDoc.freezeToValue();
}
Value ExpressionObject::serialize(bool explain) const {
MutableDocument outputDoc;
for (auto&& pair : _expressions) {
outputDoc.addField(pair.first, pair.second->serialize(explain));
}
return outputDoc.freezeToValue();
}
Expression::ComputedPaths ExpressionObject::getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar) const {
ComputedPaths outputPaths;
for (auto&& pair : _expressions) {
auto exprComputedPaths = pair.second->getComputedPaths(pair.first, renamingVar);
for (auto&& renames : exprComputedPaths.renames) {
auto newPath = FieldPath::getFullyQualifiedPath(exprFieldPath, renames.first);
outputPaths.renames[std::move(newPath)] = renames.second;
}
for (auto&& path : exprComputedPaths.paths) {
outputPaths.paths.insert(FieldPath::getFullyQualifiedPath(exprFieldPath, path));
}
}
return outputPaths;
}
/* --------------------- ExpressionFieldPath --------------------------- */
// this is the old deprecated version only used by tests not using variables
intrusive_ptr<ExpressionFieldPath> ExpressionFieldPath::deprecatedCreate(
ExpressionContext* const expCtx, const string& fieldPath) {
return new ExpressionFieldPath(expCtx, "CURRENT." + fieldPath, Variables::kRootId);
}
// this is the new version that supports every syntax
intrusive_ptr<ExpressionFieldPath> ExpressionFieldPath::parse(ExpressionContext* const expCtx,
const string& raw,
const VariablesParseState& vps) {
uassert(16873,
str::stream() << "FieldPath '" << raw << "' doesn't start with $",
raw.c_str()[0] == '$'); // c_str()[0] is always a valid reference.
uassert(16872,
str::stream() << "'$' by itself is not a valid FieldPath",
raw.size() >= 2); // need at least "$" and either "$" or a field name
if (raw[1] == '$') {
const StringData rawSD = raw;
const StringData fieldPath = rawSD.substr(2); // strip off $$
const StringData varName = fieldPath.substr(0, fieldPath.find('.'));
variableValidation::validateNameForUserRead(varName);
auto varId = vps.getVariable(varName);
if (varName.compare(Variables::getBuiltinVariableName(Variables::kSearchMetaId)) == 0) {
return new ExpressionFieldPathNonSharded(
expCtx,
fieldPath.toString(),
varId,
std::string("Search queries accessing $$SEARCH_META are not supported in sharded "
"pipelines"));
}
return new ExpressionFieldPath(expCtx, fieldPath.toString(), varId);
} else {
return new ExpressionFieldPath(expCtx,
"CURRENT." + raw.substr(1), // strip the "$" prefix
vps.getVariable("CURRENT"));
}
}
intrusive_ptr<ExpressionFieldPath> ExpressionFieldPath::createPathFromString(
ExpressionContext* const expCtx, const string& raw, const VariablesParseState& vps) {
return new ExpressionFieldPath(expCtx, "CURRENT." + raw, vps.getVariable("CURRENT"));
}
intrusive_ptr<ExpressionFieldPath> ExpressionFieldPath::createVarFromString(
ExpressionContext* const expCtx, const string& raw, const VariablesParseState& vps) {
const auto rawSD = StringData{raw};
const StringData varName = rawSD.substr(0, rawSD.find('.'));
auto varId = vps.getVariable(varName);
return new ExpressionFieldPath(expCtx, raw, varId);
}
ExpressionFieldPath::ExpressionFieldPath(ExpressionContext* const expCtx,
const string& theFieldPath,
Variables::Id variable)
: Expression(expCtx), _fieldPath(theFieldPath), _variable(variable) {
const auto varName = theFieldPath.substr(0, theFieldPath.find('.'));
tassert(5943201,
std::string{"Variable with $$ROOT's id is not $$CURRENT or $$ROOT as expected, "
"field path is actually '"} +
theFieldPath + "'",
_variable != Variables::kRootId || varName == "CURRENT" || varName == "ROOT");
}
intrusive_ptr<Expression> ExpressionFieldPath::optimize() {
if (_variable == Variables::kRemoveId) {
// The REMOVE system variable optimizes to a constant missing value.
return ExpressionConstant::create(getExpressionContext(), Value());
}
if (getExpressionContext()->variables.hasConstantValue(_variable)) {
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document(), &(getExpressionContext()->variables)));
}
return intrusive_ptr<Expression>(this);
}
bool ExpressionFieldPath::representsPath(const std::string& dottedPath) const {
if (_variable != Variables::kRootId || _fieldPath.getPathLength() == 1) {
// This variable refers to the entire document, or refers to a sub-field of something
// besides the root document. Either way we can't prove that it represents the path given by
// 'dottedPath'.
return false;
}
return _fieldPath.tail().fullPath() == dottedPath;
}
void ExpressionFieldPath::_doAddDependencies(DepsTracker* deps) const {
if (_variable == Variables::kRootId) { // includes CURRENT when it is equivalent to ROOT.
if (_fieldPath.getPathLength() == 1) {
deps->needWholeDocument = true; // need full doc if just "$$ROOT"
} else {
deps->fields.insert(_fieldPath.tail().fullPath());
}
} else if (Variables::isUserDefinedVariable(_variable)) {
deps->vars.insert(_variable);
}
}
Value ExpressionFieldPath::evaluatePathArray(size_t index, const Value& input) const {
dassert(input.isArray());
// Check for remaining path in each element of array
vector<Value> result;
const vector<Value>& array = input.getArray();
for (size_t i = 0; i < array.size(); i++) {
if (array[i].getType() != Object)
continue;
const Value nested = evaluatePath(index, array[i].getDocument());
if (!nested.missing())
result.push_back(nested);
}
return Value(std::move(result));
}
Value ExpressionFieldPath::evaluatePath(size_t index, const Document& input) const {
// Note this function is very hot so it is important that is is well optimized.
// In particular, all return paths should support RVO.
/* if we've hit the end of the path, stop */
if (index == _fieldPath.getPathLength() - 1)
return input[_fieldPath.getFieldName(index)];
// Try to dive deeper
const Value val = input[_fieldPath.getFieldName(index)];
switch (val.getType()) {
case Object:
return evaluatePath(index + 1, val.getDocument());
case Array:
return evaluatePathArray(index + 1, val);
default:
return Value();
}
}
Value ExpressionFieldPath::evaluate(const Document& root, Variables* variables) const {
if (_fieldPath.getPathLength() == 1) // get the whole variable
return variables->getValue(_variable, root);
if (_variable == Variables::kRootId) {
// ROOT is always a document so use optimized code path
return evaluatePath(1, root);
}
Value var = variables->getValue(_variable, root);
switch (var.getType()) {
case Object:
return evaluatePath(1, var.getDocument());
case Array:
return evaluatePathArray(1, var);
default:
return Value();
}
}
Value ExpressionFieldPath::serialize(bool explain) const {
if (_fieldPath.getFieldName(0) == "CURRENT" && _fieldPath.getPathLength() > 1) {
// use short form for "$$CURRENT.foo" but not just "$$CURRENT"
return Value("$" + _fieldPath.tail().fullPath());
} else {
return Value("$$" + _fieldPath.fullPath());
}
}
Value ExpressionFieldPathNonSharded::evaluate(const Document& root, Variables* variables) const {
uassert(
5858100, _errMsg, !getExpressionContext()->needsMerge && !getExpressionContext()->inMongos);
return ExpressionFieldPath::evaluate(root, variables);
}
Expression::ComputedPaths ExpressionFieldPath::getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar) const {
// An expression field path is either considered a rename or a computed path. We need to find
// out which case we fall into.
//
// The caller has told us that renames must have 'varId' as the first component. We also check
// that there is only one additional component---no dotted field paths are allowed! This is
// because dotted ExpressionFieldPaths can actually reshape the document rather than just
// changing the field names. This can happen only if there are arrays along the dotted path.
//
// For example, suppose you have document {a: [{b: 1}, {b: 2}]}. The projection {"c.d": "$a.b"}
// does *not* perform the strict rename to yield document {c: [{d: 1}, {d: 2}]}. Instead, it
// results in the document {c: {d: [1, 2]}}. Due to this reshaping, matches expressed over "a.b"
// before the $project is applied may not have the same behavior when expressed over "c.d" after
// the $project is applied.
ComputedPaths outputPaths;
if (_variable == renamingVar && _fieldPath.getPathLength() == 2u) {
outputPaths.renames[exprFieldPath] = _fieldPath.tail().fullPath();
} else {
outputPaths.paths.insert(exprFieldPath);
}
return outputPaths;
}
std::unique_ptr<Expression> ExpressionFieldPath::copyWithSubstitution(
const StringMap<std::string>& renameList) const {
if (_variable != Variables::kRootId || _fieldPath.getPathLength() == 1) {
return nullptr;
}
FieldRef path(getFieldPathWithoutCurrentPrefix().fullPath());
for (const auto& rename : renameList) {
if (FieldRef oldName(rename.first); oldName.isPrefixOfOrEqualTo(path)) {
// Remove the path components of 'oldName' from 'path'.
auto suffix = (path == oldName)
? ""
: "." + path.dottedSubstring(oldName.numParts(), path.numParts());
return std::unique_ptr<Expression>(new ExpressionFieldPath(
getExpressionContext(), "CURRENT." + rename.second + suffix, getVariableId()));
}
}
return nullptr;
}
/* ------------------------- ExpressionFilter ----------------------------- */
REGISTER_STABLE_EXPRESSION(filter, ExpressionFilter::parse);
intrusive_ptr<Expression> ExpressionFilter::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
verify(expr.fieldNameStringData() == "$filter");
uassert(28646, "$filter only supports an object as its argument", expr.type() == Object);
// "cond" must be parsed after "as" regardless of BSON order.
BSONElement inputElem;
BSONElement asElem;
BSONElement condElem;
for (auto elem : expr.Obj()) {
if (elem.fieldNameStringData() == "input") {
inputElem = elem;
} else if (elem.fieldNameStringData() == "as") {
asElem = elem;
} else if (elem.fieldNameStringData() == "cond") {
condElem = elem;
} else {
uasserted(28647,
str::stream() << "Unrecognized parameter to $filter: " << elem.fieldName());
}
}
uassert(28648, "Missing 'input' parameter to $filter", !inputElem.eoo());
uassert(28650, "Missing 'cond' parameter to $filter", !condElem.eoo());
// Parse "input", only has outer variables.
intrusive_ptr<Expression> input = parseOperand(expCtx, inputElem, vpsIn);
// Parse "as".
VariablesParseState vpsSub(vpsIn); // vpsSub gets our variable, vpsIn doesn't.
// If "as" is not specified, then use "this" by default.
auto varName = asElem.eoo() ? "this" : asElem.str();
variableValidation::validateNameForUserWrite(varName);
Variables::Id varId = vpsSub.defineVariable(varName);
// Parse "cond", has access to "as" variable.
intrusive_ptr<Expression> cond = parseOperand(expCtx, condElem, vpsSub);
return new ExpressionFilter(
expCtx, std::move(varName), varId, std::move(input), std::move(cond));
}
ExpressionFilter::ExpressionFilter(ExpressionContext* const expCtx,
string varName,
Variables::Id varId,
intrusive_ptr<Expression> input,
intrusive_ptr<Expression> filter)
: Expression(expCtx, {std::move(input), std::move(filter)}),
_varName(std::move(varName)),
_varId(varId),
_input(_children[0]),
_filter(_children[1]) {}
intrusive_ptr<Expression> ExpressionFilter::optimize() {
// TODO handle when _input is constant.
_input = _input->optimize();
_filter = _filter->optimize();
return this;
}
Value ExpressionFilter::serialize(bool explain) const {
return Value(DOC("$filter" << DOC("input" << _input->serialize(explain) << "as" << _varName
<< "cond" << _filter->serialize(explain))));
}
Value ExpressionFilter::evaluate(const Document& root, Variables* variables) const {
// We are guaranteed at parse time that this isn't using our _varId.
const Value inputVal = _input->evaluate(root, variables);
if (inputVal.nullish())
return Value(BSONNULL);
uassert(28651,
str::stream() << "input to $filter must be an array not "
<< typeName(inputVal.getType()),
inputVal.isArray());
const vector<Value>& input = inputVal.getArray();
if (input.empty())
return inputVal;
vector<Value> output;
for (const auto& elem : input) {
variables->setValue(_varId, elem);
if (_filter->evaluate(root, variables).coerceToBool()) {
output.push_back(std::move(elem));
}
}
return Value(std::move(output));
}
void ExpressionFilter::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_filter->addDependencies(deps);
}
/* ------------------------- ExpressionFloor -------------------------- */
StatusWith<Value> ExpressionFloor::apply(Value arg) {
if (!arg.numeric()) {
return Status{ErrorCodes::Error(5733411), "Floor must take a numeric argument"};
}
switch (arg.getType()) {
case NumberDouble:
return Value(std::floor(arg.getDouble()));
case NumberDecimal:
// Round toward the nearest decimal with a zero exponent in the negative direction.
return Value(arg.getDecimal().quantize(Decimal128::kNormalizedZero,
Decimal128::kRoundTowardNegative));
default:
return arg;
}
}
Value ExpressionFloor::evaluateNumericArg(const Value& numericArg) const {
// There's no point in taking the floor of integers or longs, it will have no effect.
switch (numericArg.getType()) {
case NumberDouble:
return Value(std::floor(numericArg.getDouble()));
case NumberDecimal:
// Round toward the nearest decimal with a zero exponent in the negative direction.
return Value(numericArg.getDecimal().quantize(Decimal128::kNormalizedZero,
Decimal128::kRoundTowardNegative));
default:
return numericArg;
}
}
REGISTER_STABLE_EXPRESSION(floor, ExpressionFloor::parse);
const char* ExpressionFloor::getOpName() const {
return "$floor";
}
/* ------------------------- ExpressionLet ----------------------------- */
REGISTER_STABLE_EXPRESSION(let, ExpressionLet::parse);
intrusive_ptr<Expression> ExpressionLet::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
verify(expr.fieldNameStringData() == "$let");
uassert(16874, "$let only supports an object as its argument", expr.type() == Object);
const BSONObj args = expr.embeddedObject();
// varsElem must be parsed before inElem regardless of BSON order.
BSONElement varsElem;
BSONElement inElem;
for (auto&& arg : args) {
if (arg.fieldNameStringData() == "vars") {
varsElem = arg;
} else if (arg.fieldNameStringData() == "in") {
inElem = arg;
} else {
uasserted(16875,
str::stream() << "Unrecognized parameter to $let: " << arg.fieldName());
}
}
uassert(16876, "Missing 'vars' parameter to $let", !varsElem.eoo());
uassert(16877, "Missing 'in' parameter to $let", !inElem.eoo());
// parse "vars"
VariablesParseState vpsSub(vpsIn); // vpsSub gets our vars, vpsIn doesn't.
VariableMap vars;
std::vector<boost::intrusive_ptr<Expression>> children;
auto&& varsObj = varsElem.embeddedObjectUserCheck();
for (auto&& varElem : varsObj)
children.push_back(parseOperand(expCtx, varElem, vpsIn));
// Make a place in the vector for "in".
auto& inPtr = children.emplace_back(nullptr);
std::vector<boost::intrusive_ptr<Expression>>::size_type index = 0;
std::vector<Variables::Id> orderedVariableIds;
for (auto&& varElem : varsObj) {
const string varName = varElem.fieldName();
variableValidation::validateNameForUserWrite(varName);
Variables::Id id = vpsSub.defineVariable(varName);
orderedVariableIds.push_back(id);
vars.emplace(id, NameAndExpression{varName, children[index]}); // only has outer vars
++index;
}
// parse "in"
inPtr = parseOperand(expCtx, inElem, vpsSub); // has our vars
return new ExpressionLet(
expCtx, std::move(vars), std::move(children), std::move(orderedVariableIds));
}
ExpressionLet::ExpressionLet(ExpressionContext* const expCtx,
VariableMap&& vars,
std::vector<boost::intrusive_ptr<Expression>> children,
std::vector<Variables::Id> orderedVariableIds)
: Expression(expCtx, std::move(children)),
_variables(std::move(vars)),
_orderedVariableIds(std::move(orderedVariableIds)),
_subExpression(_children.back()) {}
intrusive_ptr<Expression> ExpressionLet::optimize() {
if (_variables.empty()) {
// we aren't binding any variables so just return the subexpression
return _subExpression->optimize();
}
for (VariableMap::iterator it = _variables.begin(), end = _variables.end(); it != end; ++it) {
it->second.expression = it->second.expression->optimize();
}
_subExpression = _subExpression->optimize();
return this;
}
Value ExpressionLet::serialize(bool explain) const {
MutableDocument vars;
for (VariableMap::const_iterator it = _variables.begin(), end = _variables.end(); it != end;
++it) {
vars[it->second.name] = it->second.expression->serialize(explain);
}
return Value(
DOC("$let" << DOC("vars" << vars.freeze() << "in" << _subExpression->serialize(explain))));
}
Value ExpressionLet::evaluate(const Document& root, Variables* variables) const {
for (const auto& item : _variables) {
// It is guaranteed at parse-time that these expressions don't use the variable ids we
// are setting
variables->setValue(item.first, item.second.expression->evaluate(root, variables));
}
return _subExpression->evaluate(root, variables);
}
void ExpressionLet::_doAddDependencies(DepsTracker* deps) const {
for (auto&& idToNameExp : _variables) {
// Add the external dependencies from the 'vars' statement.
idToNameExp.second.expression->addDependencies(deps);
}
// Add subexpression dependencies, which may contain a mix of local and external variable refs.
_subExpression->addDependencies(deps);
}
/* ------------------------- ExpressionMap ----------------------------- */
REGISTER_STABLE_EXPRESSION(map, ExpressionMap::parse);
intrusive_ptr<Expression> ExpressionMap::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
verify(expr.fieldNameStringData() == "$map");
uassert(16878, "$map only supports an object as its argument", expr.type() == Object);
// "in" must be parsed after "as" regardless of BSON order
BSONElement inputElem;
BSONElement asElem;
BSONElement inElem;
const BSONObj args = expr.embeddedObject();
BSONForEach(arg, args) {
if (arg.fieldNameStringData() == "input") {
inputElem = arg;
} else if (arg.fieldNameStringData() == "as") {
asElem = arg;
} else if (arg.fieldNameStringData() == "in") {
inElem = arg;
} else {
uasserted(16879,
str::stream() << "Unrecognized parameter to $map: " << arg.fieldName());
}
}
uassert(16880, "Missing 'input' parameter to $map", !inputElem.eoo());
uassert(16882, "Missing 'in' parameter to $map", !inElem.eoo());
// parse "input"
intrusive_ptr<Expression> input =
parseOperand(expCtx, inputElem, vpsIn); // only has outer vars
// parse "as"
VariablesParseState vpsSub(vpsIn); // vpsSub gets our vars, vpsIn doesn't.
// If "as" is not specified, then use "this" by default.
auto varName = asElem.eoo() ? "this" : asElem.str();
variableValidation::validateNameForUserWrite(varName);
Variables::Id varId = vpsSub.defineVariable(varName);
// parse "in"
intrusive_ptr<Expression> in =
parseOperand(expCtx, inElem, vpsSub); // has access to map variable
return new ExpressionMap(expCtx, varName, varId, input, in);
}
ExpressionMap::ExpressionMap(ExpressionContext* const expCtx,
const string& varName,
Variables::Id varId,
intrusive_ptr<Expression> input,
intrusive_ptr<Expression> each)
: Expression(expCtx, {std::move(input), std::move(each)}),
_varName(varName),
_varId(varId),
_input(_children[0]),
_each(_children[1]) {
expCtx->sbeCompatible = false;
}
intrusive_ptr<Expression> ExpressionMap::optimize() {
// TODO handle when _input is constant
_input = _input->optimize();
_each = _each->optimize();
return this;
}
Value ExpressionMap::serialize(bool explain) const {
return Value(DOC("$map" << DOC("input" << _input->serialize(explain) << "as" << _varName << "in"
<< _each->serialize(explain))));
}
Value ExpressionMap::evaluate(const Document& root, Variables* variables) const {
// guaranteed at parse time that this isn't using our _varId
const Value inputVal = _input->evaluate(root, variables);
if (inputVal.nullish())
return Value(BSONNULL);
uassert(16883,
str::stream() << "input to $map must be an array not " << typeName(inputVal.getType()),
inputVal.isArray());
const vector<Value>& input = inputVal.getArray();
if (input.empty())
return inputVal;
vector<Value> output;
output.reserve(input.size());
for (size_t i = 0; i < input.size(); i++) {
variables->setValue(_varId, input[i]);
Value toInsert = _each->evaluate(root, variables);
if (toInsert.missing())
toInsert = Value(BSONNULL); // can't insert missing values into array
output.push_back(toInsert);
}
return Value(std::move(output));
}
void ExpressionMap::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_each->addDependencies(deps);
}
Expression::ComputedPaths ExpressionMap::getComputedPaths(const std::string& exprFieldPath,
Variables::Id renamingVar) const {
auto inputFieldPath = dynamic_cast<ExpressionFieldPath*>(_input.get());
if (!inputFieldPath) {
return {{exprFieldPath}, {}};
}
auto inputComputedPaths = inputFieldPath->getComputedPaths("", renamingVar);
if (inputComputedPaths.renames.empty()) {
return {{exprFieldPath}, {}};
}
invariant(inputComputedPaths.renames.size() == 1u);
auto fieldPathRenameIter = inputComputedPaths.renames.find("");
invariant(fieldPathRenameIter != inputComputedPaths.renames.end());
const auto& oldArrayName = fieldPathRenameIter->second;
auto eachComputedPaths = _each->getComputedPaths(exprFieldPath, _varId);
if (eachComputedPaths.renames.empty()) {
return {{exprFieldPath}, {}};
}
// Append the name of the array to the beginning of the old field path.
for (auto&& rename : eachComputedPaths.renames) {
eachComputedPaths.renames[rename.first] =
FieldPath::getFullyQualifiedPath(oldArrayName, rename.second);
}
return eachComputedPaths;
}
/* ------------------------- ExpressionMeta ----------------------------- */
REGISTER_STABLE_EXPRESSION(meta, ExpressionMeta::parse);
namespace {
const std::string textScoreName = "textScore";
const std::string randValName = "randVal";
const std::string searchScoreName = "searchScore";
const std::string searchHighlightsName = "searchHighlights";
const std::string geoNearDistanceName = "geoNearDistance";
const std::string geoNearPointName = "geoNearPoint";
const std::string recordIdName = "recordId";
const std::string indexKeyName = "indexKey";
const std::string sortKeyName = "sortKey";
const std::string searchScoreDetailsName = "searchScoreDetails";
using MetaType = DocumentMetadataFields::MetaType;
const StringMap<DocumentMetadataFields::MetaType> kMetaNameToMetaType = {
{geoNearDistanceName, MetaType::kGeoNearDist},
{geoNearPointName, MetaType::kGeoNearPoint},
{indexKeyName, MetaType::kIndexKey},
{randValName, MetaType::kRandVal},
{recordIdName, MetaType::kRecordId},
{searchHighlightsName, MetaType::kSearchHighlights},
{searchScoreName, MetaType::kSearchScore},
{searchScoreDetailsName, MetaType::kSearchScoreDetails},
{sortKeyName, MetaType::kSortKey},
{textScoreName, MetaType::kTextScore},
};
const stdx::unordered_map<DocumentMetadataFields::MetaType, StringData> kMetaTypeToMetaName = {
{MetaType::kGeoNearDist, geoNearDistanceName},
{MetaType::kGeoNearPoint, geoNearPointName},
{MetaType::kIndexKey, indexKeyName},
{MetaType::kRandVal, randValName},
{MetaType::kRecordId, recordIdName},
{MetaType::kSearchHighlights, searchHighlightsName},
{MetaType::kSearchScore, searchScoreName},
{MetaType::kSearchScoreDetails, searchScoreDetailsName},
{MetaType::kSortKey, sortKeyName},
{MetaType::kTextScore, textScoreName},
};
} // namespace
intrusive_ptr<Expression> ExpressionMeta::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
uassert(17307, "$meta only supports string arguments", expr.type() == String);
const auto iter = kMetaNameToMetaType.find(expr.valueStringData());
if (iter != kMetaNameToMetaType.end()) {
return new ExpressionMeta(expCtx, iter->second);
} else {
uasserted(17308, "Unsupported argument to $meta: " + expr.String());
}
}
ExpressionMeta::ExpressionMeta(ExpressionContext* const expCtx, MetaType metaType)
: Expression(expCtx), _metaType(metaType) {
expCtx->sbeCompatible = false;
}
Value ExpressionMeta::serialize(bool explain) const {
const auto nameIter = kMetaTypeToMetaName.find(_metaType);
invariant(nameIter != kMetaTypeToMetaName.end());
return Value(DOC("$meta" << nameIter->second));
}
Value ExpressionMeta::evaluate(const Document& root, Variables* variables) const {
const auto& metadata = root.metadata();
switch (_metaType) {
case MetaType::kTextScore:
return metadata.hasTextScore() ? Value(metadata.getTextScore()) : Value();
case MetaType::kRandVal:
return metadata.hasRandVal() ? Value(metadata.getRandVal()) : Value();
case MetaType::kSearchScore:
return metadata.hasSearchScore() ? Value(metadata.getSearchScore()) : Value();
case MetaType::kSearchHighlights:
return metadata.hasSearchHighlights() ? Value(metadata.getSearchHighlights()) : Value();
case MetaType::kGeoNearDist:
return metadata.hasGeoNearDistance() ? Value(metadata.getGeoNearDistance()) : Value();
case MetaType::kGeoNearPoint:
return metadata.hasGeoNearPoint() ? Value(metadata.getGeoNearPoint()) : Value();
case MetaType::kRecordId: {
// Be sure that a RecordId can be represented by a long long.
static_assert(RecordId::kMinRepr >= std::numeric_limits<long long>::min());
static_assert(RecordId::kMaxRepr <= std::numeric_limits<long long>::max());
if (!metadata.hasRecordId()) {
return Value();
}
BSONObjBuilder builder;
metadata.getRecordId().serializeToken("", &builder);
return Value(builder.done().firstElement());
}
case MetaType::kIndexKey:
return metadata.hasIndexKey() ? Value(metadata.getIndexKey()) : Value();
case MetaType::kSortKey:
return metadata.hasSortKey()
? Value(DocumentMetadataFields::serializeSortKey(metadata.isSingleElementKey(),
metadata.getSortKey()))
: Value();
case MetaType::kSearchScoreDetails:
return metadata.hasSearchScoreDetails() ? Value(metadata.getSearchScoreDetails())
: Value();
default:
MONGO_UNREACHABLE;
}
MONGO_UNREACHABLE;
}
void ExpressionMeta::_doAddDependencies(DepsTracker* deps) const {
if (_metaType == MetaType::kSearchScore || _metaType == MetaType::kSearchHighlights ||
_metaType == MetaType::kSearchScoreDetails) {
// We do not add the dependencies for searchScore, searchHighlights, or searchScoreDetails
// because those values are not stored in the collection (or in mongod at all).
return;
}
deps->setNeedsMetadata(_metaType, true);
}
/* ----------------------- ExpressionMod ---------------------------- */
StatusWith<Value> ExpressionMod::apply(Value lhs, Value rhs) {
BSONType leftType = lhs.getType();
BSONType rightType = rhs.getType();
if (lhs.numeric() && rhs.numeric()) {
// If either side is decimal, perform the operation in decimal.
if (leftType == NumberDecimal || rightType == NumberDecimal) {
Decimal128 left = lhs.coerceToDecimal();
Decimal128 right = rhs.coerceToDecimal();
if (right.isZero()) {
return Status(ErrorCodes::Error(5733415), str::stream() << "can't $mod by zero");
}
return Value(left.modulo(right));
}
// ensure we aren't modding by 0
double right = rhs.coerceToDouble();
if (right == 0) {
return Status(ErrorCodes::Error(16610), str::stream() << "can't $mod by zero");
};
if (leftType == NumberDouble || (rightType == NumberDouble && !rhs.integral())) {
// Need to do fmod. Integer-valued double case is handled below.
double left = lhs.coerceToDouble();
return Value(fmod(left, right));
}
if (leftType == NumberLong || rightType == NumberLong) {
// if either is long, return long
long long left = lhs.coerceToLong();
long long rightLong = rhs.coerceToLong();
return Value(overflow::safeMod(left, rightLong));
}
// lastly they must both be ints, return int
int left = lhs.coerceToInt();
int rightInt = rhs.coerceToInt();
return Value(overflow::safeMod(left, rightInt));
} else if (lhs.nullish() || rhs.nullish()) {
return Value(BSONNULL);
} else {
return Status(ErrorCodes::Error(16611),
str::stream()
<< "$mod only supports numeric types, not " << typeName(lhs.getType())
<< " and " << typeName(rhs.getType()));
}
}
Value ExpressionMod::evaluate(const Document& root, Variables* variables) const {
Value lhs = _children[0]->evaluate(root, variables);
Value rhs = _children[1]->evaluate(root, variables);
return uassertStatusOK(apply(lhs, rhs));
}
REGISTER_STABLE_EXPRESSION(mod, ExpressionMod::parse);
const char* ExpressionMod::getOpName() const {
return "$mod";
}
/* ------------------------- ExpressionMultiply ----------------------------- */
namespace {
class MultiplyState {
/**
* We'll try to return the narrowest possible result value. To do that without creating
* intermediate Values, do the arithmetic for double and integral types in parallel, tracking
* the current narrowest type.
*/
double doubleProduct = 1;
long long longProduct = 1;
Decimal128 decimalProduct; // This will be initialized on encountering the first decimal.
BSONType productType = NumberInt;
public:
void operator*=(const Value& val) {
tassert(5423304, "MultiplyState::operator*= only supports numbers", val.numeric());
BSONType oldProductType = productType;
productType = Value::getWidestNumeric(productType, val.getType());
if (productType == NumberDecimal) {
// On finding the first decimal, convert the partial product to decimal.
if (oldProductType != NumberDecimal) {
decimalProduct = oldProductType == NumberDouble
? Decimal128(doubleProduct, Decimal128::kRoundTo15Digits)
: Decimal128(static_cast<int64_t>(longProduct));
}
decimalProduct = decimalProduct.multiply(val.coerceToDecimal());
} else {
doubleProduct *= val.coerceToDouble();
if (productType != NumberDouble) {
// If `productType` is not a double, it must be one of the integer types, so we
// attempt to update `longProduct`.
if (!std::isfinite(val.coerceToDouble()) ||
overflow::mul(longProduct, val.coerceToLong(), &longProduct)) {
// The multiplier is either Infinity or NaN, or the `longProduct` would
// have overflowed, so we're abandoning it.
productType = NumberDouble;
}
}
}
}
Value getValue() const {
if (productType == NumberDouble)
return Value(doubleProduct);
else if (productType == NumberLong)
return Value(longProduct);
else if (productType == NumberInt)
return Value::createIntOrLong(longProduct);
else if (productType == NumberDecimal)
return Value(decimalProduct);
else
massert(16418, "$multiply resulted in a non-numeric type", false);
}
};
Status checkMultiplyNumeric(Value val) {
if (!val.numeric())
return Status(ErrorCodes::TypeMismatch,
str::stream() << "$multiply only supports numeric types, not "
<< typeName(val.getType()));
return Status::OK();
}
} // namespace
StatusWith<Value> ExpressionMultiply::apply(Value lhs, Value rhs) {
// evaluate() checks arguments left-to-right, short circuiting on the first null or non-number.
// Imitate that behavior here.
if (lhs.nullish())
return Value(BSONNULL);
if (Status s = checkMultiplyNumeric(lhs); !s.isOK())
return s;
if (rhs.nullish())
return Value(BSONNULL);
if (Status s = checkMultiplyNumeric(rhs); !s.isOK())
return s;
MultiplyState state;
state *= lhs;
state *= rhs;
return state.getValue();
}
Value ExpressionMultiply::evaluate(const Document& root, Variables* variables) const {
MultiplyState state;
for (auto&& child : _children) {
Value val = child->evaluate(root, variables);
if (val.nullish())
return Value(BSONNULL);
uassertStatusOK(checkMultiplyNumeric(val));
state *= child->evaluate(root, variables);
}
return state.getValue();
}
REGISTER_STABLE_EXPRESSION(multiply, ExpressionMultiply::parse);
const char* ExpressionMultiply::getOpName() const {
return "$multiply";
}
/* ----------------------- ExpressionIfNull ---------------------------- */
void ExpressionIfNull::validateArguments(const ExpressionVector& args) const {
uassert(1257300,
str::stream() << "$ifNull needs at least two arguments, had: " << args.size(),
args.size() >= 2);
}
Value ExpressionIfNull::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
for (size_t i = 0; i < n; ++i) {
Value pValue(_children[i]->evaluate(root, variables));
if (!pValue.nullish() || i == n - 1)
return pValue;
}
return Value();
}
boost::intrusive_ptr<Expression> ExpressionIfNull::optimize() {
bool allOperandsConst = true;
for (auto& operand : _children) {
operand = operand->optimize();
if (!dynamic_cast<ExpressionConstant*>(operand.get())) {
allOperandsConst = false;
}
}
// If all the operands are constant expressions, collapse the expression into one constant
// expression.
if (allOperandsConst) {
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document(), &(getExpressionContext()->variables)));
}
// Remove all null constants, unless it is the only child or it is the last parameter
// (<replacement-expression-if-null>). If one of the operands is a non-null constant expression,
// remove any operands that follow it.
auto it = _children.begin();
tassert(5868001,
str::stream() << "$ifNull needs at least two arguments, had: " << _children.size(),
_children.size() > 1);
while (it != _children.end() - 1) {
if (auto constExpression = dynamic_cast<ExpressionConstant*>(it->get())) {
if (constExpression->getValue().nullish()) {
it = _children.erase(it);
} else {
_children.erase(it + 1, _children.end());
break;
}
} else {
++it;
}
}
if (_children.size() == 1) {
// Replace $ifNull with its only child.
return _children[0];
}
return this;
}
const char* ExpressionIfNull::getOpName() const {
return "$ifNull";
}
REGISTER_STABLE_EXPRESSION(ifNull, ExpressionIfNull::parse);
/* ----------------------- ExpressionIn ---------------------------- */
Value ExpressionIn::evaluate(const Document& root, Variables* variables) const {
Value argument(_children[0]->evaluate(root, variables));
Value arrayOfValues(_children[1]->evaluate(root, variables));
uassert(40081,
str::stream() << "$in requires an array as a second argument, found: "
<< typeName(arrayOfValues.getType()),
arrayOfValues.isArray());
for (auto&& value : arrayOfValues.getArray()) {
if (getExpressionContext()->getValueComparator().evaluate(argument == value)) {
return Value(true);
}
}
return Value(false);
}
REGISTER_STABLE_EXPRESSION(in, ExpressionIn::parse);
const char* ExpressionIn::getOpName() const {
return "$in";
}
/* ----------------------- ExpressionIndexOfArray ------------------ */
namespace {
void uassertIfNotIntegralAndNonNegative(Value val,
StringData expressionName,
StringData argumentName) {
uassert(40096,
str::stream() << expressionName << "requires an integral " << argumentName
<< ", found a value of type: " << typeName(val.getType())
<< ", with value: " << val.toString(),
val.integral());
uassert(40097,
str::stream() << expressionName << " requires a nonnegative " << argumentName
<< ", found: " << val.toString(),
val.coerceToInt() >= 0);
}
} // namespace
Value ExpressionIndexOfArray::evaluate(const Document& root, Variables* variables) const {
Value arrayArg = _children[0]->evaluate(root, variables);
if (arrayArg.nullish()) {
return Value(BSONNULL);
}
uassert(40090,
str::stream() << "$indexOfArray requires an array as a first argument, found: "
<< typeName(arrayArg.getType()),
arrayArg.isArray());
std::vector<Value> array = arrayArg.getArray();
auto args = evaluateAndValidateArguments(root, _children, array.size(), variables);
for (int i = args.startIndex; i < args.endIndex; i++) {
if (getExpressionContext()->getValueComparator().evaluate(array[i] ==
args.targetOfSearch)) {
return Value(static_cast<int>(i));
}
}
return Value(-1);
}
ExpressionIndexOfArray::Arguments ExpressionIndexOfArray::evaluateAndValidateArguments(
const Document& root,
const ExpressionVector& operands,
size_t arrayLength,
Variables* variables) const {
int startIndex = 0;
if (operands.size() > 2) {
Value startIndexArg = operands[2]->evaluate(root, variables);
uassertIfNotIntegralAndNonNegative(startIndexArg, getOpName(), "starting index");
startIndex = startIndexArg.coerceToInt();
}
int endIndex = arrayLength;
if (operands.size() > 3) {
Value endIndexArg = operands[3]->evaluate(root, variables);
uassertIfNotIntegralAndNonNegative(endIndexArg, getOpName(), "ending index");
// Don't let 'endIndex' exceed the length of the array.
endIndex = std::min(static_cast<int>(arrayLength), endIndexArg.coerceToInt());
}
return {_children[1]->evaluate(root, variables), startIndex, endIndex};
}
/**
* This class handles the case where IndexOfArray is given an ExpressionConstant
* instead of using a vector and searching through it we can use a unordered_map
* for O(1) lookup time.
*/
class ExpressionIndexOfArray::Optimized : public ExpressionIndexOfArray {
public:
Optimized(ExpressionContext* const expCtx,
const ValueUnorderedMap<vector<int>>& indexMap,
const ExpressionVector& operands)
: ExpressionIndexOfArray(expCtx), _indexMap(std::move(indexMap)) {
_children = operands;
}
virtual Value evaluate(const Document& root, Variables* variables) const {
auto args = evaluateAndValidateArguments(root, _children, _indexMap.size(), variables);
auto indexVec = _indexMap.find(args.targetOfSearch);
if (indexVec == _indexMap.end())
return Value(-1);
// Search through the vector of indecies for first index in our range.
for (auto index : indexVec->second) {
if (index >= args.startIndex && index < args.endIndex) {
return Value(index);
}
}
// The value we are searching for exists but is not in our range.
return Value(-1);
}
private:
// Maps the values in the array to the positions at which they occur. We need to remember the
// positions so that we can verify they are in the appropriate range.
const ValueUnorderedMap<vector<int>> _indexMap;
};
intrusive_ptr<Expression> ExpressionIndexOfArray::optimize() {
// This will optimize all arguments to this expression.
auto optimized = ExpressionNary::optimize();
if (optimized.get() != this) {
return optimized;
}
// If the input array is an ExpressionConstant we can optimize using a unordered_map instead of
// an
// array.
if (auto constantArray = dynamic_cast<ExpressionConstant*>(_children[0].get())) {
const Value valueArray = constantArray->getValue();
if (valueArray.nullish()) {
return ExpressionConstant::create(getExpressionContext(), Value(BSONNULL));
}
uassert(50809,
str::stream() << "First operand of $indexOfArray must be an array. First "
<< "argument is of type: " << typeName(valueArray.getType()),
valueArray.isArray());
auto arr = valueArray.getArray();
// To handle the case of duplicate values the values need to map to a vector of indecies.
auto indexMap =
getExpressionContext()->getValueComparator().makeUnorderedValueMap<vector<int>>();
for (int i = 0; i < int(arr.size()); i++) {
if (indexMap.find(arr[i]) == indexMap.end()) {
indexMap.emplace(arr[i], vector<int>());
}
indexMap[arr[i]].push_back(i);
}
return new Optimized(getExpressionContext(), indexMap, _children);
}
return this;
}
REGISTER_STABLE_EXPRESSION(indexOfArray, ExpressionIndexOfArray::parse);
const char* ExpressionIndexOfArray::getOpName() const {
return "$indexOfArray";
}
/* ----------------------- ExpressionIndexOfBytes ------------------ */
namespace {
bool stringHasTokenAtIndex(size_t index, const std::string& input, const std::string& token) {
if (token.size() + index > input.size()) {
return false;
}
return input.compare(index, token.size(), token) == 0;
}
} // namespace
Value ExpressionIndexOfBytes::evaluate(const Document& root, Variables* variables) const {
Value stringArg = _children[0]->evaluate(root, variables);
if (stringArg.nullish()) {
return Value(BSONNULL);
}
uassert(40091,
str::stream() << "$indexOfBytes requires a string as the first argument, found: "
<< typeName(stringArg.getType()),
stringArg.getType() == String);
const std::string& input = stringArg.getString();
Value tokenArg = _children[1]->evaluate(root, variables);
uassert(40092,
str::stream() << "$indexOfBytes requires a string as the second argument, found: "
<< typeName(tokenArg.getType()),
tokenArg.getType() == String);
const std::string& token = tokenArg.getString();
size_t startIndex = 0;
if (_children.size() > 2) {
Value startIndexArg = _children[2]->evaluate(root, variables);
uassertIfNotIntegralAndNonNegative(startIndexArg, getOpName(), "starting index");
startIndex = static_cast<size_t>(startIndexArg.coerceToInt());
}
size_t endIndex = input.size();
if (_children.size() > 3) {
Value endIndexArg = _children[3]->evaluate(root, variables);
uassertIfNotIntegralAndNonNegative(endIndexArg, getOpName(), "ending index");
// Don't let 'endIndex' exceed the length of the string.
endIndex = std::min(input.size(), static_cast<size_t>(endIndexArg.coerceToInt()));
}
if (startIndex > input.length() || endIndex < startIndex) {
return Value(-1);
}
size_t position = input.substr(0, endIndex).find(token, startIndex);
if (position == std::string::npos) {
return Value(-1);
}
return Value(static_cast<int>(position));
}
REGISTER_STABLE_EXPRESSION(indexOfBytes, ExpressionIndexOfBytes::parse);
const char* ExpressionIndexOfBytes::getOpName() const {
return "$indexOfBytes";
}
/* ----------------------- ExpressionIndexOfCP --------------------- */
Value ExpressionIndexOfCP::evaluate(const Document& root, Variables* variables) const {
Value stringArg = _children[0]->evaluate(root, variables);
if (stringArg.nullish()) {
return Value(BSONNULL);
}
uassert(40093,
str::stream() << "$indexOfCP requires a string as the first argument, found: "
<< typeName(stringArg.getType()),
stringArg.getType() == String);
const std::string& input = stringArg.getString();
Value tokenArg = _children[1]->evaluate(root, variables);
uassert(40094,
str::stream() << "$indexOfCP requires a string as the second argument, found: "
<< typeName(tokenArg.getType()),
tokenArg.getType() == String);
const std::string& token = tokenArg.getString();
size_t startCodePointIndex = 0;
if (_children.size() > 2) {
Value startIndexArg = _children[2]->evaluate(root, variables);
uassertIfNotIntegralAndNonNegative(startIndexArg, getOpName(), "starting index");
startCodePointIndex = static_cast<size_t>(startIndexArg.coerceToInt());
}
// Compute the length (in code points) of the input, and convert 'startCodePointIndex' to a byte
// index.
size_t codePointLength = 0;
size_t startByteIndex = 0;
for (size_t byteIx = 0; byteIx < input.size(); ++codePointLength) {
if (codePointLength == startCodePointIndex) {
// We have determined the byte at which our search will start.
startByteIndex = byteIx;
}
uassert(40095,
"$indexOfCP found bad UTF-8 in the input",
!str::isUTF8ContinuationByte(input[byteIx]));
byteIx += str::getCodePointLength(input[byteIx]);
}
size_t endCodePointIndex = codePointLength;
if (_children.size() > 3) {
Value endIndexArg = _children[3]->evaluate(root, variables);
uassertIfNotIntegralAndNonNegative(endIndexArg, getOpName(), "ending index");
// Don't let 'endCodePointIndex' exceed the number of code points in the string.
endCodePointIndex =
std::min(codePointLength, static_cast<size_t>(endIndexArg.coerceToInt()));
}
// If the start index is past the end, then always return -1 since 'token' does not exist within
// these invalid bounds.
if (endCodePointIndex < startCodePointIndex) {
return Value(-1);
}
if (startByteIndex == 0 && input.empty() && token.empty()) {
// If we are finding the index of "" in the string "", the below loop will not loop, so we
// need a special case for this.
return Value(0);
}
// We must keep track of which byte, and which code point, we are examining, being careful not
// to overflow either the length of the string or the ending code point.
size_t currentCodePointIndex = startCodePointIndex;
for (size_t byteIx = startByteIndex; currentCodePointIndex < endCodePointIndex;
++currentCodePointIndex) {
if (stringHasTokenAtIndex(byteIx, input, token)) {
return Value(static_cast<int>(currentCodePointIndex));
}
byteIx += str::getCodePointLength(input[byteIx]);
}
return Value(-1);
}
REGISTER_STABLE_EXPRESSION(indexOfCP, ExpressionIndexOfCP::parse);
const char* ExpressionIndexOfCP::getOpName() const {
return "$indexOfCP";
}
/* ----------------------- ExpressionLn ---------------------------- */
Value ExpressionLn::evaluateNumericArg(const Value& numericArg) const {
if (numericArg.getType() == NumberDecimal) {
Decimal128 argDecimal = numericArg.getDecimal();
if (argDecimal.isGreater(Decimal128::kNormalizedZero))
return Value(argDecimal.logarithm());
// Fall through for error case.
}
double argDouble = numericArg.coerceToDouble();
uassert(28766,
str::stream() << "$ln's argument must be a positive number, but is " << argDouble,
argDouble > 0 || std::isnan(argDouble));
return Value(std::log(argDouble));
}
REGISTER_STABLE_EXPRESSION(ln, ExpressionLn::parse);
const char* ExpressionLn::getOpName() const {
return "$ln";
}
/* ----------------------- ExpressionLog ---------------------------- */
Value ExpressionLog::evaluate(const Document& root, Variables* variables) const {
Value argVal = _children[0]->evaluate(root, variables);
Value baseVal = _children[1]->evaluate(root, variables);
if (argVal.nullish() || baseVal.nullish())
return Value(BSONNULL);
uassert(28756,
str::stream() << "$log's argument must be numeric, not " << typeName(argVal.getType()),
argVal.numeric());
uassert(28757,
str::stream() << "$log's base must be numeric, not " << typeName(baseVal.getType()),
baseVal.numeric());
if (argVal.getType() == NumberDecimal || baseVal.getType() == NumberDecimal) {
Decimal128 argDecimal = argVal.coerceToDecimal();
Decimal128 baseDecimal = baseVal.coerceToDecimal();
if (argDecimal.isGreater(Decimal128::kNormalizedZero) &&
baseDecimal.isNotEqual(Decimal128(1)) &&
baseDecimal.isGreater(Decimal128::kNormalizedZero)) {
return Value(argDecimal.logarithm(baseDecimal));
}
// Fall through for error cases.
}
double argDouble = argVal.coerceToDouble();
double baseDouble = baseVal.coerceToDouble();
uassert(28758,
str::stream() << "$log's argument must be a positive number, but is " << argDouble,
argDouble > 0 || std::isnan(argDouble));
uassert(28759,
str::stream() << "$log's base must be a positive number not equal to 1, but is "
<< baseDouble,
(baseDouble > 0 && baseDouble != 1) || std::isnan(baseDouble));
return Value(std::log(argDouble) / std::log(baseDouble));
}
REGISTER_STABLE_EXPRESSION(log, ExpressionLog::parse);
const char* ExpressionLog::getOpName() const {
return "$log";
}
/* ----------------------- ExpressionLog10 ---------------------------- */
Value ExpressionLog10::evaluateNumericArg(const Value& numericArg) const {
if (numericArg.getType() == NumberDecimal) {
Decimal128 argDecimal = numericArg.getDecimal();
if (argDecimal.isGreater(Decimal128::kNormalizedZero))
return Value(argDecimal.logarithm(Decimal128(10)));
// Fall through for error case.
}
double argDouble = numericArg.coerceToDouble();
uassert(28761,
str::stream() << "$log10's argument must be a positive number, but is " << argDouble,
argDouble > 0 || std::isnan(argDouble));
return Value(std::log10(argDouble));
}
REGISTER_STABLE_EXPRESSION(log10, ExpressionLog10::parse);
const char* ExpressionLog10::getOpName() const {
return "$log10";
}
/* ------------------------ ExpressionNary ----------------------------- */
/**
* Optimize a general Nary expression.
*
* The optimization has the following properties:
* 1) Optimize each of the operators.
* 2) If the operand is associative, flatten internal operators of the same type. I.e.:
* A+B+(C+D)+E => A+B+C+D+E
* 3) If the operand is commutative & associative, group all constant operators. For example:
* c1 + c2 + n1 + c3 + n2 => n1 + n2 + c1 + c2 + c3
* 4) If the operand is associative, execute the operation over all the contiguous constant
* operators and replacing them by the result. For example: c1 + c2 + n1 + c3 + c4 + n5 =>
* c5 = c1 + c2, c6 = c3 + c4 => c5 + n1 + c6 + n5
*
* It returns the optimized expression. It can be exactly the same expression, a modified version
* of the same expression or a completely different expression.
*/
intrusive_ptr<Expression> ExpressionNary::optimize() {
uint32_t constOperandCount = 0;
for (auto& operand : _children) {
operand = operand->optimize();
if (dynamic_cast<ExpressionConstant*>(operand.get())) {
++constOperandCount;
}
}
// If all the operands are constant expressions, collapse the expression into one constant
// expression.
if (constOperandCount == _children.size()) {
return intrusive_ptr<Expression>(ExpressionConstant::create(
getExpressionContext(), evaluate(Document(), &(getExpressionContext()->variables))));
}
// If the expression is associative, we can collapse all the consecutive constant operands into
// one by applying the expression to those consecutive constant operands.
// If the expression is also commutative we can reorganize all the operands so that all of the
// constant ones are together (arbitrarily at the back) and we can collapse all of them into
// one.
if (isAssociative()) {
ExpressionVector constExpressions;
ExpressionVector optimizedOperands;
for (size_t i = 0; i < _children.size();) {
intrusive_ptr<Expression> operand = _children[i];
// If the operand is a constant one, add it to the current list of consecutive constant
// operands.
if (dynamic_cast<ExpressionConstant*>(operand.get())) {
constExpressions.push_back(operand);
++i;
continue;
}
// If the operand is exactly the same type as the one we are currently optimizing and
// is also associative, replace the expression for the operands it has.
// E.g: sum(a, b, sum(c, d), e) => sum(a, b, c, d, e)
ExpressionNary* nary = dynamic_cast<ExpressionNary*>(operand.get());
if (nary && !strcmp(nary->getOpName(), getOpName()) && nary->isAssociative()) {
invariant(!nary->_children.empty());
_children[i] = std::move(nary->_children[0]);
_children.insert(
_children.begin() + i + 1, nary->_children.begin() + 1, nary->_children.end());
continue;
}
// If the operand is not a constant nor a same-type expression and the expression is
// not commutative, evaluate an expression of the same type as the one we are
// optimizing on the list of consecutive constant operands and use the resulting value
// as a constant expression operand.
// If the list of consecutive constant operands has less than 2 operands just place
// back the operands.
if (!isCommutative()) {
if (constExpressions.size() > 1) {
ExpressionVector childrenSave = std::move(_children);
_children = std::move(constExpressions);
optimizedOperands.emplace_back(ExpressionConstant::create(
getExpressionContext(),
evaluate(Document(), &(getExpressionContext()->variables))));
_children = std::move(childrenSave);
} else {
optimizedOperands.insert(
optimizedOperands.end(), constExpressions.begin(), constExpressions.end());
}
constExpressions.clear();
}
optimizedOperands.push_back(operand);
++i;
}
if (constExpressions.size() > 1) {
_children = std::move(constExpressions);
optimizedOperands.emplace_back(ExpressionConstant::create(
getExpressionContext(),
evaluate(Document(), &(getExpressionContext()->variables))));
} else {
optimizedOperands.insert(
optimizedOperands.end(), constExpressions.begin(), constExpressions.end());
}
_children = std::move(optimizedOperands);
}
return this;
}
void ExpressionNary::_doAddDependencies(DepsTracker* deps) const {
for (auto&& operand : _children) {
operand->addDependencies(deps);
}
}
void ExpressionNary::addOperand(const intrusive_ptr<Expression>& pExpression) {
_children.push_back(pExpression);
}
Value ExpressionNary::serialize(bool explain) const {
const size_t nOperand = _children.size();
vector<Value> array;
/* build up the array */
for (size_t i = 0; i < nOperand; i++)
array.push_back(_children[i]->serialize(explain));
return Value(DOC(getOpName() << array));
}
/* ------------------------- ExpressionNot ----------------------------- */
Value ExpressionNot::evaluate(const Document& root, Variables* variables) const {
Value pOp(_children[0]->evaluate(root, variables));
bool b = pOp.coerceToBool();
return Value(!b);
}
REGISTER_STABLE_EXPRESSION(not, ExpressionNot::parse);
const char* ExpressionNot::getOpName() const {
return "$not";
}
/* -------------------------- ExpressionOr ----------------------------- */
Value ExpressionOr::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
for (size_t i = 0; i < n; ++i) {
Value pValue(_children[i]->evaluate(root, variables));
if (pValue.coerceToBool())
return Value(true);
}
return Value(false);
}
intrusive_ptr<Expression> ExpressionOr::optimize() {
/* optimize the disjunction as much as possible */
intrusive_ptr<Expression> pE(ExpressionNary::optimize());
/* if the result isn't a disjunction, we can't do anything */
ExpressionOr* pOr = dynamic_cast<ExpressionOr*>(pE.get());
if (!pOr)
return pE;
/*
Check the last argument on the result; if it's not constant (as
promised by ExpressionNary::optimize(),) then there's nothing
we can do.
*/
const size_t n = pOr->_children.size();
// ExpressionNary::optimize() generates an ExpressionConstant for {$or:[]}.
verify(n > 0);
intrusive_ptr<Expression> pLast(pOr->_children[n - 1]);
const ExpressionConstant* pConst = dynamic_cast<ExpressionConstant*>(pLast.get());
if (!pConst)
return pE;
/*
Evaluate and coerce the last argument to a boolean. If it's true,
then we can replace this entire expression.
*/
bool last = pConst->getValue().coerceToBool();
if (last) {
intrusive_ptr<ExpressionConstant> pFinal(
ExpressionConstant::create(getExpressionContext(), Value(true)));
return pFinal;
}
/*
If we got here, the final operand was false, so we don't need it
anymore. If there was only one other operand, we don't need the
conjunction either. Note we still need to keep the promise that
the result will be a boolean.
*/
if (n == 2) {
intrusive_ptr<Expression> pFinal(
ExpressionCoerceToBool::create(getExpressionContext(), std::move(pOr->_children[0])));
return pFinal;
}
/*
Remove the final "false" value, and return the new expression.
*/
pOr->_children.resize(n - 1);
return pE;
}
REGISTER_STABLE_EXPRESSION(or, ExpressionOr::parse);
const char* ExpressionOr::getOpName() const {
return "$or";
}
namespace {
/**
* Helper for ExpressionPow to determine wither base^exp can be represented in a 64 bit int.
*
*'base' and 'exp' are both integers. Assumes 'exp' is in the range [0, 63].
*/
bool representableAsLong(long long base, long long exp) {
invariant(exp <= 63);
invariant(exp >= 0);
struct MinMax {
long long min;
long long max;
};
// Array indices correspond to exponents 0 through 63. The values in each index are the min
// and max bases, respectively, that can be raised to that exponent without overflowing a
// 64-bit int. For max bases, this was computed by solving for b in
// b = (2^63-1)^(1/exp) for exp = [0, 63] and truncating b. To calculate min bases, for even
// exps the equation used was b = (2^63-1)^(1/exp), and for odd exps the equation used was
// b = (-2^63)^(1/exp). Since the magnitude of long min is greater than long max, the
// magnitude of some of the min bases raised to odd exps is greater than the corresponding
// max bases raised to the same exponents.
static const MinMax kBaseLimits[] = {
{std::numeric_limits<long long>::min(), std::numeric_limits<long long>::max()}, // 0
{std::numeric_limits<long long>::min(), std::numeric_limits<long long>::max()},
{-3037000499LL, 3037000499LL},
{-2097152, 2097151},
{-55108, 55108},
{-6208, 6208},
{-1448, 1448},
{-512, 511},
{-234, 234},
{-128, 127},
{-78, 78}, // 10
{-52, 52},
{-38, 38},
{-28, 28},
{-22, 22},
{-18, 18},
{-15, 15},
{-13, 13},
{-11, 11},
{-9, 9},
{-8, 8}, // 20
{-8, 7},
{-7, 7},
{-6, 6},
{-6, 6},
{-5, 5},
{-5, 5},
{-5, 5},
{-4, 4},
{-4, 4},
{-4, 4}, // 30
{-4, 4},
{-3, 3},
{-3, 3},
{-3, 3},
{-3, 3},
{-3, 3},
{-3, 3},
{-3, 3},
{-3, 3},
{-2, 2}, // 40
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2}, // 50
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2},
{-2, 2}, // 60
{-2, 2},
{-2, 2},
{-2, 1}};
return base >= kBaseLimits[exp].min && base <= kBaseLimits[exp].max;
};
} // namespace
/* ----------------------- ExpressionPow ---------------------------- */
intrusive_ptr<Expression> ExpressionPow::create(ExpressionContext* const expCtx,
Value base,
Value exp) {
intrusive_ptr<ExpressionPow> expr(new ExpressionPow(expCtx));
expr->_children.push_back(
ExpressionConstant::create(expr->getExpressionContext(), std::move(base)));
expr->_children.push_back(
ExpressionConstant::create(expr->getExpressionContext(), std::move(exp)));
return expr;
}
Value ExpressionPow::evaluate(const Document& root, Variables* variables) const {
Value baseVal = _children[0]->evaluate(root, variables);
Value expVal = _children[1]->evaluate(root, variables);
if (baseVal.nullish() || expVal.nullish())
return Value(BSONNULL);
BSONType baseType = baseVal.getType();
BSONType expType = expVal.getType();
uassert(28762,
str::stream() << "$pow's base must be numeric, not " << typeName(baseType),
baseVal.numeric());
uassert(28763,
str::stream() << "$pow's exponent must be numeric, not " << typeName(expType),
expVal.numeric());
auto checkNonZeroAndNeg = [](bool isZeroAndNeg) {
uassert(28764, "$pow cannot take a base of 0 and a negative exponent", !isZeroAndNeg);
};
// If either argument is decimal, return a decimal.
if (baseType == NumberDecimal || expType == NumberDecimal) {
Decimal128 baseDecimal = baseVal.coerceToDecimal();
Decimal128 expDecimal = expVal.coerceToDecimal();
checkNonZeroAndNeg(baseDecimal.isZero() && expDecimal.isNegative());
return Value(baseDecimal.power(expDecimal));
}
// pow() will cast args to doubles.
double baseDouble = baseVal.coerceToDouble();
double expDouble = expVal.coerceToDouble();
checkNonZeroAndNeg(baseDouble == 0 && expDouble < 0);
// If either argument is a double, return a double.
if (baseType == NumberDouble || expType == NumberDouble) {
return Value(std::pow(baseDouble, expDouble));
}
// If either number is a long, return a long. If both numbers are ints, then return an int if
// the result fits or a long if it is too big.
const auto formatResult = [baseType, expType](long long res) {
if (baseType == NumberLong || expType == NumberLong) {
return Value(res);
}
return Value::createIntOrLong(res);
};
const long long baseLong = baseVal.getLong();
const long long expLong = expVal.getLong();
// Use this when the result cannot be represented as a long.
const auto computeDoubleResult = [baseLong, expLong]() {
return Value(std::pow(baseLong, expLong));
};
// Avoid doing repeated multiplication or using std::pow if the base is -1, 0, or 1.
if (baseLong == 0) {
if (expLong == 0) {
// 0^0 = 1.
return formatResult(1);
} else if (expLong > 0) {
// 0^x where x > 0 is 0.
return formatResult(0);
}
// We should have checked earlier that 0 to a negative power is banned.
MONGO_UNREACHABLE;
} else if (baseLong == 1) {
return formatResult(1);
} else if (baseLong == -1) {
// -1^0 = -1^2 = -1^4 = -1^6 ... = 1
// -1^1 = -1^3 = -1^5 = -1^7 ... = -1
return formatResult((expLong % 2 == 0) ? 1 : -1);
} else if (expLong > 63 || expLong < 0) {
// If the base is not 0, 1, or -1 and the exponent is too large, or negative,
// the result cannot be represented as a long.
return computeDoubleResult();
}
// It's still possible that the result cannot be represented as a long. If that's the case,
// return a double.
if (!representableAsLong(baseLong, expLong)) {
return computeDoubleResult();
}
// Use repeated multiplication, since pow() casts args to doubles which could result in
// loss of precision if arguments are very large.
const auto computeWithRepeatedMultiplication = [](long long base, long long exp) {
long long result = 1;
while (exp > 1) {
if (exp % 2 == 1) {
result *= base;
exp--;
}
// 'exp' is now guaranteed to be even.
base *= base;
exp /= 2;
}
if (exp) {
invariant(exp == 1);
result *= base;
}
return result;
};
return formatResult(computeWithRepeatedMultiplication(baseLong, expLong));
}
REGISTER_STABLE_EXPRESSION(pow, ExpressionPow::parse);
const char* ExpressionPow::getOpName() const {
return "$pow";
}
/* ------------------------- ExpressionRange ------------------------------ */
Value ExpressionRange::evaluate(const Document& root, Variables* variables) const {
Value startVal(_children[0]->evaluate(root, variables));
Value endVal(_children[1]->evaluate(root, variables));
uassert(34443,
str::stream() << "$range requires a numeric starting value, found value of type: "
<< typeName(startVal.getType()),
startVal.numeric());
uassert(34444,
str::stream() << "$range requires a starting value that can be represented as a 32-bit "
"integer, found value: "
<< startVal.toString(),
startVal.integral());
uassert(34445,
str::stream() << "$range requires a numeric ending value, found value of type: "
<< typeName(endVal.getType()),
endVal.numeric());
uassert(34446,
str::stream() << "$range requires an ending value that can be represented as a 32-bit "
"integer, found value: "
<< endVal.toString(),
endVal.integral());
// Cast to broader type 'int64_t' to prevent overflow during loop.
int64_t current = startVal.coerceToInt();
int64_t end = endVal.coerceToInt();
int64_t step = 1;
if (_children.size() == 3) {
// A step was specified by the user.
Value stepVal(_children[2]->evaluate(root, variables));
uassert(34447,
str::stream() << "$range requires a numeric step value, found value of type:"
<< typeName(stepVal.getType()),
stepVal.numeric());
uassert(34448,
str::stream() << "$range requires a step value that can be represented as a 32-bit "
"integer, found value: "
<< stepVal.toString(),
stepVal.integral());
step = stepVal.coerceToInt();
uassert(34449, "$range requires a non-zero step value", step != 0);
}
// Calculate how much memory is needed to generate the array and avoid going over the memLimit.
auto steps = (end - current) / step;
// If steps not positive then no amount of steps can get you from start to end. For example
// with start=5, end=7, step=-1 steps would be negative and in this case we would return an
// empty array.
auto length = steps >= 0 ? 1 + steps : 0;
int64_t memNeeded = sizeof(std::vector<Value>) + length * startVal.getApproximateSize();
auto memLimit = internalQueryMaxRangeBytes.load();
uassert(ErrorCodes::ExceededMemoryLimit,
str::stream() << "$range would use too much memory (" << memNeeded << " bytes) "
<< "and cannot spill to disk. Memory limit: " << memLimit << " bytes",
memNeeded < memLimit);
std::vector<Value> output;
while ((step > 0 ? current < end : current > end)) {
output.emplace_back(static_cast<int>(current));
current += step;
}
return Value(std::move(output));
}
REGISTER_STABLE_EXPRESSION(range, ExpressionRange::parse);
const char* ExpressionRange::getOpName() const {
return "$range";
}
/* ------------------------ ExpressionReduce ------------------------------ */
REGISTER_STABLE_EXPRESSION(reduce, ExpressionReduce::parse);
intrusive_ptr<Expression> ExpressionReduce::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(40075,
str::stream() << "$reduce requires an object as an argument, found: "
<< typeName(expr.type()),
expr.type() == Object);
// vpsSub is used only to parse 'in', which must have access to $$this and $$value.
VariablesParseState vpsSub(vps);
auto thisVar = vpsSub.defineVariable("this");
auto valueVar = vpsSub.defineVariable("value");
boost::intrusive_ptr<Expression> input;
boost::intrusive_ptr<Expression> initial;
boost::intrusive_ptr<Expression> in;
for (auto&& elem : expr.Obj()) {
auto field = elem.fieldNameStringData();
if (field == "input") {
input = parseOperand(expCtx, elem, vps);
} else if (field == "initialValue") {
initial = parseOperand(expCtx, elem, vps);
} else if (field == "in") {
in = parseOperand(expCtx, elem, vpsSub);
} else {
uasserted(40076, str::stream() << "$reduce found an unknown argument: " << field);
}
}
uassert(40077, "$reduce requires 'input' to be specified", input);
uassert(40078, "$reduce requires 'initialValue' to be specified", initial);
uassert(40079, "$reduce requires 'in' to be specified", in);
return new ExpressionReduce(
expCtx, std::move(input), std::move(initial), std::move(in), thisVar, valueVar);
}
Value ExpressionReduce::evaluate(const Document& root, Variables* variables) const {
Value inputVal = _input->evaluate(root, variables);
if (inputVal.nullish()) {
return Value(BSONNULL);
}
uassert(40080,
str::stream() << "$reduce requires that 'input' be an array, found: "
<< inputVal.toString(),
inputVal.isArray());
Value accumulatedValue = _initial->evaluate(root, variables);
for (auto&& elem : inputVal.getArray()) {
variables->setValue(_thisVar, elem);
variables->setValue(_valueVar, accumulatedValue);
accumulatedValue = _in->evaluate(root, variables);
}
return accumulatedValue;
}
intrusive_ptr<Expression> ExpressionReduce::optimize() {
_input = _input->optimize();
_initial = _initial->optimize();
_in = _in->optimize();
return this;
}
void ExpressionReduce::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_initial->addDependencies(deps);
_in->addDependencies(deps);
}
Value ExpressionReduce::serialize(bool explain) const {
return Value(Document{{"$reduce",
Document{{"input", _input->serialize(explain)},
{"initialValue", _initial->serialize(explain)},
{"in", _in->serialize(explain)}}}});
}
/* ------------------------ ExpressionReplaceBase ------------------------ */
void ExpressionReplaceBase::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_find->addDependencies(deps);
_replacement->addDependencies(deps);
}
Value ExpressionReplaceBase::serialize(bool explain) const {
return Value(Document{{getOpName(),
Document{{"input", _input->serialize(explain)},
{"find", _find->serialize(explain)},
{"replacement", _replacement->serialize(explain)}}}});
}
namespace {
std::tuple<intrusive_ptr<Expression>, intrusive_ptr<Expression>, intrusive_ptr<Expression>>
parseExpressionReplaceBase(const char* opName,
ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(51751,
str::stream() << opName
<< " requires an object as an argument, found: " << typeName(expr.type()),
expr.type() == Object);
intrusive_ptr<Expression> input;
intrusive_ptr<Expression> find;
intrusive_ptr<Expression> replacement;
for (auto&& elem : expr.Obj()) {
auto field = elem.fieldNameStringData();
if (field == "input"_sd) {
input = Expression::parseOperand(expCtx, elem, vps);
} else if (field == "find"_sd) {
find = Expression::parseOperand(expCtx, elem, vps);
} else if (field == "replacement"_sd) {
replacement = Expression::parseOperand(expCtx, elem, vps);
} else {
uasserted(51750, str::stream() << opName << " found an unknown argument: " << field);
}
}
uassert(51749, str::stream() << opName << " requires 'input' to be specified", input);
uassert(51748, str::stream() << opName << " requires 'find' to be specified", find);
uassert(
51747, str::stream() << opName << " requires 'replacement' to be specified", replacement);
return {input, find, replacement};
}
} // namespace
Value ExpressionReplaceBase::evaluate(const Document& root, Variables* variables) const {
Value input = _input->evaluate(root, variables);
Value find = _find->evaluate(root, variables);
Value replacement = _replacement->evaluate(root, variables);
// Throw an error if any arg is non-string, non-nullish.
uassert(51746,
str::stream() << getOpName()
<< " requires that 'input' be a string, found: " << input.toString(),
input.getType() == BSONType::String || input.nullish());
uassert(51745,
str::stream() << getOpName()
<< " requires that 'find' be a string, found: " << find.toString(),
find.getType() == BSONType::String || find.nullish());
uassert(51744,
str::stream() << getOpName() << " requires that 'replacement' be a string, found: "
<< replacement.toString(),
replacement.getType() == BSONType::String || replacement.nullish());
// Return null if any arg is nullish.
if (input.nullish())
return Value(BSONNULL);
if (find.nullish())
return Value(BSONNULL);
if (replacement.nullish())
return Value(BSONNULL);
return _doEval(input.getStringData(), find.getStringData(), replacement.getStringData());
}
intrusive_ptr<Expression> ExpressionReplaceBase::optimize() {
_input = _input->optimize();
_find = _find->optimize();
_replacement = _replacement->optimize();
return this;
}
/* ------------------------ ExpressionReplaceOne ------------------------ */
REGISTER_STABLE_EXPRESSION(replaceOne, ExpressionReplaceOne::parse);
intrusive_ptr<Expression> ExpressionReplaceOne::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
auto [input, find, replacement] = parseExpressionReplaceBase(opName, expCtx, expr, vps);
return make_intrusive<ExpressionReplaceOne>(
expCtx, std::move(input), std::move(find), std::move(replacement));
}
Value ExpressionReplaceOne::_doEval(StringData input,
StringData find,
StringData replacement) const {
size_t startIndex = input.find(find);
if (startIndex == std::string::npos) {
return Value(StringData(input));
}
// An empty string matches at every position, so replaceOne should insert the replacement text
// at position 0. input.find correctly returns position 0 when 'find' is empty, so we don't need
// any special case to handle this.
size_t endIndex = startIndex + find.size();
StringBuilder output;
output << input.substr(0, startIndex);
output << replacement;
output << input.substr(endIndex);
return Value(output.stringData());
}
/* ------------------------ ExpressionReplaceAll ------------------------ */
REGISTER_STABLE_EXPRESSION(replaceAll, ExpressionReplaceAll::parse);
intrusive_ptr<Expression> ExpressionReplaceAll::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
auto [input, find, replacement] = parseExpressionReplaceBase(opName, expCtx, expr, vps);
return make_intrusive<ExpressionReplaceAll>(
expCtx, std::move(input), std::move(find), std::move(replacement));
}
Value ExpressionReplaceAll::_doEval(StringData input,
StringData find,
StringData replacement) const {
// An empty string matches at every position, so replaceAll should insert 'replacement' at every
// position when 'find' is empty. Handling this as a special case lets us assume 'find' is
// nonempty in the usual case.
if (find.size() == 0) {
StringBuilder output;
for (char c : input) {
output << replacement << c;
}
output << replacement;
return Value(output.stringData());
}
StringBuilder output;
for (;;) {
size_t startIndex = input.find(find);
if (startIndex == std::string::npos) {
output << input;
break;
}
size_t endIndex = startIndex + find.size();
output << input.substr(0, startIndex);
output << replacement;
// This step assumes 'find' is nonempty. If 'find' were empty then input.find would always
// find a match at position 0, and the input would never shrink.
input = input.substr(endIndex);
}
return Value(output.stringData());
}
/* ------------------------ ExpressionReverseArray ------------------------ */
Value ExpressionReverseArray::evaluate(const Document& root, Variables* variables) const {
Value input(_children[0]->evaluate(root, variables));
if (input.nullish()) {
return Value(BSONNULL);
}
uassert(34435,
str::stream() << "The argument to $reverseArray must be an array, but was of type: "
<< typeName(input.getType()),
input.isArray());
if (input.getArrayLength() < 2) {
return input;
}
std::vector<Value> array = input.getArray();
std::reverse(array.begin(), array.end());
return Value(array);
}
REGISTER_STABLE_EXPRESSION(reverseArray, ExpressionReverseArray::parse);
const char* ExpressionReverseArray::getOpName() const {
return "$reverseArray";
}
namespace {
ValueSet arrayToSet(const Value& val, const ValueComparator& valueComparator) {
const vector<Value>& array = val.getArray();
ValueSet valueSet = valueComparator.makeOrderedValueSet();
valueSet.insert(array.begin(), array.end());
return valueSet;
}
ValueUnorderedSet arrayToUnorderedSet(const Value& val, const ValueComparator& valueComparator) {
const vector<Value>& array = val.getArray();
ValueUnorderedSet valueSet = valueComparator.makeUnorderedValueSet();
valueSet.insert(array.begin(), array.end());
return valueSet;
}
} // namespace
/* ----------------------- ExpressionSetDifference ---------------------------- */
Value ExpressionSetDifference::evaluate(const Document& root, Variables* variables) const {
const Value lhs = _children[0]->evaluate(root, variables);
const Value rhs = _children[1]->evaluate(root, variables);
if (lhs.nullish() || rhs.nullish()) {
return Value(BSONNULL);
}
uassert(17048,
str::stream() << "both operands of $setDifference must be arrays. First "
<< "argument is of type: " << typeName(lhs.getType()),
lhs.isArray());
uassert(17049,
str::stream() << "both operands of $setDifference must be arrays. Second "
<< "argument is of type: " << typeName(rhs.getType()),
rhs.isArray());
ValueSet rhsSet = arrayToSet(rhs, getExpressionContext()->getValueComparator());
const vector<Value>& lhsArray = lhs.getArray();
vector<Value> returnVec;
for (vector<Value>::const_iterator it = lhsArray.begin(); it != lhsArray.end(); ++it) {
// rhsSet serves the dual role of filtering out elements that were originally present
// in RHS and of eleminating duplicates from LHS
if (rhsSet.insert(*it).second) {
returnVec.push_back(*it);
}
}
return Value(std::move(returnVec));
}
REGISTER_STABLE_EXPRESSION(setDifference, ExpressionSetDifference::parse);
const char* ExpressionSetDifference::getOpName() const {
return "$setDifference";
}
/* ----------------------- ExpressionSetEquals ---------------------------- */
void ExpressionSetEquals::validateArguments(const ExpressionVector& args) const {
uassert(17045,
str::stream() << "$setEquals needs at least two arguments had: " << args.size(),
args.size() >= 2);
}
Value ExpressionSetEquals::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
const auto& valueComparator = getExpressionContext()->getValueComparator();
ValueSet lhs = valueComparator.makeOrderedValueSet();
for (size_t i = 0; i < n; i++) {
const Value nextEntry = _children[i]->evaluate(root, variables);
uassert(17044,
str::stream() << "All operands of $setEquals must be arrays. One "
<< "argument is of type: " << typeName(nextEntry.getType()),
nextEntry.isArray());
if (i == 0) {
lhs.insert(nextEntry.getArray().begin(), nextEntry.getArray().end());
} else {
ValueSet rhs = valueComparator.makeOrderedValueSet();
rhs.insert(nextEntry.getArray().begin(), nextEntry.getArray().end());
if (lhs.size() != rhs.size()) {
return Value(false);
}
if (!std::equal(lhs.begin(), lhs.end(), rhs.begin(), valueComparator.getEqualTo())) {
return Value(false);
}
}
}
return Value(true);
}
REGISTER_STABLE_EXPRESSION(setEquals, ExpressionSetEquals::parse);
const char* ExpressionSetEquals::getOpName() const {
return "$setEquals";
}
/* ----------------------- ExpressionSetIntersection ---------------------------- */
Value ExpressionSetIntersection::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
const auto& valueComparator = getExpressionContext()->getValueComparator();
ValueSet currentIntersection = valueComparator.makeOrderedValueSet();
for (size_t i = 0; i < n; i++) {
const Value nextEntry = _children[i]->evaluate(root, variables);
if (nextEntry.nullish()) {
return Value(BSONNULL);
}
uassert(17047,
str::stream() << "All operands of $setIntersection must be arrays. One "
<< "argument is of type: " << typeName(nextEntry.getType()),
nextEntry.isArray());
if (i == 0) {
currentIntersection.insert(nextEntry.getArray().begin(), nextEntry.getArray().end());
} else if (!currentIntersection.empty()) {
ValueSet nextSet = arrayToSet(nextEntry, valueComparator);
if (currentIntersection.size() > nextSet.size()) {
// to iterate over whichever is the smaller set
nextSet.swap(currentIntersection);
}
ValueSet::iterator it = currentIntersection.begin();
while (it != currentIntersection.end()) {
if (!nextSet.count(*it)) {
ValueSet::iterator del = it;
++it;
currentIntersection.erase(del);
} else {
++it;
}
}
}
}
return Value(vector<Value>(currentIntersection.begin(), currentIntersection.end()));
}
REGISTER_STABLE_EXPRESSION(setIntersection, ExpressionSetIntersection::parse);
const char* ExpressionSetIntersection::getOpName() const {
return "$setIntersection";
}
/* ----------------------- ExpressionSetIsSubset ---------------------------- */
namespace {
Value setIsSubsetHelper(const vector<Value>& lhs, const ValueUnorderedSet& rhs) {
// do not shortcircuit when lhs.size() > rhs.size()
// because lhs can have redundant entries
for (vector<Value>::const_iterator it = lhs.begin(); it != lhs.end(); ++it) {
if (!rhs.count(*it)) {
return Value(false);
}
}
return Value(true);
}
} // namespace
Value ExpressionSetIsSubset::evaluate(const Document& root, Variables* variables) const {
const Value lhs = _children[0]->evaluate(root, variables);
const Value rhs = _children[1]->evaluate(root, variables);
uassert(17046,
str::stream() << "both operands of $setIsSubset must be arrays. First "
<< "argument is of type: " << typeName(lhs.getType()),
lhs.isArray());
uassert(17042,
str::stream() << "both operands of $setIsSubset must be arrays. Second "
<< "argument is of type: " << typeName(rhs.getType()),
rhs.isArray());
return setIsSubsetHelper(
lhs.getArray(), arrayToUnorderedSet(rhs, getExpressionContext()->getValueComparator()));
}
/**
* This class handles the case where the RHS set is constant.
*
* Since it is constant we can construct the hashset once which makes the runtime performance
* effectively constant with respect to the size of RHS. Large, constant RHS is expected to be a
* major use case for $redact and this has been verified to improve performance significantly.
*/
class ExpressionSetIsSubset::Optimized : public ExpressionSetIsSubset {
public:
Optimized(ExpressionContext* const expCtx,
const ValueUnorderedSet& cachedRhsSet,
const ExpressionVector& operands)
: ExpressionSetIsSubset(expCtx), _cachedRhsSet(cachedRhsSet) {
_children = operands;
}
virtual Value evaluate(const Document& root, Variables* variables) const {
const Value lhs = _children[0]->evaluate(root, variables);
uassert(17310,
str::stream() << "both operands of $setIsSubset must be arrays. First "
<< "argument is of type: " << typeName(lhs.getType()),
lhs.isArray());
return setIsSubsetHelper(lhs.getArray(), _cachedRhsSet);
}
private:
const ValueUnorderedSet _cachedRhsSet;
};
intrusive_ptr<Expression> ExpressionSetIsSubset::optimize() {
// perfore basic optimizations
intrusive_ptr<Expression> optimized = ExpressionNary::optimize();
// if ExpressionNary::optimize() created a new value, return it directly
if (optimized.get() != this)
return optimized;
if (ExpressionConstant* ec = dynamic_cast<ExpressionConstant*>(_children[1].get())) {
const Value rhs = ec->getValue();
uassert(17311,
str::stream() << "both operands of $setIsSubset must be arrays. Second "
<< "argument is of type: " << typeName(rhs.getType()),
rhs.isArray());
intrusive_ptr<Expression> optimizedWithConstant(
new Optimized(this->getExpressionContext(),
arrayToUnorderedSet(rhs, getExpressionContext()->getValueComparator()),
_children));
return optimizedWithConstant;
}
return optimized;
}
REGISTER_STABLE_EXPRESSION(setIsSubset, ExpressionSetIsSubset::parse);
const char* ExpressionSetIsSubset::getOpName() const {
return "$setIsSubset";
}
/* ----------------------- ExpressionSetUnion ---------------------------- */
Value ExpressionSetUnion::evaluate(const Document& root, Variables* variables) const {
ValueSet unionedSet = getExpressionContext()->getValueComparator().makeOrderedValueSet();
const size_t n = _children.size();
for (size_t i = 0; i < n; i++) {
const Value newEntries = _children[i]->evaluate(root, variables);
if (newEntries.nullish()) {
return Value(BSONNULL);
}
uassert(17043,
str::stream() << "All operands of $setUnion must be arrays. One argument"
<< " is of type: " << typeName(newEntries.getType()),
newEntries.isArray());
unionedSet.insert(newEntries.getArray().begin(), newEntries.getArray().end());
}
return Value(vector<Value>(unionedSet.begin(), unionedSet.end()));
}
REGISTER_STABLE_EXPRESSION(setUnion, ExpressionSetUnion::parse);
const char* ExpressionSetUnion::getOpName() const {
return "$setUnion";
}
/* ----------------------- ExpressionIsArray ---------------------------- */
Value ExpressionIsArray::evaluate(const Document& root, Variables* variables) const {
Value argument = _children[0]->evaluate(root, variables);
return Value(argument.isArray());
}
REGISTER_STABLE_EXPRESSION(isArray, ExpressionIsArray::parse);
const char* ExpressionIsArray::getOpName() const {
return "$isArray";
}
/* ----------------------- ExpressionSlice ---------------------------- */
Value ExpressionSlice::evaluate(const Document& root, Variables* variables) const {
const size_t n = _children.size();
Value arrayVal = _children[0]->evaluate(root, variables);
// Could be either a start index or the length from 0.
Value arg2 = _children[1]->evaluate(root, variables);
if (arrayVal.nullish() || arg2.nullish()) {
return Value(BSONNULL);
}
uassert(28724,
str::stream() << "First argument to $slice must be an array, but is"
<< " of type: " << typeName(arrayVal.getType()),
arrayVal.isArray());
uassert(28725,
str::stream() << "Second argument to $slice must be a numeric value,"
<< " but is of type: " << typeName(arg2.getType()),
arg2.numeric());
uassert(28726,
str::stream() << "Second argument to $slice can't be represented as"
<< " a 32-bit integer: " << arg2.coerceToDouble(),
arg2.integral());
const auto& array = arrayVal.getArray();
size_t start;
size_t end;
if (n == 2) {
// Only count given.
int count = arg2.coerceToInt();
start = 0;
end = array.size();
if (count >= 0) {
end = std::min(end, size_t(count));
} else {
// Negative count's start from the back. If a abs(count) is greater
// than the
// length of the array, return the whole array.
start = std::max(0, static_cast<int>(array.size()) + count);
}
} else {
// We have both a start index and a count.
int startInt = arg2.coerceToInt();
if (startInt < 0) {
// Negative values start from the back. If a abs(start) is greater
// than the length
// of the array, start from 0.
start = std::max(0, static_cast<int>(array.size()) + startInt);
} else {
start = std::min(array.size(), size_t(startInt));
}
Value countVal = _children[2]->evaluate(root, variables);
if (countVal.nullish()) {
return Value(BSONNULL);
}
uassert(28727,
str::stream() << "Third argument to $slice must be numeric, but "
<< "is of type: " << typeName(countVal.getType()),
countVal.numeric());
uassert(28728,
str::stream() << "Third argument to $slice can't be represented"
<< " as a 32-bit integer: " << countVal.coerceToDouble(),
countVal.integral());
uassert(28729,
str::stream() << "Third argument to $slice must be positive: "
<< countVal.coerceToInt(),
countVal.coerceToInt() > 0);
size_t count = size_t(countVal.coerceToInt());
end = std::min(start + count, array.size());
}
return Value(vector<Value>(array.begin() + start, array.begin() + end));
}
REGISTER_STABLE_EXPRESSION(slice, ExpressionSlice::parse);
const char* ExpressionSlice::getOpName() const {
return "$slice";
}
/* ----------------------- ExpressionSize ---------------------------- */
Value ExpressionSize::evaluate(const Document& root, Variables* variables) const {
Value array = _children[0]->evaluate(root, variables);
uassert(17124,
str::stream() << "The argument to $size must be an array, but was of type: "
<< typeName(array.getType()),
array.isArray());
return Value::createIntOrLong(array.getArray().size());
}
REGISTER_STABLE_EXPRESSION(size, ExpressionSize::parse);
const char* ExpressionSize::getOpName() const {
return "$size";
}
/* ----------------------- ExpressionSplit --------------------------- */
Value ExpressionSplit::evaluate(const Document& root, Variables* variables) const {
Value inputArg = _children[0]->evaluate(root, variables);
Value separatorArg = _children[1]->evaluate(root, variables);
if (inputArg.nullish() || separatorArg.nullish()) {
return Value(BSONNULL);
}
uassert(40085,
str::stream() << "$split requires an expression that evaluates to a string as a first "
"argument, found: "
<< typeName(inputArg.getType()),
inputArg.getType() == BSONType::String);
uassert(40086,
str::stream() << "$split requires an expression that evaluates to a string as a second "
"argument, found: "
<< typeName(separatorArg.getType()),
separatorArg.getType() == BSONType::String);
StringData input = inputArg.getStringData();
StringData separator = separatorArg.getStringData();
uassert(40087, "$split requires a non-empty separator", !separator.empty());
std::vector<Value> output;
const char* needle = separator.rawData();
const char* const needleEnd = needle + separator.size();
const char* remainingHaystack = input.rawData();
const char* const haystackEnd = remainingHaystack + input.size();
const char* it = remainingHaystack;
while ((it = std::search(remainingHaystack, haystackEnd, needle, needleEnd)) != haystackEnd) {
StringData sd(remainingHaystack, it - remainingHaystack);
output.push_back(Value(sd));
remainingHaystack = it + separator.size();
}
StringData splitString(remainingHaystack, input.size() - (remainingHaystack - input.rawData()));
output.push_back(Value(splitString));
return Value(std::move(output));
}
REGISTER_STABLE_EXPRESSION(split, ExpressionSplit::parse);
const char* ExpressionSplit::getOpName() const {
return "$split";
}
/* ----------------------- ExpressionSqrt ---------------------------- */
Value ExpressionSqrt::evaluateNumericArg(const Value& numericArg) const {
auto checkArg = [](bool nonNegative) {
uassert(28714, "$sqrt's argument must be greater than or equal to 0", nonNegative);
};
if (numericArg.getType() == NumberDecimal) {
Decimal128 argDec = numericArg.getDecimal();
checkArg(!argDec.isLess(Decimal128::kNormalizedZero)); // NaN returns Nan without error
return Value(argDec.squareRoot());
}
double argDouble = numericArg.coerceToDouble();
checkArg(!(argDouble < 0)); // NaN returns Nan without error
return Value(sqrt(argDouble));
}
REGISTER_STABLE_EXPRESSION(sqrt, ExpressionSqrt::parse);
const char* ExpressionSqrt::getOpName() const {
return "$sqrt";
}
/* ----------------------- ExpressionStrcasecmp ---------------------------- */
Value ExpressionStrcasecmp::evaluate(const Document& root, Variables* variables) const {
Value pString1(_children[0]->evaluate(root, variables));
Value pString2(_children[1]->evaluate(root, variables));
/* boost::iequals returns a bool not an int so strings must actually be allocated */
string str1 = boost::to_upper_copy(pString1.coerceToString());
string str2 = boost::to_upper_copy(pString2.coerceToString());
int result = str1.compare(str2);
if (result == 0)
return Value(0);
else if (result > 0)
return Value(1);
else
return Value(-1);
}
REGISTER_STABLE_EXPRESSION(strcasecmp, ExpressionStrcasecmp::parse);
const char* ExpressionStrcasecmp::getOpName() const {
return "$strcasecmp";
}
/* ----------------------- ExpressionSubstrBytes ---------------------------- */
Value ExpressionSubstrBytes::evaluate(const Document& root, Variables* variables) const {
Value pString(_children[0]->evaluate(root, variables));
Value pLower(_children[1]->evaluate(root, variables));
Value pLength(_children[2]->evaluate(root, variables));
string str = pString.coerceToString();
uassert(16034,
str::stream() << getOpName()
<< ": starting index must be a numeric type (is BSON type "
<< typeName(pLower.getType()) << ")",
pLower.numeric());
uassert(16035,
str::stream() << getOpName() << ": length must be a numeric type (is BSON type "
<< typeName(pLength.getType()) << ")",
pLength.numeric());
const long long signedLower = pLower.coerceToLong();
uassert(50752,
str::stream() << getOpName()
<< ": starting index must be non-negative (got: " << signedLower << ")",
signedLower >= 0);
const string::size_type lower = static_cast<string::size_type>(signedLower);
// If the passed length is negative, we should return the rest of the string.
const long long signedLength = pLength.coerceToLong();
const string::size_type length =
signedLength < 0 ? str.length() : static_cast<string::size_type>(signedLength);
uassert(28656,
str::stream() << getOpName()
<< ": Invalid range, starting index is a UTF-8 continuation byte.",
(lower >= str.length() || !str::isUTF8ContinuationByte(str[lower])));
// Check the byte after the last character we'd return. If it is a continuation byte, that
// means we're in the middle of a UTF-8 character.
uassert(
28657,
str::stream() << getOpName()
<< ": Invalid range, ending index is in the middle of a UTF-8 character.",
(lower + length >= str.length() || !str::isUTF8ContinuationByte(str[lower + length])));
if (lower >= str.length()) {
// If lower > str.length() then string::substr() will throw out_of_range, so return an
// empty string if lower is not a valid string index.
return Value(StringData());
}
return Value(str.substr(lower, length));
}
// $substr is deprecated in favor of $substrBytes, but for now will just parse into a $substrBytes.
REGISTER_STABLE_EXPRESSION(substrBytes, ExpressionSubstrBytes::parse);
REGISTER_STABLE_EXPRESSION(substr, ExpressionSubstrBytes::parse);
const char* ExpressionSubstrBytes::getOpName() const {
return "$substrBytes";
}
/* ----------------------- ExpressionSubstrCP ---------------------------- */
Value ExpressionSubstrCP::evaluate(const Document& root, Variables* variables) const {
Value inputVal(_children[0]->evaluate(root, variables));
Value lowerVal(_children[1]->evaluate(root, variables));
Value lengthVal(_children[2]->evaluate(root, variables));
std::string str = inputVal.coerceToString();
uassert(34450,
str::stream() << getOpName() << ": starting index must be a numeric type (is BSON type "
<< typeName(lowerVal.getType()) << ")",
lowerVal.numeric());
uassert(34451,
str::stream() << getOpName()
<< ": starting index cannot be represented as a 32-bit integral value: "
<< lowerVal.toString(),
lowerVal.integral());
uassert(34452,
str::stream() << getOpName() << ": length must be a numeric type (is BSON type "
<< typeName(lengthVal.getType()) << ")",
lengthVal.numeric());
uassert(34453,
str::stream() << getOpName()
<< ": length cannot be represented as a 32-bit integral value: "
<< lengthVal.toString(),
lengthVal.integral());
int startIndexCodePoints = lowerVal.coerceToInt();
int length = lengthVal.coerceToInt();
uassert(34454,
str::stream() << getOpName() << ": length must be a nonnegative integer.",
length >= 0);
uassert(34455,
str::stream() << getOpName() << ": the starting index must be nonnegative integer.",
startIndexCodePoints >= 0);
size_t startIndexBytes = 0;
for (int i = 0; i < startIndexCodePoints; i++) {
if (startIndexBytes >= str.size()) {
return Value(StringData());
}
uassert(34456,
str::stream() << getOpName() << ": invalid UTF-8 string",
!str::isUTF8ContinuationByte(str[startIndexBytes]));
size_t codePointLength = str::getCodePointLength(str[startIndexBytes]);
uassert(
34457, str::stream() << getOpName() << ": invalid UTF-8 string", codePointLength <= 4);
startIndexBytes += codePointLength;
}
size_t endIndexBytes = startIndexBytes;
for (int i = 0; i < length && endIndexBytes < str.size(); i++) {
uassert(34458,
str::stream() << getOpName() << ": invalid UTF-8 string",
!str::isUTF8ContinuationByte(str[endIndexBytes]));
size_t codePointLength = str::getCodePointLength(str[endIndexBytes]);
uassert(
34459, str::stream() << getOpName() << ": invalid UTF-8 string", codePointLength <= 4);
endIndexBytes += codePointLength;
}
return Value(std::string(str, startIndexBytes, endIndexBytes - startIndexBytes));
}
REGISTER_STABLE_EXPRESSION(substrCP, ExpressionSubstrCP::parse);
const char* ExpressionSubstrCP::getOpName() const {
return "$substrCP";
}
/* ----------------------- ExpressionStrLenBytes ------------------------- */
namespace {
Value strLenBytes(StringData str) {
size_t strLen = str.size();
uassert(34470,
"string length could not be represented as an int.",
strLen <= std::numeric_limits<int>::max());
return Value(static_cast<int>(strLen));
}
} // namespace
Value ExpressionStrLenBytes::evaluate(const Document& root, Variables* variables) const {
Value str(_children[0]->evaluate(root, variables));
uassert(34473,
str::stream() << "$strLenBytes requires a string argument, found: "
<< typeName(str.getType()),
str.getType() == BSONType::String);
return strLenBytes(str.getStringData());
}
REGISTER_STABLE_EXPRESSION(strLenBytes, ExpressionStrLenBytes::parse);
const char* ExpressionStrLenBytes::getOpName() const {
return "$strLenBytes";
}
/* -------------------------- ExpressionBinarySize ------------------------------ */
Value ExpressionBinarySize::evaluate(const Document& root, Variables* variables) const {
Value arg = _children[0]->evaluate(root, variables);
if (arg.nullish()) {
return Value(BSONNULL);
}
uassert(51276,
str::stream() << "$binarySize requires a string or BinData argument, found: "
<< typeName(arg.getType()),
arg.getType() == BSONType::BinData || arg.getType() == BSONType::String);
if (arg.getType() == BSONType::String) {
return strLenBytes(arg.getStringData());
}
BSONBinData binData = arg.getBinData();
return Value(binData.length);
}
REGISTER_STABLE_EXPRESSION(binarySize, ExpressionBinarySize::parse);
const char* ExpressionBinarySize::getOpName() const {
return "$binarySize";
}
/* ----------------------- ExpressionStrLenCP ------------------------- */
Value ExpressionStrLenCP::evaluate(const Document& root, Variables* variables) const {
Value val(_children[0]->evaluate(root, variables));
uassert(34471,
str::stream() << "$strLenCP requires a string argument, found: "
<< typeName(val.getType()),
val.getType() == String);
std::string stringVal = val.getString();
size_t strLen = str::lengthInUTF8CodePoints(stringVal);
uassert(34472,
"string length could not be represented as an int.",
strLen <= std::numeric_limits<int>::max());
return Value(static_cast<int>(strLen));
}
REGISTER_STABLE_EXPRESSION(strLenCP, ExpressionStrLenCP::parse);
const char* ExpressionStrLenCP::getOpName() const {
return "$strLenCP";
}
/* ----------------------- ExpressionSubtract ---------------------------- */
Value ExpressionSubtract::evaluate(const Document& root, Variables* variables) const {
return uassertStatusOK(
apply(_children[0]->evaluate(root, variables), _children[1]->evaluate(root, variables)));
}
StatusWith<Value> ExpressionSubtract::apply(Value lhs, Value rhs) {
BSONType diffType = Value::getWidestNumeric(rhs.getType(), lhs.getType());
if (diffType == NumberDecimal) {
Decimal128 right = rhs.coerceToDecimal();
Decimal128 left = lhs.coerceToDecimal();
return Value(left.subtract(right));
} else if (diffType == NumberDouble) {
double right = rhs.coerceToDouble();
double left = lhs.coerceToDouble();
return Value(left - right);
} else if (diffType == NumberLong) {
long long result;
// If there is an overflow, convert the values to doubles.
if (overflow::sub(lhs.coerceToLong(), rhs.coerceToLong(), &result)) {
return Value(lhs.coerceToDouble() - rhs.coerceToDouble());
}
return Value(result);
} else if (diffType == NumberInt) {
long long right = rhs.coerceToLong();
long long left = lhs.coerceToLong();
return Value::createIntOrLong(left - right);
} else if (lhs.nullish() || rhs.nullish()) {
return Value(BSONNULL);
} else if (lhs.getType() == Date) {
if (rhs.getType() == Date) {
return Value(durationCount<Milliseconds>(lhs.getDate() - rhs.getDate()));
} else if (rhs.numeric()) {
return Value(lhs.getDate() - Milliseconds(rhs.coerceToLong()));
} else {
return Status(ErrorCodes::TypeMismatch,
str::stream()
<< "can't $subtract " << typeName(rhs.getType()) << " from Date");
}
} else {
return Status(ErrorCodes::TypeMismatch,
str::stream() << "can't $subtract " << typeName(rhs.getType()) << " from "
<< typeName(lhs.getType()));
}
}
REGISTER_STABLE_EXPRESSION(subtract, ExpressionSubtract::parse);
const char* ExpressionSubtract::getOpName() const {
return "$subtract";
}
/* ------------------------- ExpressionSwitch ------------------------------ */
REGISTER_STABLE_EXPRESSION(switch, ExpressionSwitch::parse);
Value ExpressionSwitch::evaluate(const Document& root, Variables* variables) const {
for (auto&& branch : _branches) {
Value caseExpression(branch.first->evaluate(root, variables));
if (caseExpression.coerceToBool()) {
return branch.second->evaluate(root, variables);
}
}
uassert(40066,
"$switch could not find a matching branch for an input, and no default was specified.",
_default);
return _default->evaluate(root, variables);
}
boost::intrusive_ptr<Expression> ExpressionSwitch::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(40060,
str::stream() << "$switch requires an object as an argument, found: "
<< typeName(expr.type()),
expr.type() == Object);
boost::intrusive_ptr<Expression> expDefault;
std::vector<boost::intrusive_ptr<Expression>> children;
for (auto&& elem : expr.Obj()) {
auto field = elem.fieldNameStringData();
if (field == "branches") {
// Parse each branch separately.
uassert(40061,
str::stream() << "$switch expected an array for 'branches', found: "
<< typeName(elem.type()),
elem.type() == Array);
for (auto&& branch : elem.Array()) {
uassert(40062,
str::stream() << "$switch expected each branch to be an object, found: "
<< typeName(branch.type()),
branch.type() == Object);
boost::intrusive_ptr<Expression> switchCase, switchThen;
for (auto&& branchElement : branch.Obj()) {
auto branchField = branchElement.fieldNameStringData();
if (branchField == "case") {
switchCase = parseOperand(expCtx, branchElement, vps);
} else if (branchField == "then") {
switchThen = parseOperand(expCtx, branchElement, vps);
} else {
uasserted(40063,
str::stream() << "$switch found an unknown argument to a branch: "
<< branchField);
}
}
uassert(40064, "$switch requires each branch have a 'case' expression", switchCase);
uassert(
40065, "$switch requires each branch have a 'then' expression.", switchThen);
children.push_back(std::move(switchCase));
children.push_back(std::move(switchThen));
}
} else if (field == "default") {
// Optional, arbitrary expression.
expDefault = parseOperand(expCtx, elem, vps);
} else {
uasserted(40067, str::stream() << "$switch found an unknown argument: " << field);
}
}
children.push_back(std::move(expDefault));
// Obtain references to the case and branch expressions two-by-two from the children vector,
// ignore the last.
std::vector<ExpressionPair> branches;
boost::optional<boost::intrusive_ptr<Expression>&> first;
for (auto&& child : children) {
if (first) {
branches.emplace_back(*first, child);
first = boost::none;
} else {
first = child;
}
}
uassert(40068, "$switch requires at least one branch.", !branches.empty());
return new ExpressionSwitch(expCtx, std::move(children), std::move(branches));
}
void ExpressionSwitch::_doAddDependencies(DepsTracker* deps) const {
for (auto&& branch : _branches) {
branch.first->addDependencies(deps);
branch.second->addDependencies(deps);
}
if (_default) {
_default->addDependencies(deps);
}
}
boost::intrusive_ptr<Expression> ExpressionSwitch::optimize() {
if (_default) {
_default = _default->optimize();
}
std::vector<ExpressionPair>::iterator it = _branches.begin();
bool true_const = false;
while (!true_const && it != _branches.end()) {
(it->first) = (it->first)->optimize();
if (auto* val = dynamic_cast<ExpressionConstant*>((it->first).get())) {
if (!((val->getValue()).coerceToBool())) {
// Case is constant and evaluates to false, so it is removed.
it = _branches.erase(it);
} else {
// Case is constant and true so it is set to default and then removed.
true_const = true;
// Optimizing this case's then, so that default will remain optimized.
(it->second) = (it->second)->optimize();
_default = it->second;
it = _branches.erase(it);
}
} else {
// Since case is not removed from the switch, its then is now optimized.
(it->second) = (it->second)->optimize();
++it;
}
}
// Erasing the rest of the cases because found a default true value.
if (true_const) {
_branches.erase(it, _branches.end());
}
// If there are no cases, make the switch its default.
if (_branches.size() == 0 && _default) {
return _default;
} else if (_branches.size() == 0) {
uassert(40069,
"One cannot execute a switch statement where all the cases evaluate to false "
"without a default.",
_branches.size());
}
return this;
}
Value ExpressionSwitch::serialize(bool explain) const {
std::vector<Value> serializedBranches;
serializedBranches.reserve(_branches.size());
for (auto&& branch : _branches) {
serializedBranches.push_back(Value(Document{{"case", branch.first->serialize(explain)},
{"then", branch.second->serialize(explain)}}));
}
if (_default) {
return Value(Document{{"$switch",
Document{{"branches", Value(serializedBranches)},
{"default", _default->serialize(explain)}}}});
}
return Value(Document{{"$switch", Document{{"branches", Value(serializedBranches)}}}});
}
/* ------------------------- ExpressionToLower ----------------------------- */
Value ExpressionToLower::evaluate(const Document& root, Variables* variables) const {
Value pString(_children[0]->evaluate(root, variables));
string str = pString.coerceToString();
boost::to_lower(str);
return Value(str);
}
REGISTER_STABLE_EXPRESSION(toLower, ExpressionToLower::parse);
const char* ExpressionToLower::getOpName() const {
return "$toLower";
}
/* ------------------------- ExpressionToUpper -------------------------- */
Value ExpressionToUpper::evaluate(const Document& root, Variables* variables) const {
Value pString(_children[0]->evaluate(root, variables));
string str(pString.coerceToString());
boost::to_upper(str);
return Value(str);
}
REGISTER_STABLE_EXPRESSION(toUpper, ExpressionToUpper::parse);
const char* ExpressionToUpper::getOpName() const {
return "$toUpper";
}
/* -------------------------- ExpressionTrim ------------------------------ */
REGISTER_STABLE_EXPRESSION(trim, ExpressionTrim::parse);
REGISTER_STABLE_EXPRESSION(ltrim, ExpressionTrim::parse);
REGISTER_STABLE_EXPRESSION(rtrim, ExpressionTrim::parse);
intrusive_ptr<Expression> ExpressionTrim::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
const auto name = expr.fieldNameStringData();
TrimType trimType = TrimType::kBoth;
if (name == "$ltrim"_sd) {
trimType = TrimType::kLeft;
} else if (name == "$rtrim"_sd) {
trimType = TrimType::kRight;
} else {
invariant(name == "$trim"_sd);
}
uassert(50696,
str::stream() << name << " only supports an object as an argument, found "
<< typeName(expr.type()),
expr.type() == Object);
boost::intrusive_ptr<Expression> input;
boost::intrusive_ptr<Expression> characters;
for (auto&& elem : expr.Obj()) {
const auto field = elem.fieldNameStringData();
if (field == "input"_sd) {
input = parseOperand(expCtx, elem, vps);
} else if (field == "chars"_sd) {
characters = parseOperand(expCtx, elem, vps);
} else {
uasserted(50694,
str::stream() << name << " found an unknown argument: " << elem.fieldName());
}
}
uassert(50695, str::stream() << name << " requires an 'input' field", input);
return new ExpressionTrim(expCtx, trimType, name, input, characters);
}
namespace {
const std::vector<StringData> kDefaultTrimWhitespaceChars = {
"\0"_sd, // Null character. Avoid using "\u0000" syntax to work around a gcc bug:
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=53690.
"\u0020"_sd, // Space
"\u0009"_sd, // Horizontal tab
"\u000A"_sd, // Line feed/new line
"\u000B"_sd, // Vertical tab
"\u000C"_sd, // Form feed
"\u000D"_sd, // Horizontal tab
"\u00A0"_sd, // Non-breaking space
"\u1680"_sd, // Ogham space mark
"\u2000"_sd, // En quad
"\u2001"_sd, // Em quad
"\u2002"_sd, // En space
"\u2003"_sd, // Em space
"\u2004"_sd, // Three-per-em space
"\u2005"_sd, // Four-per-em space
"\u2006"_sd, // Six-per-em space
"\u2007"_sd, // Figure space
"\u2008"_sd, // Punctuation space
"\u2009"_sd, // Thin space
"\u200A"_sd // Hair space
};
/**
* Assuming 'charByte' is the beginning of a UTF-8 code point, returns the number of bytes that
* should be used to represent the code point. Said another way, computes how many continuation
* bytes are expected to be present after 'charByte' in a UTF-8 encoded string.
*/
inline size_t numberOfBytesForCodePoint(char charByte) {
if ((charByte & 0b11111000) == 0b11110000) {
return 4;
} else if ((charByte & 0b11110000) == 0b11100000) {
return 3;
} else if ((charByte & 0b11100000) == 0b11000000) {
return 2;
} else {
return 1;
}
}
/**
* Returns a vector with one entry per code point to trim, or throws an exception if 'utf8String'
* contains invalid UTF-8.
*/
std::vector<StringData> extractCodePointsFromChars(StringData utf8String,
StringData expressionName) {
std::vector<StringData> codePoints;
std::size_t i = 0;
while (i < utf8String.size()) {
uassert(50698,
str::stream() << "Failed to parse \"chars\" argument to " << expressionName
<< ": Detected invalid UTF-8. Got continuation byte when expecting "
"the start of a new code point.",
!str::isUTF8ContinuationByte(utf8String[i]));
codePoints.push_back(utf8String.substr(i, numberOfBytesForCodePoint(utf8String[i])));
i += numberOfBytesForCodePoint(utf8String[i]);
}
uassert(50697,
str::stream()
<< "Failed to parse \"chars\" argument to " << expressionName
<< ": Detected invalid UTF-8. Missing expected continuation byte at end of string.",
i <= utf8String.size());
return codePoints;
}
} // namespace
Value ExpressionTrim::evaluate(const Document& root, Variables* variables) const {
auto unvalidatedInput = _input->evaluate(root, variables);
if (unvalidatedInput.nullish()) {
return Value(BSONNULL);
}
uassert(50699,
str::stream() << _name << " requires its input to be a string, got "
<< unvalidatedInput.toString() << " (of type "
<< typeName(unvalidatedInput.getType()) << ") instead.",
unvalidatedInput.getType() == BSONType::String);
const StringData input(unvalidatedInput.getStringData());
if (!_characters) {
return Value(doTrim(input, kDefaultTrimWhitespaceChars));
}
auto unvalidatedUserChars = _characters->evaluate(root, variables);
if (unvalidatedUserChars.nullish()) {
return Value(BSONNULL);
}
uassert(50700,
str::stream() << _name << " requires 'chars' to be a string, got "
<< unvalidatedUserChars.toString() << " (of type "
<< typeName(unvalidatedUserChars.getType()) << ") instead.",
unvalidatedUserChars.getType() == BSONType::String);
return Value(
doTrim(input, extractCodePointsFromChars(unvalidatedUserChars.getStringData(), _name)));
}
bool ExpressionTrim::codePointMatchesAtIndex(const StringData& input,
std::size_t indexOfInput,
const StringData& testCP) {
for (size_t i = 0; i < testCP.size(); ++i) {
if (indexOfInput + i >= input.size() || input[indexOfInput + i] != testCP[i]) {
return false;
}
}
return true;
};
StringData ExpressionTrim::trimFromLeft(StringData input, const std::vector<StringData>& trimCPs) {
std::size_t bytesTrimmedFromLeft = 0u;
while (bytesTrimmedFromLeft < input.size()) {
// Look for any matching code point to trim.
auto matchingCP = std::find_if(trimCPs.begin(), trimCPs.end(), [&](auto& testCP) {
return codePointMatchesAtIndex(input, bytesTrimmedFromLeft, testCP);
});
if (matchingCP == trimCPs.end()) {
// Nothing to trim, stop here.
break;
}
bytesTrimmedFromLeft += matchingCP->size();
}
return input.substr(bytesTrimmedFromLeft);
}
StringData ExpressionTrim::trimFromRight(StringData input, const std::vector<StringData>& trimCPs) {
std::size_t bytesTrimmedFromRight = 0u;
while (bytesTrimmedFromRight < input.size()) {
std::size_t indexToTrimFrom = input.size() - bytesTrimmedFromRight;
auto matchingCP = std::find_if(trimCPs.begin(), trimCPs.end(), [&](auto& testCP) {
if (indexToTrimFrom < testCP.size()) {
// We've gone off the left of the string.
return false;
}
return codePointMatchesAtIndex(input, indexToTrimFrom - testCP.size(), testCP);
});
if (matchingCP == trimCPs.end()) {
// Nothing to trim, stop here.
break;
}
bytesTrimmedFromRight += matchingCP->size();
}
return input.substr(0, input.size() - bytesTrimmedFromRight);
}
StringData ExpressionTrim::doTrim(StringData input, const std::vector<StringData>& trimCPs) const {
if (_trimType == TrimType::kBoth || _trimType == TrimType::kLeft) {
input = trimFromLeft(input, trimCPs);
}
if (_trimType == TrimType::kBoth || _trimType == TrimType::kRight) {
input = trimFromRight(input, trimCPs);
}
return input;
}
boost::intrusive_ptr<Expression> ExpressionTrim::optimize() {
_input = _input->optimize();
if (_characters) {
_characters = _characters->optimize();
}
if (ExpressionConstant::allNullOrConstant({_input, _characters})) {
return ExpressionConstant::create(
getExpressionContext(),
this->evaluate(Document(), &(getExpressionContext()->variables)));
}
return this;
}
Value ExpressionTrim::serialize(bool explain) const {
return Value(
Document{{_name,
Document{{"input", _input->serialize(explain)},
{"chars", _characters ? _characters->serialize(explain) : Value()}}}});
}
void ExpressionTrim::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
if (_characters) {
_characters->addDependencies(deps);
}
}
/* ------------------------- ExpressionRound and ExpressionTrunc -------------------------- */
void assertFlagsValid(uint32_t flags,
const std::string& opName,
long long numericValue,
long long precisionValue) {
uassert(51080,
str::stream() << "invalid conversion from Decimal128 result in " << opName
<< " resulting from arguments: [" << numericValue << ", "
<< precisionValue << "]",
!Decimal128::hasFlag(flags, Decimal128::kInvalid));
}
static Value evaluateRoundOrTrunc(const Document& root,
const std::vector<boost::intrusive_ptr<Expression>>& children,
const std::string& opName,
Decimal128::RoundingMode roundingMode,
double (*doubleOp)(double),
Variables* variables) {
constexpr auto maxPrecision = 100LL;
constexpr auto minPrecision = -20LL;
auto numericArg = Value(children[0]->evaluate(root, variables));
if (numericArg.nullish()) {
return Value(BSONNULL);
}
uassert(51081,
str::stream() << opName << " only supports numeric types, not "
<< typeName(numericArg.getType()),
numericArg.numeric());
long long precisionValue = 0;
if (children.size() > 1) {
auto precisionArg = Value(children[1]->evaluate(root, variables));
if (precisionArg.nullish()) {
return Value(BSONNULL);
}
precisionValue = precisionArg.coerceToLong();
uassert(51082,
str::stream() << "precision argument to " << opName << " must be a integral value",
precisionArg.integral());
uassert(51083,
str::stream() << "cannot apply " << opName << " with precision value "
<< precisionValue << " value must be in [-20, 100]",
minPrecision <= precisionValue && precisionValue <= maxPrecision);
}
// Construct 10^-precisionValue, which will be used as the quantize reference.
auto quantum = Decimal128(0LL, Decimal128::kExponentBias - precisionValue, 0LL, 1LL);
switch (numericArg.getType()) {
case BSONType::NumberDecimal: {
if (numericArg.getDecimal().isInfinite()) {
return numericArg;
}
auto out = numericArg.getDecimal().quantize(quantum, roundingMode);
return Value(out);
}
case BSONType::NumberDouble: {
auto dec = Decimal128(numericArg.getDouble(), Decimal128::kRoundTo34Digits);
if (dec.isInfinite()) {
return numericArg;
}
auto out = dec.quantize(quantum, roundingMode);
return Value(out.toDouble());
}
case BSONType::NumberInt:
case BSONType::NumberLong: {
if (precisionValue >= 0) {
return numericArg;
}
auto numericArgll = numericArg.getLong();
auto out =
Decimal128(static_cast<int64_t>(numericArgll)).quantize(quantum, roundingMode);
uint32_t flags = 0;
auto outll = out.toLong(&flags);
assertFlagsValid(flags, opName, numericArgll, precisionValue);
if (numericArg.getType() == BSONType::NumberLong ||
outll > std::numeric_limits<int>::max()) {
// Even if the original was an int to begin with - it has to be a long now.
return Value(static_cast<long long>(outll));
}
return Value(static_cast<int>(outll));
}
default:
MONGO_UNREACHABLE;
}
}
Value ExpressionRound::evaluate(const Document& root, Variables* variables) const {
return evaluateRoundOrTrunc(
root, _children, getOpName(), Decimal128::kRoundTiesToEven, &std::round, variables);
}
REGISTER_STABLE_EXPRESSION(round, ExpressionRound::parse);
const char* ExpressionRound::getOpName() const {
return "$round";
}
Value ExpressionTrunc::evaluate(const Document& root, Variables* variables) const {
return evaluateRoundOrTrunc(
root, _children, getOpName(), Decimal128::kRoundTowardZero, &std::trunc, variables);
}
intrusive_ptr<Expression> ExpressionTrunc::parse(ExpressionContext* const expCtx,
BSONElement elem,
const VariablesParseState& vps) {
return ExpressionRangedArity<ExpressionTrunc, 1, 2>::parse(expCtx, elem, vps);
}
REGISTER_STABLE_EXPRESSION(trunc, ExpressionTrunc::parse);
const char* ExpressionTrunc::getOpName() const {
return "$trunc";
}
/* ------------------------- ExpressionType ----------------------------- */
Value ExpressionType::evaluate(const Document& root, Variables* variables) const {
Value val(_children[0]->evaluate(root, variables));
return Value(StringData(typeName(val.getType())));
}
REGISTER_STABLE_EXPRESSION(type, ExpressionType::parse);
const char* ExpressionType::getOpName() const {
return "$type";
}
/* ------------------------ ExpressionIsNumber --------------------------- */
Value ExpressionIsNumber::evaluate(const Document& root, Variables* variables) const {
Value val(_children[0]->evaluate(root, variables));
return Value(val.numeric());
}
REGISTER_STABLE_EXPRESSION(isNumber, ExpressionIsNumber::parse);
const char* ExpressionIsNumber::getOpName() const {
return "$isNumber";
}
/* -------------------------- ExpressionZip ------------------------------ */
REGISTER_STABLE_EXPRESSION(zip, ExpressionZip::parse);
intrusive_ptr<Expression> ExpressionZip::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(34460,
str::stream() << "$zip only supports an object as an argument, found "
<< typeName(expr.type()),
expr.type() == Object);
auto useLongestLength = false;
std::vector<boost::intrusive_ptr<Expression>> children;
// We need to ensure defaults appear after inputs so we build them seperately and then
// concatenate them.
std::vector<boost::intrusive_ptr<Expression>> tempDefaultChildren;
for (auto&& elem : expr.Obj()) {
const auto field = elem.fieldNameStringData();
if (field == "inputs") {
uassert(34461,
str::stream() << "inputs must be an array of expressions, found "
<< typeName(elem.type()),
elem.type() == Array);
for (auto&& subExpr : elem.Array()) {
children.push_back(parseOperand(expCtx, subExpr, vps));
}
} else if (field == "defaults") {
uassert(34462,
str::stream() << "defaults must be an array of expressions, found "
<< typeName(elem.type()),
elem.type() == Array);
for (auto&& subExpr : elem.Array()) {
tempDefaultChildren.push_back(parseOperand(expCtx, subExpr, vps));
}
} else if (field == "useLongestLength") {
uassert(34463,
str::stream() << "useLongestLength must be a bool, found "
<< typeName(expr.type()),
elem.type() == Bool);
useLongestLength = elem.Bool();
} else {
uasserted(34464,
str::stream() << "$zip found an unknown argument: " << elem.fieldName());
}
}
auto numInputs = children.size();
std::move(tempDefaultChildren.begin(), tempDefaultChildren.end(), std::back_inserter(children));
std::vector<std::reference_wrapper<boost::intrusive_ptr<Expression>>> inputs;
std::vector<std::reference_wrapper<boost::intrusive_ptr<Expression>>> defaults;
for (auto&& child : children) {
if (numInputs == 0) {
defaults.push_back(child);
} else {
inputs.push_back(child);
numInputs--;
}
}
uassert(34465, "$zip requires at least one input array", !inputs.empty());
uassert(34466,
"cannot specify defaults unless useLongestLength is true",
(useLongestLength || defaults.empty()));
uassert(34467,
"defaults and inputs must have the same length",
(defaults.empty() || defaults.size() == inputs.size()));
return new ExpressionZip(
expCtx, useLongestLength, std::move(children), std::move(inputs), std::move(defaults));
}
Value ExpressionZip::evaluate(const Document& root, Variables* variables) const {
// Evaluate input values.
vector<vector<Value>> inputValues;
inputValues.reserve(_inputs.size());
size_t minArraySize = 0;
size_t maxArraySize = 0;
for (size_t i = 0; i < _inputs.size(); i++) {
Value evalExpr = _inputs[i].get()->evaluate(root, variables);
if (evalExpr.nullish()) {
return Value(BSONNULL);
}
uassert(34468,
str::stream() << "$zip found a non-array expression in input: "
<< evalExpr.toString(),
evalExpr.isArray());
inputValues.push_back(evalExpr.getArray());
size_t arraySize = evalExpr.getArrayLength();
if (i == 0) {
minArraySize = arraySize;
maxArraySize = arraySize;
} else {
auto arraySizes = std::minmax({minArraySize, arraySize, maxArraySize});
minArraySize = arraySizes.first;
maxArraySize = arraySizes.second;
}
}
vector<Value> evaluatedDefaults(_inputs.size(), Value(BSONNULL));
// If we need default values, evaluate each expression.
if (minArraySize != maxArraySize) {
for (size_t i = 0; i < _defaults.size(); i++) {
evaluatedDefaults[i] = _defaults[i].get()->evaluate(root, variables);
}
}
size_t outputLength = _useLongestLength ? maxArraySize : minArraySize;
// The final output array, e.g. [[1, 2, 3], [2, 3, 4]].
vector<Value> output;
// Used to construct each array in the output, e.g. [1, 2, 3].
vector<Value> outputChild;
output.reserve(outputLength);
outputChild.reserve(_inputs.size());
for (size_t row = 0; row < outputLength; row++) {
outputChild.clear();
for (size_t col = 0; col < _inputs.size(); col++) {
if (inputValues[col].size() > row) {
// Add the value from the appropriate input array.
outputChild.push_back(inputValues[col][row]);
} else {
// Add the corresponding default value.
outputChild.push_back(evaluatedDefaults[col]);
}
}
output.push_back(Value(outputChild));
}
return Value(output);
}
boost::intrusive_ptr<Expression> ExpressionZip::optimize() {
for (auto&& input : _inputs)
input.get() = input.get()->optimize();
for (auto&& zipDefault : _defaults)
zipDefault.get() = zipDefault.get()->optimize();
return this;
}
Value ExpressionZip::serialize(bool explain) const {
vector<Value> serializedInput;
vector<Value> serializedDefaults;
Value serializedUseLongestLength = Value(_useLongestLength);
for (auto&& expr : _inputs) {
serializedInput.push_back(expr.get()->serialize(explain));
}
for (auto&& expr : _defaults) {
serializedDefaults.push_back(expr.get()->serialize(explain));
}
return Value(DOC("$zip" << DOC("inputs" << Value(serializedInput) << "defaults"
<< Value(serializedDefaults) << "useLongestLength"
<< serializedUseLongestLength)));
}
void ExpressionZip::_doAddDependencies(DepsTracker* deps) const {
std::for_each(
_inputs.begin(), _inputs.end(), [&deps](intrusive_ptr<Expression> inputExpression) -> void {
inputExpression->addDependencies(deps);
});
std::for_each(_defaults.begin(),
_defaults.end(),
[&deps](intrusive_ptr<Expression> defaultExpression) -> void {
defaultExpression->addDependencies(deps);
});
}
/* -------------------------- ExpressionConvert ------------------------------ */
namespace {
/**
* $convert supports a big grab bag of conversions, so ConversionTable maintains a collection of
* conversion functions, as well as a table to organize them by inputType and targetType.
*/
class ConversionTable {
public:
using ConversionFunc = std::function<Value(ExpressionContext* const, Value)>;
ConversionTable() {
//
// Conversions from NumberDouble
//
table[BSONType::NumberDouble][BSONType::NumberDouble] = &performIdentityConversion;
table[BSONType::NumberDouble][BSONType::String] = &performFormatDouble;
table[BSONType::NumberDouble][BSONType::Bool] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToBool());
};
table[BSONType::NumberDouble][BSONType::Date] = &performCastNumberToDate;
table[BSONType::NumberDouble][BSONType::NumberInt] = &performCastDoubleToInt;
table[BSONType::NumberDouble][BSONType::NumberLong] = &performCastDoubleToLong;
table[BSONType::NumberDouble][BSONType::NumberDecimal] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToDecimal());
};
//
// Conversions from String
//
table[BSONType::String][BSONType::NumberDouble] = &parseStringToNumber<double, 0>;
table[BSONType::String][BSONType::String] = &performIdentityConversion;
table[BSONType::String][BSONType::jstOID] = &parseStringToOID;
table[BSONType::String][BSONType::Bool] = &performConvertToTrue;
table[BSONType::String][BSONType::Date] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(expCtx->timeZoneDatabase->fromString(inputValue.getStringData(),
mongo::TimeZoneDatabase::utcZone()));
};
table[BSONType::String][BSONType::NumberInt] = &parseStringToNumber<int, 10>;
table[BSONType::String][BSONType::NumberLong] = &parseStringToNumber<long long, 10>;
table[BSONType::String][BSONType::NumberDecimal] = &parseStringToNumber<Decimal128, 0>;
//
// Conversions from jstOID
//
table[BSONType::jstOID][BSONType::String] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.getOid().toString());
};
table[BSONType::jstOID][BSONType::jstOID] = &performIdentityConversion;
table[BSONType::jstOID][BSONType::Bool] = &performConvertToTrue;
table[BSONType::jstOID][BSONType::Date] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.getOid().asDateT());
};
//
// Conversions from Bool
//
table[BSONType::Bool][BSONType::NumberDouble] = [](ExpressionContext* const expCtx,
Value inputValue) {
return inputValue.getBool() ? Value(1.0) : Value(0.0);
};
table[BSONType::Bool][BSONType::String] = [](ExpressionContext* const expCtx,
Value inputValue) {
return inputValue.getBool() ? Value("true"_sd) : Value("false"_sd);
};
table[BSONType::Bool][BSONType::Bool] = &performIdentityConversion;
table[BSONType::Bool][BSONType::NumberInt] = [](ExpressionContext* const expCtx,
Value inputValue) {
return inputValue.getBool() ? Value(int{1}) : Value(int{0});
};
table[BSONType::Bool][BSONType::NumberLong] = [](ExpressionContext* const expCtx,
Value inputValue) {
return inputValue.getBool() ? Value(1LL) : Value(0LL);
};
table[BSONType::Bool][BSONType::NumberDecimal] = [](ExpressionContext* const expCtx,
Value inputValue) {
return inputValue.getBool() ? Value(Decimal128(1)) : Value(Decimal128(0));
};
//
// Conversions from Date
//
table[BSONType::Date][BSONType::NumberDouble] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(static_cast<double>(inputValue.getDate().toMillisSinceEpoch()));
};
table[BSONType::Date][BSONType::String] = [](ExpressionContext* const expCtx,
Value inputValue) {
auto dateString = uassertStatusOK(
TimeZoneDatabase::utcZone().formatDate(kISOFormatString, inputValue.getDate()));
return Value(dateString);
};
table[BSONType::Date][BSONType::Bool] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToBool());
};
table[BSONType::Date][BSONType::Date] = &performIdentityConversion;
table[BSONType::Date][BSONType::NumberLong] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.getDate().toMillisSinceEpoch());
};
table[BSONType::Date][BSONType::NumberDecimal] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(
Decimal128(static_cast<int64_t>(inputValue.getDate().toMillisSinceEpoch())));
};
//
// Conversions from NumberInt
//
table[BSONType::NumberInt][BSONType::NumberDouble] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToDouble());
};
table[BSONType::NumberInt][BSONType::String] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(static_cast<std::string>(str::stream() << inputValue.getInt()));
};
table[BSONType::NumberInt][BSONType::Bool] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToBool());
};
table[BSONType::NumberInt][BSONType::NumberInt] = &performIdentityConversion;
table[BSONType::NumberInt][BSONType::NumberLong] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(static_cast<long long>(inputValue.getInt()));
};
table[BSONType::NumberInt][BSONType::NumberDecimal] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToDecimal());
};
//
// Conversions from NumberLong
//
table[BSONType::NumberLong][BSONType::NumberDouble] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToDouble());
};
table[BSONType::NumberLong][BSONType::String] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(static_cast<std::string>(str::stream() << inputValue.getLong()));
};
table[BSONType::NumberLong][BSONType::Bool] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToBool());
};
table[BSONType::NumberLong][BSONType::Date] = &performCastNumberToDate;
table[BSONType::NumberLong][BSONType::NumberInt] = &performCastLongToInt;
table[BSONType::NumberLong][BSONType::NumberLong] = &performIdentityConversion;
table[BSONType::NumberLong][BSONType::NumberDecimal] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToDecimal());
};
//
// Conversions from NumberDecimal
//
table[BSONType::NumberDecimal][BSONType::NumberDouble] = &performCastDecimalToDouble;
table[BSONType::NumberDecimal][BSONType::String] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.getDecimal().toString());
};
table[BSONType::NumberDecimal][BSONType::Bool] = [](ExpressionContext* const expCtx,
Value inputValue) {
return Value(inputValue.coerceToBool());
};
table[BSONType::NumberDecimal][BSONType::Date] = &performCastNumberToDate;
table[BSONType::NumberDecimal][BSONType::NumberInt] = [](ExpressionContext* const expCtx,
Value inputValue) {
return performCastDecimalToInt(BSONType::NumberInt, inputValue);
};
table[BSONType::NumberDecimal][BSONType::NumberLong] = [](ExpressionContext* const expCtx,
Value inputValue) {
return performCastDecimalToInt(BSONType::NumberLong, inputValue);
};
table[BSONType::NumberDecimal][BSONType::NumberDecimal] = &performIdentityConversion;
//
// Miscellaneous conversions to Bool
//
table[BSONType::Object][BSONType::Bool] = &performConvertToTrue;
table[BSONType::Array][BSONType::Bool] = &performConvertToTrue;
table[BSONType::BinData][BSONType::Bool] = &performConvertToTrue;
table[BSONType::RegEx][BSONType::Bool] = &performConvertToTrue;
table[BSONType::DBRef][BSONType::Bool] = &performConvertToTrue;
table[BSONType::Code][BSONType::Bool] = &performConvertToTrue;
table[BSONType::Symbol][BSONType::Bool] = &performConvertToTrue;
table[BSONType::CodeWScope][BSONType::Bool] = &performConvertToTrue;
table[BSONType::bsonTimestamp][BSONType::Bool] = &performConvertToTrue;
}
ConversionFunc findConversionFunc(BSONType inputType, BSONType targetType) const {
ConversionFunc foundFunction;
// Note: We can't use BSONType::MinKey (-1) or BSONType::MaxKey (127) as table indexes,
// so we have to treat them as special cases.
if (inputType != BSONType::MinKey && inputType != BSONType::MaxKey &&
targetType != BSONType::MinKey && targetType != BSONType::MaxKey) {
invariant(inputType >= 0 && inputType <= JSTypeMax);
invariant(targetType >= 0 && targetType <= JSTypeMax);
foundFunction = table[inputType][targetType];
} else if (targetType == BSONType::Bool) {
// This is a conversion from MinKey or MaxKey to Bool, which is allowed (and always
// returns true).
foundFunction = &performConvertToTrue;
} else {
// Any other conversions involving MinKey or MaxKey (either as the target or input) are
// illegal.
}
uassert(ErrorCodes::ConversionFailure,
str::stream() << "Unsupported conversion from " << typeName(inputType) << " to "
<< typeName(targetType) << " in $convert with no onError value",
foundFunction);
return foundFunction;
}
private:
ConversionFunc table[JSTypeMax + 1][JSTypeMax + 1];
static void validateDoubleValueIsFinite(double inputDouble) {
uassert(ErrorCodes::ConversionFailure,
"Attempt to convert NaN value to integer type in $convert with no onError value",
!std::isnan(inputDouble));
uassert(
ErrorCodes::ConversionFailure,
"Attempt to convert infinity value to integer type in $convert with no onError value",
std::isfinite(inputDouble));
}
static Value performCastDoubleToInt(ExpressionContext* const expCtx, Value inputValue) {
double inputDouble = inputValue.getDouble();
validateDoubleValueIsFinite(inputDouble);
uassert(ErrorCodes::ConversionFailure,
str::stream()
<< "Conversion would overflow target type in $convert with no onError value: "
<< inputDouble,
inputDouble >= std::numeric_limits<int>::lowest() &&
inputDouble <= std::numeric_limits<int>::max());
return Value(static_cast<int>(inputDouble));
}
static Value performCastDoubleToLong(ExpressionContext* const expCtx, Value inputValue) {
double inputDouble = inputValue.getDouble();
validateDoubleValueIsFinite(inputDouble);
uassert(ErrorCodes::ConversionFailure,
str::stream()
<< "Conversion would overflow target type in $convert with no onError value: "
<< inputDouble,
inputDouble >= std::numeric_limits<long long>::lowest() &&
inputDouble < BSONElement::kLongLongMaxPlusOneAsDouble);
return Value(static_cast<long long>(inputDouble));
}
static Value performCastDecimalToInt(BSONType targetType, Value inputValue) {
invariant(targetType == BSONType::NumberInt || targetType == BSONType::NumberLong);
Decimal128 inputDecimal = inputValue.getDecimal();
// Performing these checks up front allows us to provide more specific error messages than
// if we just gave the same error for any 'kInvalid' conversion.
uassert(ErrorCodes::ConversionFailure,
"Attempt to convert NaN value to integer type in $convert with no onError value",
!inputDecimal.isNaN());
uassert(
ErrorCodes::ConversionFailure,
"Attempt to convert infinity value to integer type in $convert with no onError value",
!inputDecimal.isInfinite());
std::uint32_t signalingFlags = Decimal128::SignalingFlag::kNoFlag;
Value result;
if (targetType == BSONType::NumberInt) {
int intVal =
inputDecimal.toInt(&signalingFlags, Decimal128::RoundingMode::kRoundTowardZero);
result = Value(intVal);
} else if (targetType == BSONType::NumberLong) {
long long longVal =
inputDecimal.toLong(&signalingFlags, Decimal128::RoundingMode::kRoundTowardZero);
result = Value(longVal);
} else {
MONGO_UNREACHABLE;
}
// NB: Decimal128::SignalingFlag has a values specifically for overflow, but it is used for
// arithmetic with Decimal128 operands, _not_ for conversions of this style. Overflowing
// conversions only trigger a 'kInvalid' flag.
uassert(ErrorCodes::ConversionFailure,
str::stream()
<< "Conversion would overflow target type in $convert with no onError value: "
<< inputDecimal.toString(),
(signalingFlags & Decimal128::SignalingFlag::kInvalid) == 0);
invariant(signalingFlags == Decimal128::SignalingFlag::kNoFlag);
return result;
}
static Value performCastDecimalToDouble(ExpressionContext* const expCtx, Value inputValue) {
Decimal128 inputDecimal = inputValue.getDecimal();
std::uint32_t signalingFlags = Decimal128::SignalingFlag::kNoFlag;
double result =
inputDecimal.toDouble(&signalingFlags, Decimal128::RoundingMode::kRoundTiesToEven);
uassert(ErrorCodes::ConversionFailure,
str::stream()
<< "Conversion would overflow target type in $convert with no onError value: "
<< inputDecimal.toString(),
signalingFlags == Decimal128::SignalingFlag::kNoFlag ||
signalingFlags == Decimal128::SignalingFlag::kInexact);
return Value(result);
}
static Value performCastLongToInt(ExpressionContext* const expCtx, Value inputValue) {
long long longValue = inputValue.getLong();
uassert(ErrorCodes::ConversionFailure,
str::stream()
<< "Conversion would overflow target type in $convert with no onError value: ",
longValue >= std::numeric_limits<int>::min() &&
longValue <= std::numeric_limits<int>::max());
return Value(static_cast<int>(longValue));
}
static Value performCastNumberToDate(ExpressionContext* const expCtx, Value inputValue) {
long long millisSinceEpoch;
switch (inputValue.getType()) {
case BSONType::NumberLong:
millisSinceEpoch = inputValue.getLong();
break;
case BSONType::NumberDouble:
millisSinceEpoch = performCastDoubleToLong(expCtx, inputValue).getLong();
break;
case BSONType::NumberDecimal:
millisSinceEpoch =
performCastDecimalToInt(BSONType::NumberLong, inputValue).getLong();
break;
default:
MONGO_UNREACHABLE;
}
return Value(Date_t::fromMillisSinceEpoch(millisSinceEpoch));
}
static Value performFormatDouble(ExpressionContext* const expCtx, Value inputValue) {
double doubleValue = inputValue.getDouble();
if (std::isinf(doubleValue)) {
return Value(std::signbit(doubleValue) ? "-Infinity"_sd : "Infinity"_sd);
} else if (std::isnan(doubleValue)) {
return Value("NaN"_sd);
} else if (doubleValue == 0.0 && std::signbit(doubleValue)) {
return Value("-0"_sd);
} else {
return Value(static_cast<std::string>(str::stream() << doubleValue));
}
}
template <class targetType, int base>
static Value parseStringToNumber(ExpressionContext* const expCtx, Value inputValue) {
auto stringValue = inputValue.getStringData();
targetType result;
// Reject any strings in hex format. This check is needed because the
// NumberParser::parse call below allows an input hex string prefixed by '0x' when
// parsing to a double.
uassert(ErrorCodes::ConversionFailure,
str::stream() << "Illegal hexadecimal input in $convert with no onError value: "
<< stringValue,
!stringValue.startsWith("0x"));
Status parseStatus = NumberParser().base(base)(stringValue, &result);
uassert(ErrorCodes::ConversionFailure,
str::stream() << "Failed to parse number '" << stringValue
<< "' in $convert with no onError value: " << parseStatus.reason(),
parseStatus.isOK());
return Value(result);
}
static Value parseStringToOID(ExpressionContext* const expCtx, Value inputValue) {
try {
return Value(OID::createFromString(inputValue.getStringData()));
} catch (const DBException& ex) {
// Rethrow any caught exception as a conversion failure such that 'onError' is evaluated
// and returned.
uasserted(ErrorCodes::ConversionFailure,
str::stream() << "Failed to parse objectId '" << inputValue.getString()
<< "' in $convert with no onError value: " << ex.reason());
}
}
static Value performConvertToTrue(ExpressionContext* const expCtx, Value inputValue) {
return Value(true);
}
static Value performIdentityConversion(ExpressionContext* const expCtx, Value inputValue) {
return inputValue;
}
};
Expression::Parser makeConversionAlias(const StringData shortcutName, BSONType toType) {
return [=](ExpressionContext* const expCtx,
BSONElement elem,
const VariablesParseState& vps) -> intrusive_ptr<Expression> {
// Use parseArguments to allow for a singleton array, or the unwrapped version.
auto operands = ExpressionNary::parseArguments(expCtx, elem, vps);
uassert(50723,
str::stream() << shortcutName << " requires a single argument, got "
<< operands.size(),
operands.size() == 1);
return ExpressionConvert::create(expCtx, std::move(operands[0]), toType);
};
}
} // namespace
REGISTER_STABLE_EXPRESSION(convert, ExpressionConvert::parse);
// Also register shortcut expressions like $toInt, $toString, etc. which can be used as a shortcut
// for $convert without an 'onNull' or 'onError'.
REGISTER_STABLE_EXPRESSION(toString, makeConversionAlias("$toString"_sd, BSONType::String));
REGISTER_STABLE_EXPRESSION(toObjectId, makeConversionAlias("$toObjectId"_sd, BSONType::jstOID));
REGISTER_STABLE_EXPRESSION(toDate, makeConversionAlias("$toDate"_sd, BSONType::Date));
REGISTER_STABLE_EXPRESSION(toDouble, makeConversionAlias("$toDouble"_sd, BSONType::NumberDouble));
REGISTER_STABLE_EXPRESSION(toInt, makeConversionAlias("$toInt"_sd, BSONType::NumberInt));
REGISTER_STABLE_EXPRESSION(toLong, makeConversionAlias("$toLong"_sd, BSONType::NumberLong));
REGISTER_STABLE_EXPRESSION(toDecimal,
makeConversionAlias("$toDecimal"_sd, BSONType::NumberDecimal));
REGISTER_STABLE_EXPRESSION(toBool, makeConversionAlias("$toBool"_sd, BSONType::Bool));
boost::intrusive_ptr<Expression> ExpressionConvert::create(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> input,
BSONType toType) {
return new ExpressionConvert(
expCtx,
std::move(input),
ExpressionConstant::create(expCtx, Value(StringData(typeName(toType)))),
nullptr,
nullptr);
}
ExpressionConvert::ExpressionConvert(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> input,
boost::intrusive_ptr<Expression> to,
boost::intrusive_ptr<Expression> onError,
boost::intrusive_ptr<Expression> onNull)
: Expression(expCtx, {std::move(input), std::move(to), std::move(onError), std::move(onNull)}),
_input(_children[0]),
_to(_children[1]),
_onError(_children[2]),
_onNull(_children[3]) {
expCtx->sbeCompatible = false;
}
intrusive_ptr<Expression> ExpressionConvert::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
uassert(ErrorCodes::FailedToParse,
str::stream() << "$convert expects an object of named arguments but found: "
<< typeName(expr.type()),
expr.type() == BSONType::Object);
boost::intrusive_ptr<Expression> input;
boost::intrusive_ptr<Expression> to;
boost::intrusive_ptr<Expression> onError;
boost::intrusive_ptr<Expression> onNull;
for (auto&& elem : expr.embeddedObject()) {
const auto field = elem.fieldNameStringData();
if (field == "input"_sd) {
input = parseOperand(expCtx, elem, vps);
} else if (field == "to"_sd) {
to = parseOperand(expCtx, elem, vps);
} else if (field == "onError"_sd) {
onError = parseOperand(expCtx, elem, vps);
} else if (field == "onNull"_sd) {
onNull = parseOperand(expCtx, elem, vps);
} else {
uasserted(ErrorCodes::FailedToParse,
str::stream()
<< "$convert found an unknown argument: " << elem.fieldNameStringData());
}
}
uassert(ErrorCodes::FailedToParse, "Missing 'input' parameter to $convert", input);
uassert(ErrorCodes::FailedToParse, "Missing 'to' parameter to $convert", to);
return new ExpressionConvert(
expCtx, std::move(input), std::move(to), std::move(onError), std::move(onNull));
}
Value ExpressionConvert::evaluate(const Document& root, Variables* variables) const {
auto toValue = _to->evaluate(root, variables);
Value inputValue = _input->evaluate(root, variables);
boost::optional<BSONType> targetType;
if (!toValue.nullish()) {
targetType = computeTargetType(toValue);
}
if (inputValue.nullish()) {
return _onNull ? _onNull->evaluate(root, variables) : Value(BSONNULL);
} else if (!targetType) {
// "to" evaluated to a nullish value.
return Value(BSONNULL);
}
try {
return performConversion(*targetType, inputValue);
} catch (const ExceptionFor<ErrorCodes::ConversionFailure>&) {
if (_onError) {
return _onError->evaluate(root, variables);
} else {
throw;
}
}
}
boost::intrusive_ptr<Expression> ExpressionConvert::optimize() {
_input = _input->optimize();
_to = _to->optimize();
if (_onError) {
_onError = _onError->optimize();
}
if (_onNull) {
_onNull = _onNull->optimize();
}
// Perform constant folding if possible. This does not support folding for $convert operations
// that have constant _to and _input values but non-constant _onError and _onNull values.
// Because _onError and _onNull are evaluated lazily, conversions that do not used the _onError
// and _onNull values could still be legally folded if those values are not needed. Support for
// that case would add more complexity than it's worth, though.
if (ExpressionConstant::allNullOrConstant({_input, _to, _onError, _onNull})) {
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
}
Value ExpressionConvert::serialize(bool explain) const {
return Value(Document{{"$convert",
Document{{"input", _input->serialize(explain)},
{"to", _to->serialize(explain)},
{"onError", _onError ? _onError->serialize(explain) : Value()},
{"onNull", _onNull ? _onNull->serialize(explain) : Value()}}}});
}
void ExpressionConvert::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_to->addDependencies(deps);
if (_onError) {
_onError->addDependencies(deps);
}
if (_onNull) {
_onNull->addDependencies(deps);
}
}
BSONType ExpressionConvert::computeTargetType(Value targetTypeName) const {
BSONType targetType;
if (targetTypeName.getType() == BSONType::String) {
// typeFromName() does not consider "missing" to be a valid type, but we want to accept it,
// because it is a possible result of the $type aggregation operator.
if (targetTypeName.getStringData() == "missing"_sd) {
return BSONType::EOO;
}
// This will throw if the type name is invalid.
targetType = typeFromName(targetTypeName.getString());
} else if (targetTypeName.numeric()) {
uassert(ErrorCodes::FailedToParse,
"In $convert, numeric 'to' argument is not an integer",
targetTypeName.integral());
int typeCode = targetTypeName.coerceToInt();
uassert(ErrorCodes::FailedToParse,
str::stream()
<< "In $convert, numeric value for 'to' does not correspond to a BSON type: "
<< typeCode,
isValidBSONType(typeCode));
targetType = static_cast<BSONType>(typeCode);
} else {
uasserted(ErrorCodes::FailedToParse,
str::stream() << "$convert's 'to' argument must be a string or number, but is "
<< typeName(targetTypeName.getType()));
}
return targetType;
}
Value ExpressionConvert::performConversion(BSONType targetType, Value inputValue) const {
invariant(!inputValue.nullish());
static const ConversionTable table;
BSONType inputType = inputValue.getType();
return table.findConversionFunc(inputType, targetType)(getExpressionContext(), inputValue);
}
namespace {
auto CommonRegexParse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn,
StringData opName) {
uassert(51103,
str::stream() << opName
<< " expects an object of named arguments but found: " << expr.type(),
expr.type() == BSONType::Object);
struct {
boost::intrusive_ptr<Expression> input;
boost::intrusive_ptr<Expression> regex;
boost::intrusive_ptr<Expression> options;
} parsed;
for (auto&& elem : expr.embeddedObject()) {
const auto field = elem.fieldNameStringData();
if (field == "input"_sd) {
parsed.input = Expression::parseOperand(expCtx, elem, vpsIn);
} else if (field == "regex"_sd) {
parsed.regex = Expression::parseOperand(expCtx, elem, vpsIn);
} else if (field == "options"_sd) {
parsed.options = Expression::parseOperand(expCtx, elem, vpsIn);
} else {
uasserted(31024,
str::stream() << opName << " found an unknown argument: "
<< elem.fieldNameStringData());
}
}
uassert(31022, str::stream() << opName << " requires 'input' parameter", parsed.input);
uassert(31023, str::stream() << opName << " requires 'regex' parameter", parsed.regex);
return parsed;
}
} // namespace
/* -------------------------- ExpressionRegex ------------------------------ */
ExpressionRegex::RegexExecutionState ExpressionRegex::buildInitialState(
const Document& root, Variables* variables) const {
Value textInput = _input->evaluate(root, variables);
Value regexPattern = _regex->evaluate(root, variables);
Value regexOptions = _options ? _options->evaluate(root, variables) : Value(BSONNULL);
auto executionState = _initialExecStateForConstantRegex.value_or(RegexExecutionState());
// The 'input' parameter can be a variable and needs to be extracted from the expression
// document even when '_preExecutionState' is present.
_extractInputField(&executionState, textInput);
// If we have a prebuilt execution state, then the 'regex' and 'options' fields are constant
// values, and we do not need to re-compile them.
if (!hasConstantRegex()) {
_extractRegexAndOptions(&executionState, regexPattern, regexOptions);
_compile(&executionState);
}
return executionState;
}
int ExpressionRegex::execute(RegexExecutionState* regexState) const {
invariant(regexState);
invariant(!regexState->nullish());
invariant(regexState->pcrePtr);
int execResult = pcre_exec(regexState->pcrePtr.get(),
nullptr,
regexState->input->c_str(),
regexState->input->size(),
regexState->startBytePos,
0, // No need to overwrite the options set during pcre_compile.
&(regexState->capturesBuffer.front()),
regexState->capturesBuffer.size());
// The 'execResult' will be -1 if there is no match, 0 < execResult <= (numCaptures + 1)
// depending on how many capture groups match, negative (other than -1) if there is an error
// during execution, and zero if capturesBuffer's capacity is not sufficient to hold all the
// results. The latter scenario should never occur.
uassert(51156,
str::stream() << "Error occurred while executing the regular expression in " << _opName
<< ". Result code: " << execResult,
execResult == -1 || (execResult > 0 && execResult <= (regexState->numCaptures + 1)));
return execResult;
}
Value ExpressionRegex::nextMatch(RegexExecutionState* regexState) const {
int execResult = execute(regexState);
// No match.
if (execResult < 0) {
return Value(BSONNULL);
}
// Use 'input' as StringData throughout the function to avoid copying the string on 'substr'
// calls.
StringData input = *(regexState->input);
auto verifyBounds = [&input, this](auto startPos, auto limitPos, auto isCapture) {
// If a capture group was not matched, then the 'startPos' and 'limitPos' will both be -1.
// These bounds cannot occur for a match on the full string.
if (startPos == -1 || limitPos == -1) {
massert(31304,
str::stream() << "Unexpected error occurred while executing " << _opName
<< ". startPos: " << startPos << ", limitPos: " << limitPos,
isCapture && startPos == -1 && limitPos == -1);
return;
}
massert(31305,
str::stream() << "Unexpected error occurred while executing " << _opName
<< ". startPos: " << startPos,
(startPos >= 0 && static_cast<size_t>(startPos) <= input.size()));
massert(31306,
str::stream() << "Unexpected error occurred while executing " << _opName
<< ". limitPos: " << limitPos,
(limitPos >= 0 && static_cast<size_t>(limitPos) <= input.size()));
massert(31307,
str::stream() << "Unexpected error occurred while executing " << _opName
<< ". startPos: " << startPos << ", limitPos: " << limitPos,
startPos <= limitPos);
};
// The first and second entries of the 'capturesBuffer' will have the start and (end+1) indices
// of the matched string, as byte offsets. '(limit - startIndex)' would be the length of the
// captured string.
verifyBounds(regexState->capturesBuffer[0], regexState->capturesBuffer[1], false);
const int matchStartByteIndex = regexState->capturesBuffer[0];
StringData matchedStr =
input.substr(matchStartByteIndex, regexState->capturesBuffer[1] - matchStartByteIndex);
// We iterate through the input string's contents preceding the match index, in order to convert
// the byte offset to a code point offset.
for (int byteIx = regexState->startBytePos; byteIx < matchStartByteIndex;
++(regexState->startCodePointPos)) {
byteIx += str::getCodePointLength(input[byteIx]);
}
// Set the start index for match to the new one.
regexState->startBytePos = matchStartByteIndex;
std::vector<Value> captures;
captures.reserve(regexState->numCaptures);
// The next '2 * numCaptures' entries (after the first two entries) of 'capturesBuffer' will
// hold the start index and limit pairs, for each of the capture groups. We skip the first two
// elements and start iteration from 3rd element so that we only construct the strings for
// capture groups.
for (int i = 0; i < regexState->numCaptures; ++i) {
const int start = regexState->capturesBuffer[2 * (i + 1)];
const int limit = regexState->capturesBuffer[2 * (i + 1) + 1];
verifyBounds(start, limit, true);
// The 'start' and 'limit' will be set to -1, if the 'input' didn't match the current
// capture group. In this case we put a 'null' placeholder in place of the capture group.
captures.push_back(start == -1 && limit == -1 ? Value(BSONNULL)
: Value(input.substr(start, limit - start)));
}
MutableDocument match;
match.addField("match", Value(matchedStr));
match.addField("idx", Value(regexState->startCodePointPos));
match.addField("captures", Value(captures));
return match.freezeToValue();
}
boost::intrusive_ptr<Expression> ExpressionRegex::optimize() {
_input = _input->optimize();
_regex = _regex->optimize();
if (_options) {
_options = _options->optimize();
}
if (ExpressionConstant::allNullOrConstant({_regex, _options})) {
_initialExecStateForConstantRegex.emplace();
_extractRegexAndOptions(
_initialExecStateForConstantRegex.get_ptr(),
static_cast<ExpressionConstant*>(_regex.get())->getValue(),
_options ? static_cast<ExpressionConstant*>(_options.get())->getValue() : Value());
_compile(_initialExecStateForConstantRegex.get_ptr());
}
return this;
}
void ExpressionRegex::_compile(RegexExecutionState* executionState) const {
const auto pcreOptions =
regex_util::flagsToPcreOptions(executionState->options.value_or(""), _opName).all_options();
if (!executionState->pattern) {
return;
}
const char* compile_error;
int eoffset;
// The C++ interface pcreccp.h doesn't have a way to capture the matched string (or the index of
// the match). So we are using the C interface. First we compile all the regex options to
// generate pcre object, which will later be used to match against the input string.
executionState->pcrePtr = std::shared_ptr<pcre>(
pcre_compile(
executionState->pattern->c_str(), pcreOptions, &compile_error, &eoffset, nullptr),
pcre_free);
uassert(51111,
str::stream() << "Invalid Regex in " << _opName << ": " << compile_error,
executionState->pcrePtr);
// Calculate the number of capture groups present in 'pattern' and store in 'numCaptures'.
const int pcre_retval = pcre_fullinfo(executionState->pcrePtr.get(),
nullptr,
PCRE_INFO_CAPTURECOUNT,
&executionState->numCaptures);
invariant(pcre_retval == 0);
// The first two-thirds of the vector is used to pass back captured substrings' start and
// (end+1) indexes. The remaining third of the vector is used as workspace by pcre_exec() while
// matching capturing subpatterns, and is not available for passing back information.
// pcre_compile will error if there are too many capture groups in the pattern. As long as this
// memory is allocated after compile, the amount of memory allocated will not be too high.
executionState->capturesBuffer.resize((1 + executionState->numCaptures) * 3);
}
Value ExpressionRegex::serialize(bool explain) const {
return Value(
Document{{_opName,
Document{{"input", _input->serialize(explain)},
{"regex", _regex->serialize(explain)},
{"options", _options ? _options->serialize(explain) : Value()}}}});
}
void ExpressionRegex::_extractInputField(RegexExecutionState* executionState,
const Value& textInput) const {
uassert(51104,
str::stream() << _opName << " needs 'input' to be of type string",
textInput.nullish() || textInput.getType() == BSONType::String);
if (textInput.getType() == BSONType::String) {
executionState->input = textInput.getString();
}
}
void ExpressionRegex::_extractRegexAndOptions(RegexExecutionState* executionState,
const Value& regexPattern,
const Value& regexOptions) const {
uassert(51105,
str::stream() << _opName << " needs 'regex' to be of type string or regex",
regexPattern.nullish() || regexPattern.getType() == BSONType::String ||
regexPattern.getType() == BSONType::RegEx);
uassert(51106,
str::stream() << _opName << " needs 'options' to be of type string",
regexOptions.nullish() || regexOptions.getType() == BSONType::String);
// The 'regex' field can be a RegEx object and may have its own options...
if (regexPattern.getType() == BSONType::RegEx) {
StringData regexFlags = regexPattern.getRegexFlags();
executionState->pattern = regexPattern.getRegex();
uassert(51107,
str::stream()
<< _opName
<< ": found regex option(s) specified in both 'regex' and 'option' fields",
regexOptions.nullish() || regexFlags.empty());
if (!regexFlags.empty()) {
executionState->options = regexFlags.toString();
}
} else if (regexPattern.getType() == BSONType::String) {
// ...or it can be a string field with options specified separately.
executionState->pattern = regexPattern.getString();
}
// If 'options' is non-null, we must validate its contents even if 'regexPattern' is nullish.
if (!regexOptions.nullish()) {
executionState->options = regexOptions.getString();
}
uassert(51109,
str::stream() << _opName << ": regular expression cannot contain an embedded null byte",
!executionState->pattern ||
executionState->pattern->find('\0', 0) == std::string::npos);
uassert(51110,
str::stream() << _opName
<< ": regular expression options cannot contain an embedded null byte",
!executionState->options ||
executionState->options->find('\0', 0) == std::string::npos);
}
void ExpressionRegex::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_regex->addDependencies(deps);
if (_options) {
_options->addDependencies(deps);
}
}
boost::optional<std::pair<boost::optional<std::string>, std::string>>
ExpressionRegex::getConstantPatternAndOptions() const {
if (!ExpressionConstant::isNullOrConstant(_regex) ||
!ExpressionConstant::isNullOrConstant(_options)) {
return {};
}
auto patternValue = static_cast<ExpressionConstant*>(_regex.get())->getValue();
uassert(5073405,
str::stream() << _opName << " needs 'regex' to be of type string or regex",
patternValue.nullish() || patternValue.getType() == BSONType::RegEx ||
patternValue.getType() == BSONType::String);
auto patternStr = [&]() -> boost::optional<std::string> {
if (patternValue.getType() == BSONType::RegEx) {
StringData flags = patternValue.getRegexFlags();
uassert(5073406,
str::stream()
<< _opName
<< ": found regex options specified in both 'regex' and 'options' fields",
_options.get() == nullptr || flags.empty());
return std::string(patternValue.getRegex());
} else if (patternValue.getType() == BSONType::String) {
return patternValue.getString();
} else {
return boost::none;
}
}();
auto optionsStr = [&]() -> std::string {
if (_options.get() != nullptr) {
auto optValue = static_cast<ExpressionConstant*>(_options.get())->getValue();
uassert(5126607,
str::stream() << _opName << " needs 'options' to be of type string",
optValue.nullish() || optValue.getType() == BSONType::String);
if (optValue.getType() == BSONType::String) {
return optValue.getString();
}
}
if (patternValue.getType() == BSONType::RegEx) {
StringData flags = patternValue.getRegexFlags();
if (!flags.empty()) {
return flags.toString();
}
}
return {};
}();
uassert(5073407,
str::stream() << _opName << ": regular expression cannot contain an embedded null byte",
!patternStr || patternStr->find('\0') == std::string::npos);
uassert(5073408,
str::stream() << _opName
<< ": regular expression options cannot contain an embedded null byte",
optionsStr.find('\0') == std::string::npos);
return std::make_pair(patternStr, optionsStr);
}
/* -------------------------- ExpressionRegexFind ------------------------------ */
REGISTER_STABLE_EXPRESSION(regexFind, ExpressionRegexFind::parse);
boost::intrusive_ptr<Expression> ExpressionRegexFind::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
auto opName = "$regexFind"_sd;
auto [input, regex, options] = CommonRegexParse(expCtx, expr, vpsIn, opName);
return new ExpressionRegexFind(
expCtx, std::move(input), std::move(regex), std::move(options), opName);
}
Value ExpressionRegexFind::evaluate(const Document& root, Variables* variables) const {
auto executionState = buildInitialState(root, variables);
if (executionState.nullish()) {
return Value(BSONNULL);
}
return nextMatch(&executionState);
}
/* -------------------------- ExpressionRegexFindAll ------------------------------ */
REGISTER_STABLE_EXPRESSION(regexFindAll, ExpressionRegexFindAll::parse);
boost::intrusive_ptr<Expression> ExpressionRegexFindAll::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
auto opName = "$regexFindAll"_sd;
auto [input, regex, options] = CommonRegexParse(expCtx, expr, vpsIn, opName);
return new ExpressionRegexFindAll(
expCtx, std::move(input), std::move(regex), std::move(options), opName);
}
Value ExpressionRegexFindAll::evaluate(const Document& root, Variables* variables) const {
std::vector<Value> output;
auto executionState = buildInitialState(root, variables);
if (executionState.nullish()) {
return Value(output);
}
StringData input = *(executionState.input);
size_t totalDocSize = 0;
// Using do...while loop because, when input is an empty string, we still want to see if there
// is a match.
do {
auto matchObj = nextMatch(&executionState);
if (matchObj.getType() == BSONType::jstNULL) {
break;
}
totalDocSize += matchObj.getApproximateSize();
uassert(51151,
str::stream() << getOpName()
<< ": the size of buffer to store output exceeded the 64MB limit",
totalDocSize <= mongo::BufferMaxSize);
output.push_back(matchObj);
std::string matchStr = matchObj.getDocument().getField("match").getString();
if (matchStr.empty()) {
// This would only happen if the regex matched an empty string. In this case, even if
// the character at startByteIndex matches the regex, we cannot return it since we are
// already returing an empty string starting at this index. So we move on to the next
// byte index.
executionState.startBytePos +=
str::getCodePointLength(input[executionState.startBytePos]);
++executionState.startCodePointPos;
continue;
}
// We don't want any overlapping sub-strings. So we move 'startBytePos' to point to the
// byte after 'matchStr'. We move the code point index also correspondingly.
executionState.startBytePos += matchStr.size();
for (size_t byteIx = 0; byteIx < matchStr.size(); ++executionState.startCodePointPos) {
byteIx += str::getCodePointLength(matchStr[byteIx]);
}
invariant(executionState.startBytePos > 0);
invariant(executionState.startCodePointPos > 0);
invariant(executionState.startCodePointPos <= executionState.startBytePos);
} while (static_cast<size_t>(executionState.startBytePos) < input.size());
return Value(output);
}
/* -------------------------- ExpressionRegexMatch ------------------------------ */
REGISTER_STABLE_EXPRESSION(regexMatch, ExpressionRegexMatch::parse);
boost::intrusive_ptr<Expression> ExpressionRegexMatch::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vpsIn) {
auto opName = "$regexMatch"_sd;
auto [input, regex, options] = CommonRegexParse(expCtx, expr, vpsIn, opName);
return new ExpressionRegexMatch(
expCtx, std::move(input), std::move(regex), std::move(options), opName);
}
Value ExpressionRegexMatch::evaluate(const Document& root, Variables* variables) const {
auto executionState = buildInitialState(root, variables);
// Return output of execute only if regex is not nullish.
return executionState.nullish() ? Value(false) : Value(execute(&executionState) > 0);
}
/* -------------------------- ExpressionRandom ------------------------------ */
REGISTER_STABLE_EXPRESSION(rand, ExpressionRandom::parse);
static thread_local PseudoRandom threadLocalRNG(SecureRandom().nextInt64());
ExpressionRandom::ExpressionRandom(ExpressionContext* const expCtx) : Expression(expCtx) {
expCtx->sbeCompatible = false;
}
intrusive_ptr<Expression> ExpressionRandom::parse(ExpressionContext* const expCtx,
BSONElement exprElement,
const VariablesParseState& vps) {
uassert(3040500,
"$rand not allowed inside collection validators",
!expCtx->isParsingCollectionValidator);
uassert(3040501, "$rand does not currently accept arguments", exprElement.Obj().isEmpty());
return new ExpressionRandom(expCtx);
}
const char* ExpressionRandom::getOpName() const {
return "$rand";
}
double ExpressionRandom::getRandomValue() const {
return kMinValue + (kMaxValue - kMinValue) * threadLocalRNG.nextCanonicalDouble();
}
Value ExpressionRandom::evaluate(const Document& root, Variables* variables) const {
return Value(getRandomValue());
}
intrusive_ptr<Expression> ExpressionRandom::optimize() {
return intrusive_ptr<Expression>(this);
}
void ExpressionRandom::_doAddDependencies(DepsTracker* deps) const {
deps->needRandomGenerator = true;
}
Value ExpressionRandom::serialize(const bool explain) const {
return Value(DOC(getOpName() << Document()));
}
/* ------------------------- ExpressionToHashedIndexKey -------------------------- */
REGISTER_STABLE_EXPRESSION(toHashedIndexKey, ExpressionToHashedIndexKey::parse);
boost::intrusive_ptr<Expression> ExpressionToHashedIndexKey::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
return make_intrusive<ExpressionToHashedIndexKey>(expCtx, parseOperand(expCtx, expr, vps));
}
Value ExpressionToHashedIndexKey::evaluate(const Document& root, Variables* variables) const {
Value inpVal(_children[0]->evaluate(root, variables));
if (inpVal.missing()) {
inpVal = Value(BSONNULL);
}
return Value(BSONElementHasher::hash64(BSON("" << inpVal).firstElement(),
BSONElementHasher::DEFAULT_HASH_SEED));
}
Value ExpressionToHashedIndexKey::serialize(bool explain) const {
return Value(DOC("$toHashedIndexKey" << _children[0]->serialize(explain)));
}
void ExpressionToHashedIndexKey::_doAddDependencies(DepsTracker* deps) const {
_children[0]->addDependencies(deps);
}
/* ------------------------- ExpressionDateArithmetics -------------------------- */
namespace {
auto commonDateArithmeticsParse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps,
StringData opName) {
uassert(5166400,
str::stream() << opName << " expects an object as its argument",
expr.type() == BSONType::Object);
struct {
boost::intrusive_ptr<Expression> startDate;
boost::intrusive_ptr<Expression> unit;
boost::intrusive_ptr<Expression> amount;
boost::intrusive_ptr<Expression> timezone;
} parsedArgs;
const BSONObj args = expr.embeddedObject();
for (auto&& arg : args) {
auto field = arg.fieldNameStringData();
if (field == "startDate"_sd) {
parsedArgs.startDate = Expression::parseOperand(expCtx, arg, vps);
} else if (field == "unit"_sd) {
parsedArgs.unit = Expression::parseOperand(expCtx, arg, vps);
} else if (field == "amount"_sd) {
parsedArgs.amount = Expression::parseOperand(expCtx, arg, vps);
} else if (field == "timezone"_sd) {
parsedArgs.timezone = Expression::parseOperand(expCtx, arg, vps);
} else {
uasserted(5166401,
str::stream()
<< "Unrecognized argument to " << opName << ": " << arg.fieldName()
<< ". Expected arguments are startDate, unit, amount, and optionally "
"timezone.");
}
}
uassert(5166402,
str::stream() << opName << " requires startDate, unit, and amount to be present",
parsedArgs.startDate && parsedArgs.unit && parsedArgs.amount);
return parsedArgs;
}
} // namespace
void ExpressionDateArithmetics::_doAddDependencies(DepsTracker* deps) const {
_startDate->addDependencies(deps);
_unit->addDependencies(deps);
_amount->addDependencies(deps);
if (_timeZone) {
_timeZone->addDependencies(deps);
}
}
boost::intrusive_ptr<Expression> ExpressionDateArithmetics::optimize() {
_startDate = _startDate->optimize();
_unit = _unit->optimize();
_amount = _amount->optimize();
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (ExpressionConstant::allNullOrConstant({_startDate, _unit, _amount, _timeZone})) {
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return intrusive_ptr<Expression>(this);
}
Value ExpressionDateArithmetics::serialize(bool explain) const {
return Value(
Document{{_opName,
Document{{"startDate", _startDate->serialize(explain)},
{"unit", _unit->serialize(explain)},
{"amount", _amount->serialize(explain)},
{"timezone", _timeZone ? _timeZone->serialize(explain) : Value()}}}});
}
Value ExpressionDateArithmetics::evaluate(const Document& root, Variables* variables) const {
const Value startDate = _startDate->evaluate(root, variables);
if (startDate.nullish()) {
return Value(BSONNULL);
}
auto unitVal = _unit->evaluate(root, variables);
if (unitVal.nullish()) {
return Value(BSONNULL);
}
auto amount = _amount->evaluate(root, variables);
if (amount.nullish()) {
return Value(BSONNULL);
}
// Get the TimeZone object for the timezone parameter, if it is specified, or UTC otherwise.
auto timezone =
makeTimeZone(getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
if (!timezone) {
return Value(BSONNULL);
}
uassert(5166403,
str::stream() << _opName << " requires startDate to be convertible to a date",
startDate.coercibleToDate());
uassert(5166404,
str::stream() << _opName << " expects string defining the time unit",
unitVal.getType() == BSONType::String);
auto unit = parseTimeUnit(unitVal.getString());
uassert(5166405,
str::stream() << _opName << " expects integer amount of time units",
amount.integral64Bit());
return evaluateDateArithmetics(
startDate.coerceToDate(), unit, amount.coerceToLong(), timezone.get());
}
REGISTER_EXPRESSION_WITH_MIN_VERSION(dateAdd,
ExpressionDateAdd::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
boost::none);
boost::intrusive_ptr<Expression> ExpressionDateAdd::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
constexpr auto opName = "$dateAdd"_sd;
auto [startDate, unit, amount, timezone] =
commonDateArithmeticsParse(expCtx, expr, vps, opName);
return make_intrusive<ExpressionDateAdd>(expCtx,
std::move(startDate),
std::move(unit),
std::move(amount),
std::move(timezone),
opName);
}
Value ExpressionDateAdd::evaluateDateArithmetics(Date_t date,
TimeUnit unit,
long long amount,
const TimeZone& timezone) const {
return Value(dateAdd(date, unit, amount, timezone));
}
REGISTER_EXPRESSION_WITH_MIN_VERSION(dateSubtract,
ExpressionDateSubtract::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
boost::none);
boost::intrusive_ptr<Expression> ExpressionDateSubtract::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
constexpr auto opName = "$dateSubtract"_sd;
auto [startDate, unit, amount, timezone] =
commonDateArithmeticsParse(expCtx, expr, vps, opName);
return make_intrusive<ExpressionDateSubtract>(expCtx,
std::move(startDate),
std::move(unit),
std::move(amount),
std::move(timezone),
opName);
}
Value ExpressionDateSubtract::evaluateDateArithmetics(Date_t date,
TimeUnit unit,
long long amount,
const TimeZone& timezone) const {
// Long long min value cannot be negated.
uassert(6045000,
str::stream() << "invalid $dateSubtract 'amount' parameter value: " << amount,
amount != std::numeric_limits<long long>::min());
return Value(dateAdd(date, unit, -amount, timezone));
}
/* ----------------------- ExpressionDateTrunc ---------------------------- */
REGISTER_EXPRESSION_WITH_MIN_VERSION(dateTrunc,
ExpressionDateTrunc::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
boost::none);
ExpressionDateTrunc::ExpressionDateTrunc(ExpressionContext* const expCtx,
boost::intrusive_ptr<Expression> date,
boost::intrusive_ptr<Expression> unit,
boost::intrusive_ptr<Expression> binSize,
boost::intrusive_ptr<Expression> timezone,
boost::intrusive_ptr<Expression> startOfWeek)
: Expression{expCtx,
{std::move(date),
std::move(unit),
std::move(binSize),
std::move(timezone),
std::move(startOfWeek)}},
_date{_children[0]},
_unit{_children[1]},
_binSize{_children[2]},
_timeZone{_children[3]},
_startOfWeek{_children[4]} {
expCtx->sbeCompatible = false;
}
boost::intrusive_ptr<Expression> ExpressionDateTrunc::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
tassert(5439011, "Invalid expression passed", expr.fieldNameStringData() == "$dateTrunc");
uassert(5439007,
"$dateTrunc only supports an object as its argument",
expr.type() == BSONType::Object);
BSONElement dateElement, unitElement, binSizeElement, timezoneElement, startOfWeekElement;
for (auto&& element : expr.embeddedObject()) {
auto field = element.fieldNameStringData();
if ("date"_sd == field) {
dateElement = element;
} else if ("binSize"_sd == field) {
binSizeElement = element;
} else if ("unit"_sd == field) {
unitElement = element;
} else if ("timezone"_sd == field) {
timezoneElement = element;
} else if ("startOfWeek"_sd == field) {
startOfWeekElement = element;
} else {
uasserted(5439008,
str::stream()
<< "Unrecognized argument to $dateTrunc: " << element.fieldName()
<< ". Expected arguments are date, unit, and optionally, binSize, "
"timezone, startOfWeek");
}
}
uassert(5439009, "Missing 'date' parameter to $dateTrunc", dateElement);
uassert(5439010, "Missing 'unit' parameter to $dateTrunc", unitElement);
return make_intrusive<ExpressionDateTrunc>(
expCtx,
parseOperand(expCtx, dateElement, vps),
parseOperand(expCtx, unitElement, vps),
binSizeElement ? parseOperand(expCtx, binSizeElement, vps) : nullptr,
timezoneElement ? parseOperand(expCtx, timezoneElement, vps) : nullptr,
startOfWeekElement ? parseOperand(expCtx, startOfWeekElement, vps) : nullptr);
}
boost::intrusive_ptr<Expression> ExpressionDateTrunc::optimize() {
_date = _date->optimize();
_unit = _unit->optimize();
if (_binSize) {
_binSize = _binSize->optimize();
}
if (_timeZone) {
_timeZone = _timeZone->optimize();
}
if (_startOfWeek) {
_startOfWeek = _startOfWeek->optimize();
}
if (ExpressionConstant::allNullOrConstant({_date, _unit, _binSize, _timeZone, _startOfWeek})) {
// Everything is a constant, so we can turn into a constant.
return ExpressionConstant::create(
getExpressionContext(), evaluate(Document{}, &(getExpressionContext()->variables)));
}
return this;
};
Value ExpressionDateTrunc::serialize(bool explain) const {
return Value{Document{
{"$dateTrunc"_sd,
Document{{"date"_sd, _date->serialize(explain)},
{"unit"_sd, _unit->serialize(explain)},
{"binSize"_sd, _binSize ? _binSize->serialize(explain) : Value{}},
{"timezone"_sd, _timeZone ? _timeZone->serialize(explain) : Value{}},
{"startOfWeek"_sd, _startOfWeek ? _startOfWeek->serialize(explain) : Value{}}}}}};
};
Date_t ExpressionDateTrunc::convertToDate(const Value& value) {
uassert(5439012,
str::stream() << "$dateTrunc requires 'date' to be a date, but got "
<< typeName(value.getType()),
value.coercibleToDate());
return value.coerceToDate();
}
unsigned long long ExpressionDateTrunc::convertToBinSize(const Value& value) {
uassert(5439017,
str::stream() << "$dateTrunc requires 'binSize' to be a 64-bit integer, but got value '"
<< value.toString() << "' of type " << typeName(value.getType()),
value.integral64Bit());
const long long binSize = value.coerceToLong();
uassert(5439018,
str::stream() << "$dateTrunc requires 'binSize' to be greater than 0, but got value "
<< binSize,
binSize > 0);
return static_cast<unsigned long long>(binSize);
}
Value ExpressionDateTrunc::evaluate(const Document& root, Variables* variables) const {
const Value dateValue = _date->evaluate(root, variables);
if (dateValue.nullish()) {
return Value(BSONNULL);
}
const Value unitValue = _unit->evaluate(root, variables);
if (unitValue.nullish()) {
return Value(BSONNULL);
}
Value binSizeValue;
if (_binSize) {
binSizeValue = _binSize->evaluate(root, variables);
if (binSizeValue.nullish()) {
return Value(BSONNULL);
}
}
const bool startOfWeekParameterActive = _startOfWeek && isTimeUnitWeek(unitValue);
Value startOfWeekValue{};
if (startOfWeekParameterActive) {
startOfWeekValue = _startOfWeek->evaluate(root, variables);
if (startOfWeekValue.nullish()) {
return Value(BSONNULL);
}
}
const auto timezone = addContextToAssertionException(
[&]() {
return makeTimeZone(
getExpressionContext()->timeZoneDatabase, root, _timeZone.get(), variables);
},
"$dateTrunc parameter 'timezone' value parsing failed"_sd);
if (!timezone) {
return Value(BSONNULL);
}
// Convert parameter values.
const Date_t date = convertToDate(dateValue);
const TimeUnit unit = parseTimeUnit(unitValue, "$dateTrunc"_sd);
const unsigned long long binSize = _binSize ? convertToBinSize(binSizeValue) : 1;
const DayOfWeek startOfWeek = startOfWeekParameterActive
? parseDayOfWeek(startOfWeekValue, "$dateTrunc"_sd, "startOfWeek"_sd)
: kStartOfWeekDefault;
return Value{truncateDate(date, unit, binSize, *timezone, startOfWeek)};
}
void ExpressionDateTrunc::_doAddDependencies(DepsTracker* deps) const {
_date->addDependencies(deps);
_unit->addDependencies(deps);
if (_binSize) {
_binSize->addDependencies(deps);
}
if (_timeZone) {
_timeZone->addDependencies(deps);
}
if (_startOfWeek) {
_startOfWeek->addDependencies(deps);
}
}
/* -------------------------- ExpressionGetField ------------------------------ */
REGISTER_EXPRESSION_WITH_MIN_VERSION(
getField,
ExpressionGetField::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
multiversion::FeatureCompatibilityVersion::kFullyDowngradedTo_5_0);
intrusive_ptr<Expression> ExpressionGetField::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
boost::intrusive_ptr<Expression> fieldExpr;
boost::intrusive_ptr<Expression> inputExpr;
if (expr.type() == BSONType::Object) {
for (auto&& elem : expr.embeddedObject()) {
const auto fieldName = elem.fieldNameStringData();
if (!fieldExpr && !inputExpr && fieldName[0] == '$') {
// This may be an expression, so we should treat it as such.
fieldExpr = Expression::parseOperand(expCtx, expr, vps);
inputExpr = ExpressionFieldPath::parse(expCtx, "$$CURRENT", vps);
break;
} else if (fieldName == "field"_sd) {
fieldExpr = Expression::parseOperand(expCtx, elem, vps);
} else if (fieldName == "input"_sd) {
inputExpr = Expression::parseOperand(expCtx, elem, vps);
} else {
uasserted(3041701,
str::stream()
<< kExpressionName << " found an unknown argument: " << fieldName);
}
}
} else {
fieldExpr = Expression::parseOperand(expCtx, expr, vps);
inputExpr = ExpressionFieldPath::parse(expCtx, "$$CURRENT", vps);
}
uassert(3041702,
str::stream() << kExpressionName << " requires 'field' to be specified",
fieldExpr);
uassert(3041703,
str::stream() << kExpressionName << " requires 'input' to be specified",
inputExpr);
// The 'field' argument to '$getField' must evaluate to a constant string, for example,
// {$const: "$a.b"}. In case the has forgotten to wrap the value into a '$const' or
// '$literal' expression, we will raise an error with a more meaningful description.
if (auto fieldPathExpr = dynamic_cast<ExpressionFieldPath*>(fieldExpr.get()); fieldPathExpr) {
auto fp = fieldPathExpr->getFieldPath().fullPathWithPrefix();
uasserted(5654600,
str::stream() << "'" << fp
<< "' is a field path reference which is not allowed "
"in this context. Did you mean {$literal: '"
<< fp << "'}?");
}
auto constFieldExpr = dynamic_cast<ExpressionConstant*>(fieldExpr.get());
uassert(5654601,
str::stream() << kExpressionName
<< " requires 'field' to evaluate to a constant, "
"but got a non-constant argument",
constFieldExpr);
uassert(5654602,
str::stream() << kExpressionName
<< " requires 'field' to evaluate to type String, "
"but got "
<< typeName(constFieldExpr->getValue().getType()),
constFieldExpr->getValue().getType() == BSONType::String);
return make_intrusive<ExpressionGetField>(expCtx, fieldExpr, inputExpr);
}
Value ExpressionGetField::evaluate(const Document& root, Variables* variables) const {
auto fieldValue = _field->evaluate(root, variables);
// The parser guarantees that the '_field' expression evaluates to a constant string.
tassert(3041704,
str::stream() << kExpressionName
<< " requires 'field' to evaluate to type String, "
"but got "
<< typeName(fieldValue.getType()),
fieldValue.getType() == BSONType::String);
auto inputValue = _input->evaluate(root, variables);
if (inputValue.nullish()) {
if (inputValue.missing()) {
return Value();
} else {
return Value(BSONNULL);
}
} else if (inputValue.getType() != BSONType::Object) {
return Value();
}
return inputValue.getDocument().getField(fieldValue.getString());
}
intrusive_ptr<Expression> ExpressionGetField::optimize() {
return intrusive_ptr<Expression>(this);
}
void ExpressionGetField::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_field->addDependencies(deps);
}
Value ExpressionGetField::serialize(const bool explain) const {
return Value(Document{{"$getField"_sd,
Document{{"field"_sd, _field->serialize(explain)},
{"input"_sd, _input->serialize(explain)}}}});
}
/* -------------------------- ExpressionSetField ------------------------------ */
REGISTER_EXPRESSION_WITH_MIN_VERSION(
setField,
ExpressionSetField::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
multiversion::FeatureCompatibilityVersion::kFullyDowngradedTo_5_0);
// $unsetField is syntactic sugar for $setField where value is set to $$REMOVE.
REGISTER_EXPRESSION_WITH_MIN_VERSION(
unsetField,
ExpressionSetField::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
multiversion::FeatureCompatibilityVersion::kFullyDowngradedTo_5_0);
intrusive_ptr<Expression> ExpressionSetField::parse(ExpressionContext* const expCtx,
BSONElement expr,
const VariablesParseState& vps) {
const auto name = expr.fieldNameStringData();
const bool isUnsetField = name == "$unsetField";
uassert(4161100,
str::stream() << name << " only supports an object as its argument",
expr.type() == BSONType::Object);
boost::intrusive_ptr<Expression> fieldExpr;
boost::intrusive_ptr<Expression> inputExpr;
boost::intrusive_ptr<Expression> valueExpr;
for (auto&& elem : expr.embeddedObject()) {
const auto fieldName = elem.fieldNameStringData();
if (fieldName == "field"_sd) {
fieldExpr = Expression::parseOperand(expCtx, elem, vps);
} else if (fieldName == "input"_sd) {
inputExpr = Expression::parseOperand(expCtx, elem, vps);
} else if (!isUnsetField && fieldName == "value"_sd) {
valueExpr = Expression::parseOperand(expCtx, elem, vps);
} else {
uasserted(4161101,
str::stream() << name << " found an unknown argument: " << fieldName);
}
}
if (isUnsetField) {
tassert(
4161110, str::stream() << name << " expects 'value' not to be specified.", !valueExpr);
valueExpr = ExpressionFieldPath::parse(expCtx, "$$REMOVE", vps);
}
uassert(4161102, str::stream() << name << " requires 'field' to be specified", fieldExpr);
uassert(4161103, str::stream() << name << " requires 'value' to be specified", valueExpr);
uassert(4161109, str::stream() << name << " requires 'input' to be specified", inputExpr);
// The 'field' argument to '$setField' must evaluate to a constant string, for example,
// {$const: "$a.b"}. In case the user has forgotten to wrap the value into a '$const' or
// '$literal' expression, we will raise an error with a more meaningful description.
if (auto fieldPathExpr = dynamic_cast<ExpressionFieldPath*>(fieldExpr.get()); fieldPathExpr) {
auto fp = fieldPathExpr->getFieldPath().fullPathWithPrefix();
uasserted(4161108,
str::stream() << "'" << fp
<< "' is a field path reference which is not allowed "
"in this context. Did you mean {$literal: '"
<< fp << "'}?");
}
auto constFieldExpr = dynamic_cast<ExpressionConstant*>(fieldExpr.get());
uassert(4161106,
str::stream() << name
<< " requires 'field' to evaluate to a constant, "
"but got a non-constant argument",
constFieldExpr);
uassert(4161107,
str::stream() << name
<< " requires 'field' to evaluate to type String, "
"but got "
<< typeName(constFieldExpr->getValue().getType()),
constFieldExpr->getValue().getType() == BSONType::String);
return make_intrusive<ExpressionSetField>(expCtx, fieldExpr, inputExpr, valueExpr);
}
Value ExpressionSetField::evaluate(const Document& root, Variables* variables) const {
auto field = _field->evaluate(root, variables);
// The parser guarantees that the '_field' expression evaluates to a constant string.
tassert(4161104,
str::stream() << kExpressionName
<< " requires 'field' to evaluate to type String, "
"but got "
<< typeName(field.getType()),
field.getType() == BSONType::String);
auto input = _input->evaluate(root, variables);
if (input.nullish()) {
return Value(BSONNULL);
}
uassert(4161105,
str::stream() << kExpressionName << " requires 'input' to evaluate to type Object",
input.getType() == BSONType::Object);
auto value = _value->evaluate(root, variables);
// Build output document and modify 'field'.
MutableDocument outputDoc(input.getDocument());
outputDoc.setField(field.getString(), value);
return outputDoc.freezeToValue();
}
intrusive_ptr<Expression> ExpressionSetField::optimize() {
return intrusive_ptr<Expression>(this);
}
void ExpressionSetField::_doAddDependencies(DepsTracker* deps) const {
_input->addDependencies(deps);
_field->addDependencies(deps);
_value->addDependencies(deps);
}
Value ExpressionSetField::serialize(const bool explain) const {
return Value(Document{{"$setField"_sd,
Document{{"field"_sd, _field->serialize(explain)},
{"input"_sd, _input->serialize(explain)},
{"value"_sd, _value->serialize(explain)}}}});
}
/* ------------------------- ExpressionTsSecond ----------------------------- */
Value ExpressionTsSecond::evaluate(const Document& root, Variables* variables) const {
const Value operand = _children[0]->evaluate(root, variables);
if (operand.nullish()) {
return Value(BSONNULL);
}
uassert(5687301,
str::stream() << " Argument to " << opName << " must be a timestamp, but is "
<< typeName(operand.getType()),
operand.getType() == BSONType::bsonTimestamp);
return Value(static_cast<long long>(operand.getTimestamp().getSecs()));
}
REGISTER_EXPRESSION_WITH_MIN_VERSION(
tsSecond,
ExpressionTsSecond::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
multiversion::FeatureCompatibilityVersion::kFullyDowngradedTo_5_0);
/* ------------------------- ExpressionTsIncrement ----------------------------- */
Value ExpressionTsIncrement::evaluate(const Document& root, Variables* variables) const {
const Value operand = _children[0]->evaluate(root, variables);
if (operand.nullish()) {
return Value(BSONNULL);
}
uassert(5687302,
str::stream() << " Argument to " << opName << " must be a timestamp, but is "
<< typeName(operand.getType()),
operand.getType() == BSONType::bsonTimestamp);
return Value(static_cast<long long>(operand.getTimestamp().getInc()));
}
REGISTER_EXPRESSION_WITH_MIN_VERSION(
tsIncrement,
ExpressionTsIncrement::parse,
AllowedWithApiStrict::kNeverInVersion1,
AllowedWithClientType::kAny,
multiversion::FeatureCompatibilityVersion::kFullyDowngradedTo_5_0);
MONGO_INITIALIZER_GROUP(BeginExpressionRegistration, ("default"), ("EndExpressionRegistration"))
MONGO_INITIALIZER_GROUP(EndExpressionRegistration, ("BeginExpressionRegistration"), ())
} // namespace mongo
|