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
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
|
#! @PERL@
# $NetBSD: pkglint.pl,v 1.702 2007/03/02 05:54:18 wiz Exp $
#
# pkglint - static analyzer and checker for pkgsrc packages
#
# Written by:
# Roland Illig <rillig@NetBSD.org>
#
# Based on work by:
# Hubert Feyrer <hubertf@NetBSD.org>
# Thorsten Frueauf <frueauf@NetBSD.org>
# Thomas Klausner <wiz@NetBSD.org>
# and others.
#
# Based on FreeBSD's portlint by:
# Jun-ichiro itojun Hagino <itojun@itojun.org>
# Yoshishige Arai <ryo2@on.rim.or.jp>
#
# FreeBSD Id: portlint.pl,v 1.64 1998/02/28 02:34:05 itojun Exp
# Copyright(c) 1997 by Jun-ichiro Hagino <itojun@itojun.org>.
# All rights reserved.
# Freely redistributable. Absolutely no warranty.
#==========================================================================
# Note: The @EXPORT clauses in the packages must be in a BEGIN block,
# because otherwise the names starting with an uppercase letter are not
# recognized as subroutines but as file handles.
#==========================================================================
use strict;
use warnings;
package PkgLint::Util;
#==========================================================================
# This package is a catch-all for subroutines that are not application-spe-
# cific. Currently it contains the boolean constants C<false> and C<true>,
# as well as a function to print text in a table format, and a function
# that converts an array into a hash. The latter is just for convenience
# because I don't know of a Perl operator similar to qw() that can be used
# for creating a hash.
#==========================================================================
BEGIN {
use Exporter;
use vars qw(@ISA @EXPORT_OK);
@ISA = qw(Exporter);
@EXPORT_OK = qw(
assert
false true dont_know doesnt_matter
min max
array_to_hash normalize_pathname print_table
);
}
use enum qw(false true dont_know doesnt_matter);
sub assert($$) {
my ($cond, $msg) = @_;
my (@callers, $n);
if (!$cond) {
print STDERR ("FATAL: Assertion failed: ${msg}.\n");
for ($n = 0; my @info = caller($n); $n++) {
push(@callers, [$info[2], $info[3]]);
}
for (my $i = $#callers; $i >= 0; $i--) {
my $info = $callers[$i];
printf STDERR (" line %4d called %s\n", $info->[0], $info->[1]);
}
exit(1);
}
}
sub min($$) {
my ($a, $b) = @_;
return ($a < $b) ? $a : $b;
}
sub max($$) {
my ($a, $b) = @_;
return ($a > $b) ? $a : $b;
}
# Prints the C<$table> on the C<$out> stream. The C<$table> shall be an
# array of rows, each row shall be an array of cells, and each cell shall
# be a string.
sub print_table($$) {
my ($out, $table) = @_;
my (@width) = ();
foreach my $row (@{$table}) {
foreach my $i (0..$#{$row}) {
if (!defined($width[$i]) || length($row->[$i]) > $width[$i]) {
$width[$i] = length($row->[$i]);
}
}
}
foreach my $row (@{$table}) {
my ($max) = ($#{$row});
foreach my $i (0..$max) {
if ($i != 0) {
print $out (" ");
}
print $out ($row->[$i]);
if ($i != $max) {
print $out (" " x ($width[$i] - length($row->[$i])));
}
}
print $out ("\n");
}
}
sub array_to_hash(@) {
my ($result) = {};
foreach my $arg (@_) {
$result->{$arg} = 1;
}
return $result;
}
sub normalize_pathname($) {
my ($fname) = @_;
# strip "." path components
$fname =~ s,^(?:\./)+,,;
$fname =~ s,/(?:\./)+,/,g;
$fname =~ s,/+,/,g;
# strip intermediate "../.." path components
while ($fname =~ s,/[^.][^/]*/[^.][^/]*/\.\./\.\./,/,) {
}
return $fname;
}
#== End of PkgLint::Util ==================================================
package PkgLint::Logging;
#==========================================================================
# This package provides subroutines for printing messages to the user in a
# common format. The subroutines all have the parameters C<$fname>,
# C<$lineno> and C<$message>. In case there's no appropriate filename for
# the message, NO_FILE may be passed, likewise for C<$lineno> and
# NO_LINES. Before printing, the filename is normalized, that is,
# "/foo/bar/../../" components are removed, as well as "." components.
# At the end of the program, the subroutine print_summary_and_exit should
# be called.
#
# Examples:
# log_error(NO_FILE, NO_LINES, "Invalid command line.");
# log_warning($fname, NO_LINES, "Not found.");
# log_debug($fname, $lineno, sprintf("invalid character (0x%02x).", $c));
#==========================================================================
use strict;
use warnings;
BEGIN {
use Exporter;
use vars qw(@ISA @EXPORT_OK);
@ISA = qw(Exporter);
@EXPORT_OK = qw(
NO_FILE NO_LINE_NUMBER NO_LINES
log_fatal log_error log_warning log_note log_debug
explain_error explain_warning explain_info
print_summary_and_exit
set_explain set_gcc_output_format
get_show_source_flag set_show_source_flag
get_klickibunti_flag set_klickibunti_flag
);
import PkgLint::Util qw(
false true
normalize_pathname
);
}
use constant NO_FILE => undef;
use constant NO_LINE_NUMBER => undef;
use constant NO_LINES => undef;
use enum qw(:LL_ FATAL ERROR WARNING NOTE DEBUG);
use constant traditional_type => ["FATAL", "ERROR", "WARN", "NOTE", "DEBUG"];
use constant gcc_type => ["fatal", "error", "warning", "note", "debug"];
my $errors = 0;
my $warnings = 0;
my $gcc_output_format = false;
my $klickibunti_flag = false;
my $explain_flag = false;
my $show_source_flag = false;
sub strxvis($) {
my ($s) = @_;
$s =~ s/([^\x09\x20-\x7e])/"\\x" . unpack("H*", $1)/eg;
return $s;
}
sub log_message($$$$) {
my ($level, $fname, $lineno, $message) = @_;
my ($text, $sep);
if (defined($fname)) {
$fname = normalize_pathname($fname);
}
$text = "";
$sep = "";
if (!$gcc_output_format) {
$text .= "${sep}" . traditional_type->[$level] . ":";
$sep = " ";
}
if (defined($fname)) {
$text .= defined($lineno)
? "${sep}${fname}:${lineno}"
: "${sep}${fname}";
$sep = ": ";
}
if ($gcc_output_format) {
$text .= "${sep}" . gcc_type->[$level] . ":";
$sep = " ";
}
if (defined($message)) {
$text .= $sep . strxvis($message);
$sep = "";
}
if ($level == LL_FATAL) {
print STDERR ("${text}\n");
} else {
print STDOUT ("${text}\n");
}
}
sub log_fatal($$$) {
my ($fname, $lineno, $msg) = @_;
log_message(LL_FATAL, $fname, $lineno, $msg);
exit(1);
}
sub log_error($$$) {
my ($fname, $lineno, $msg) = @_;
log_message(LL_ERROR, $fname, $lineno, $msg);
$errors++;
}
sub log_warning($$$) {
my ($fname, $lineno, $msg) = @_;
log_message(LL_WARNING, $fname, $lineno, $msg);
$warnings++;
}
sub log_note($$$) {
my ($fname, $lineno, $msg) = @_;
log_message(LL_NOTE, $fname, $lineno, $msg);
}
sub log_debug($$$) {
my ($fname, $lineno, $msg) = @_;
log_message(LL_DEBUG, $fname, $lineno, $msg);
}
sub explain($$@) {
my ($loglevel, $fname, $lines, @texts) = @_;
my $out = ($loglevel == LL_FATAL) ? *STDERR : *STDOUT;
if ($explain_flag) {
foreach my $text ("", @texts, "") {
print $out ("\t${text}\n");
}
}
}
sub explain_error($$@) {
my ($fname, $lines, @texts) = @_;
explain(LL_ERROR, $fname, $lines, @texts);
}
sub explain_warning($$@) {
my ($fname, $lines, @texts) = @_;
explain(LL_WARNING, $fname, $lines, @texts);
}
sub explain_note($$@) {
my ($fname, $lines, @texts) = @_;
explain(LL_NOTE, $fname, $lines, @texts);
}
sub print_summary_and_exit($) {
my ($quiet) = @_;
if (!$quiet) {
if ($errors != 0 || $warnings != 0) {
print("$errors errors and $warnings warnings found.\n");
} else {
print "looks fine.\n";
}
}
exit($errors != 0);
}
sub set_explain() { $explain_flag = true; }
sub set_gcc_output_format() { $gcc_output_format = true; }
sub get_klickibunti_flag() { return $klickibunti_flag; }
sub set_klickibunti_flag() { $klickibunti_flag = true; }
sub get_show_source_flag() { return $show_source_flag; }
sub set_show_source_flag() { $show_source_flag = true; }
#== End of PkgLint::Logging ===============================================
#==========================================================================
# A File is a structure containing the contents of a file:
# name: string The name of the file.
# lines: array of string The physical lines in the file.
#==========================================================================
package PkgLint::File;
use enum qw(NAME LINES);
sub new($$$) {
my ($class, $name, $lines) = @_;
my $self = [$name, $lines];
bless($self, $class);
return $self;
}
sub name($) { return shift(@_)->[NAME]; }
sub lines($) { return shift(@_)->[LINES]; }
sub load($$) {
my ($self, $fname) = @_;
my ($lines);
$lines = [];
open(F, "<", $fname) or return undef;
while (defined(my $line = <F>)) {
push(@{$lines}, $line);
}
close(F) or return undef;
$self->[NAME] = $fname;
$self->[LINES] = $lines;
return $self;
}
#==========================================================================
# A Location is a structure containing a location in a file:
# lineno: int The line number in the file
# colno: int The column number in the file
#==========================================================================
package PkgLint::Location;
use enum qw(LINENO COLNO);
sub new($$$$) {
my ($class, $lineno, $colno) = @_;
my ($self) = ([$lineno, $colno]);
bless($self, $class);
return $self;
}
sub lineno($) { return shift(@_)->[LINENO]; }
sub colno($) { return shift(@_)->[COLNO]; }
#==========================================================================
# A SimpleMatch is the result of applying a regular expression to a Perl
# scalar value. It can return the range and the text of the captured
# groups.
#==========================================================================
package PkgLint::SimpleMatch;
use enum qw(STRING STARTS ENDS N);
sub new($$) {
my ($class, $string, $starts, $ends) = @_;
my ($self) = ([$string, [@{$starts}], [@{$ends}], $#{$ends}]);
bless($self, $class);
return $self;
}
sub string($) { return shift(@_)->[STRING]; }
sub n($) { return shift(@_)->[N]; }
sub has($$) {
my ($self, $n) = @_;
return 0 <= $n && $n <= $self->n
&& defined($self->[STARTS]->[$n])
&& defined($self->[ENDS]->[$n]);
}
sub text($$) {
my ($self, $n) = @_;
my $start = $self->[STARTS]->[$n];
my $end = $self->[ENDS]->[$n];
return substr($self->string, $start, $end - $start);
}
sub range($$) {
my ($self, $n) = @_;
return ($self->[STARTS]->[$n], $self->[ENDS]->[$n]);
}
#==========================================================================
# A StringMatch is the result of applying a regular expression to a String.
# It can return the range and the text of the captured groups.
#==========================================================================
package PkgLint::StringMatch;
use enum qw(STRING STARTS ENDS);
sub new($$) {
my ($class, $string, $starts, $ends) = @_;
my ($self) = ([$string, [@{$starts}], [@{$ends}]]);
bless($self, $class);
return $self;
}
sub string($) { return shift(@_)->[STRING]; }
sub text($$) {
my ($self, $n) = @_;
my $start = $self->[STARTS]->[$n];
my $end = $self->[ENDS]->[$n];
return $self->string->substring($start, $end - $start)->text;
}
sub range($$) {
my ($self, $n) = @_;
return ($self->[STARTS]->[$n], $self->[ENDS]->[$n]);
}
sub highlight($$) {
my ($self, $n) = @_;
$self->string->highlight(0, $self->[STARTS]->[$n], $self->[ENDS]->[$n]);
}
#==========================================================================
# When files are read in by pkglint, they are interpreted in terms of
# lines. For Makefiles, line continuations are handled properly, allowing
# multiple physical lines to end in a single logical line. For other files
# there is a 1:1 translation.
#
# A difference between the physical and the logical lines is that the
# physical lines include the line end sequence, whereas the logical lines
# do not.
#
# A logical line is a class having the read-only fields C<file>,
# C<lines>, C<text>, C<physlines> and C<is_changed>, as well as some
# methods for printing diagnostics easily.
#
# Some other methods allow modification of the physical lines, but leave
# the logical line (the C<text>) untouched. These methods are used in the
# --autofix mode.
#
# A line can have some "extra" fields that allow the results of parsing to
# be saved under a name.
#==========================================================================
package PkgLint::Line;
BEGIN {
import PkgLint::Util qw(
false true
assert
);
}
use enum qw(FNAME LINES TEXT PHYSLINES CHANGED BEFORE AFTER EXTRA);
sub new($$$$) {
my ($class, $fname, $lines, $text, $physlines) = @_;
my ($self) = ([$fname, $lines, $text, $physlines, false, [], [], {}]);
bless($self, $class);
return $self;
}
sub fname($) { return shift(@_)->[FNAME]; }
sub lines($) { return shift(@_)->[LINES]; }
sub text($) { return shift(@_)->[TEXT]; }
# Note: physlines is _not_ a usual getter method.
sub is_changed($) { return shift(@_)->[CHANGED]; }
# querying, getting and setting the extra values.
sub has($$) {
my ($self, $name) = @_;
return exists($self->[EXTRA]->{$name});
}
sub get($$) {
my ($self, $name) = @_;
assert(exists($self->[EXTRA]->{$name}), "Field ${name} does not exist.");
return $self->[EXTRA]->{$name};
}
sub set($$$) {
my ($self, $name, $value) = @_;
assert(!exists($self->[EXTRA]->{$name}), "Field ${name} already exists.");
# Make sure that the line does not become a cyclic data structure.
my $type = ref($value);
if ($type eq "") {
# ok
} elsif ($type eq "ARRAY") {
foreach my $element (@{$value}) {
my $element_type = ref($element);
assert($element_type eq "" || $element_type eq "PkgLint::SimpleMatch",
"Invalid array data type: name=${name}, type=${element_type}.");
}
} else {
assert(false, "Invalid data: name=${name}, value=${value}.");
}
$self->[EXTRA]->{$name} = $value;
}
sub physlines($) {
my ($self) = @_;
return [@{$self->[BEFORE]}, @{$self->[PHYSLINES]}, @{$self->[AFTER]}];
}
# Only for PkgLint::String support
sub substring($$$$) {
my ($self, $line, $start, $end) = @_;
my ($text, $physlines);
return substr($self->[PHYSLINES]->[$line]->[1], $start, $end);
}
sub show_source($$) {
my ($self, $out) = @_;
if (PkgLint::Logging::get_show_source_flag()) {
foreach my $line (@{$self->physlines}) {
print $out ("> " . $line->[1]);
}
}
}
sub log_fatal($$) {
my ($self, $text) = @_;
$self->show_source(*STDERR);
PkgLint::Logging::log_fatal($self->fname, $self->[LINES], $text);
}
sub log_error($$) {
my ($self, $text) = @_;
$self->show_source(*STDOUT);
PkgLint::Logging::log_error($self->fname, $self->[LINES], $text);
}
sub log_warning($$) {
my ($self, $text) = @_;
$self->show_source(*STDOUT);
PkgLint::Logging::log_warning($self->fname, $self->[LINES], $text);
}
sub log_note($$) {
my ($self, $text) = @_;
$self->show_source(*STDOUT);
PkgLint::Logging::log_note($self->fname, $self->[LINES], $text);
}
sub log_debug($$) {
my ($self, $text) = @_;
$self->show_source(*STDOUT);
PkgLint::Logging::log_debug($self->fname, $self->[LINES], $text);
}
sub explain_error($@) {
my ($self, @texts) = @_;
PkgLint::Logging::explain_error($self->fname, $self->[LINES], @texts);
}
sub explain_warning($@) {
my ($self, @texts) = @_;
PkgLint::Logging::explain_warning($self->fname, $self->[LINES], @texts);
}
sub explain_note($@) {
my ($self, @texts) = @_;
PkgLint::Logging::explain_note($self->fname, $self->[LINES], @texts);
}
sub explain_info($@) {
my ($self, @texts) = @_;
PkgLint::Logging::explain_info($self->fname, $self->[LINES], @texts);
}
sub to_string($) {
my ($self) = @_;
return $self->fname . ":" . $self->[LINES] . ": " . $self->[TEXT];
}
sub prepend_before($$) {
my ($self, $text) = @_;
unshift(@{$self->[BEFORE]}, [0, "$text\n"]);
$self->[CHANGED] = true;
}
sub append_before($$) {
my ($self, $text) = @_;
push(@{$self->[BEFORE]}, [0, "$text\n"]);
$self->[CHANGED] = true;
}
sub prepend_after($$) {
my ($self, $text) = @_;
unshift(@{$self->[AFTER]}, [0, "$text\n"]);
$self->[CHANGED] = true;
}
sub append_after($$) {
my ($self, $text) = @_;
push(@{$self->[AFTER]}, [0, "$text\n"]);
$self->[CHANGED] = true;
}
sub delete($) {
my ($self) = @_;
$self->[PHYSLINES] = [];
$self->[CHANGED] = true;
}
sub replace($$$) {
my ($self, $from, $to) = @_;
my $phys = $self->[PHYSLINES];
foreach my $i (0..$#{$phys}) {
if ($phys->[$i]->[0] != 0 && $phys->[$i]->[1] =~ s/\Q$from\E/$to/g) {
$self->[CHANGED] = true;
}
}
}
sub replace_regex($$$) {
my ($self, $from_re, $to) = @_;
my $phys = $self->[PHYSLINES];
foreach my $i (0..$#{$phys}) {
if ($phys->[$i]->[0] != 0 && $phys->[$i]->[1] =~ s/$from_re/$to/) {
$self->[CHANGED] = true;
}
}
}
sub set_text($$) {
my ($self, $text) = @_;
$self->[PHYSLINES] = [[0, "$text\n"]];
$self->[CHANGED] = true;
}
#== End of PkgLint::Line ==================================================
package PkgLint::String;
#==========================================================================
# In pkglint, a String is a part of a Line that contains exact references
# to the locations of its substrings in the physical lines of the file from
# which it has been read. This makes it possible for diagnostics to be
# marked at character level instead of logical line level.
#
# Implementation notes:
#
# A String consists of three components:
# * a reference to a logical line,
# * a list of Parts, which, when concatenated, form the text of the String.
# A Part is either a literal string or an array of the form [$lineno,
# $startcol, $endcol], which is used as a reference into the physical
# lines array (without and local additions) of the logical line.
# * a list of highlighting intervals, which are used in the
# show_highlighted() method to mark up certain parts of the string.
#==========================================================================
BEGIN {
import PkgLint::Util qw(
false true
min max
);
}
use enum qw(LINE PARTS MARKUPS);
# The structure fields of a Part of a String
use enum qw(:P_ LINENO STARTCOL ENDCOL);
# The structure fields of a MarkupPoint of a String
use enum qw(:MP_ LINENO COLNO TEXT);
sub new($$@) {
my ($class, $line, @parts) = @_;
my ($self) = ([$line, \@parts]);
bless($self, $class);
$self->compress();
return $self;
}
sub line($) { return shift(@_)->[LINE]; }
sub parts($) { return shift(@_)->[PARTS]; }
sub text($) {
my ($self) = @_;
my ($text);
$text = "";
foreach my $part (@{$self->[PARTS]}) {
if (ref($part) eq "") {
$text .= $part;
} else {
$text .= $self->line->substring($part->[P_LINENO], $part->[P_STARTCOL], $part->[P_ENDCOL] - $part->[P_STARTCOL]);
}
}
return $text;
}
sub substring($$$) {
my ($self, $from, $len) = @_;
my (@nparts, $skip, $take, $physlines);
# XXX: This code is slow, but simple.
$physlines = $self->[LINE]->[PkgLint::Line::PHYSLINES];
$skip = $from;
$take = defined($len) ? $len : 0x7fff_ffff;
foreach my $part (@{$self->[PARTS]}) {
if (ref($part) eq "") {
my $p = "";
my $nskipped = min($skip, strlen($part));
$skip -= $nskipped;
$part = substr($part, $nskipped);
my $ntaken = min($take, strlen($part));
$take -= $ntaken;
$p .= substr($part, 0, $ntaken);
$part = substr($part, $ntaken);
push(@nparts, $p);
} else {
my $line = $part->[P_LINENO];
my $col = $part->[P_STARTCOL];
my $tocol = $part->[P_ENDCOL];
my $linelen = length($physlines->[$line]->[1]);
my $nskipped = max(0, min($skip, min($tocol - $col, $linelen - $col)));
$skip -= $nskipped;
$col += $nskipped;
my $start = $col;
my $ntaken = max(0, min($take, min($tocol - $col, $linelen - $col)));
$take -= $ntaken;
$col += $ntaken;
my $end = $col;
push(@nparts, [$line, $start, $end]);
}
}
return PkgLint::String->new($self->[LINE], @nparts);
}
sub match($$) {
my ($self, $re) = @_;
my ($m);
if ($self->text !~ $re) {
return false;
}
# @- and @+ are very special arrays, so we better copy them
# before doing anything with them.
my @starts = @-;
my @ends = @+;
return PkgLint::StringMatch->new($self, \@starts, \@ends);
}
sub match_all($$) {
my ($self, $re) = @_;
my ($mm, $rest, $lastpos);
$mm = [];
$rest = $self->text;
$lastpos = 0;
pos(undef);
while ($rest =~ m/$re/gc) {
my @starts = @-;
my @ends = @+;
$lastpos = $ends[0];
push(@{$mm}, PkgLint::StringMatch->new($self, \@starts, \@ends));
}
return ($mm, substr($rest, $lastpos));
}
sub compress($) {
my ($self) = @_;
my ($parts, @nparts);
$parts = $self->[PARTS];
# Copy all but empty parts into nparts.
foreach my $part (@{$parts}) {
if (ref($part) eq "") {
if ($part ne "") {
push(@nparts, $part);
}
} else {
if ($part->[P_STARTCOL] != $part->[P_ENDCOL]) {
push(@nparts, $part);
}
}
}
$self->[PARTS] = \@nparts;
# TODO: Merge adjacent parts
}
# FIXME: lineno should not be needed here.
sub highlight($$$$) {
my ($self, $lineno, $startcol, $endcol) = @_;
push(@{$self->[MARKUPS]}, [$lineno, $startcol, $endcol]);
}
sub show_highlighted($$) {
my ($self) = @_;
my ($physlines, @points, $curpoint, $maxpoint, $text, $physline, $col);
return unless (PkgLint::Logging::get_show_source_flag() && PkgLint::Logging::get_klickibunti_flag());
foreach my $m (@{$self->[MARKUPS]}) {
push(@points, [$m->[P_LINENO], $m->[P_STARTCOL], "\x1B[33m\x1B[1m"]);
push(@points, [$m->[P_LINENO], $m->[P_ENDCOL], "\x1B[0m"]);
}
@points = sort {
$a->[MP_LINENO] <=> $b->[MP_LINENO]
|| $a->[MP_COLNO] <=> $b->[MP_COLNO];
} (@points);
$physlines = $self->line->[PkgLint::Line::PHYSLINES];
$curpoint = 0;
$maxpoint = $#points + 1;
foreach my $lineno (0..$#{$physlines}) {
while ($curpoint < $maxpoint && $points[$curpoint]->[MP_LINENO] < $lineno) {
$curpoint++;
}
$text = "";
$col = 0;
$physline = $physlines->[$lineno];
while ($curpoint < $maxpoint && $points[$curpoint]->[MP_LINENO] == $lineno) {
$text .= substr($physline->[1], $col, $points[$curpoint]->[MP_COLNO] - $col);
$text .= $points[$curpoint]->[MP_TEXT];
$col = $points[$curpoint]->[MP_COLNO];
$curpoint++;
}
$text .= substr($physline->[1], $col);
print("> $text");
}
}
# TODO: Rewrite the code of log_warning to be shorter. After that is
# done, add the other log_* methods.
sub log_warning($$) {
my ($self, $msg) = @_;
if (PkgLint::Logging::get_show_source_flag()) {
if (PkgLint::Logging::get_klickibunti_flag()) {
$self->show_highlighted();
} else {
$self->line->show_source(*STDOUT);
}
}
PkgLint::Logging::log_warning($self->line->fname, $self->line->lines, $msg);
}
#== End of PkgLint::String ================================================
package PkgLint::FileUtil;
#==========================================================================
# This package provides subroutines for loading and saving line-oriented
# files. The load_file() subroutine loads a file completely into memory,
# optionally handling continuation line folding. The load_lines() subrou-
# tine is an abbreviation for the common case of loading files without
# continuation lines. The save_autofix_changes() subroutine examines an
# array of lines if some of them have changed. It then saves the modified
# files.
#==========================================================================
use strict;
use warnings;
BEGIN {
use Exporter;
use vars qw(@ISA @EXPORT_OK);
@ISA = qw(Exporter);
@EXPORT_OK = qw(
load_file load_lines
save_autofix_changes
);
import PkgLint::Util qw(
false true
);
import PkgLint::Logging qw(
NO_LINE_NUMBER
log_error log_note
);
}
sub load_physical_lines($) {
my ($fname) = @_;
my ($physlines, $line, $lineno);
$physlines = [];
open(F, "< $fname") or return undef;
$lineno = 0;
while (defined($line = <F>)) {
$lineno++;
push(@{$physlines}, [$lineno, $line]);
}
close(F) or return undef;
return $physlines;
}
sub get_logical_line($$$) {
my ($fname, $lines, $ref_lineno) = @_;
my ($value, $lineno, $first, $firstlineno, $lastlineno, $physlines);
$value = "";
$first = true;
$lineno = ${$ref_lineno};
$firstlineno = $lines->[$lineno]->[0];
$physlines = [];
for (; $lineno <= $#{$lines}; $lineno++) {
if ($lines->[$lineno]->[1] =~ qr"^([ \t]*)(.*?)([ \t]*)(\\?)\n?$") {
my ($indent, $text, $outdent, $cont) = ($1, $2, $3, $4);
if ($first) {
$value .= $indent;
$first = false;
}
$value .= $text;
push(@{$physlines}, $lines->[$lineno]);
if ($cont eq "\\") {
$value .= " ";
} else {
$value .= $outdent;
last;
}
}
}
if ($lineno > $#{$lines}) {
# The last line in the file is a continuation line
$lineno--;
}
$lastlineno = $lines->[$lineno]->[0];
${$ref_lineno} = $lineno + 1;
return PkgLint::Line->new($fname,
$firstlineno == $lastlineno
? $firstlineno
: "$firstlineno--$lastlineno",
$value,
$physlines);
}
sub load_lines($$) {
my ($fname, $fold_backslash_lines) = @_;
my ($physlines, $seen_newline, $loglines);
$physlines = load_physical_lines($fname);
if (!$physlines) {
return false;
}
$seen_newline = true;
$loglines = [];
if ($fold_backslash_lines) {
for (my $lineno = 0; $lineno <= $#{$physlines}; ) {
push(@{$loglines}, get_logical_line($fname, $physlines, \$lineno));
}
} else {
foreach my $physline (@{$physlines}) {
my $text = $physline->[1];
$text =~ s/\n$//;
push(@{$loglines}, PkgLint::Line->new($fname, $physline->[0], $text, [$physline]));
}
}
if (0 <= $#{$physlines} && $physlines->[-1]->[1] !~ qr"\n$") {
log_error($fname, $physlines->[-1]->[0], "File must end with a newline.");
}
return $loglines;
}
sub load_file($) {
my ($fname) = @_;
return load_lines($fname, false);
}
sub get_folded_string($$$) {
my ($fname, $lines, $ref_lineno) = @_;
my ($value, $lineno, $first, $firstlineno, $lastlineno, $physline, $physlines, @parts);
$value = "";
$first = true;
$lineno = ${$ref_lineno};
$firstlineno = $lines->[$lineno]->[0];
$physlines = [];
$physline = 0;
for (; $lineno <= $#{$lines}; $lineno++) {
if ($lines->[$lineno]->[1] =~ qr"^([ \t]*)(.*?)([ \t]*)(\\?)\n?$") {
my ($indent, $text, $outdent, $cont) = ($1, $2, $3, $4);
my (@start) = (@-);
my (@end) = (@+);
if ($first) {
$value .= $indent;
push(@parts, [$physline, $start[1], $end[1]]);
$first = false;
}
$value .= $text;
push(@parts, [$physline, $start[2], $end[2]]);
push(@{$physlines}, $lines->[$lineno]);
$physline++;
if ($cont eq "\\") {
$value .= " ";
push(@parts, " ");
} else {
$value .= $outdent;
push(@parts, [$physline, $start[3], $end[3]]);
last;
}
}
}
if ($lineno > $#{$lines}) {
# The last line in the file is a continuation line
$lineno--;
}
$lastlineno = $lines->[$lineno]->[0];
${$ref_lineno} = $lineno + 1;
my $line = PkgLint::Line->new($fname,
$firstlineno == $lastlineno
? $firstlineno
: "$firstlineno--$lastlineno",
$value,
$physlines);
return PkgLint::String->new($line, @parts);
}
sub load_strings($$) {
my ($fname, $fold_backslash_lines) = @_;
my ($physlines, $seen_newline, $strings);
$physlines = load_physical_lines($fname);
if (!$physlines) {
return false;
}
$seen_newline = true;
$strings = [];
if ($fold_backslash_lines) {
for (my $lineno = 0; $lineno <= $#{$physlines}; ) {
push(@{$strings}, get_folded_string($fname, $physlines, \$lineno));
}
} else {
foreach my $physline (@{$physlines}) {
my ($text, $line);
($text = $physline->[1]) =~ s/\n$//;
$line = PkgLint::Line->new($fname, $physline->[0], $text, [$physline]);
push(@{$strings}, PkgLint::String->new($line, [0, 0, length($text)]));
}
}
if (0 <= $#{$physlines} && $physlines->[-1]->[1] !~ qr"\n$") {
log_error($fname, $physlines->[-1]->[0], "File must end with a newline.");
}
return $strings;
}
sub save_autofix_changes($) {
my ($lines) = @_;
my (%changed, %physlines);
foreach my $line (@{$lines}) {
if ($line->is_changed) {
$changed{$line->fname}++;
}
push(@{$physlines{$line->fname}}, @{$line->physlines});
}
foreach my $fname (sort(keys(%changed))) {
my $new = "${fname}.pkglint.tmp";
if (!open(F, ">", $new)) {
log_error($new, NO_LINE_NUMBER, "$!");
next;
}
foreach my $physline (@{$physlines{$fname}}) {
print F ($physline->[1]);
}
if (!close(F)) {
log_error($new, NO_LINE_NUMBER, "$!");
next;
}
if (!rename($new, $fname)) {
log_error($fname, NO_LINE_NUMBER, "$!");
next;
}
log_note($fname, NO_LINE_NUMBER, "Has been autofixed. Please re-run pkglint.");
}
}
#== End of PkgLint::FileUtil ==============================================
package PkgLint::Type;
#==========================================================================
# A Type in pkglint is a combination of a data type and a permission
# specification. Further details can be found in the chapter ``The pkglint
# type system'' of the pkglint book.
#==========================================================================
BEGIN {
import PkgLint::Util qw(
false true
);
import PkgLint::Logging qw(
log_warning NO_LINES
);
use Exporter;
use vars qw(@ISA @EXPORT_OK);
@ISA = qw(Exporter);
@EXPORT_OK = qw(
LK_NONE LK_INTERNAL LK_EXTERNAL
GUESSED NOT_GUESSED
);
}
use enum qw(KIND_OF_LIST BASIC_TYPE ACLS IS_GUESSED);
use enum qw(:LK_ NONE INTERNAL EXTERNAL);
use enum qw(:ACLE_ SUBJECT_RE PERMS);
use enum qw(NOT_GUESSED GUESSED);
sub new($$$) {
my ($class, $kind_of_list, $basic_type, $acls, $guessed) = @_;
my ($self) = ([$kind_of_list, $basic_type, $acls, $guessed]);
bless($self, $class);
return $self;
}
sub kind_of_list($) { return shift(@_)->[KIND_OF_LIST]; }
sub basic_type($) { return shift(@_)->[BASIC_TYPE]; }
# no getter method for acls
sub is_guessed($) { return shift(@_)->[IS_GUESSED]; }
sub perms($$) {
my ($self, $fname) = @_;
my ($perms);
foreach my $acl_entry (@{$self->[ACLS]}) {
if ($fname =~ $acl_entry->[ACLE_SUBJECT_RE]) {
return $acl_entry->[ACLE_PERMS];
}
}
return undef;
}
# Returns the union of all possible permissions. This can be used to
# check whether a variable may be defined or used at all, or if it is
# read-only.
sub perms_union($) {
my ($self) = @_;
my ($perms);
$perms = "";
foreach my $acl_entry(@{$self->[ACLS]}) {
$perms .= $acl_entry->[ACLE_PERMS];
}
return $perms;
}
# Returns whether the type is considered an external list. All external
# lists are, of course, as well as some other data types that are not
# defined as lists to make the implementation of checkline_mk_vartype
# easier.
sub is_practically_a_list($) {
my ($self) = @_;
return ($self->kind_of_list == LK_EXTERNAL) ? true
: ($self->kind_of_list == LK_INTERNAL) ? false
: ($self->basic_type eq "BuildlinkPackages") ? true
: ($self->basic_type eq "SedCommands") ? true
: ($self->basic_type eq "ShellCommand") ? true
: false;
}
# Returns whether variables of this type may be extended using the "+="
# operator.
sub may_use_plus_eq($) {
my ($self) = @_;
return ($self->kind_of_list != LK_NONE) ? true
: ($self->basic_type eq "AwkCommand") ? true
: ($self->basic_type eq "BuildlinkPackages") ? true
: ($self->basic_type eq "SedCommands") ? true
: false;
}
sub to_string($) {
my ($self) = @_;
return (["", "InternalList of ", "List of "]->[$self->kind_of_list]) . $self->basic_type;
}
#== End of PkgLint::Type ==================================================
package PkgLint::VarUseContext;
#==========================================================================
# This class represents the various contexts in which make(1) variables can
# appear in pkgsrc. Further details can be found in the chapter ``The
# pkglint type system'' of the pkglint book.
#==========================================================================
BEGIN {
import PkgLint::Util qw(
false true
);
import PkgLint::Logging qw(
log_warning NO_LINES
);
use Exporter;
use vars qw(@ISA @EXPORT_OK);
@ISA = qw(Exporter);
@EXPORT_OK = qw(
VUC_TIME_UNKNOWN VUC_TIME_LOAD VUC_TIME_RUN
VUC_TYPE_UNKNOWN
VUC_SHELLWORD_UNKNOWN VUC_SHELLWORD_PLAIN VUC_SHELLWORD_DQUOT
VUC_SHELLWORD_SQUOT VUC_SHELLWORD_BACKT VUC_SHELLWORD_FOR
VUC_EXTENT_UNKNOWN VUC_EXTENT_FULL VUC_EXTENT_WORD
VUC_EXTENT_WORD_PART
);
}
use enum qw(TIME TYPE SHELLWORD EXTENT);
use enum qw(:VUC_TIME_ UNKNOWN LOAD RUN);
use constant VUC_TYPE_UNKNOWN => undef;
use enum qw(:VUC_SHELLWORD_ UNKNOWN PLAIN DQUOT SQUOT BACKT FOR);
use enum qw(:VUC_EXTENT_ UNKNOWN FULL WORD WORD_PART);
my $pool = {};
sub new($$$$$) {
my ($class, $time, $type, $shellword, $extent) = @_;
my ($self) = ([$time, $type, $shellword, $extent]);
bless($self, $class);
return $self;
}
sub new_from_pool($$$$$) {
my ($class, $time, $type, $shellword, $extent) = @_;
my $key = "${time}-${type}-${shellword}-${extent}";
if (!exists($pool->{$key})) {
$pool->{$key} = $class->new($time, $type, $shellword, $extent);
}
return $pool->{$key};
}
sub time($) { return shift(@_)->[TIME]; }
sub type($) { return shift(@_)->[TYPE]; }
sub shellword($) { return shift(@_)->[SHELLWORD]; }
sub extent($) { return shift(@_)->[EXTENT]; }
sub to_string($) {
my ($self) = @_;
return sprintf("(%s %s %s %s)",
["unknown-time", "load-time", "run-time"]->[$self->time],
(defined($self->type) ? $self->type->to_string() : "no-type"),
["none", "plain", "squot", "dquot", "backt", "for"]->[$self->shellword],
["unknown", "full", "word", "word-part"]->[$self->extent]);
}
#== End of PkgLint::VarUseContext =========================================
package PkgLint::SubstContext;
#==========================================================================
# This class records the state of a block of variable assignments that make
# up a SUBST class. As these variable assignments are not easy to get right
# unless you do it every day, and the possibility of typos is high, pkglint
# provides additional checks for them.
#==========================================================================
BEGIN {
import PkgLint::Util qw(
false true
);
import PkgLint::Logging qw(
log_warning
);
}
use enum qw(:SUBST_ ID CLASS STAGE MESSAGE FILES SED VARS FILTER_CMD);
sub new($) {
my ($class) = @_;
my ($self) = ([undef, undef, undef, undef, [], [], undef, undef]);
bless($self, $class);
return $self;
}
sub subst_class($) { return shift(@_)->[SUBST_CLASS]; }
sub subst_stage($) { return shift(@_)->[SUBST_STAGE]; }
sub subst_message($) { return shift(@_)->[SUBST_MESSAGE]; }
sub subst_files($) { return shift(@_)->[SUBST_FILES]; }
sub subst_sed($) { return shift(@_)->[SUBST_SED]; }
sub subst_filter_cmd($) { return shift(@_)->[SUBST_FILTER_CMD]; }
sub subst_id($) { return shift(@_)->[SUBST_ID]; }
sub init($) {
my ($self) = @_;
$self->[SUBST_CLASS] = undef;
$self->[SUBST_STAGE] = undef;
$self->[SUBST_MESSAGE] = undef;
$self->[SUBST_FILES] = [];
$self->[SUBST_SED] = [];
$self->[SUBST_FILTER_CMD] = undef;
$self->[SUBST_ID] = undef;
}
sub check_end($$) {
my ($self, $line) = @_;
return unless defined($self->subst_id);
if (!defined($self->subst_class)) {
$line->log_warning("Incomplete SUBST block: SUBST_CLASSES missing.");
}
if (!defined($self->subst_stage)) {
$line->log_warning("Incomplete SUBST block: SUBST_STAGE missing.");
}
if (@{$self->subst_files} == 0) {
$line->log_warning("Incomplete SUBST block: SUBST_FILES missing.");
}
if (@{$self->subst_sed} == 0 && !defined($self->subst_filter_cmd)) {
$line->log_warning("Incomplete SUBST block: SUBST_SED missing.");
}
$self->init();
}
sub is_complete($) {
my ($self) = @_;
return false unless defined($self->subst_id);
return false unless defined($self->subst_class);
return false unless defined($self->subst_files);
return false unless defined($self->subst_sed);
return true;
}
sub check_varassign($$$$$) {
my ($self, $line, $varname, $op, $value) = @_;
my ($varbase, $varparam, $id);
if ($varname eq "SUBST_CLASSES") {
if ($value =~ qr"^(\S+)\s") {
$line->log_warning("Please add only one class at a time to SUBST_CLASSES.");
$self->[SUBST_CLASS] = $1;
$self->[SUBST_ID] = $1;
} else {
if (defined($self->subst_class)) {
$line->log_warning("SUBST_CLASSES should only appear once in a SUBST block.");
}
$self->[SUBST_CLASS] = $value;
$self->[SUBST_ID] = $value;
}
return;
}
$id = $self->subst_id;
if ($varname =~ qr"^(SUBST_(?:STAGE|MESSAGE|FILES|SED|FILTER_CMD))\.([\-\w_]+)$") {
($varbase, $varparam) = ($1, $2);
if (!defined($id)) {
$line->log_note("SUBST_CLASSES should precede the definition of ${varbase}.${varparam}.");
$id = $self->[SUBST_ID] = $varparam;
}
} else {
if (defined($id)) {
$line->log_warning("Foreign variable in SUBST block.");
}
return;
}
if ($varparam ne $id) {
# XXX: This code sometimes produces weird warnings. See
# meta-pkgs/xorg/Makefile.common 1.41 for an example.
if ($self->is_complete()) {
$self->check_end($line);
# The following assignment prevents an additional warning,
# but from a technically viewpoint, it is incorrect.
$self->[SUBST_CLASS] = $varparam;
$self->[SUBST_ID] = $varparam;
$id = $varparam;
} else {
$line->log_warning("Variable parameter \"${varparam}\" does not match SUBST class \"${id}\".");
}
}
if ($varbase eq "SUBST_STAGE") {
if (defined($self->subst_stage)) {
$line->log_warning("Duplicate definition of SUBST_STAGE.${id}.");
} else {
$self->[SUBST_STAGE] = $value;
}
} elsif ($varbase eq "SUBST_MESSAGE") {
if (defined($self->subst_message)) {
$line->log_warning("Duplicate definition of SUBST_MESSAGE.${id}.");
} else {
$self->[SUBST_MESSAGE] = $value;
}
} elsif ($varbase eq "SUBST_FILES") {
if (@{$self->subst_files} > 0) {
if ($op ne "+=") {
$line->log_warning("All but the first SUBST_FILES line should use the \"+=\" operator.");
}
}
push(@{$self->subst_files}, $value);
} elsif ($varbase eq "SUBST_SED") {
if (@{$self->subst_sed} > 0) {
if ($op ne "+=") {
$line->log_warning("All but the first SUBST_SED line should use the \"+=\" operator.");
}
}
push(@{$self->subst_sed}, $value);
} elsif ($varbase eq "SUBST_FILTER_CMD") {
if (defined($self->subst_filter_cmd)) {
$line->log_warning("Duplicate definition of SUBST_FILTER_CMD.${id}.");
} else {
$self->[SUBST_FILTER_CMD] = $value;
}
} else {
$line->log_warning("Foreign variable in SUBST block.");
}
}
sub to_string($) {
my ($self) = @_;
return sprintf("SubstContext(%s %s %s %s %s %s)",
(defined($self->subst_class) ? $self->subst_class : "(undef)"),
(defined($self->subst_stage) ? $self->subst_stage : "(undef)"),
(defined($self->subst_message) ? $self->subst_message : "(undef)"),
scalar(@{$self->subst_files}),
scalar(@{$self->subst_sed}),
(defined($self->subst_id) ? $self->subst_id : "(undef)"));
}
#== End of PkgLint::SubstContext ==========================================
package CVS_Entry;
#==========================================================================
# A CVS_Entry represents one line from a CVS/Entries file.
#==========================================================================
BEGIN {
import PkgLint::Util qw(
false true
);
import PkgLint::Logging qw(
log_warning
);
}
use enum qw(FNAME REVISION MTIME TAG);
sub new($$$$$) {
my ($class, $fname, $revision, $date, $tag) = @_;
my $self = [ $fname, $revision, $date, $tag ];
bless($self, $class);
return $self;
}
sub fname($) { return shift()->[FNAME]; }
sub revision($) { return shift()->[REVISION]; }
sub mtime($) { return shift()->[MTIME]; }
sub tag($) { return shift()->[TAG]; }
#== End of CVS_Entry ======================================================
package main;
#==========================================================================
# This package contains the application-specific code of pkglint.
# Most subroutines in this package follow a strict naming convention:
#
# The get_*() functions provide easy access to important non-trivial data
# structures that are loaded from external files and are therefore cached.
#
# The is_*() functions return a boolean value and have no side effects.
#
# The checkline_*() procedures check a single line for compliance with some
# rules.
#
# The checklines_*() procedures check an array of lines for compliance.
# Usually they make use of several checkline_*() procedures.
#
# The checkfile_*() procedures load a file and check the lines of that
# file. Usually they make use of several checklines_*() and checkline_*()
# procedures.
#
# The checkdir_*() procedures check the files of a directory and call
# checkfile_*() on them.
#
# Note: I have tried to order the subroutines so that there are no
# back-references, that is, if you start reading the code from the top to
# the bottom you should not find a call to a subroutine you haven't yet
# seen.
#==========================================================================
use strict;
use warnings;
use Digest::SHA1;
use Getopt::Long qw(:config no_ignore_case bundling require_order);
use Fcntl qw(:mode);
use File::Basename;
use File::stat;
use Cwd;
use pkgsrc::Dewey;
BEGIN {
import PkgLint::Util qw(
array_to_hash assert
false true dont_know doesnt_matter
normalize_pathname
);
import PkgLint::Logging qw(
NO_FILE NO_LINE_NUMBER NO_LINES
log_fatal log_error log_warning log_note log_debug
explain_error explain_warning explain_info
);
import PkgLint::FileUtil qw(
load_file load_lines
save_autofix_changes
);
import PkgLint::Type qw(
LK_NONE LK_INTERNAL LK_EXTERNAL
GUESSED NOT_GUESSED
);
import PkgLint::VarUseContext qw(
VUC_TIME_UNKNOWN VUC_TIME_LOAD VUC_TIME_RUN
VUC_TYPE_UNKNOWN
VUC_SHELLWORD_UNKNOWN VUC_SHELLWORD_PLAIN VUC_SHELLWORD_DQUOT
VUC_SHELLWORD_SQUOT VUC_SHELLWORD_BACKT VUC_SHELLWORD_FOR
VUC_EXTENT_UNKNOWN VUC_EXTENT_FULL VUC_EXTENT_WORD
VUC_EXTENT_WORD_PART
);
}
#
# Buildtime configuration
#
use constant conf_distver => '@DISTVER@';
use constant conf_make => '@MAKE@';
use constant conf_datadir => '@DATADIR@';
#
# Global variables that can be modified via command line options.
#
# The pkgsrc directory, relative to the current working directory of
# pkglint.
my $cwd_pkgsrcdir = undef;
# The pkgsrc directory, relative to the directory that is currently
# checked.
my $cur_pkgsrcdir = undef;
#
# Command Line Options
#
my $opt_check_ALTERNATIVES = true;
my $opt_check_bl3 = true;
my $opt_check_DESCR = true;
my $opt_check_distinfo = true;
my $opt_check_extra = false;
my $opt_check_global = false;
my $opt_check_INSTALL = true;
my $opt_check_Makefile = true;
my $opt_check_MESSAGE = true;
my $opt_check_mk = true;
my $opt_check_patches = true;
my $opt_check_PLIST = true;
my (%checks) = (
"ALTERNATIVES" => [\$opt_check_ALTERNATIVES, "check ALTERNATIVES files"],
"bl3" => [\$opt_check_bl3, "check buildlink3 files"],
"DESCR" => [\$opt_check_DESCR, "check DESCR file"],
"distinfo" => [\$opt_check_distinfo, "check distinfo file"],
"extra" => [\$opt_check_extra, "check various additional files"],
"global" => [\$opt_check_global, "inter-package checks"],
"INSTALL" => [\$opt_check_INSTALL, "check INSTALL and DEINSTALL scripts"],
"Makefile" => [\$opt_check_Makefile, "check Makefiles"],
"MESSAGE" => [\$opt_check_MESSAGE, "check MESSAGE files"],
"mk" => [\$opt_check_mk, "check other .mk files"],
"patches" => [\$opt_check_patches, "check patches"],
"PLIST" => [\$opt_check_PLIST, "check PLIST files"],
);
my $opt_debug_include = false;
my $opt_debug_misc = false;
my $opt_debug_patches = false;
my $opt_debug_quoting = false;
my $opt_debug_shell = false;
my $opt_debug_tools = false;
my $opt_debug_trace = false;
my $opt_debug_unchecked = false;
my $opt_debug_unused = false;
my $opt_debug_vartypes = false;
my $opt_debug_varuse = false;
my (%debug) = (
"include" => [\$opt_debug_include, "included files"],
"misc" => [\$opt_debug_misc, "all things that didn't fit elsewhere"],
"patches" => [\$opt_debug_patches, "the states of the patch parser"],
"quoting" => [\$opt_debug_quoting, "additional information about quoting"],
"shell" => [\$opt_debug_shell, "the parsers for shell words and shell commands"],
"tools" => [\$opt_debug_tools, "the tools framework"],
"trace" => [\$opt_debug_trace, "follow subroutine calls"],
"unchecked" => [\$opt_debug_unchecked, "show the current limitations of pkglint"],
"unused" => [\$opt_debug_unused, "unused variables"],
"vartypes" => [\$opt_debug_vartypes, "additional type information"],
"varuse" => [\$opt_debug_varuse, "contexts where variables are used"],
);
my $opt_warn_absname = true;
my $opt_warn_directcmd = true;
my $opt_warn_extra = false;
my $opt_warn_order = true;
my $opt_warn_perm = false;
my $opt_warn_plist_depr = false;
my $opt_warn_plist_sort = false;
my $opt_warn_quoting = false;
my $opt_warn_space = false;
my $opt_warn_style = false;
my $opt_warn_types = true;
my $opt_warn_varorder = false;
my (%warnings) = (
"absname" => [\$opt_warn_absname, "warn about use of absolute file names"],
"directcmd" => [\$opt_warn_directcmd, "warn about use of direct command names instead of Make variables"],
"extra" => [\$opt_warn_extra, "enable some extra warnings"],
"order" => [\$opt_warn_order, "warn if Makefile entries are unordered"],
"perm" => [\$opt_warn_perm, "warn about unforeseen variable definition and use"],
"plist-depr" => [\$opt_warn_plist_depr, "warn about deprecated paths in PLISTs"],
"plist-sort" => [\$opt_warn_plist_sort, "warn about unsorted entries in PLISTs"],
"quoting" => [\$opt_warn_quoting, "warn about quoting issues"],
"space" => [\$opt_warn_space, "warn about inconsistent use of white-space"],
"style" => [\$opt_warn_style, "warn about stylistic issues"],
"types" => [\$opt_warn_types, "do some simple type checking in Makefiles"],
"varorder" => [\$opt_warn_varorder, "warn about the ordering of variables"],
);
my $opt_autofix = false;
my $opt_dumpmakefile = false;
my $opt_import = false;
my $opt_klickibunti = false; # experimental
my $opt_quiet = false;
my $opt_recursive = false;
my $opt_rcsidstring = "NetBSD";
my (@options) = (
# [ usage-opt, usage-message, getopt-opt, getopt-action ]
[ "-C{check,...}", "Enable or disable specific checks",
"check|C=s",
sub {
my ($opt, $val) = @_;
parse_multioption($val, \%checks);
} ],
[ "-D{debug,...}", "Enable or disable debugging categories",
"debugging|D=s",
sub ($$) {
my ($opt, $val) = @_;
parse_multioption($val, \%debug);
} ],
[ "-F|--autofix", "Try to automatically fix some errors (experimental)",
"autofix|F", \$opt_autofix ],
[ "-I|--dumpmakefile", "Dump the Makefile after parsing",
"dumpmakefile|I", \$opt_dumpmakefile ],
[ "-R|--rcsidstring", "Set the allowed RCS Id strings",
"rcsidstring|R=s", \$opt_rcsidstring ],
[ "-V|--version", "print the version number of pkglint",
"version|V",
sub {
print(conf_distver . "\n");
exit(0);
} ],
[ "-W{warn,...}", "enable or disable specific warnings",
"warning|W=s",
sub {
my ($opt, $val) = @_;
parse_multioption($val, \%warnings);
} ],
[ "-e|--explain", "Explain the diagnostics or give further help",
"explain|e", sub {
PkgLint::Logging::set_explain();
} ],
[ "-g|--gcc-output-format", "Mimic the gcc output format",
"gcc-output-format|g",
sub {
PkgLint::Logging::set_gcc_output_format();
} ],
[ "-h|--help", "print a detailed help message",
"help|h",
sub {
help(*STDOUT, 0, 1);
} ],
[ "-i|--import", "Prepare the import of a wip package",
"import|i", \$opt_import ],
# Note: This is intentionally undocumented.
[ "--pkgsrcdir", "Set the root directory of pkgsrc explicitly.",
"pkgsrcdir=s", \$cwd_pkgsrcdir ],
[ "-q|--quiet", "Don't print a summary line when finishing",
"quiet|q", \$opt_quiet ],
[ "-r|--recursive", "Recursive---check subdirectories, too",
"recursive|r", \$opt_recursive ],
[ "-s|--source", "Show the source lines together with diagnostics",
"source|s",
sub {
PkgLint::Logging::set_show_source_flag();
} ],
[ "--klickibunti", "Enable colored and precise diagnostics",
"klickibunti",
sub {
PkgLint::Logging::set_klickibunti_flag();
} ],
);
#
# Commonly used regular expressions.
#
use constant regex_dependency_gt => qr"^((?:\$\{[\w_]+\}|[\w_]|-[^\d])+)>=(.*)$";
use constant regex_dependency_wildcard
=> qr"^((?:\$\{[\w_]+\}|[\w_]|-[^\d\[])+)-(?:\[0-9\]|\d.*)$";
use constant regex_gnu_configure_volatile_vars
=> qr"^(?:.*_)?(?:CFLAGS||CPPFLAGS|CXXFLAGS|FFLAGS|LDFLAGS|LIBS)$";
use constant regex_mk_comment => qr"^ *\s*#(.*)$";
use constant regex_mk_cond => qr"^\.(\s*)(if|ifdef|ifndef|else|elif|endif|for|endfor|undef)(?:\s+([^\s#][^#]*?))?\s*(?:#.*)?$";
use constant regex_mk_dependency=> qr"^([^\s:]+(?:\s*[^\s:]+)*):\s*([^#]*?)(?:\s*#.*)?$";
use constant regex_mk_include => qr"^\.\s*s?include\s+\"([^\"]+)\"\s*(?:#.*)?$";
use constant regex_mk_sysinclude=> qr"^\.\s*s?include\s+<([^>]+)>\s*(?:#.*)?$";
use constant regex_mk_shellvaruse => qr"(?:^|[^\$])\$\$\{?(\w+)\}?"; # XXX: not perfect
use constant regex_pkgname => qr"^((?:[\w.+]|-[^\d])+)-(\d(?:\w|\.\d)*)$";
use constant regex_mk_shellcmd => qr"^\t(.*)$";
use constant regex_rcs_conflict => qr"^(<<<<<<<|=======|>>>>>>>)";
use constant regex_unresolved => qr"\$\{";
use constant regex_validchars => qr"[\011\040-\176]";
# Note: the following regular expression looks more complicated than
# necessary to avoid a stack overflow in the Perl interpreter.
# The leading white-space may only consist of \040 characters, otherwise
# the order of regex_varassign and regex_mk_shellcmd becomes important.
use constant regex_varassign => qr"^ *([-*+A-Z_a-z0-9.\${}\[]+?)\s*(=|\?=|\+=|:=|!=)\s*((?:[^\\#\s]+|\s+?|(?:\\#)+|\\)*?)(?:\s*(#.*))?$";
use constant regex_sh_varassign => qr"^([A-Z_a-z][0-9A-Z_a-z]*)=";
# The following "constants" are often used in contexts where
# interpolation comes handy, so they are variables. Nevertheless they
# are not modified.
# This regular expression cannot parse all kinds of shell programs, but
# it will catch almost all shell programs that are portable enough to be
# used in pkgsrc.
my $regex_shellword = qr"\s*(
\#.* # shell comment
|
(?: '[^']*' # single quoted string
| \"(?:\\.|[^\"\\])*\" # double quoted string
| \`[^\`]*\` # backticks string
| \\\$\$ # an escaped dollar sign
| \\[^\$] # other escaped characters
| \$\{[^{}]+\} # make(1) variable
| \$\([^()]+\) # make(1) variable, $(...)
| \$[/\@<^] # special make(1) variables
| \$\$[0-9A-Z_a-z]+ # shell variable
| \$\$[?@] # special shell variables
| \$\$\{[0-9A-Z_a-z]+\} # shell variable in braces
| \$\$\( # POSIX-style backticks replacement
| [^\(\)'\"\\\s;&\|<>\`\$] # non-special character
| \$\{[^\s\"'`]+ # HACK: nested make(1) variables
)+ | ;;? | &&? | \|\|? | \( | \) | >& | <<? | >>? | \#.*)"sx;
my $regex_varname = qr"(?:[-*+.0-9A-Z_a-z{}\[]+|\$\{[\w_]+\})+";
my $regex_pkgbase = qr"(?:[+.0-9A-Z_a-z]|-[A-Z_a-z])+";
my $regex_pkgversion = qr"\d(?:\w|\.\d)*";
#
# Commonly used explanations for diagnostics.
#
use constant expl_relative_dirs => (
"Directories in the form \"../../category/package\" make it easier to",
"move a package around in pkgsrc, for example from pkgsrc-wip to the",
"main pkgsrc repository.");
#
# Global variables.
#
my $current_dir; # The currently checked directory.
my $is_wip; # Is the current directory from pkgsrc-wip?
my $is_internal; # Is the current item from the infrastructure?
#
# Variables for inter-package checks.
#
my $ipc_distinfo; # Maps "$alg:$fname" => "checksum".
# Context of the package that is currently checked.
my $pkgdir; # PKGDIR from the package Makefile
my $filesdir; # FILESDIR from the package Makefile
my $patchdir; # PATCHDIR from the package Makefile
my $distinfo_file; # DISTINFO_FILE from the package Makefile
my $effective_pkgname; # PKGNAME or DISTNAME from the package Makefile
my $effective_pkgbase; # The effective PKGNAME without the version
my $effective_pkgversion; # The version part of the effective PKGNAME
my $effective_pkgname_line; # The origin of the three effective_* values
my $hack_php_patches; # Ignore non-existing patches in distinfo
my $seen_bsd_prefs_mk; # Has bsd.prefs.mk already been included?
my $pkgctx_vardef; # variable name => line of definition
my $pkgctx_varuse; # variable name => Boolean
my $pkgctx_bl3; # buildlink3.mk name => line of inclusion
my $seen_Makefile_common; # Does the package have any .includes?
# Context of the Makefile that is currently checked.
my $mkctx_for_variables; # The variables currently used in .for loops
my $mkctx_indentations; # Indentation depth of preprocessing directives
my $mkctx_target; # Current make(1) target
my $mkctx_vardef; # { varname => line } for all variables that
# are defined in the current file
my $mkctx_build_defs; # Set of variables that are registered in
# BUILD_DEFS, to assure that all user-defined
# variables are added to it.
my $mkctx_tools; # Set of tools that are declared to be used.
my @todo_items; # The list of directory entries that still need
# to be checked. Mostly relevant with
# --recursive.
#
# Command line parsing and handling.
#
sub help($$$) {
my ($out, $exitval, $show_all) = @_;
my ($prog) = (basename($0));
print $out ("usage: $prog [options] [package_directory]\n\n");
my (@option_table) = ();
foreach my $opt (@options) {
push(@option_table, [" ", $opt->[0], $opt->[1]]);
}
print $out ("options:\n");
PkgLint::Util::print_table($out, \@option_table);
print $out ("\n");
if (!$show_all) {
exit($exitval);
}
my $categories = [
# options, leading text,
[ \%checks, "checks", "check" ],
[ \%debug, "debugging options", "debug" ],
[ \%warnings, "warnings", "warning" ],
];
foreach my $category (@{$categories}) {
my ($options, $leading, $name) = (@{$category});
my $table = [
[" ", "all", "", "enable all ".$category->[1]],
[" ", "none", "", "disable all ".$category->[1]],
];
foreach my $opt (sort keys %{$options}) {
push(@{$table}, [ " ", $opt,
(${$options->{$opt}->[0]} ? "(enabled)" : "(disabled)"),
$options->{$opt}->[1]]);
}
print $out ("${leading}: (use \"${name}\" to enable, \"no-${name}\" to disable)\n");
PkgLint::Util::print_table($out, $table);
print $out ("\n");
}
exit($exitval);
}
sub parse_multioption($$) {
my ($value, $optdefs) = @_;
foreach my $opt (split(qr",", $value)) {
if ($opt eq "none") {
foreach my $key (keys %{$optdefs}) {
${$optdefs->{$key}->[0]} = false;
}
} elsif ($opt eq "all") {
foreach my $key (keys %{$optdefs}) {
${$optdefs->{$key}->[0]} = true;
}
} else {
my ($value) = (($opt =~ s/^no-//) ? false : true);
if (exists($optdefs->{$opt})) {
${$optdefs->{$opt}->[0]} = $value;
} else {
print STDERR ("Invalid option: ${opt}\n");
help(*STDERR, 1, 0);
}
}
}
}
sub parse_command_line() {
my (%options);
foreach my $opt (@options) {
$options{$opt->[2]} = $opt->[3];
}
{
local $SIG{__WARN__} = sub {};
if (!GetOptions(%options)) {
help(*STDERR, 1, false);
}
}
}
#
# Caching subroutines.
#
# The get_regex_plurals() function returns a regular expression that
# matches for all make(1) variable names that are considered lists
# of something.
#
# Rationale:
#
# The pkglint author thinks that variables containing lists of things
# should have a name indicating some plural form. Sadly, there are other
# reasons like backwards compatibility and other developer's
# expectations that make changes to most of the following variables
# highly unlikely.
my $get_regex_plurals_value = undef;
sub get_regex_plurals() {
if (defined($get_regex_plurals_value)) {
return $get_regex_plurals_value;
}
my @plurals_ok = qw(
.*S
.*LIST
.*_AWK
.*_ENV
.*_REQD
.*_SED
.*_SKIP
BUILDLINK_LDADD
COMMENT
EXTRACT_ONLY
FETCH_MESSAGE
GENERATE_PLIST
PLIST_CAT
PLIST_PRE
PREPEND_PATH
);
my @plurals_missing_an_s = qw(
.*_OVERRIDE
.*_PREREQ
.*_SRC
.*_SUBST
.*_TARGET
.*_TMPL
BUILDLINK_DEPMETHOD
BUILDLINK_TRANSFORM
EVAL_PREFIX
INTERACTIVE_STAGE
LICENSE
MASTER_SITE_.*
MASTER_SORT_REGEX
NOT_FOR_COMPILER
NOT_FOR_PLATFORM
ONLY_FOR_COMPILER
ONLY_FOR_PLATFORM
PERL5_PACKLIST
PKG_FAIL_REASON
PKG_SKIP_REASON
);
my @plurals_reluctantly_accepted = qw(
CRYPTO
DEINSTALL_TEMPLATE
FIX_RPATH
INSTALL_TEMPLATE
PYTHON_VERSIONS_INCOMPATIBLE
REPLACE_INTERPRETER
REPLACE_PERL
REPLACE_RUBY
RESTRICTED
SITES_.*
TOOLS_ALIASES\.*
TOOLS_BROKEN
TOOLS_CREATE
TOOLS_GNU_MISSING
TOOLS_NOOP
);
my $plurals = join("|",
@plurals_ok,
@plurals_missing_an_s,
@plurals_reluctantly_accepted
);
$get_regex_plurals_value = qr"^(?:${plurals})$";
return $get_regex_plurals_value;
}
#
# Loading pkglint-specific data from files.
#
# The symbol table for ACL definitions maps ACL names to ACLs.
my $acl_definitions = {};
sub parse_acls($$) {
my ($line, $acltext) = @_;
my ($acls);
use constant ACL_shortcuts => {
"b" => qr"(?:^|/)buildlink3\.mk$",
"c" => qr"(?:^|/)Makefile\.common$",
"h" => qr"(?:^|/)hacks\.mk$",
"m" => qr"(?:^|/)Makefile$",
"o" => qr"(?:^|/)options\.mk$",
};
my $regex_acl_entry = qr"^(?:
\$([\w_]+) # $acl_name
| ([\w.*]+|_):([adpsu]*) # file*mask:perms
) (?:\,\s*|$)"x;
if (!defined($acltext)) {
return undef;
}
$acls = [];
while ($acltext =~ s,$regex_acl_entry,,) {
my ($acldef, $subject, $perms) = ($1, $2, $3);
if (defined($acldef)) {
if (!exists($acl_definitions->{$acldef})) {
$line->log_fatal("ACL definition ${acldef} not found.");
} else {
push(@{$acls}, @{$acl_definitions->{$acldef}});
}
} else {
# Transform $subject to a regular expression.
$subject =~ s/\./[.]/g;
$subject =~ s/\*/.*/g;
push(@{$acls}, [exists(ACL_shortcuts->{$subject}) ? ACL_shortcuts->{$subject} : qr"(?:^|/)${subject}$", $perms]);
}
}
if ($acltext ne "") {
$line->log_fatal("Invalid ACL: ${acltext}.");
}
return $acls;
}
my $get_vartypes_map_result = undef;
sub get_vartypes_map() {
my ($fname, $vartypes);
if (defined($get_vartypes_map_result)) {
return $get_vartypes_map_result;
}
use constant re_acl_def => qr"^
acl \s+
(\w+) \s+ # ACL name
= \s+
\[ ([^\]]*) \] # ACL value
(?:\s*\#.*)? # optional comment
$"x;
use constant re_vartypedef => qr"^
([\w\d_.]+?) # variable name
(\*|\.\*|) \s+ # parameterized?
(?:(InternalList|List) \s+ of \s+)? # kind of list
(?:([\w\d_]+) | \{\s*([\w\d_+,\-.\s]+?)\s*\}) # basic type
(?:\s+ \[ ([^\]]*) \])? # optional ACL
(?:\s*\#.*)? # optional comment
$"x;
$fname = conf_datadir."/makevars.map";
$vartypes = {};
if ((my $lines = load_lines($fname, true))) {
foreach my $line (@{$lines}) {
if ($line->text =~ qr"^(?:#.*|\s*)$") {
# ignore empty and comment lines
} elsif ($line->text =~ re_acl_def) {
my ($aclname, $aclvalue) = ($1, $2);
$acl_definitions->{$aclname} = parse_acls($line, $aclvalue);
} elsif ($line->text =~ re_vartypedef) {
my ($varname, $par, $kind_of_list_text, $typename, $enums, $acltext) = ($1, $2, $3, $4, $5, $6);
my $kind_of_list = !defined($kind_of_list_text) ? LK_NONE
: ($kind_of_list_text eq "List") ? LK_EXTERNAL
: LK_INTERNAL;
my $basic_type = defined($enums)
? array_to_hash(split(qr"\s+", $enums))
: $typename;
my $type = PkgLint::Type->new($kind_of_list, $basic_type, parse_acls($line, $acltext), NOT_GUESSED);
if ($par eq "" || $par eq "*") {
$vartypes->{$varname} = $type;
}
if ($par eq "*" || $par eq ".*") {
$vartypes->{"${varname}.*"} = $type;
}
} else {
$line->log_fatal("Unknown line format.");
}
}
} else {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
# TODO: Enable when the time is ripe.
if (false) {
# Additionally, scan mk/defaults/mk.conf for variable
# definitions. All these variables are reserved for the user and
# must not be set within packages.
$fname = "${cwd_pkgsrcdir}/mk/defaults/mk.conf";
if ((my $lines = load_file($fname))) {
foreach my $line (@{$lines}) {
if ($line->text =~ qr"^#?([\w_]+)\?=") {
my ($varname) = ($1);
$opt_debug_misc and $line->log_debug("Found user-definable variable ${varname}.");
$vartypes->{$varname} = "Userdefined"; # FIXME: type error
}
}
} else {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
}
return ($get_vartypes_map_result = $vartypes);
}
my $get_deprecated_map_result = undef;
sub get_deprecated_map() {
my ($fname, $lines, $vars);
if (defined($get_deprecated_map_result)) {
return $get_deprecated_map_result;
}
$fname = conf_datadir."/deprecated.map";
if (!($lines = load_file($fname))) {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
$vars = {};
foreach my $line (@{$lines}) {
if ($line->text =~ qr"^#" || $line->text =~ qr"^\s*$") {
# Ignore empty and comment lines.
} elsif ($line->text =~ qr"^(\S+)\s+(.*)$") {
$vars->{$1} = $2;
} else {
$line->log_fatal("Unknown line format.");
}
}
return ($get_deprecated_map_result = $vars);
}
my $load_dist_sites_url2name = undef;
my $load_dist_sites_names = undef;
sub load_dist_sites() {
my ($fname) = ("${cwd_pkgsrcdir}/mk/fetch/sites.mk");
my ($lines) = load_file($fname);
my ($varname) = undef;
my ($ignoring) = false;
my ($url2name) = {};
my ($names) = {};
if (!$lines) {
log_error($fname, NO_LINE_NUMBER, "Could not be read.");
$load_dist_sites_url2name = $url2name;
$load_dist_sites_names = $names;
return;
}
foreach my $line (@{$lines}) {
my $text = $line->text;
if ($text =~ qr"^(MASTER_SITE_\w+)\+=\s*\\$"o) {
$varname = $1;
$names->{$varname} = true;
$ignoring = false;
} elsif ($text eq "MASTER_SITE_BACKUP?=\t\\") {
$ignoring = true;
} elsif ($text =~ qr"^\t((?:http://|ftp://)\S+/)(?:|\s*\\)$"o) {
if (!$ignoring) {
if (defined($varname)) {
$url2name->{$1} = $varname;
} else {
$line->log_error("Lonely URL found.");
}
}
} elsif ($text =~ qr"^(?:#.*|\s*)$") {
# ignore empty and comment lines
} elsif ($text =~ qr"BSD_SITES_MK") {
# ignore multiple inclusion guards
} else {
$line->log_fatal("Unknown line type.");
}
}
# Explicitly allowed, although not defined in mk/fetch/sites.mk.
$names->{"MASTER_SITE_SUSE_UPD"} = true;
$names->{"MASTER_SITE_LOCAL"} = true;
$opt_debug_misc and log_debug($fname, NO_LINES, "Loaded " . scalar(keys(%{$url2name})) . " MASTER_SITE_* definitions.");
$load_dist_sites_url2name = $url2name;
$load_dist_sites_names = $names;
}
sub get_dist_sites() {
if (!defined($load_dist_sites_url2name)) {
load_dist_sites();
}
return $load_dist_sites_url2name;
}
sub get_dist_sites_names() {
if (!defined($load_dist_sites_names)) {
load_dist_sites();
}
return $load_dist_sites_names;
}
my $get_pkg_options_result = undef;
sub get_pkg_options() {
if (defined($get_pkg_options_result)) {
return $get_pkg_options_result;
}
my ($fname) = ("${cwd_pkgsrcdir}/mk/defaults/options.description");
my ($lines, $options);
if (!($lines = load_file($fname))) {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
$options = {};
foreach my $line (@{$lines}) {
if ($line->text =~ qr"^([-0-9a-z_]+)(?:\s+(.*))?$") {
my ($optname, $optdescr) = ($1, $2);
$options->{$optname} = defined($optdescr)
? $optdescr
: "";
} else {
$line->log_error("Unknown line format.");
}
}
return ($get_pkg_options_result = $options);
}
my $load_tool_names_system_build_defs = undef; # XXX: misplaced, but works
my $load_tool_names_tools = undef;
my $load_tool_names_vartools = undef;
my $load_tool_names_varname_to_toolname = undef;
my $load_tool_names_predefined_tools = undef;
sub load_tool_names() {
my ($tools, $vartools, $predefined_tools, $varname_to_toolname, @tool_files);
my ($system_build_defs);
#
# Get the list of files that define the tools from bsd.tools.mk.
#
@tool_files = ("defaults.mk");
{
my $fname = "${cwd_pkgsrcdir}/mk/tools/bsd.tools.mk";
my $lines = load_lines($fname, true);
if (!$lines) {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
foreach my $line (@{$lines}) {
if ($line->text =~ regex_mk_include) {
my ($includefile) = ($1);
if ($includefile =~ qr"^\$\{PKGSRCDIR\}/mk/tools/(.*)$") {
push(@tool_files, $1);
}
}
}
}
assert(scalar(@tool_files) > 1, "Too few tool files. Maybe the files have been renamed again?");
#
# Scan the tool files for the actual definitions of the tools.
#
$tools = {};
$vartools = {};
$predefined_tools = {};
$varname_to_toolname = {};
$system_build_defs = {};
foreach my $basename (@tool_files) {
my $fname = "${cwd_pkgsrcdir}/mk/tools/${basename}";
my $lines = load_lines($fname, true);
if (!$lines) {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
foreach my $line (@{$lines}) {
if ($line->text =~ regex_varassign) {
my ($varname, undef, $value, undef) = ($1, $2, $3, $4);
if ($varname eq "TOOLS_CREATE" && $value =~ qr"^([-\w.]+|\[)$") {
$tools->{$value} = true;
} elsif ($varname =~ qr"^(?:_TOOLS_VARNAME)\.([-\w.]+|\[)$") {
$tools->{$1} = true;
$vartools->{$1} = $value;
$varname_to_toolname->{$value} = $1;
} elsif ($varname =~ qr"^(?:TOOLS_PATH|_TOOLS_DEPMETHOD)\.([-\w.]+|\[)$") {
$tools->{$1} = true;
} elsif ($varname =~ qr"^_TOOLS\.(.*)") {
$tools->{$1} = true;
foreach my $tool (split(qr"\s+", $value)) {
$tools->{$tool} = true;
}
}
}
}
}
foreach my $basename ("bsd.pkg.mk") {
my $fname = "${cwd_pkgsrcdir}/mk/${basename}";
my $lines = load_lines($fname, true);
my $cond_depth = 0;
if (!$lines) {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
foreach my $line (@{$lines}) {
my $text = $line->text;
if ($text =~ regex_varassign) {
my ($varname, undef, $value, undef) = ($1, $2, $3, $4);
if ($varname eq "USE_TOOLS") {
$opt_debug_tools and $line->log_debug("[cond_depth=${cond_depth}] $value");
if ($cond_depth == 0) {
foreach my $tool (split(qr"\s+", $value)) {
if ($tool !~ regex_unresolved && exists($tools->{$tool})) {
$predefined_tools->{$tool} = true;
# The path (without arguments) to the tool
$predefined_tools->{"TOOLS_${tool}"} = true;
}
}
}
} elsif ($varname eq "_BUILD_DEFS") {
foreach my $bdvar (split(qr"\s+", $value)) {
$system_build_defs->{$bdvar} = true;
}
}
} elsif ($text =~ regex_mk_cond) {
my ($indent, $cond, $args, $comment) = ($1, $2, $3, $4);
if ($cond =~ qr"^(?:if|ifdef|ifndef|for)$") {
$cond_depth++;
} elsif ($cond =~ qr"^(?:endif|endfor)$") {
$cond_depth--;
}
}
}
}
$opt_debug_tools and log_debug(NO_FILE, NO_LINE_NUMBER, "Known tools: ".join(" ", sort(keys(%{$tools}))));
$opt_debug_tools and log_debug(NO_FILE, NO_LINE_NUMBER, "Known vartools: ".join(" ", sort(keys(%{$vartools}))));
$opt_debug_tools and log_debug(NO_FILE, NO_LINE_NUMBER, "Predefined tools: " . join(" ", sort(keys(%{$predefined_tools}))));
$opt_debug_tools and log_debug(NO_FILE, NO_LINE_NUMBER, "Known varnames: " . join(" ", sort(keys(%{$varname_to_toolname}))));
$opt_debug_misc and log_debug(NO_FILE, NO_LINES, "System-provided BUILD_DEFS: " . join(" ", sort(keys(%{$system_build_defs}))));
# Some user-defined variables do not influence the binary
# package at all and therefore do not have to be added to
# BUILD_DEFS.
foreach my $bdvar (qw(DISTDIR FETCH_CMD FETCH_OUTPUT_ARGS GAMEOWN GAMEGRP GAMEDIRMODE)) {
$system_build_defs->{$bdvar} = true;
}
#$system_build_defs->{"PACKAGES"} = true;
$load_tool_names_tools = $tools;
$load_tool_names_vartools = $vartools;
$load_tool_names_predefined_tools = $predefined_tools;
$load_tool_names_varname_to_toolname = $varname_to_toolname;
$load_tool_names_system_build_defs = $system_build_defs;
}
# Returns the set of known tool names and contains for example "sed" and
# "gm4".
sub get_tool_names() {
if (!defined($load_tool_names_tools)) {
load_tool_names();
}
return $load_tool_names_tools;
}
# Returns the mapping from tool names to their respective variable. For
# example, "sed" => "SED", "gzip" => "GZIP_CMD".
sub get_vartool_names() {
if (!defined($load_tool_names_vartools)) {
load_tool_names();
}
return $load_tool_names_vartools;
}
# Returns the set of those tools with associated variables that a
# package does not need to add to USE_TOOLS explicitly because they
# are used by the pkgsrc infrastructure, too.
sub get_predefined_tool_names() {
if (!defined($load_tool_names_predefined_tools)) {
load_tool_names();
}
return $load_tool_names_predefined_tools;
}
# Returns a mapping from tool variable names to the tool name they use.
# For example, "GZIP_CMD" => "gzip" and "SED" => "sed".
sub get_varname_to_toolname() {
if (!defined($load_tool_names_varname_to_toolname)) {
load_tool_names();
}
return $load_tool_names_varname_to_toolname;
}
# Returns the set of tool variable names that may not be converted to
# their "direct" form, that is: ${CP} => cp.
sub get_required_vartool_varnames() {
use constant required_vartool_varnames => array_to_hash(qw(ECHO ECHO_N FALSE TEST TRUE));
return required_vartool_varnames;
}
# Returns the set of tools that must be used by their variable name.
sub get_required_vartools() {
use constant required_vartools => array_to_hash(qw(echo false test true));
return required_vartools;
}
# Returns the set of user-defined variables that are added to BUILD_DEFS
# within the bsd.pkg.mk file.
sub get_system_build_defs() {
if (!defined($load_tool_names_system_build_defs)) {
load_tool_names();
}
return $load_tool_names_system_build_defs;
}
sub load_doc_TODO_updates($) {
my ($fname) = @_;
my ($lines, $updates, $state, $re_suggested_update);
if (!($lines = load_file($fname))) {
log_fatal($fname, NO_LINE_NUMBER, "Cannot be read.");
}
$updates = [];
$state = 0;
foreach my $line (@{$lines}) {
my $text = $line->text;
if ($state == 0 && $text eq "Suggested package updates") {
$state = 1;
} elsif ($state == 1 && $text eq "") {
$state = 2;
} elsif ($state == 2) {
$state = 3;
} elsif ($state == 3 && $text eq "") {
$state = 4;
}
if ($state == 3) {
if ($text =~ qr"^\to\s(\S+)(?:\s*(.+))?$") {
my ($spuname, $comment) = ($1, $2);
if ($spuname =~ regex_pkgname) {
push(@{$updates}, [$line, $1, $2, $comment]);
} else {
$line->log_warning("Invalid package name $spuname");
}
} else {
$line->log_warning("Invalid line format $text");
}
}
}
return $updates;
}
my $get_doc_TODO_updates_result = undef;
sub get_doc_TODO_updates() {
if (!defined($get_doc_TODO_updates_result)) {
$get_doc_TODO_updates_result = load_doc_TODO_updates("${cwd_pkgsrcdir}/doc/TODO");
}
return $get_doc_TODO_updates_result;
}
my $get_wip_TODO_updates_result = undef;
sub get_wip_TODO_updates() {
if (!defined($get_wip_TODO_updates_result)) {
$get_wip_TODO_updates_result = load_doc_TODO_updates("${cwd_pkgsrcdir}/wip/TODO");
}
return $get_wip_TODO_updates_result;
}
sub get_suggested_package_updates() {
return ($is_wip)
? get_wip_TODO_updates()
: get_doc_TODO_updates();
}
# Load all variables from mk/defaults/mk.conf. Since pkglint does not
# load the infrastructure files during normal operation, these
# definitions have to be added explicitly.
sub load_userdefined_variables() {
my $fname = "${cwd_pkgsrcdir}/mk/defaults/mk.conf";
my ($lines, $vars);
$vars = {};
$lines = load_lines($fname, true);
if (!$lines) {
log_fatal($fname, NO_LINES, "Cannot be read.");
}
foreach my $line (@{$lines}) {
if ($line->text =~ regex_varassign) {
my ($varname, $op, $value, $comment) = ($1, $2, $3, $4);
$vars->{$varname} = $line;
}
}
return $vars;
}
my $get_userdefined_variables_result = undef;
sub get_userdefined_variables() {
if (!defined($get_userdefined_variables_result)) {
$get_userdefined_variables_result = load_userdefined_variables();
}
return $get_userdefined_variables_result;
}
sub match_all($$); # needed by load_shared_dirs()
my $load_shared_dirs_dir_to_varname = undef;
my $load_shared_dirs_varname_to_dirs = undef;
my $load_shared_dirs_dir_to_id = undef;
sub load_shared_dirs() {
return if defined($load_shared_dirs_dir_to_varname);
$opt_debug_trace and log_debug(NO_FILE, NO_LINES, "load_shared_dirs()");
my $dir_to_varname = {};
my $varname_to_dirs = {};
my $dir_to_id = {};
foreach my $pkg qw(
misc/gnome-dirs misc/gnome1-dirs misc/gnome2-dirs
misc/theme-dirs
misc/xdg-dirs misc/xdg-x11-dirs
misc/xorg-dirs
print/texmf-dirs) {
$opt_debug_trace and log_debug(NO_FILE, NO_LINES, "pkg=$pkg");
my $dirs_mk = load_lines("$cwd_pkgsrcdir/$pkg/dirs.mk", true);
assert(defined($dirs_mk), "$pkg/dirs.mk is not readable.");
foreach my $line (@$dirs_mk) {
parseline_mk($line);
if ($line->has("is_varassign")) {
my $varname = $line->get("varname");
my $value = $line->get("value");
if ($varname =~ qr"^[A-Z]\w*_DIRS$" && $value ne "") {
if (exists($dir_to_varname->{$value})) {
# FIXME: misc/xdg-x11-dirs and misc/xdg-dirs conflict.
#$line->log_warning("Duplicate directory, also appears in " . $dir_to_varname->{$value} . ".");
} else {
$dir_to_varname->{$value} = $varname;
}
}
} elsif ($line->has("is_cond") && $line->get("directive") eq "for") {
my $args = $line->get("args");
while ($args =~ /\$\{(\w+_DIRS)\}/gc) {
push(@{$varname_to_dirs->{$1}}, $pkg);
}
}
}
my $makefile = load_lines("$cwd_pkgsrcdir/$pkg/Makefile", true);
assert(defined($makefile), "$pkg/Makefile is not readable.");
foreach my $line (@$makefile) {
my $pkgname = undef;
parseline_mk($line);
if ($line->has("is_varassign") && $line->get("varname") eq "DISTNAME") {
if ($line->get("value") =~ qr"^(.*)-dirs-(.*)$") {
$dir_to_id->{$pkg} = "$1-$2";
} else {
assert(false, "$pkg/Makefile does not define a proper DISTNAME.");
}
}
}
}
$load_shared_dirs_dir_to_varname = $dir_to_varname;
$load_shared_dirs_varname_to_dirs = $varname_to_dirs;
$load_shared_dirs_dir_to_id = $dir_to_id;
}
# Given a directory name, returns a list of possible identifiers to be
# used in USE_DIRS.
sub get_shared_dir_ids($$) {
my ($line, $dir) = @_;
my @ids;
$opt_debug_trace and $line->log_debug("get_shared_dir_ids(\"$dir\")");
load_shared_dirs();
my $varname = $load_shared_dirs_dir_to_varname->{$dir};
return () unless $varname;
#print "varname=$varname\n";
foreach my $dir2 (@{$load_shared_dirs_varname_to_dirs->{$varname}}) {
#print "dir2=$dir2\n";
my $id = $load_shared_dirs_dir_to_id->{$dir2};
#print "id=$id\n";
push(@ids, $id);
}
return @ids;
}
#
# Miscellaneous functions
#
sub match_all($$) {
my ($text, $re) = @_;
my ($mm, $rest, $lastpos);
$mm = [];
$rest = $text;
$lastpos = 0;
pos(undef);
while ($rest =~ m/$re/gc) {
my @starts = @-;
my @ends = @+;
$lastpos = $ends[0];
push(@{$mm}, PkgLint::SimpleMatch->new($text, \@starts, \@ends));
}
return ($mm, substr($rest, $lastpos));
}
sub autofix($) {
my ($lines) = @_;
if ($opt_autofix) {
save_autofix_changes($lines);
}
}
# Checks whether a file is already committed to the CVS repository or not.
sub is_committed($) {
my ($fname) = @_;
my ($basename, $entries);
$basename = basename($fname);
$entries = load_file(dirname($fname) . "/CVS/Entries");
if (!$entries) {
return false;
}
foreach my $entry (@{$entries}) {
if ($entry->text =~ qr"^/\Q${basename}\E/") {
return true;
}
}
return false;
}
# Checks whether a directory is practically empty, that is, all it
# contains are ".", ".." and "CVS", recursively.
sub is_emptydir($);
sub is_emptydir($) {
my ($dir) = @_;
my ($rv);
if (!opendir(DIR, $dir)) {
return true;
}
$rv = true;
foreach my $subdir (readdir(DIR)) {
next if $subdir eq "." || $subdir eq ".." || $subdir eq "CVS";
next if -d "${dir}/${subdir}" && is_emptydir("${dir}/${subdir}");
$rv = false;
last;
}
closedir(DIR);
return $rv;
}
# Guess the type of file based on the filename. This is used to select
# the proper subroutine for detecting absolute pathnames.
#
# Returns one of "source", "shell", "make", "text", "configure",
# "ignore", "unknown".
#
sub get_filetype($$) {
my ($line, $fname) = @_;
my $basename = basename($fname);
# The trailig .in part is not needed, since it does not
# influence the type of contents.
$basename =~ s,\.in$,,;
# Let's assume that everything else that looks like a Makefile
# is indeed a Makefile.
if ($basename =~ qr"^I?[Mm]akefile(?:\..*|)?|.*\.ma?k$") {
return "make";
}
# Too many false positives for shell scripts, so configure
# scripts get their own category.
if ($basename =~ qr"^configure(?:|\.ac)$") {
$opt_debug_unchecked and $line->log_debug("Skipped check for absolute pathnames.");
return "configure";
}
if ($basename =~ qr"\.(?:sh|m4)$"i) {
return "shell";
}
if ($basename =~ qr"\.(?:cc?|cpp|cxx|el|hh?|hpp|l|pl|pm|py|s|t|y)$"i) {
return "source";
}
if ($basename =~ qr"^.+\.(?:\d+|conf|html|info|man|po|tex|texi|texinfo|txt|xml)$"i) {
return "text";
}
# Filenames without extension are hard to guess right. :(
if ($basename !~ qr"\.") {
return "unknown";
}
$opt_debug_misc and $line->log_debug("Don't know the file type of ${fname}.");
return "unknown";
}
# Returns the list of subdirectories of a directory, except "CVS".
sub get_subdirs($) {
my ($dir) = @_;
my (@result) = ();
if (opendir(DIR, $dir)) {
foreach my $subdir (readdir(DIR)) {
if ($subdir ne "." && $subdir ne ".." && $subdir ne "CVS" && -d "${dir}/${subdir}" && !is_emptydir("${dir}/${subdir}")) {
push(@result, $subdir);
}
}
closedir(DIR);
}
return @result;
}
# No package file should ever be executable. Even the INSTALL and
# DEINSTALL scripts are usually not usable in the form they have in the
# package, as the pathnames get adjusted during installation. So there is
# no need to have any file executable.
sub checkperms($) {
my ($fname) = @_;
if (-f $fname && -x $fname && !is_committed($fname)) {
log_warning($fname, NO_LINE_NUMBER, "Should not be executable.");
}
}
sub resolve_relative_path($$) {
my ($relpath, $adjust_depth) = @_;
$relpath =~ s,\$\{PKGSRCDIR\},$cur_pkgsrcdir,;
$relpath =~ s,\$\{\.CURDIR\},.,;
$relpath =~ s,\$\{\.PARSEDIR\},.,;
$relpath =~ s,\$\{PHPPKGSRCDIR\},../../lang/php5,;
$relpath =~ s,\$\{SUSE_DIR_PREFIX\},suse91,;
$relpath =~ s,\$\{PYPKGSRCDIR\},../../lang/python23,;
if ($adjust_depth && $relpath =~ qr"^\.\./\.\./([^.].*)$") {
$relpath = "${cur_pkgsrcdir}/$1";
}
if (defined($pkgdir)) {
$relpath =~ s,\$\{PKGDIR\},$pkgdir,g;
}
return $relpath;
}
sub expand_variable($$) {
my ($whole, $varname) = @_;
my ($value, $re);
$re = qr"\n\Q${varname}\E([+:?]?)=[ \t]*([^\n#]*)";
$value = undef;
while ($whole =~ m/$re/g) {
my ($op, $val) = ($1, $2);
if ($op ne "?" || !defined($value)) {
$value = $val;
}
}
if (!defined($value)) {
return undef;
}
$value = resolve_relative_path($value, true);
if ($value =~ regex_unresolved) {
$opt_debug_misc and log_debug(NO_FILE, NO_LINES, "[expand_variable] The variable ${varname} could not be resolved completely. Its value is \"${value}\".");
}
return $value;
}
sub set_default_value($$) {
my ($varref, $value) = @_;
if (!defined(${$varref}) || ${$varref} =~ regex_unresolved) {
${$varref} = $value;
}
}
sub strip_mk_comment($) {
my ($text) = @_;
$text =~ s/(^|[^\\])#.*/$1/;
$text =~ s/\\#/#/g;
return $text;
}
# Returns the value of a shell word, with one level of quoting removed.
# This makes pattern matching easier when the interesting part is not
# what make(1) or sh(1) sees, but the command that is called by the
# shell. This function does not resolve or replace any variables.
sub unescape_shellword($) {
my ($text) = @_;
# TODO: implement this.
assert(false, "unescape_shellword is not yet implemented.");
}
# Removes all uses of make variables from a string.
sub remove_variables($) {
my ($text) = @_;
while ($text =~ s/\$\{([^{}]*)\}//g) {
}
return $text;
}
# Converts an array of PkgLint::String to an array of PkgLint::Line.
sub strings_to_lines($) {
my ($strings) = @_;
my ($retval);
$retval = [];
foreach my $s (@{$strings}) {
push(@{$retval}, $s->line);
}
return $retval;
}
sub backtrace($) {
my $msg = shift();
my (@callers);
my $n = 0;
while (my @info = caller($n)) {
push(@callers, [$info[2], $info[3]]);
$n++;
}
log_debug(NO_FILE, NO_LINE_NUMBER, $msg);
for (my $i = $#callers; $i >= 0; $i--) {
my $info = $callers[$i];
log_debug(NO_FILE, NO_LINE_NUMBER, sprintf(" line %4d called %s", $info->[0], $info->[1]));
}
}
# Returns the number of columns that a string occupies when printed with
# a tabulator size of 8.
sub tablen($) {
my ($s) = @_;
my ($len);
$len = 0;
foreach my $c (split(qr"", $s)) {
if ($c eq "\t") {
$len = ($len + 7) & ~7;
} else {
$len++;
}
}
return $len;
}
sub shell_split($) {
my ($text) = @_;
my ($words);
$words = [];
while ($text =~ s/^$regex_shellword//) {
push(@{$words}, $1);
}
return (($text =~ qr"^\s*$") ? $words : false);
}
sub varname_base($) {
my ($varname) = @_;
return ($varname =~ qr"^(.*?)\..*$") ? $1 : $varname;
}
sub varname_canon($) {
my ($varname) = @_;
return ($varname =~ qr"^(.*?)\..*$") ? "$1.*" : $varname;
}
sub varname_param($) {
my ($varname) = @_;
return ($varname =~ qr"^.*?\.(.*)$") ? $2 : undef;
}
sub determine_used_variables($) {
my ($lines) = @_;
my ($rest);
foreach my $line (@{$lines}) {
$rest = $line->text;
while ($rest =~ s/(?:\$\{|defined\(|empty\()([0-9+.A-Z_a-z]+)[:})]//) {
my ($varname) = ($1);
$pkgctx_varuse->{$varname} = $line;
$pkgctx_varuse->{varname_canon($varname)} = $line;
$opt_debug_unused and $line->log_debug("Variable ${varname} is used.");
}
}
}
sub extract_used_variables($$) {
my ($line, $text) = @_;
my ($rest, $result);
$rest = $text;
$result = [];
while ($rest =~ s/^(?:[^\$]+|\$[\$*<>?\@]|\$\{([.0-9A-Z_a-z]+)(?::(?:[^\${}]|\$[^{])+)?\})//) {
my ($varname) = ($1);
if (defined($varname)) {
push(@{$result}, $varname);
}
}
if ($rest ne "") {
$opt_debug_misc and $line->log_warning("Could not extract variables: ${rest}");
}
return $result;
}
my $check_pkglint_version_done = false;
sub check_pkglint_version() {
return if $check_pkglint_version_done;
$check_pkglint_version_done = true;
my $lines = load_lines("${cwd_pkgsrcdir}/pkgtools/pkglint/Makefile", true);
return unless $lines;
my $pkglint_version = undef;
foreach my $line (@{$lines}) {
if ($line->text =~ regex_varassign) {
my ($varname, undef, $value, undef) = ($1, $2, $3, $4);
if ($varname eq "DISTNAME" || $varname eq "PKGNAME") {
if ($value =~ regex_pkgname) {
$pkglint_version = $2;
}
}
}
}
return unless defined($pkglint_version);
if (dewey_cmp($pkglint_version, ">", conf_distver)) {
log_note(NO_FILE, NO_LINE_NUMBER, "A newer version of pkglint is available.");
} elsif (dewey_cmp($pkglint_version, "<", conf_distver)) {
log_error(NO_FILE, NO_LINE_NUMBER, "The pkglint version is newer than the tree to check.");
}
}
# When processing a file using the expect* subroutines below, it may
# happen that $lineno points past the end of the file. In that case,
# print the warning without associated source code.
sub lines_log_warning($$$) {
my ($lines, $lineno, $msg) = @_;
assert(0 <= $lineno, "The line number is negative (${lineno}).");
assert(@{$lines} != 0, "The lines may not be empty.");
if ($lineno <= $#{$lines}) {
$lines->[$lineno]->log_warning($msg);
} else {
log_warning($lines->[0]->fname, "EOF", $msg);
}
}
sub expect($$$) {
my ($lines, $lineno_ref, $regex) = @_;
my $lineno = ${$lineno_ref};
if ($lineno <= $#{$lines} && $lines->[$lineno]->text =~ $regex) {
${$lineno_ref}++;
return new PkgLint::SimpleMatch($lines->[$lineno]->text, \@-, \@+);
} else {
return false;
}
}
sub expect_empty_line($$) {
my ($lines, $lineno_ref) = @_;
if (expect($lines, $lineno_ref, qr"^$")) {
return true;
} else {
$opt_warn_space and $lines->[${$lineno_ref}]->log_note("Empty line expected.");
return false;
}
}
sub expect_text($$$) {
my ($lines, $lineno_ref, $text) = @_;
if (expect($lines, $lineno_ref, qr"^\Q${text}\E$")) {
return true;
} else {
lines_log_warning($lines, ${$lineno_ref}, "Expected \"${text}\".");
return false;
}
}
sub get_variable_type($$) {
my ($line, $varname) = @_;
my ($type);
assert(defined($varname), "The varname parameter must be defined.");
if (exists(get_vartypes_map()->{$varname})) {
return get_vartypes_map()->{$varname};
}
my $varcanon = varname_canon($varname);
if (exists(get_vartypes_map()->{$varcanon})) {
return get_vartypes_map()->{$varcanon};
}
if (exists(get_varname_to_toolname()->{$varname})) {
return PkgLint::Type->new(LK_NONE, "ShellCommand", [[ qr".*", "u" ]], NOT_GUESSED);
}
if ($varname =~ qr"^TOOLS_(.*)" && exists(get_varname_to_toolname()->{$1})) {
return PkgLint::Type->new(LK_NONE, "Pathname", [[ qr".*", "u" ]], NOT_GUESSED);
}
use constant allow_all => [[ qr".*", "adpsu" ]];
use constant allow_runtime => [[ qr".*", "adsu" ]];
# Guess the datatype of the variable based on
# naming conventions.
$type = ($varname =~ qr"DIRS$") ? PkgLint::Type->new(LK_EXTERNAL, "Pathmask", allow_runtime, GUESSED)
: ($varname =~ qr"(?:DIR|_HOME)$") ? PkgLint::Type->new(LK_NONE, "Pathname", allow_runtime, GUESSED)
: ($varname =~ qr"FILES$") ? PkgLint::Type->new(LK_EXTERNAL, "Pathmask", allow_runtime, GUESSED)
: ($varname =~ qr"FILE$") ? PkgLint::Type->new(LK_NONE, "Pathname", allow_runtime, GUESSED)
: ($varname =~ qr"PATH$") ? PkgLint::Type->new(LK_NONE, "Pathlist", allow_runtime, GUESSED)
: ($varname =~ qr"PATHS$") ? PkgLint::Type->new(LK_EXTERNAL, "List of Pathname", allow_runtime, GUESSED)
: ($varname =~ qr"_USER$") ? PkgLint::Type->new(LK_NONE, "UserGroupName", allow_all, GUESSED)
: ($varname =~ qr"_GROUP$") ? PkgLint::Type->new(LK_NONE, "UserGroupName", allow_all, GUESSED)
: ($varname =~ qr"_ENV$") ? PkgLint::Type->new(LK_EXTERNAL, "ShellWord", allow_runtime, GUESSED)
: ($varname =~ qr"_CMD$") ? PkgLint::Type->new(LK_NONE, "ShellCommand", allow_runtime, GUESSED)
: ($varname =~ qr"_ARGS$") ? PkgLint::Type->new(LK_EXTERNAL, "ShellWord", allow_runtime, GUESSED)
: ($varname =~ qr"_(?:C|CPP|CXX|LD|)FLAGS$") ? PkgLint::Type->new(LK_EXTERNAL, "ShellWord", allow_runtime, GUESSED)
: ($varname =~ qr"_MK$") ? PkgLint::Type->new(LK_NONE, "Unchecked", allow_all, GUESSED)
: undef;
if (defined($type)) {
$opt_debug_vartypes and $line->log_debug("The guessed type of ${varname} is \"" . $type->to_string . "\".");
return $type;
}
$opt_debug_vartypes and $line->log_debug("No type definition found for ${varcanon}.");
return undef;
}
sub get_variable_perms($$) {
my ($line, $varname) = @_;
my $type = get_variable_type($line, $varname);
if (!defined($type)) {
$opt_debug_misc and $line->log_debug("No type definition found for ${varname}.");
return "adpsu";
}
my $perms = $type->perms($line->fname, $varname);
if (!defined($perms)) {
$opt_debug_misc and $line->log_debug("No permissions specified for ${varname}.");
return "?";
}
return $perms;
}
# This function returns whether a variable needs the :Q operator in a
# certain context. There are four possible outcomes:
#
# false: The variable should not be quoted.
# true: The variable should be quoted.
# doesnt_matter:
# Since the values of the variable usually don't contain
# special characters, it does not matter whether the
# variable is quoted or not.
# dont_know: pkglint cannot say whether the variable should be quoted
# or not, most likely because type information is missing.
#
sub variable_needs_quoting($$$) {
my ($line, $varname, $context) = @_;
my $type = get_variable_type($line, $varname);
my ($want_list, $have_list);
use constant safe_types => array_to_hash(qw(
DistSuffix
Filemask FileMode Filename
Identifier
Option
Pathmask Pathname PkgName PkgOptionsVar PkgRevision
RelativePkgDir RelativePkgPath
URL UserGroupName
Varname Version
WrkdirSubdirectory
));
if (!defined($type) || !defined($context->type)) {
return dont_know;
}
# Variables of certain predefined types, as well as all
# enumerations, are expected to not require the :Q operator.
if (ref($type->basic_type) eq "HASH" || exists(safe_types->{$type->basic_type})) {
if ($type->kind_of_list == LK_NONE) {
return doesnt_matter;
} elsif ($type->kind_of_list == LK_EXTERNAL && $context->extent != VUC_EXTENT_WORD_PART) {
return doesnt_matter;
}
}
# In .for loops, the :Q operator is always misplaced, since
# the items are broken up at white-space, not as shell words
# like in all other parts of make(1).
if ($context->shellword == VUC_SHELLWORD_FOR) {
return false;
}
# Determine whether the context expects a list of shell words or
# not.
$want_list = $context->type->is_practically_a_list() && ($context->shellword == VUC_SHELLWORD_BACKT || $context->extent != VUC_EXTENT_WORD_PART);
$have_list = $type->is_practically_a_list();
$opt_debug_quoting and $line->log_debug("[variable_needs_quoting]"
. " varname=$varname"
. " context=" . $context->to_string()
. " type=" . $type->to_string()
. " want_list=" . ($want_list ? "yes" : "no")
. " have_list=" . ($have_list ? "yes" : "no")
. ".");
# A shell word may appear as part of a shell word, for example
# COMPILER_RPATH_FLAG.
if ($context->extent == VUC_EXTENT_WORD_PART && $context->shellword == VUC_SHELLWORD_PLAIN) {
if ($type->kind_of_list == LK_NONE && $type->basic_type eq "ShellWord") {
return false;
}
}
# Assume that the tool definitions don't include very special
# characters, so they can safely be used inside any quotes.
if (exists(get_varname_to_toolname()->{$varname})) {
my $sw = $context->shellword;
if ($sw == VUC_SHELLWORD_PLAIN && $context->extent != VUC_EXTENT_WORD_PART) {
return false;
} elsif ($sw == VUC_SHELLWORD_BACKT) {
return false;
} elsif ($sw == VUC_SHELLWORD_DQUOT || $sw == VUC_SHELLWORD_SQUOT) {
return doesnt_matter;
} else {
# Let the other rules decide.
}
}
# Variables that appear as parts of shell words generally need
# to be quoted. An exception is in the case of backticks,
# because the whole backticks expression is parsed as a single
# shell word by pkglint.
#
# XXX: When the shell word parser gets rewritten the next time,
# this test can be refined.
if ($context->extent == VUC_EXTENT_WORD_PART && $context->shellword != VUC_SHELLWORD_BACKT) {
return true;
}
# Assigning lists to lists does not require any quoting, though
# there may be cases like "CONFIGURE_ARGS+= -libs ${LDFLAGS:Q}"
# where quoting is necessary. So let's hope that no developer
# ever makes the mistake of using :Q when appending a list to
# a list.
if ($want_list && $have_list) {
return doesnt_matter;
}
# Appending elements to a list requires quoting, as well as
# assigning a list value to a non-list variable.
if ($want_list != $have_list) {
return true;
}
$opt_debug_quoting and $line->log_debug("Don't know whether :Q is needed for ${varname}.");
return dont_know;
}
#
# Parsing.
#
# This procedure fills in the extra fields of a line, depending on the
# line type. These fields can later be queried without having to parse
# them again and again.
#
sub parseline_mk($) {
my ($line) = @_;
my $text = $line->text;
if ($text =~ regex_varassign) {
my ($varname, $op, $value, $comment) = ($1, $2, $3, $4);
# In variable assignments, a '#' character is preceded
# by a backslash. In shell commands, it is interpreted
# literally.
$value =~ s/\\\#/\#/g;
$line->set("is_varassign", true);
$line->set("varname", $varname);
$line->set("varcanon", varname_canon($varname));
my $varparam = varname_param($varname);
defined($varparam) and $line->set("varparam", $varparam);
$line->set("op", $op);
$line->set("value", $value);
defined($comment) and $line->set("comment", $comment);
} elsif ($text =~ regex_mk_shellcmd) {
my ($shellcmd) = ($1);
# Shell command lines cannot have embedded comments.
$line->set("is_shellcmd", true);
$line->set("shellcmd", $shellcmd);
my ($shellwords, $rest) = match_all($shellcmd, $regex_shellword);
$line->set("shellwords", $shellwords);
if ($rest !~ qr"^\s*$") {
$line->set("shellwords_rest", $rest);
}
} elsif ($text =~ regex_mk_comment) {
my ($comment) = ($1);
$line->set("is_comment", true);
$line->set("comment", $comment);
} elsif ($text =~ qr"^\s*$") {
$line->set("is_empty", true);
} elsif ($text =~ regex_mk_cond) {
my ($indent, $directive, $args, $comment) = ($1, $2, $3, $4);
$line->set("is_cond", true);
$line->set("indent", $indent);
$line->set("directive", $directive);
defined($args) and $line->set("args", $args);
defined($comment) and $line->set("comment", $comment);
} elsif ($text =~ regex_mk_include) {
my ($includefile, $comment) = ($1, $2);
$line->set("is_include", true);
$line->set("includefile", $includefile);
defined($comment) and $line->set("comment", $comment);
} elsif ($text =~ regex_mk_sysinclude) {
my ($includefile, $comment) = ($1, $2);
$line->set("is_sysinclude", true);
$line->set("includefile", $includefile);
defined($comment) and $line->set("comment", $comment);
} elsif ($text =~ regex_mk_dependency) {
my ($targets, $sources, $comment) = ($1, $2, $3);
$line->set("is_dependency", true);
$line->set("targets", $targets);
$line->set("sources", $sources);
defined($comment) and $line->set("comment", $comment);
} elsif ($text =~ regex_rcs_conflict) {
# This line is useless
} else {
assert(false, "Unknown line format: " . $line->to_string());
}
}
sub parselines_mk($) {
my ($lines) = @_;
foreach my $line (@{$lines}) {
parseline_mk($line);
}
}
#
# Loading package-specific data from files.
#
sub readmakefile($$$$);
sub readmakefile($$$$) {
my ($fname, $main_lines, $all_lines, $seen_Makefile_include) = @_;
my $contents = "";
my ($includefile, $dirname, $lines, $is_main_Makefile);
$lines = load_lines($fname, true);
if (!$lines) {
return false;
}
parselines_mk($lines);
$is_main_Makefile = (@{$main_lines} == 0);
foreach my $line (@{$lines}) {
my $text = $line->text;
if ($is_main_Makefile) {
push(@{$main_lines}, $line);
}
push(@{$all_lines}, $line);
# try to get any included file
my $is_include_line = false;
if ($text =~ qr"^\.\s*include\s+\"(.*)\"$") {
$includefile = resolve_relative_path($1, true);
if ($includefile =~ regex_unresolved) {
if ($fname !~ qr"/mk/") {
$line->log_note("Skipping include file \"${includefile}\". This may result in false warnings.");
}
} else {
$is_include_line = true;
}
}
if ($is_include_line) {
if ($fname !~ qr"buildlink3\.mk$" && $includefile =~ qr"^\.\./\.\./(.*)/buildlink3\.mk$") {
my ($bl3_file) = ($1);
$pkgctx_bl3->{$bl3_file} = $line;
$opt_debug_misc and $line->log_debug("Buildlink3 file in package: ${bl3_file}");
}
}
if ($is_include_line && !exists($seen_Makefile_include->{$includefile})) {
$seen_Makefile_include->{$includefile} = true;
if ($includefile =~ qr"^\.\./[^./][^/]*/[^/]+") {
$line->log_warning("Relative directories should look like \"../../category/package\", not \"../package\".");
$line->explain_warning(expl_relative_dirs);
}
if ($includefile =~ qr"(?:^|/)Makefile.common$"
|| ($includefile =~ qr"^(?:\.\./(\.\./[^/]+/)?[^/]+/)?([^/]+)$"
&& (!defined($1) || $1 ne "../mk")
&& $2 ne "buildlink3.mk"
&& $2 ne "options.mk")) {
$opt_debug_include and $line->log_debug("including ${includefile} sets seen_Makefile_common.");
$seen_Makefile_common = true;
}
if ($includefile =~ qr"/mk/") {
# skip these files
$contents .= $text . "\n";
} else {
$dirname = dirname($fname);
# Only look in the directory relative to the
# current file and in the current working directory.
# We don't have an include dir list, like make(1) does.
if (!-f "$dirname/$includefile") {
$dirname = $current_dir;
}
if (!-f "$dirname/$includefile") {
$line->log_error("Cannot read $dirname/$includefile.");
} else {
$opt_debug_include and $line->log_debug("Including \"$dirname/$includefile\".");
$contents .= readmakefile("$dirname/$includefile", $main_lines, $all_lines, $seen_Makefile_include);
}
}
} elsif ($line->has("is_varassign")) {
my ($varname, $op, $value) = ($line->get("varname"), $line->get("op"), $line->get("value"));
# Record all variables that are defined in these lines, so that they
# are not reported as "used but not defined".
if ($op ne "?=" || !exists($pkgctx_vardef->{$varname})) {
$opt_debug_misc and $line->log_debug("varassign(${varname}, ${op}, ${value})");
$pkgctx_vardef->{$varname} = $line;
}
$contents .= $text . "\n";
} else {
$contents .= $text . "\n";
}
}
return $contents;
}
sub load_package_Makefile($$$) {
my ($fname, $ref_whole, $ref_lines) = @_;
my ($subr) = "load_package_Makefile";
my ($whole, $lines, $all_lines);
$opt_debug_trace and log_debug($fname, NO_LINES, "load_package_Makefile()");
$whole = readmakefile($fname, $lines = [], $all_lines = [], {});
if (!$whole) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return false;
}
if ($opt_dumpmakefile) {
log_debug(NO_FILE, NO_LINES, "Whole Makefile (with all included files) follows:");
foreach my $line (@{$all_lines}) {
print($line->to_string() . "\n");
}
}
determine_used_variables($all_lines);
# HACK
if ($whole =~ qr"\nPHPEXT_MK" && $whole !~ qr"\nUSE_PHP_EXT_PATCHES") {
$opt_debug_misc and log_debug($fname, NO_LINES, "[hack] USE_PHP_EXT_PATCHES");
$whole =~ s,\nPATCHDIR=.*PHPPKGSRCDIR.*,,;
$hack_php_patches = true;
}
# HACK
if ($whole =~ qr"\nPECL_VERSION") {
$opt_debug_misc and log_debug($fname, NO_LINES, "[hack] PECL_VERSION");
$whole =~ s,\nDISTINFO_FILE=.*PHPPKGSRCDIR.*,,;
}
$pkgdir = expand_variable($whole, "PKGDIR");
set_default_value(\$pkgdir, ".");
$distinfo_file = expand_variable($whole, "DISTINFO_FILE");
set_default_value(\$distinfo_file, "distinfo");
$filesdir = expand_variable($whole, "FILESDIR");
set_default_value(\$filesdir, "files");
$patchdir = expand_variable($whole, "PATCHDIR");
set_default_value(\$patchdir, "patches");
$opt_debug_misc and log_debug(NO_FILE, NO_LINE_NUMBER, "[${subr}] DISTINFO_FILE=$distinfo_file");
$opt_debug_misc and log_debug(NO_FILE, NO_LINE_NUMBER, "[${subr}] FILESDIR=$filesdir");
$opt_debug_misc and log_debug(NO_FILE, NO_LINE_NUMBER, "[${subr}] PATCHDIR=$patchdir");
$opt_debug_misc and log_debug(NO_FILE, NO_LINE_NUMBER, "[${subr}] PKGDIR=$pkgdir");
${$ref_whole} = $whole;
${$ref_lines} = $lines;
return true;
}
#
# Subroutines to check part of a single line.
#
sub checkword_absolute_pathname($$) {
my ($line, $word) = @_;
$opt_debug_trace and $line->log_debug("checkword_absolute_pathname(\"${word}\")");
if ($word =~ qr"^/dev/(?:null|tty|zero)$") {
# These are defined by POSIX.
} elsif ($word eq "/bin/sh") {
# This is usually correct, although on Solaris, it's pretty
# feature-crippled.
} elsif ($word !~ qr"/(?:[a-z]|\$[({])") {
# Assume that all pathnames start with a lowercase letter.
} else {
$line->log_warning("Found absolute pathname: ${word}");
$line->explain_warning(
"Absolute pathnames are often an indicator for unportable code. As",
"pkgsrc aims to be a portable system, absolute pathnames should be",
"avoided whenever possible.",
"",
"A special variable in this context is \${DESTDIR}, which is used in GNU",
"projects to specify a different directory for installation than what",
"the programs see later when they are executed. Usually it is empty, so",
"if anything after that variable starts with a slash, it is considered",
"an absolute pathname.");
}
}
#
# Subroutines to check a single line.
#
sub checkline_length($$) {
my ($line, $maxlength) = @_;
if (length($line->text) > $maxlength) {
$line->log_warning("Line too long (should be no more than $maxlength characters).");
$line->explain_warning(
"Back in the old time, terminals with 80x25 characters were common.",
"And this is still the default size of many terminal emulators.",
"Moderately short lines also make reading easier.");
}
}
sub checkline_valid_characters($$) {
my ($line, $re_validchars) = @_;
my ($rest);
($rest = $line->text) =~ s/$re_validchars//g;
if ($rest ne "") {
my @chars = map { $_ = sprintf("0x%02x", ord($_)); } split(//, $rest);
$line->log_warning("Line contains invalid characters (" . join(", ", @chars) . ").");
}
}
sub checkline_valid_characters_in_variable($$) {
my ($line, $re_validchars) = @_;
my ($varname, $rest);
$varname = $line->get("varname");
$rest = $line->get("value");
$rest =~ s/$re_validchars//g;
if ($rest ne "") {
my @chars = map { $_ = sprintf("0x%02x", ord($_)); } split(//, $rest);
$line->log_warning("${varname} contains invalid characters (" . join(", ", @chars) . ").");
}
}
sub checkline_trailing_whitespace($) {
my ($line) = @_;
$opt_debug_trace and $line->log_debug("checkline_trailing_whitespace()");
if ($line->text =~ /\s+$/) {
$line->log_note("Trailing white-space.");
$line->replace_regex(qr"\s+\n$", "\n");
}
}
sub checkline_rcsid_regex($$$) {
my ($line, $prefix_regex, $prefix) = @_;
my ($id) = ($opt_rcsidstring . ($is_wip ? "|Id" : ""));
$opt_debug_trace and $line->log_debug("checkline_rcsid_regex(${prefix_regex}, ${prefix})");
if ($line->text !~ qr"^${prefix_regex}\$(${id})(?::[^\$]*|)\$$") {
$line->log_error("\"${prefix}\$${opt_rcsidstring}\$\" expected.");
return false;
}
return true;
}
sub checkline_rcsid($$) {
my ($line, $prefix) = @_;
checkline_rcsid_regex($line, quotemeta($prefix), $prefix);
}
# Checks whether the line contains text that looks like absolute
# pathnames, assuming that the file uses the common syntax with
# single or double quotes to represent strings.
#
sub checkline_source_absolute_pathname($$) {
my ($line, $text) = @_;
my ($abspath);
$opt_debug_trace and $line->log_debug("checkline_source_absolute_pathname(${text})");
if ($text =~ qr"(.*)([\"'])(/[^\"']*)\2") {
my ($before, $delim, $string) = ($1, $2, $3);
$opt_debug_misc and $line->log_debug("checkline_source_absolute_pathname(before=${before}, string=${string})");
if ($before =~ qr"[A-Z_]+\s*$") {
# allowed: PREFIX "/bin/foo"
} elsif ($string =~ qr"^/[*/]") {
# This is more likely to be a C or C++ comment.
} elsif ($string !~ qr"^/\w") {
# Assume that pathnames start with a letter or digit.
} elsif ($before =~ qr"\+\s*$") {
# Something like foodir + '/lib'
} else {
$abspath = $string;
}
}
if (defined($abspath)) {
checkword_absolute_pathname($line, $abspath);
}
}
sub checkline_mk_absolute_pathname($$) {
my ($line, $text) = @_;
my $abspath;
$opt_debug_trace and $line->log_debug("checkline_mk_absolute_pathname(${text})");
# In the GNU coding standards, DESTDIR is defined as a (usually
# empty) prefix that can be used to install files to a different
# location from what they have been built for. Therefore
# everything following it is considered an absolute pathname.
# Another commonly used context is in assignments like
# "bindir=/bin".
if ($text =~ qr"(?:^|\$\{DESTDIR\}|\$\(DESTDIR\)|[\w_]+\s*=\s*)(/(?:[^\"'\`\s]|\"[^\"*]\"|'[^']*'|\`[^\`]*\`)*)") {
my $path = $1;
if ($path =~ qr"^/\w") {
$abspath = $path;
}
}
if (defined($abspath)) {
checkword_absolute_pathname($line, $abspath);
}
}
# Last resort if the file does not look like a Makefile or typical
# source code. All strings that look like pathnames and start with
# one of the typical Unix prefixes are found.
#
sub checkline_other_absolute_pathname($$) {
my ($line, $text) = @_;
$opt_debug_trace and $line->log_debug("checkline_other_absolute_pathname(\"${text}\")");
if ($text =~ qr"^#[^!]") {
# Don't warn for absolute pathnames in comments,
# except for shell interpreters.
} elsif ($text =~ qr"^(.*?)((?:/[\w.]+)*/(?:bin|dev|etc|home|lib|mnt|opt|proc|sbin|tmp|usr|var)\b[\w./\-]*)(.*)$") {
my ($before, $path, $after) = ($1, $2, $3);
if ($before =~ qr"\@$") {
# Something like @PREFIX@/bin
} elsif ($before =~ qr"[)}]$") {
# Something like ${prefix}/bin or $(PREFIX)/bin
} elsif ($before =~ qr"\+\s*[\"']$") {
# Something like foodir + '/lib'
} elsif ($before =~ qr"\w$") {
# Something like $dir/lib
} elsif ($before =~ qr"\.$") {
# ../foo is not an absolute pathname.
} else {
$opt_debug_misc and $line->log_debug("before=${before}");
checkword_absolute_pathname($line, $path);
}
}
}
sub checkline_relative_path($$) {
my ($line, $path) = @_;
my ($res_path);
if (!$is_wip && $path =~ qr"/wip/") {
$line->log_error("A pkgsrc package must not depend on any outside package.");
}
$res_path = resolve_relative_path($path, true);
if ($res_path =~ regex_unresolved) {
$opt_debug_unchecked and $line->log_debug("Unchecked path: \"${path}\".");
} elsif (!-e ((($res_path =~ qr"^/") ? "" : "${current_dir}/") . $res_path)) {
$line->log_error("\"${res_path}\" does not exist.");
} elsif ($path =~ qr"^\.\./\.\./([^/]+)/([^/]+)(.*)") {
my ($cat, $pkg, $rest) = ($1, $2, $3);
} elsif ($path =~ qr"^\.\./\.\./mk/") {
# There need not be two directory levels for mk/ files.
} elsif ($path =~ qr"^\.\./mk/" && $cur_pkgsrcdir eq "..") {
# That's fine for category Makefiles.
} elsif ($path =~ qr"^\.\.") {
$line->log_warning("Invalid relative path \"${path}\".");
}
}
sub checkline_relative_pkgdir($$) {
my ($line, $path) = @_;
checkline_relative_path($line, $path);
$path = resolve_relative_path($path, false);
if ($path !~ qr"^(?:\./)?\.\./\.\./[^/]+/[^/]+$") {
$line->log_warning("\"${path}\" is not a valid relative package directory.");
$line->explain_warning(
"A relative pathname always starts with \"../../\", followed",
"by a category, a slash and a the directory name of the package.",
"For example, \"../../misc/screen\" is a valid relative pathname.");
}
}
sub checkline_spellcheck($) {
my ($line) = @_;
if ($line->text =~ qr"existant") {
$line->log_warning("The word \"existant\" is nonexistent in the m-w dictionary.");
$line->explain_warning("Please use \"existent\" instead.");
}
}
sub checkline_cpp_macro_names($$) {
my ($line, $text) = @_;
my ($rest);
use constant good_macros => PkgLint::Util::array_to_hash(qw(
__STDC__
__GNUC__ __GNUC_MINOR__
__SUNPRO_C
__i386
__mips
__sparc
__APPLE__
__bsdi__
__CYGWIN__
__DragonFly__
__FreeBSD__ __FreeBSD_version
__INTERIX
__linux__
__MINGW32__
__NetBSD__ __NetBSD_Version__
__OpenBSD__
__SVR4
__sgi
__sun
__GLIBC__
));
use constant bad_macros => {
"__sgi__" => "__sgi",
"__sparc__" => "__sparc",
"__sparc_v9__" => "__sparcv9",
"__sun__" => "__sun",
"__svr4__" => "__SVR4",
};
$rest = $text;
while ($rest =~ s/defined\((__[\w_]+)\)//) {
my ($macro) = ($1);
if (exists(good_macros->{$macro})) {
$opt_debug_misc and $line->log_debug("Found good macro \"${macro}\".");
} elsif (exists(bad_macros->{$macro})) {
$line->log_warning("The macro \"${macro}\" is not portable enough. Please use \"".bad_macros->{$macro}."\" instead.");
$line->explain_warning("See the pkgsrc guide, section \"CPP defines\" for details.");
} else {
$opt_debug_unchecked and $line->log_debug("Unchecked macro \"${macro}\".");
}
}
}
sub checkline_mk_varuse($$$$) {
my ($line, $varname, $mod, $context) = @_;
assert(defined($varname), "The varname parameter must be defined");
assert(defined($context), "The context parameter must be defined");
$opt_debug_trace and $line->log_debug("checkline_mk_varuse(\"${varname}\", \"${mod}\", ".$context->to_string().")");
# Check for spelling mistakes.
my $type = get_variable_type($line, $varname);
if (defined($type) && !($type->is_guessed)) {
# Great.
} elsif (defined($pkgctx_vardef) && exists($pkgctx_vardef->{$varname})) {
# A variable that is defined somewhere may also be used.
} elsif (exists($mkctx_vardef->{$varname})) {
# A variable that has been defined in the current file
# may also be used.
} elsif (defined($mkctx_for_variables) && exists($mkctx_for_variables->{$varname})) {
# Variables defined in .for loops are also ok.
} else {
$opt_warn_extra and $line->log_warning("${varname} is used but not defined. Spelling mistake?");
}
if ($opt_warn_perm) {
my $perms = get_variable_perms($line, $varname);
my $is_load_time; # Will the variable be used at load time?
my $is_indirect; # Might the variable be used indirectly at load time,
# for example by assigning it to another variable
# which then gets evaluated?
# Don't warn about variables that are not recorded in the
# pkglint variable definition.
if (defined($context->type) && $context->type->is_guessed()) {
$is_load_time = false;
} elsif ($context->time == VUC_TIME_LOAD && $perms !~ qr"p") {
$is_load_time = true;
$is_indirect = false;
} elsif (defined($context->type) && $context->type->perms_union() =~ qr"p" && $perms !~ qr"p") {
$is_load_time = true;
$is_indirect = true;
} else {
$is_load_time = false;
}
if ($is_load_time && !$is_indirect) {
$line->log_warning("${varname} should not be evaluated at load time.");
$line->explain_warning(
"Many variables, especially lists of something, get their values",
"incrementally. Therefore it is generally unsafe to rely on their value",
"until it is clear that it will never change again. This point is",
"reached when the whole package Makefile is loaded and execution of the",
"shell commands starts, in some cases earlier.",
"",
"Additionally, when using the \":=\" operator, each \$\$ is replaced",
"with a single \$, so variables that have references to shell variables",
"or regular expressions are modified in a subtle way.");
}
if ($is_load_time && $is_indirect) {
$line->log_warning("${varname} should not be evaluated indirectly at load time.");
$line->explain_warning(
"The variable on the left-hand side may be evaluated at load time, but",
"the variable on the right-hand side may not. Due to this assignment, it",
"might be used indirectly at load-time, when it is not guaranteed to be",
"properly defined.");
}
if ($perms !~ qr"p" && $perms !~ qr"u") {
$line->log_warning("${varname} may not be used in this file.");
}
}
my $needs_quoting = variable_needs_quoting($line, $varname, $context);
if ($context->shellword == VUC_SHELLWORD_FOR) {
if (!defined($type)) {
# Cannot check anything here.
} elsif ($type->kind_of_list == LK_INTERNAL) {
# Fine.
} elsif ($needs_quoting == doesnt_matter) {
# Fine, these variables are assumed to not
# contain special characters.
} else {
$line->log_warning("The variable ${varname} should not be used in .for loops.");
$line->explain_warning(
"The .for loop splits its argument at sequences of white-space, as",
"opposed to all other places in make(1), which act like the shell.",
"Therefore only variables that are specifically designed to match this",
"requirement should be used here.");
}
}
if ($context->shellword != VUC_SHELLWORD_UNKNOWN && $needs_quoting != dont_know) {
# In GNU configure scripts, a few variables need to be
# passed through the :M* operator before they reach the
# configure scripts.
my $need_mstar = false;
if ($varname =~ regex_gnu_configure_volatile_vars) {
# When we are not checking a package, but some other file,
# the :M* operator is needed for safety.
if (!defined($pkgctx_vardef) || exists($pkgctx_vardef->{"GNU_CONFIGURE"})) {
$need_mstar = true;
}
}
my $stripped_mod = ($mod =~ qr"(.*?)(?::M\*)?(?::Q)?$") ? $1 : $mod;
my $correct_mod = $stripped_mod . ($need_mstar ? ":M*:Q" : ":Q");
if ($mod eq ":M*:Q" && !$need_mstar) {
$line->log_note("The :M* modifier is not needed here.");
} elsif ($mod ne $correct_mod && $needs_quoting == true) {
if ($context->shellword == VUC_SHELLWORD_PLAIN) {
$line->log_warning("Please use \${${varname}${correct_mod}} instead of \${${varname}${mod}}.");
#$line->replace("\${${varname}}", "\${${varname}:Q}");
} else {
$line->log_warning("Please use \${${varname}${correct_mod}} instead of \${${varname}${mod}} and make sure the variable appears outside of any quoting characters.");
}
$line->explain_warning("See the pkgsrc guide, section \"quoting guideline\", for details.");
}
if ($needs_quoting == false && $mod =~ qr":Q$") {
$line->log_warning("The :Q operator should not be used for \${${varname}} here.");
$line->explain_warning(
"When a variable of type ShellWord appears in a context that expects",
"a shell word, it does not need to have a :Q operator. Even when it",
"is concatenated with another variable, it still stays _one_ word.",
"",
"Example:",
"\tWORD1= Have\\ fun # 1 word",
"\tWORD2= \"with BSD Make\" # 1 word, too",
"",
"\tdemo:",
"\t\techo \${WORD1}\${WORD2} # still 1 word");
}
}
assert(defined($mkctx_build_defs), "The build_defs variable must be defined here.");
if (exists(get_userdefined_variables()->{$varname}) && !exists(get_system_build_defs()->{$varname}) && !exists($mkctx_build_defs->{$varname})) {
$line->log_warning("The user-defined variable ${varname} is used but not added to BUILD_DEFS.");
}
}
sub checkline_mk_text($$) {
my ($line, $text) = @_;
my ($rest, $state, $vartools, $depr_map);
if ($text =~ qr"^(?:[^#]*[^\$])?\$(\w+)") {
my ($varname) = ($1);
$line->log_warning("\$$varname is ambiguous. Use \${$varname} if you mean a Makefile variable or \$\$$varname if you mean a shell variable.");
}
if ($line->lines eq "1") {
checkline_rcsid_regex($line, qr"#\s+", "# ");
}
if ($text =~ qr"\$\{WRKSRC\}/\.\./") {
$line->log_warning("Using \"\${WRKSRC}/..\" is conceptually wrong. Please use a combination of WRKSRC, CONFIGURE_DIRS and BUILD_DIRS instead.");
$line->explain_warning(
"You should define WRKSRC such that all of CONFIGURE_DIRS, BUILD_DIRS",
"and INSTALL_DIRS are subdirectories of it.");
}
if ($text =~ qr"\b(-Wl,--rpath,|-Wl,-rpath-link,|-Wl,-rpath,|-Wl,-R)\b") {
$line->log_warning("Please use \${COMPILER_RPATH_FLAG} instead of $1.");
}
# Note: A simple -R is not detected, as the rate of false
# positives is too high.
$rest = $text;
$depr_map = get_deprecated_map();
while ($rest =~ s/(?:^|[^\$])\$\{([-A-Z0-9a-z_]+)(\.[\-0-9A-Z_a-z]+)?(?::[^\}]+)?\}//) {
my ($varbase, $varext) = ($1, $2);
my $varname = $varbase . (defined($varext) ? $varext : "");
my $varcanon = varname_canon($varname);
my $instead =
(exists($depr_map->{$varname})) ? $depr_map->{$varname}
: (exists($depr_map->{$varcanon})) ? $depr_map->{$varcanon}
: undef;
if (defined($instead)) {
$line->log_warning("Use of ${varname} is deprecated. ${instead}");
}
}
$rest = $text;
while ($rest =~ s/(?:^|[^\$])\$\(([-A-Z0-9a-z_]+)(?::[^\}]+)?\)//) {
my ($varname) = ($1);
$line->log_warning("Please use \${${varname}\} instead of \$(${varname}).");
}
}
sub checkline_mk_shellword($$$) {
my ($line, $shellword, $check_quoting) = @_;
my ($rest, $state, $value);
$opt_debug_trace and $line->log_debug("checkline_mk_shellword(\"${shellword}\", ${check_quoting}).");
use constant shellcommand_context_type => PkgLint::Type->new(
LK_NONE, "ShellCommand", [[ qr".*", "adsu" ]], NOT_GUESSED
);
use constant shellword_vuc => PkgLint::VarUseContext->new(
VUC_TIME_UNKNOWN,
shellcommand_context_type,
VUC_SHELLWORD_PLAIN,
VUC_EXTENT_WORD
);
if ($shellword =~ qr"^\$\{(${regex_varname})(:[^{}]+)?\}$") {
my ($varname, $mod) = ($1, $2);
checkline_mk_varuse($line, $varname, defined($mod) ? $mod : "", shellword_vuc);
return;
}
if ($shellword =~ qr"\$\{PREFIX\}/man(?:$|/)") {
$line->log_warning("Please use \${PKGMANDIR} instead of \"man\".");
}
# Note: SWST means [S]hell[W]ord [ST]ate
use enum qw(:SWST_ PLAIN SQUOT DQUOT DQUOT_BACKT BACKT);
use constant statename => [
"SWST_PLAIN", "SWST_SQUOT", "SWST_DQUOT",
"SWST_DQUOT_BACKT", "SWST_BACKT",
];
use constant user_statename => [
"unquoted string", "single quoted string",
"double quoted string", "backticks inside double quoted string",
"backticks",
];
$rest = ($shellword =~ qr"^#") ? "" : $shellword;
$state = SWST_PLAIN;
while ($rest ne "") {
$opt_debug_shell and $line->log_debug(statename->[$state] . ": ${rest}");
# When we are parsing inside backticks, it is more
# reasonable to check the whole shell command
# recursively, instead of splitting off the first
# make(1) variable (see the elsif below).
if ($state == SWST_BACKT) {
# Scan for the end of the backticks, checking
# for single backslashes and removing one level
# of backslashes. Backslashes are only removed
# before a dollar, a backslash or a backtick.
#
# References:
# * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_06_03
my $stripped = "";
while ($rest ne "") {
if ($rest =~ s/^\`//) {
last;
} elsif ($rest =~ s/^\\([\\\`\$])//) {
$stripped .= $1;
} elsif ($rest =~ s/^(\\)//) {
$line->log_warning("Backslashes should be doubled inside backticks.");
$stripped .= $1;
} elsif ($rest =~ s/^([^\\\`]+)//) {
$stripped .= $1;
} else {
assert(false, "rest=$rest");
}
}
# Check the resulting command.
checkline_mk_shelltext($line, $stripped);
# make(1) variables have the same syntax, no matter in
# which state we are currently.
} elsif ($rest =~ s/^\$\{(${regex_varname}|[\@])(:[^\{]+)?\}//
|| $rest =~ s/^\$\((${regex_varname}|[\@])(:[^\)]+)?\)//
|| $rest =~ s/^\$(\@)//) {
my ($varname, $mod) = ($1, $2);
if ($varname eq "\@") {
$line->log_warning("Please use \"\${.TARGET}\" instead of \"\$\@\".");
$line->explain_warning(
"The variable \$\@ can easily be confused with the shell variable of the",
"same name, which has a completely different meaning.");
$varname = ".TARGET";
}
if ($state == SWST_PLAIN && defined($mod) && $mod =~ qr":Q$") {
# Fine.
} elsif ($state == SWST_BACKT) {
# Don't check here, to avoid false positives
# for tool names.
} elsif (($state == SWST_SQUOT || $state == SWST_DQUOT) && $varname =~ qr"^(?:.*DIR|.*FILE|.*PATH|.*_VAR|PREFIX|.*BASE|PKGNAME)$") {
# This is ok if we don't allow these
# variables to have embedded [\$\\\"\'\`].
} elsif ($state == SWST_DQUOT && defined($mod) && $mod =~ qr":Q$") {
$line->log_warning("Please don't use the :Q operator in double quotes.");
$line->explain_warning(
"Either remove the :Q or the double quotes. In most cases, it is more",
"appropriate to remove the double quotes.");
}
my $ctx = PkgLint::VarUseContext->new_from_pool(
VUC_TIME_UNKNOWN,
shellcommand_context_type,
($state == SWST_PLAIN) ? VUC_SHELLWORD_PLAIN
: ($state == SWST_DQUOT) ? VUC_SHELLWORD_DQUOT
: ($state == SWST_SQUOT) ? VUC_SHELLWORD_SQUOT
: ($state == SWST_BACKT) ? VUC_SHELLWORD_BACKT
: VUC_SHELLWORD_UNKNOWN,
VUC_EXTENT_WORD_PART
);
if ($varname ne "\@") {
checkline_mk_varuse($line, $varname, defined($mod) ? $mod : "", $ctx);
}
} elsif ($state == SWST_PLAIN) {
if ($rest =~ s/^[!#\%&\(\)*+,\-.\/0-9:;<=>?\@A-Z\[\]^_a-z{|}~]+//) {
} elsif ($rest =~ s/^\'//) {
$state = SWST_SQUOT;
} elsif ($rest =~ s/^\"//) {
$state = SWST_DQUOT;
} elsif ($rest =~ s/^\`//) {
$state = SWST_BACKT;
} elsif ($rest =~ s/^\\(?:[ !"#'\(\)*;?\\^{|}]|\$\$)//) {
} elsif ($rest =~ s/^\$\$([0-9A-Z_a-z]+)//
|| $rest =~ s/^\$\$\{([0-9A-Z_a-z]+)\}//) {
my ($shvarname) = ($1);
if ($opt_warn_quoting && $check_quoting) {
$line->log_warning("Unquoted shell variable \"${shvarname}\".");
}
} elsif ($rest =~ s/^\$\@//) {
$line->log_warning("Please use \"\${.TARGET}\" instead of \"\$@\".");
$line->explain_warning(
"It is more readable and prevents confusion with the shell variable of",
"the same name.");
} elsif ($rest =~ s/^\$\$\@//) {
$line->log_warning("The \$@ shell variable should only be used in double quotes.");
} elsif ($rest =~ s/^\$\$\?//) {
$line->log_warning("The \$? shell variable is often not available in \"set -e\" mode.");
} elsif ($rest =~ s/^\$\$\(/(/) {
$line->log_warning("Invoking subshells via \$(...) is not portable enough.");
$line->explain_warning(
"The Solaris /bin/sh does not know this way to execute a command in a",
"subshell. Please use backticks (\`...\`) as a replacement.");
} else {
last;
}
} elsif ($state == SWST_SQUOT) {
if ($rest =~ s/^\'//) {
$state = SWST_PLAIN;
} elsif ($rest =~ s/^[^\$\']+//) {
} elsif ($rest =~ s/^\$\$//) {
} else {
last;
}
} elsif ($state == SWST_DQUOT) {
if ($rest =~ s/^\"//) {
$state = SWST_PLAIN;
} elsif ($rest =~ s/^[^\$"\\\`]+//) {
} elsif ($rest =~ s/^\\(?:[\\\"\`]|\$\$)//) {
} elsif ($rest =~ s/^\$\$\{([0-9A-Za-z_]+)\}//
|| $rest =~ s/^\$\$([0-9A-Z_a-z]+|[\$!#?\@])//) {
my ($shvarname) = ($1);
$opt_debug_shell and $line->log_debug("[checkline_mk_shellword] Found double-quoted variable ${shvarname}.");
} elsif ($rest =~ s/^\$\$//) {
$line->log_warning("Unquoted \$ or strange shell variable found.");
} elsif ($rest =~ s/^\\(.)//) {
my ($char) = ($1);
$line->log_warning("Please use \"\\\\${char}\" instead of \"\\${char}\".");
$line->explain_warning(
"Although the current code may work, it is not good style to rely on",
"the shell passing \"\\${char}\" exactly as is, and not discarding the",
"backslash. Alternatively you can use single quotes instead of double",
"quotes.");
} else {
last;
}
} else {
last;
}
}
if ($rest !~ qr"^\s*$") {
$line->log_error("Internal pkglint error: " . statename->[$state] . ": rest=${rest}");
}
}
# Some shell commands should not be used in the install phase.
#
sub checkline_mk_shellcmd_use($$) {
my ($line, $shellcmd) = @_;
use constant allowed_install_commands => array_to_hash(qw(
${INSTALL}
${INSTALL_DATA} ${INSTALL_DATA_DIR}
${INSTALL_LIB} ${INSTALL_LIB_DIR}
${INSTALL_MAN} ${INSTALL_MAN_DIR}
${INSTALL_PROGRAM} ${INSTALL_PROGRAM_DIR}
${INSTALL_SCRIPT}
${LIBTOOL}
${LN}
${PAX}
));
use constant discouraged_install_commands => array_to_hash(qw(
sed ${SED}
tr ${TR}
));
if (defined($mkctx_target) && $mkctx_target =~ qr"^(?:pre|do|post)-install") {
if (exists(allowed_install_commands->{$shellcmd})) {
# Fine.
} elsif (exists(discouraged_install_commands->{$shellcmd})) {
$line->log_warning("The shell command \"${shellcmd}\" should not be used in the install phase.");
$line->explain_warning(
"In the install phase, the only thing that should be done is to install",
"the prepared files to their final location. The file's contents should",
"not be changed anymore.");
} elsif ($shellcmd eq "\${CP}") {
$line->log_warning("\${CP} should not be used to install files.");
$line->explain_warning(
"The \${CP} command is highly platform dependent and cannot overwrite",
"files that don't have write permission. Please use \${PAX} instead.",
"",
"For example, instead of",
"\t\${CP} -R \${WRKSRC}/* \${PREFIX}/foodir",
"you should use",
"\tcd \${WRKSRC} && \${PAX} -wr * \${PREFIX}/foodir");
} else {
$opt_debug_misc and $line->log_debug("May \"${shellcmd}\" be used in the install phase?");
}
}
}
sub checkline_mk_shelltext($$) {
my ($line, $text) = @_;
my ($vartools, $state, $rest, $set_e_mode);
$opt_debug_trace and $line->log_debug("checkline_mk_shelltext(\"$text\")");
# Note: SCST is the abbreviation for [S]hell [C]ommand [ST]ate.
use constant scst => qw(
START CONT
INSTALL INSTALL_D
MKDIR
PAX PAX_S
SED SED_E
SET SET_CONT
COND COND_CONT
CASE CASE_IN CASE_LABEL CASE_LABEL_CONT CASE_PAREN
FOR FOR_IN FOR_CONT
ECHO
INSTALL_DIR INSTALL_DIR2
);
use enum (":SCST_", scst);
use constant scst_statename => [ map { $_ = "SCST_$_"; } scst ];
use constant forbidden_commands => array_to_hash(qw(
ktrace
strace
truss
));
if ($text =~ qr"\$\{SED\}" && $text =~ qr"\$\{MV\}") {
$line->log_note("Please use the SUBST framework instead of \${SED} and \${MV}.");
$line->explain_note(
"When converting things, pay attention to \"#\" characters. In shell",
"commands make(1) does not interpret them as comment character, but",
"in other lines it does. Therefore, instead of the shell command",
"",
"\tsed -e 's,#define foo,,'",
"",
"you need to write",
"",
"\tSUBST_SED.foo+=\t's,\\#define foo,,'");
}
if ($text =~ qr"^\@*-(.*(MKDIR|INSTALL.*-d|INSTALL_.*_DIR).*)") {
my ($mkdir_cmd) = ($1);
$line->log_note("You don't need to use \"-\" before ${mkdir_cmd}.");
}
$vartools = get_vartool_names();
$rest = $text;
use constant hidden_shell_commands => array_to_hash(qw(
${DELAYED_ERROR_MSG} ${DELAYED_WARNING_MSG}
${DO_NADA}
${ECHO} ${ECHO_MSG} ${ECHO_N} ${ERROR_CAT} ${ERROR_MSG}
${PHASE_MSG} ${PRINTF}
${SHCOMMENT} ${STEP_MSG}
${WARNING_CAT} ${WARNING_MSG}
));
if ($rest =~ s/^\s*([-@]*)(?:\$\{_PKG_SILENT\}\$\{_PKG_DEBUG\})?//) {
my ($hidden) = ($1);
if ($hidden !~ qr"\@") {
# Nothing is hidden at all.
} elsif (defined($mkctx_target) && $mkctx_target =~ qr"^(?:show-.*|.*-message)$") {
# In some targets commands may be hidden.
} elsif ($rest =~ $regex_shellword) {
my ($cmd) = ($1);
if (!exists(hidden_shell_commands->{$cmd})) {
$line->log_warning("The shell command \"${cmd}\" should not be hidden.");
$line->explain_warning(
"Hidden shell commands do not appear on the terminal or in the log file",
"when they are executed. When they fail, the error message cannot be",
"assigned to the command, which is very difficult to debug.");
}
}
if ($hidden =~ qr"-") {
$line->log_warning("The use of a leading \"-\" to suppress errors is deprecated.");
$line->explain_warning(
"If you really want to ignore any errors from this command (including",
"all errors you never thought of), append \"|| \${TRUE}\" to the",
"command.");
}
}
$state = SCST_START;
$set_e_mode = false;
while ($rest =~ s/^$regex_shellword//) {
my ($shellword) = ($1);
$opt_debug_shell and $line->log_debug(scst_statename->[$state] . ": ${shellword}");
checkline_mk_shellword($line, $shellword, !(
$state == SCST_CASE
|| $state == SCST_FOR_CONT
|| $state == SCST_SET_CONT
|| ($state == SCST_START && $shellword =~ regex_sh_varassign)));
#
# Actions associated with the current state
# and the symbol on the "input tape".
#
if ($state == SCST_START || $state == SCST_COND) {
my ($type);
if ($shellword eq "\${RUN}") {
# Just skip this one.
} elsif (exists(forbidden_commands->{$shellword})) {
$line->log_error("${shellword} is forbidden and must not be used.");
} elsif (exists(get_tool_names()->{$shellword})) {
if (!exists($mkctx_tools->{$shellword})) {
$line->log_warning("The \"${shellword}\" tool is used but not added to USE_TOOLS.");
}
if (exists(get_required_vartools()->{$shellword})) {
$line->log_warning("Please use \"\${" . get_vartool_names()->{$shellword} . "}\" instead of \"${shellword}\".");
}
checkline_mk_shellcmd_use($line, $shellword);
} elsif ($shellword =~ qr"^\$\{([\w_]+)\}$" && exists(get_varname_to_toolname()->{$1})) {
my ($vartool) = ($1);
my $plain_tool = get_varname_to_toolname()->{$vartool};
if (!exists($mkctx_tools->{$plain_tool})) {
$line->log_warning("The \"${plain_tool}\" tool is used but not added to USE_TOOLS.");
}
if (defined($mkctx_target) && $mkctx_target =~ qr"^(?:pre|do|post)-") {
if (!exists(get_required_vartool_varnames()->{$vartool})) {
$opt_warn_extra and $line->log_note("You can write \"${plain_tool}\" instead of \"${shellword}\".");
$opt_warn_extra and $line->explain_note(
"The wrapper framework from pkgsrc takes care that a sufficiently",
"capable implementation of that tool will be selected.");
}
}
checkline_mk_shellcmd_use($line, $shellword);
} elsif ($shellword =~ qr"^\$\{([\w_]+)\}$" && defined($type = get_variable_type($line, $1)) && $type->basic_type eq "ShellCommand") {
checkline_mk_shellcmd_use($line, $shellword);
} elsif ($shellword =~ qr"^(?:\(|\)|:|;|;;|&&|\|\||\{|\}|break|case|cd|continue|do|done|elif|else|esac|eval|exec|exit|export|fi|for|if|read|set|shift|then|umask|unset|while)$") {
# Shell builtins are fine.
} elsif ($shellword =~ qr"^[\w_]+=.*$") {
# Variable assignment.
} elsif ($shellword =~ qr"^\./.*$") {
# All commands from the current directory are fine.
} elsif ($shellword =~ qr"^#") {
my $semicolon = ($shellword =~ qr";");
my $multiline = ($line->lines =~ qr"--");
if ($semicolon) {
$line->log_warning("A shell comment should not contain semicolons.");
}
if ($multiline) {
$line->log_warning("A shell comment does not stop at the end of line.");
}
if ($semicolon || $multiline) {
$line->explain_warning(
"When you split a shell command into multiple lines that are continued",
"with a backslash, they will nevertheless be converted to a single line",
"before the shell sees them. That means that even if it _looks_ like that",
"the comment only spans one line in the Makefile, in fact it spans until",
"the end of the whole shell command. To insert a comment into shell code,",
"you can pass it as an argument to the \${SHCOMMENT} macro, which expands",
"to a command doing nothing. Note that any special characters are",
"nevertheless interpreted by the shell.");
}
} else {
$opt_warn_extra and $line->log_warning("Unknown shell command \"${shellword}\".");
$opt_warn_extra and $line->explain_warning(
"If you want your package to be portable to all platforms that pkgsrc",
"supports, you should only use shell commands that are covered by the",
"tools framework.");
}
}
if ($state == SCST_COND && $shellword eq "cd") {
$line->log_error("The Solaris /bin/sh cannot handle \"cd\" inside conditionals.");
$line->explain_error(
"When the Solaris shell is in \"set -e\" mode and \"cd\" fails, the",
"shell will exit, no matter if it is protected by an \"if\" or the",
"\"||\" operator.");
}
if (($state != SCST_PAX_S && $state != SCST_SED_E && $state != SCST_CASE_LABEL)) {
checkline_mk_absolute_pathname($line, $shellword);
}
if (($state == SCST_INSTALL_D || $state == SCST_MKDIR) && $shellword =~ qr"^\$\{PREFIX(?:|:Q)\}/") {
$line->log_warning("Please use one of the INSTALL_*_DIR commands instead of "
. (($state == SCST_MKDIR) ? "\${MKDIR}" : "\${INSTALL} -d")
. ".");
$line->explain_warning(
"Choose one of INSTALL_PROGRAM_DIR, INSTALL_SCRIPT_DIR, INSTALL_LIB_DIR,",
"INSTALL_MAN_DIR, INSTALL_DATA_DIR.");
}
if (($state == SCST_INSTALL_DIR || $state == SCST_INSTALL_DIR2) && $shellword !~ regex_mk_shellvaruse && $shellword =~ qr"^\$\{PREFIX(?:|:Q)\}/(.*)") {
my ($dirname) = ($1);
$opt_warn_extra and $line->log_note("You can use INSTALLATION_DIRS+= ${dirname} instead of this command.");
$opt_warn_extra and $line->explain_note(
"This saves you some typing. You also don't have to think about which of",
"the many INSTALL_*_DIR macros is appropriate, since INSTALLATION_DIRS",
"takes care of that.",
"",
"Note that you should only do this if the package creates _all_",
"directories it needs before trying to install files into them.");
}
if ($state == SCST_INSTALL_DIR2 && $shellword =~ qr"^\$") {
$line->log_warning("The INSTALL_*_DIR commands can only handle one directory at a time.");
$line->explain_warning(
"Many implementations of install(1) can handle more, but pkgsrc aims at",
"maximum portability.");
}
if ($state == SCST_PAX && $shellword eq "-pe") {
$line->log_warning("Please use the -pp option to pax(1) instead of -pe.");
$line->explain_warning(
"The -pe option tells pax to preserve the ownership of the files, which",
"means that the installed files will belong to the user that has built",
"the package. That's a Bad Thing.");
}
if ($state == SCST_PAX_S || $state == SCST_SED_E) {
if (false && $shellword !~ qr"^[\"\'].*[\"\']$") {
$line->log_warning("Substitution commands like \"${shellword}\" should always be quoted.");
$line->explain_warning(
"Usually these substitution commands contain characters like '*' or",
"other shell metacharacters that might lead to lookup of matching",
"filenames and then expand to more than one word.");
}
}
if ($state == SCST_ECHO && $shellword eq "-n") {
$line->log_warning("Please use \${ECHO_N} instead of \"echo -n\".");
}
if ($opt_warn_extra && $state != SCST_CASE_LABEL_CONT && $shellword eq "|") {
$line->log_warning("The exitcode of the left-hand-side command of the pipe operator is ignored.");
$line->explain_warning(
"If you need to detect the failure of the left-hand-side command, use",
"temporary files to save the output of the command.");
}
if ($opt_warn_extra && $shellword eq ";" && $state != SCST_COND_CONT && $state != SCST_FOR_CONT && !$set_e_mode) {
$line->log_warning("Please switch to \"set -e\" mode before using a semicolon to separate commands.");
$line->explain_warning(
"Older versions of the NetBSD make(1) had run the shell commands using",
"the \"-e\" option of /bin/sh. In 2004, this behavior has been changed to",
"follow the POSIX conventions, which is to not use the \"-e\" option.",
"The consequence of this change is that shell programs don't terminate",
"as soon as an error occurs, but try to continue with the next command.",
"Imagine what would happen for these commands:",
" cd \"\$HOME\"; cd /nonexistent; rm -rf *",
"To fix this warning, either insert \"set -e\" at the beginning of this",
"line or use the \"&&\" operator instead of the semicolon.");
}
#
# State transition.
#
if ($state == SCST_SET && $shellword =~ qr"^-.*e") {
$set_e_mode = true;
}
if ($state == SCST_START && $shellword eq "\${RUN}") {
$set_e_mode = true;
}
$state = ($shellword eq ";;") ? SCST_CASE_LABEL
# Note: The order of the following two lines is important.
: ($state == SCST_CASE_LABEL_CONT && $shellword eq "|") ? SCST_CASE_LABEL
: ($shellword =~ qr"^[;&\|]+$") ? SCST_START
: ($state == SCST_START) ? (
($shellword eq "\${INSTALL}") ? SCST_INSTALL
: ($shellword eq "\${MKDIR}") ? SCST_MKDIR
: ($shellword eq "\${PAX}") ? SCST_PAX
: ($shellword eq "\${SED}") ? SCST_SED
: ($shellword eq "\${ECHO}") ? SCST_ECHO
: ($shellword eq "\${RUN}") ? SCST_START
: ($shellword eq "echo") ? SCST_ECHO
: ($shellword eq "set") ? SCST_SET
: ($shellword =~ qr"^(?:if|elif|while)$") ? SCST_COND
: ($shellword =~ qr"^(?:then|else|do)$") ? SCST_START
: ($shellword eq "case") ? SCST_CASE
: ($shellword eq "for") ? SCST_FOR
: ($shellword eq "(") ? SCST_START
: ($shellword =~ qr"^\$\{INSTALL_[A-Z]+_DIR\}$") ? SCST_INSTALL_DIR
: ($shellword =~ regex_sh_varassign) ? SCST_START
: SCST_CONT)
: ($state == SCST_MKDIR) ? SCST_MKDIR
: ($state == SCST_INSTALL && $shellword eq "-d") ? SCST_INSTALL_D
: ($state == SCST_INSTALL || $state == SCST_INSTALL_D) ? (
($shellword =~ qr"^-[ogm]$") ? SCST_CONT
: $state)
: ($state == SCST_INSTALL_DIR) ? (
($shellword =~ qr"^-") ? SCST_CONT
: ($shellword =~ qr"^\$") ? SCST_INSTALL_DIR2
: $state)
: ($state == SCST_INSTALL_DIR2) ? $state
: ($state == SCST_PAX) ? (
($shellword eq "-s") ? SCST_PAX_S
: ($shellword =~ qr"^-") ? SCST_PAX
: SCST_CONT)
: ($state == SCST_PAX_S) ? SCST_PAX
: ($state == SCST_SED) ? (
($shellword eq "-e") ? SCST_SED_E
: ($shellword =~ qr"^-") ? SCST_SED
: SCST_CONT)
: ($state == SCST_SED_E) ? SCST_SED
: ($state == SCST_SET) ? SCST_SET_CONT
: ($state == SCST_SET_CONT) ? SCST_SET_CONT
: ($state == SCST_CASE) ? SCST_CASE_IN
: ($state == SCST_CASE_IN && $shellword eq "in") ? SCST_CASE_LABEL
: ($state == SCST_CASE_LABEL && $shellword eq "esac") ? SCST_CONT
: ($state == SCST_CASE_LABEL) ? SCST_CASE_LABEL_CONT
: ($state == SCST_CASE_LABEL_CONT && $shellword eq ")") ? SCST_START
: ($state == SCST_CONT) ? SCST_CONT
: ($state == SCST_COND) ? SCST_COND_CONT
: ($state == SCST_COND_CONT) ? SCST_COND_CONT
: ($state == SCST_FOR) ? SCST_FOR_IN
: ($state == SCST_FOR_IN && $shellword eq "in") ? SCST_FOR_CONT
: ($state == SCST_FOR_CONT) ? SCST_FOR_CONT
: ($state == SCST_ECHO) ? SCST_CONT
: do {
$line->log_warning("[" . scst_statename->[$state] . " ${shellword}] Keeping the current state.");
$state;
};
}
if ($rest !~ qr"^\s*$") {
$line->log_error("Internal pkglint error: " . scst_statename->[$state] . ": rest=${rest}");
}
}
sub checkline_mk_shellcmd($$) {
my ($line, $shellcmd) = @_;
checkline_mk_text($line, $shellcmd);
checkline_mk_shelltext($line, $shellcmd);
}
sub checkline_mk_vardef($$$) {
my ($line, $varname, $op) = @_;
$opt_debug_trace and $line->log_debug("checkline_mk_vardef(${varname}, ${op})");
# If we are checking a whole package, add it to the package-wide
# list of defined variables.
if (defined($pkgctx_vardef) && !exists($pkgctx_vardef->{$varname})) {
$pkgctx_vardef->{$varname} = $line;
}
# Add it to the file-wide list of defined variables.
if (!exists($mkctx_vardef->{$varname})) {
$mkctx_vardef->{$varname} = $line;
}
return unless $opt_warn_perm;
my $perms = get_variable_perms($line, $varname);
my $needed = { "=" => "s", "!=" => "s", "?=" => "d", "+=" => "a", ":=" => "s" }->{$op};
if (index($perms, $needed) == -1) {
$line->log_warning("Permission [${needed}] requested for ${varname}, but only [${perms}] is allowed.");
$line->explain_warning(
"The available permissions are:",
"\ta\tappend something using +=",
"\td\tset a default value using ?=",
"\ts\tset a variable using :=, =, !=",
"\tp\tuse a variable during preprocessing",
"\tu\tuse a variable at runtime",
"",
"A \"?\" means that it is not yet clear which permissions are allowed",
"and which aren't.");
}
}
sub checkline_mk_vartype_basic($$$$$$$$);
sub checkline_mk_vartype_basic($$$$$$$$) {
my ($line, $varname, $type, $op, $value, $comment, $list_context, $is_guessed) = @_;
my ($value_novar);
$opt_debug_trace and $line->log_debug(sprintf("checkline_mk_vartype_basic(%s, %s, %s, %s, %s, %s, %s)",
$varname, $type, $op, $value, defined($comment) ? $comment : "<undef>", $list_context, $is_guessed));
$value_novar = $value;
while ($value_novar =~ s/\$\{([^{}]*)\}//g) {
my ($pkgctx_varuse) = ($1);
if (!$list_context && $pkgctx_varuse =~ qr":Q$") {
$line->log_warning("The :Q operator should only be used in lists and shell commands.");
}
}
if (ref($type) eq "HASH") {
if (!exists($type->{$value})) {
$line->log_warning("\"${value}\" is not valid for ${varname}. Use one of ".join(" ", sort(keys(%{$type})))." instead.");
}
} elsif ($type eq "AwkCommand") {
$opt_debug_unchecked and $line->log_debug("Unchecked AWK command: ${value}");
} elsif ($type eq "BrokenIn") {
if ($value ne $value_novar) {
$line->log_error("${varname} must not refer to other variables.");
} elsif ($value =~ qr"^pkgsrc-(\d\d\d\d)Q(\d)$") {
my ($year, $quarter) = ($1, $2);
# Fine.
} else {
$line->log_warning("Invalid value \"${value}\" for ${varname}.");
}
$line->log_note("Please remove this line if the package builds for you.");
} elsif ($type eq "BuildlinkDepmethod") {
# Note: this cannot be replaced with { build full } because
# enumerations may not contain references to other variables.
if ($value ne $value_novar) {
# No checks yet.
} elsif ($value ne "build" && $value ne "full") {
$line->log_warning("Invalid dependency method \"${value}\". Valid methods are \"build\" or \"full\".");
}
} elsif ($type eq "BuildlinkDepth") {
if ($value ne "\${BUILDLINK_DEPTH}+"
&& $value ne "\${BUILDLINK_DEPTH:S/+\$//}") {
$line->log_warning("Invalid value for ${varname}.");
}
} elsif ($type eq "BuildlinkPackages") {
my $re_del = qr"\$\{BUILDLINK_PACKAGES:N(?:[+\-.0-9A-Z_a-z]|\$\{[^\}]+\})+\}";
my $re_add = qr"(?:[+\-.0-9A-Z_a-z]|\$\{[^\}]+\})+";
if (($op eq ":=" && $value =~ qr"^${re_del}$") ||
($op eq ":=" && $value =~ qr"^${re_del}\s+${re_add}$") ||
($op eq "+=" && $value =~ qr"^${re_add}$")) {
# Fine.
} else {
$line->log_warning("Invalid value for ${varname}.");
}
} elsif ($type eq "Category") {
my $allowed_categories = join("|", qw(
archivers audio
benchmarks biology
cad chat chinese comms converters cross crosspkgtools
databases devel
editors emulators
filesystems finance fonts
games geography gnome gnustep graphics
ham
inputmethod
japanese java
kde korean
lang linux
mail math mbone meta-pkgs misc multimedia
net news
packages parallel perl5 pkgtools plan9 print python
ruby
security shells sysutils
tcl textproc time tk
windowmaker wm www
x11 xmms
));
if ($value !~ qr"^(?:${allowed_categories})$") {
$line->log_error("Invalid category \"${value}\".");
}
} elsif ($type eq "CFlag") {
if ($value =~ qr"^-D([0-9A-Z_a-z]+)=(.*)") {
my ($macname, $macval) = ($1, $2);
# No checks needed, since the macro definitions
# are usually directory names, which don't need
# any quoting.
} elsif ($value =~ qr"^-[DU]([0-9A-Z_a-z]+)") {
my ($macname) = ($1);
$opt_debug_unchecked and $line->log_debug("Unchecked macro ${macname} in ${varname}.");
} elsif ($value =~ qr"^-I(.*)") {
my ($dirname) = ($1);
$opt_debug_unchecked and $line->log_debug("Unchecked directory ${dirname} in ${varname}.");
} elsif ($value eq "-c99") {
# Only works on IRIX, but is usually enclosed with
# the proper preprocessor conditional.
} elsif ($value =~ qr"^-[OWfgm]") {
$opt_debug_unchecked and $line->log_debug("Unchecked compiler flag ${value} in ${varname}.");
} elsif ($value =~ qr"^-.*") {
$line->log_warning("Unknown compiler flag \"${value}\".");
} elsif ($value =~ regex_unresolved) {
$opt_debug_unchecked and $line->log_debug("Unchecked CFLAG: ${value}");
} else {
$line->log_warning("Compiler flag \"${value}\" does not start with a dash.");
}
} elsif ($type eq "Comment") {
if ($value eq "SHORT_DESCRIPTION_OF_THE_PACKAGE") {
$line->log_error("COMMENT must be set.");
}
if ($value =~ qr"^(a|an)\s+"i) {
$line->log_warning("COMMENT should not begin with '$1'.");
}
if ($value =~ qr"^[a-z]") {
$line->log_warning("COMMENT should start with a capital letter.");
}
if ($value =~ qr"\.$") {
$line->log_warning("COMMENT should not end with a period.");
}
if (length($value) > 70) {
$line->log_warning("COMMENT should not be longer than 70 characters.");
}
} elsif ($type eq "Dependency") {
if ($value =~ qr"^(${regex_pkgbase})(<|=|>|<=|>=|!=)(${regex_pkgversion})$") {
my ($depbase, $op, $depversion) = ($1, $2, $3);
} elsif ($value =~ qr"^(${regex_pkgbase})-(\[.*\]\*|\d.*|\*)$") {
my ($depbase, $depversion) = ($1, $2);
if ($depversion eq "*") {
$line->log_warning("Please use ${depbase}-[0-9]* instead of ${depbase}-*.");
$line->explain_warning(
"If you use a * alone, the package specification may match other",
"packages that have the same prefix, but a longer name. For example,",
"foo-* matches foo-1.2, but also foo-client-1.2 and foo-server-1.2.");
} elsif ($depversion =~ qr"^\[.*\]$") {
if ($depversion ne "[0-9]*") {
$line->log_warning("Only [0-9]* is allowed in the numeric part of a dependency.");
}
} elsif ($depversion !~ qr"\[" && $depversion !~ qr"\.\*$") {
$line->log_warning("Error-prone dependency pattern \"${depversion}\".");
$line->explain_warning(
"Instead of 3*, you should either write write 3{,nb*} or 3.* if you",
"meant that. Otherwise, maybe you meant \"package>=3\"?");
} else {
# Great.
}
} elsif ($value =~ qr"\{") {
# Dependency patterns containing alternatives
# are just too hard to check.
$opt_debug_unchecked and $line->log_debug("Unchecked dependency pattern: ${value}");
} elsif ($value ne $value_novar) {
$opt_debug_unchecked and $line->log_debug("Unchecked dependency: ${value}");
} else {
$line->log_warning("Unknown dependency format: ${value}");
$line->explain_warning(
"Typical dependencies have the form \"package>=2.5\", \"package-[0-9]*\"",
"or \"package-3.141\".");
}
} elsif ($type eq "DependencyWithPath") {
if ($value =~ regex_unresolved) {
# don't even try to check anything
} elsif ($value =~ qr":(\.\./\.\./([^/]+)/([^/]+))$") {
my ($relpath, $cat, $pkg) = ($1, $2, $3);
checkline_relative_pkgdir($line, $relpath);
if ($pkg eq "msgfmt" || $pkg eq "gettext") {
$line->log_warning("Please use BUILD_USES_MSGFMT=yes instead of this dependency.");
} elsif ($pkg =~ qr"^perl\d+") {
$line->log_warning("Please use USE_TOOLS+=perl:run instead of this dependency.");
} elsif ($pkg eq "gmake") {
$line->log_warning("Please use USE_TOOLS+=gmake instead of this dependency.");
} elsif ($pkg =~ qr"^([-a-zA-Z0-9]+)-dirs[-><=]+(.*)$") {
my ($dirs, $version) = ($1, $2);
$line->log_warning("Please use USE_DIRS+=${dirs}-${version} instead of this dependency.");
}
} elsif ($value =~ qr":\.\./[^/]+$") {
$line->log_warning("Dependencies should have the form \"../../category/package\".");
$line->explain_warning(expl_relative_dirs);
} else {
$line->log_warning("Unknown dependency format.");
$line->explain_warning(
"Examples for valid dependencies are:",
" package-[0-9]*:../../category/package",
" package>=3.41:../../category/package",
" package-2.718:../../category/package");
}
} elsif ($type eq "DistSuffix") {
if ($value eq ".tar.gz") {
$line->log_note("${varname} is \".tar.gz\" by default, so this definition may be redundant.");
}
} elsif ($type eq "Filename") {
if ($value_novar =~ qr"/") {
$line->log_warning("A filename should not contain a slash.");
} elsif ($value_novar !~ qr"^[-0-9\@A-Za-z.,_~+%]*$") {
$line->log_warning("\"${value}\" is not a valid filename.");
}
} elsif ($type eq "Filemask") {
if ($value_novar !~ qr"^[-0-9A-Za-z._~+%*?]*$") {
$line->log_warning("\"${value}\" is not a valid filename mask.");
}
} elsif ($type eq "FileMode") {
if ($value ne "" && $value_novar eq "") {
# Fine.
} elsif ($value =~ qr"^[0-7]{3,4}") {
# Fine.
} else {
$line->log_warning("Invalid file mode ${value}.");
}
} elsif ($type eq "Identifier") {
if ($value ne $value_novar) {
#$line->log_warning("Identifiers should be given directly.");
}
if ($value_novar =~ qr"^[+\-.0-9A-Z_a-z]+$") {
# Fine.
} elsif ($value ne "" && $value_novar eq "") {
# Don't warn here.
} else {
$line->log_warning("Invalid identifier \"${value}\".");
}
} elsif ($type eq "Integer") {
if ($value !~ qr"^\d+$") {
$line->log_warning("${varname} must be a valid integer.");
}
} elsif ($type eq "LdFlag") {
if ($value =~ qr"^-L(.*)") {
my ($dirname) = ($1);
$opt_debug_unchecked and $line->log_debug("Unchecked directory ${dirname} in ${varname}.");
} elsif ($value =~ qr"^-l(.*)") {
my ($libname) = ($1);
$opt_debug_unchecked and $line->log_debug("Unchecked library name ${libname} in ${varname}.");
} elsif ($value =~ qr"^(?:-static)$") {
# Assume that the wrapper framework catches these.
} elsif ($value =~ qr"^(-Wl,(?:-R|-rpath|--rpath))") {
my ($rpath_flag) = ($1);
$line->log_warning("Please use \${COMPILER_RPATH_FLAG} instead of ${rpath_flag}.");
} elsif ($value =~ qr"^-.*") {
$line->log_warning("Unknown linker flag \"${value}\".");
} elsif ($value =~ regex_unresolved) {
$opt_debug_unchecked and $line->log_debug("Unchecked LDFLAG: ${value}");
} else {
$line->log_warning("Linker flag \"${value}\" does not start with a dash.");
}
} elsif ($type eq "License") {
use constant deprecated_licenses => array_to_hash(qw(
fee-based-commercial-use
no-commercial-use no-profit no-redistribution
shareware
));
my $license_file = "${cwd_pkgsrcdir}/licenses/${value}";
if (defined($pkgctx_vardef) && exists($pkgctx_vardef->{"LICENSE_FILE"})) {
my $license_file_line = $pkgctx_vardef->{"LICENSE_FILE"};
$license_file = "${current_dir}/" . resolve_relative_path($license_file_line->get("value"), false);
}
if (!-f $license_file) {
$line->log_warning("License file ".normalize_pathname($license_file)." does not exist.");
}
if (exists(deprecated_licenses->{$value})) {
$line->log_warning("License ${value} is deprecated.");
}
} elsif ($type eq "Mail_Address") {
if ($value =~ qr"^([+\-.0-9A-Z_a-z]+)\@([-\w\d.]+)$") {
my ($localpart, $domain) = ($1, $2);
if ($domain =~ qr"^NetBSD.org"i && $domain ne "NetBSD.org") {
$line->log_warning("Please write NetBSD.org instead of ${domain}.");
}
if ("${localpart}\@${domain}" =~ qr"^(tech-pkg|packages)\@NetBSD\.org$"i) {
$line->log_warning("${localpart}\@${domain} is deprecated. Use pkgsrc-users\@NetBSD.org instead.");
}
} else {
$line->log_warning("\"${value}\" is not a valid mail address.");
}
} elsif ($type eq "Message") {
if ($value =~ qr"^[\"'].*[\"']$") {
$line->log_warning("${varname} should not be quoted.");
}
} elsif ($type eq "Option") {
if ($value ne $value_novar) {
$opt_debug_unchecked and $line->log_debug("Unchecked option name \"${value}\".");
} elsif ($value_novar =~ qr"^-?([a-z][-0-9a-z]*)$") {
my ($optname) = ($1);
if (!exists(get_pkg_options()->{$optname})) {
$line->log_warning("Unknown option \"${value}\".");
$line->explain_warning(
"This option is not documented in the mk/defaults/options.description",
"file. If this is not a typo, please think of a brief but precise",
"description and ask on the tech-pkg\@NetBSD.org for inclusion in the",
"database.");
}
} elsif ($value_novar =~ qr"^-?([a-z][-0-9a-z_]*)$") {
my ($optname) = ($1);
$line->log_warning("Use of the underscore character in option names is deprecated.");
} else {
$line->log_error("\"${value}\" is not a valid option name.");
}
} elsif ($type eq "Pathlist") {
if ($value !~ qr":" && $is_guessed) {
checkline_mk_vartype_basic($line, $varname, "Pathname", $op, $value, $comment, $list_context, $is_guessed);
} else {
# XXX: The splitting will fail if $value contains any
# variables with modifiers, for example :Q or :S/././.
foreach my $p (split(qr":", $value)) {
my $p_novar = remove_variables($p);
if ($p_novar !~ qr"^[-0-9A-Za-z._~+%/]*$") {
$line->log_warning("\"${p}\" is not a valid pathname.");
}
if ($p !~ qr"^[\$/]") {
$line->log_warning("All components of ${varname} (in this case \"${p}\") should be an absolute path.");
}
}
}
} elsif ($type eq "Pathmask") {
if ($value_novar !~ qr"^[#\-0-9A-Za-z._~+%*?/\[\]]*$") {
$line->log_warning("\"${value}\" is not a valid pathname mask.");
}
checkline_mk_absolute_pathname($line, $value);
} elsif ($type eq "Pathname") {
if ($value_novar !~ qr"^[#\-0-9A-Za-z._~+%/]*$") {
$line->log_warning("\"${value}\" is not a valid pathname.");
}
checkline_mk_absolute_pathname($line, $value);
} elsif ($type eq "Perl5Packlist") {
if ($value ne $value_novar) {
$line->log_warning("${varname} should not depend on other variables.");
}
} elsif ($type eq "PkgName") {
if ($value eq $value_novar && $value !~ regex_pkgname) {
$line->log_warning("\"${value}\" is not a valid package name. A valid package name has the form packagename-version, where version consists only of digits, letters and dots.");
}
} elsif ($type eq "PkgOptionsVar") {
checkline_mk_vartype_basic($line, $varname, "Varname", $op, $value, $comment, false, $is_guessed);
if ($value =~ qr"\$\{PKGBASE[:\}]") {
$line->log_error("PKGBASE must not be used in PKG_OPTIONS_VAR.");
$line->explain_error(
"PKGBASE is defined in bsd.pkg.mk, which is included as the",
"very last file, but PKG_OPTIONS_VAR is evaluated earlier.",
"Use \${PKGNAME:C/-[0-9].*//} instead.");
}
} elsif ($type eq "PkgRevision") {
if ($value !~ qr"^[1-9]\d*$") {
$line->log_warning("${varname} must be a positive integer number.");
}
if ($line->fname !~ qr"(?:^|/)Makefile$") {
$line->log_error("${varname} must not be set outside the package Makefile.");
}
} elsif ($type eq "PlatformTriple") {
my $part = qr"(?:\[[^\]]+\]|[^-\[])+";
if ($value =~ qr"^(${part})-(${part})-(${part})$") {
my ($opsys, $os_version, $arch) = ($1, $2, $3);
if ($opsys !~ qr"^(?:\*|Darwin|DragonFly|FreeBSD|Interix|Linux|NetBSD|OpenBSD|SunOS|IRIX)$") {
$line->log_warning("Unknown operating system: ${opsys}");
}
# no check for $os_version
if ($arch !~ qr"^(?:\*|i386|alpha|amd64|arc|arm|arm32|cobalt|convex|dreamcast|hpcmips|hpcsh|hppa|ia64|m68k|m88k|mips|mips64|mipsel|mipseb|mipsn32|ns32k|pc532|pmax|powerpc|rs6000|s390|sparc|sparc64|vax|x86_64)$") {
$line->log_warning("Unknown hardware architecture: ${arch}");
}
} else {
$line->log_warning("\"${value}\" is not a valid platform triple.");
$line->explain_warning(
"A platform triple has the form <OPSYS>-<OS_VERSION>-<MACHINE_ARCH>.",
"Each of these components may be a shell globbing expression.",
"Examples: NetBSD-*-i386, *-*-*, Linux-*-*.");
}
} elsif ($type eq "PrefixPathname") {
if ($value =~ qr"^man/(.*)") {
my ($mansubdir) = ($1);
$line->log_warning("Please use \"\${PKGMANDIR}/${mansubdir}\" instead of \"${value}\".");
}
} elsif ($type eq "RelativePkgDir") {
checkline_relative_pkgdir($line, $value);
} elsif ($type eq "RelativePkgPath") {
checkline_relative_path($line, $value);
} elsif ($type eq "Restricted") {
if ($value ne "\${RESTRICTED}") {
$line->log_warning("The only valid value for this variable is \${RESTRICTED}.");
}
} elsif ($type eq "SVR4PkgName") {
if ($value =~ regex_unresolved) {
$line->log_error("SVR4_PKGNAME must not contain references to other variables.");
} elsif (length($value) > 5) {
$line->log_error("SVR4_PKGNAME must not be longer than 5 characters.");
}
} elsif ($type eq "SedCommand") {
} elsif ($type eq "SedCommands") {
my $words = shell_split($value);
if (!$words) {
$line->log_error("Invalid shell words in sed commands.");
$line->explain_error(
"If your sed commands have embedded \"#\" characters, you need to escape",
"them with a backslash, otherwise make(1) will interpret them as a",
"comment, no matter if they occur in single or double quotes or",
"whatever.");
} else {
my $nwords = scalar(@{$words});
my $ncommands = 0;
for (my $i = 0; $i < $nwords; $i++) {
my $word = $words->[$i];
checkline_mk_shellword($line, $word, true);
if ($word eq "-e") {
if ($i + 1 < $nwords) {
# Check the real sed command here.
$i++;
$ncommands++;
if ($ncommands > 1) {
$line->log_warning("Each sed command should appear in an assignment of its own.");
$line->explain_warning(
"For example, instead of",
" SUBST_SED.foo+= -e s,command1,, -e s,command2,,",
"use",
" SUBST_SED.foo+= -e s,command1,,",
" SUBST_SED.foo+= -e s,command2,,",
"",
"This way, short sed commands cannot be hidden at the end of a line.");
}
checkline_mk_shellword($line, $words->[$i - 1], true);
checkline_mk_shellword($line, $words->[$i], true);
checkline_mk_vartype_basic($line, $varname, "SedCommand", $op, $words->[$i], $comment, $list_context, $is_guessed);
} else {
$line->log_error("The -e option to sed requires an argument.");
}
} elsif ($word eq "-E") {
# Switch to extended regular expressions mode.
} elsif ($word eq "-n") {
# Don't print lines per default.
} elsif ($i == 0 && $word =~ qr"^([\"']?)(?:\d*|/.*/)s(.).*\2g?\1$") {
$line->log_warning("Please always use \"-e\" in sed commands, even if there is only one substitution.");
} else {
$line->log_warning("Unknown sed command ${word}.");
}
}
}
} elsif ($type eq "ShellCommand") {
checkline_mk_shelltext($line, $value);
} elsif ($type eq "ShellWord") {
if (!$list_context) {
checkline_mk_shellword($line, $value, true);
}
} elsif ($type eq "Stage") {
if ($value !~ qr"^(?:pre|do|post)-(?:extract|patch|configure|build|install)$") {
$line->log_warning("Invalid stage name. Use one of {pre,do,post}-{extract,patch,configure,build,install}.");
}
} elsif ($type eq "String") {
# No further checks possible.
} elsif ($type eq "Tool") {
if ($value =~ qr"^([-\w]+|\[)(?::(\w+))?$") {
my ($toolname, $tooldep) = ($1, $2);
if (!exists(get_tool_names()->{$toolname})) {
$line->log_error("Unknown tool \"${toolname}\".");
}
if (defined($tooldep) && $tooldep !~ qr"^(?:bootstrap|build|pkgsrc|run)$") {
$line->log_error("Unknown tool dependency \"${tooldep}\". Use one of \"build\", \"pkgsrc\" or \"run\".");
}
} else {
$line->log_error("Invalid tool syntax: \"${value}\".");
}
} elsif ($type eq "Unchecked") {
# Do nothing, as the name says.
} elsif ($type eq "URL") {
if ($value eq "" && defined($comment) && $comment =~ qr"^#") {
# Ok
} elsif ($value =~ qr"\$\{(MASTER_SITE_[^:]*).*:=(.*)\}$") {
my ($name, $subdir) = ($1, $2);
if (!exists(get_dist_sites_names()->{$name})) {
$line->log_error("${name} does not exist.");
}
if ($subdir !~ qr"/$") {
$line->log_error("The subdirectory in ${name} must end with a slash.");
}
} elsif ($value =~ regex_unresolved) {
# No further checks
} elsif ($value =~ qr"^(https?|ftp|gopher)://([-0-9A-Za-z.]+)(?::(\d+))?/([-%&+,./0-9:=?\@A-Z_a-z~]|#)*$") {
my ($proto, $host, $port, $path) = ($1, $2, $3, $4);
my $sites = get_dist_sites();
if ($host =~ qr"\.NetBSD\.org$"i && $host !~ qr"\.NetBSD\.org$") {
$line->log_warning("Please write NetBSD.org instead of ${host}.");
}
foreach my $site (keys(%{$sites})) {
if (index($value, $site) == 0) {
my $subdir = substr($value, length($site));
$line->log_warning(sprintf("Please use \${%s:=%s} instead of \"%s\".", $sites->{$site}, $subdir, $value));
last;
}
}
} elsif ($value =~ qr"^([0-9A-Za-z]+)://([^/]+)(.*)$") {
my ($scheme, $host, $abs_path) = ($1, $2, $3);
if ($scheme ne "ftp" && $scheme ne "http" && $scheme ne "gopher") {
$line->log_warning("\"${value}\" is not a valid URL. Only http, ftp and gopher URLs are allowed here.");
} elsif ($abs_path eq "") {
$line->log_note("For consistency, please add a trailing slash to \"${value}\".");
} else {
$line->log_warning("\"${value}\" is not a valid URL.");
}
} else {
$line->log_warning("\"${value}\" is not a valid URL.");
}
} elsif ($type eq "UserGroupName") {
if ($value ne $value_novar) {
# No checks for now.
} elsif ($value !~ qr"^[0-9_a-z]+$") {
$line->log_warning("Invalid user or group name \"${value}\".");
}
} elsif ($type eq "Varname") {
if ($value ne "" && $value_novar eq "") {
# The value of another variable
} elsif ($value_novar !~ qr"^[A-Z_][0-9A-Z_]*(?:[.].*)?$") {
$line->log_warning("\"${value}\" is not a valid variable name.");
}
} elsif ($type eq "Version") {
if ($value !~ qr"^([\d.])+$") {
$line->log_warning("Invalid version number \"${value}\".");
}
} elsif ($type eq "WrapperReorder") {
if ($value =~ qr"^reorder:l:([\w\-]+):([\w\-]+)$") {
my ($lib1, $lib2) = ($1, $2);
# Fine.
} else {
$line->log_warning("Unknown wrapper reorder command \"${value}\".");
}
} elsif ($type eq "WrapperTransform") {
if ($value =~ qr"^rm:(?:-[DILOUWflm].*|-std=.*)$") {
# Fine.
} elsif ($value =~ qr"^l:([^:]+):(.+)$") {
my ($lib, $replacement_libs) = ($1, $2);
# Fine.
} elsif ($value =~ qr"^'?(?:opt|rename|rm-optarg|rmdir):.*$") {
# FIXME: This is cheated.
# Fine.
} elsif ($value eq "-e" || $value =~ qr"^\"?'?s[|:,]") {
# FIXME: This is cheated.
# Fine.
} else {
$line->log_warning("Unknown wrapper transform command \"${value}\".");
}
} elsif ($type eq "WrkdirSubdirectory") {
checkline_mk_vartype_basic($line, $varname, "Pathname", $op, $value, $comment, $list_context, $is_guessed);
if ($value eq "\${WRKDIR}") {
# Fine.
} else {
$opt_debug_unchecked and $line->log_debug("Unchecked subdirectory \"${value}\" of \${WRKDIR}.");
}
} elsif ($type eq "WrksrcSubdirectory") {
if ($value =~ qr"^(\$\{WRKSRC\})(?:/(.*))?") {
my ($prefix, $rest) = ($1, $2);
$line->log_note("You can use \"" . (defined($rest) ? $rest : ".") . "\" instead of \"${value}\".");
} elsif ($value ne "" && $value_novar eq "") {
# The value of another variable
} elsif ($value_novar !~ qr"^(?:\.|[0-9A-Za-z][-0-9A-Za-z._/+]*)$") {
$line->log_warning("\"${value}\" is not a valid subdirectory of \${WRKSRC}.");
}
} elsif ($type eq "Yes") {
if ($value !~ qr"^(?:YES|yes)(?:\s+#.*)?$") {
$line->log_warning("${varname} should be set to YES or yes.");
$line->explain_warning(
"This variable means \"yes\" if it is defined, and \"no\" if it is",
"undefined. Even when it has the value \"no\", this means \"yes\".",
"Therefore when it is defined, its value should correspond to its",
"meaning.");
}
} elsif ($type eq "YesNo") {
if ($value !~ qr"^(?:YES|yes|NO|no)(?:\s+#.*)?$") {
$line->log_warning("${varname} should be set to YES, yes, NO, or no.");
}
} elsif ($type eq "YesNo_Indirectly") {
if ($value_novar ne "" && $value !~ qr"^(?:YES|yes|NO|no)(?:\s+#.*)?$") {
$line->log_warning("${varname} should be set to YES, yes, NO, or no.");
}
} else {
$line->log_fatal("Type ${type} unknown.");
}
}
# Checks whether the list of version numbers that are given as the
# C<value> of the variable C<varname> are in decreasing order.
sub checkline_decreasing_order($$$) {
my ($line, $varname, $value) = @_;
my @pyver = split(qr"\s+", $value);
if (!@pyver) {
$line->log_error("There must be at least one value for ${varname}.");
return;
}
my $ver = shift(@pyver);
if ($ver !~ qr"^\d+$") {
$line->log_error("All values for ${varname} must be numeric.");
return;
}
while (@pyver) {
my $nextver = shift(@pyver);
if ($nextver !~ qr"^\d+$") {
$line->log_error("All values for ${varname} must be numeric.");
return;
}
if ($nextver >= $ver) {
$line->log_warning("The values for ${varname} should be in decreasing order.");
$line->explain_warning(
"If they aren't, it may be possible that needless versions of packages",
"are installed.");
}
$ver = $nextver;
}
}
sub checkline_mk_vartype($$$$$) {
my ($line, $varname, $op, $value, $comment) = @_;
return unless $opt_warn_types;
my $vartypes = get_vartypes_map();
my $varbase = varname_base($varname);
my $varcanon = varname_canon($varname);
my $type = get_variable_type($line, $varname);
if ($op eq "+=") {
if (defined($type)) {
if (!$type->may_use_plus_eq()) {
$line->log_warning("The \"+=\" operator should only be used with lists.");
}
} elsif ($varbase !~ qr"^_" && $varbase !~ get_regex_plurals()) {
$line->log_warning("As ${varname} is modified using \"+=\", its name should indicate plural.");
}
}
if (!defined($type)) {
# Cannot check anything if the type is not known.
$opt_debug_unchecked and $line->log_debug("Unchecked variable assignment for ${varname}.");
} elsif ($op eq "!=") {
$opt_debug_misc and $line->log_debug("Use of !=: ${value}");
} elsif ($type->kind_of_list != LK_NONE) {
my (@words, $rest);
if ($type->kind_of_list == LK_INTERNAL) {
@words = split(qr"\s+", $value);
$rest = "";
} else {
@words = ();
$rest = $value;
while ($rest =~ s/^$regex_shellword//) {
my ($word) = ($1);
last if ($word =~ qr"^#");
push(@words, $1);
}
}
foreach my $word (@words) {
checkline_mk_vartype_basic($line, $varname, $type->basic_type, $op, $word, $comment, true, $type->is_guessed);
if ($type->kind_of_list != LK_INTERNAL) {
checkline_mk_shellword($line, $word, true);
}
}
if ($rest !~ qr"^\s*$") {
$line->log_error("Internal pkglint error: rest=${rest}");
}
} else {
checkline_mk_vartype_basic($line, $varname, $type->basic_type, $op, $value, $comment, $type->is_practically_a_list(), $type->is_guessed);
}
}
sub checkline_mk_varassign($$$$$) {
my ($line, $varname, $op, $value, $comment) = @_;
my ($used_vars);
my $varbase = varname_base($varname);
my $varcanon = varname_canon($varname);
$opt_debug_trace and $line->log_debug("checkline_mk_varassign($varname, $op, $value)");
checkline_mk_vardef($line, $varname, $op);
if ($op eq "?=" && defined($seen_bsd_prefs_mk) && !$seen_bsd_prefs_mk) {
if ($varbase eq "BUILDLINK_PKGSRCDIR"
|| $varbase eq "BUILDLINK_DEPMETHOD"
|| $varbase eq "BUILDLINK_ABI_DEPENDS") {
# FIXME: What about these ones? They occur quite often.
} else {
$opt_warn_extra and $line->log_warning("Please include \"../../mk/bsd.prefs.mk\" before using \"?=\".");
}
}
checkline_mk_text($line, $value);
checkline_mk_vartype($line, $varname, $op, $value, $comment);
# If the variable is not used and is untyped, it may be a
# spelling mistake.
if (defined($pkgctx_varuse)) {
my $vartypes = get_vartypes_map();
my $deprecated = get_deprecated_map();
if (exists($pkgctx_varuse->{$varname}) || exists($pkgctx_varuse->{$varcanon})) {
# Ok
} elsif (exists($vartypes->{$varname}) || exists($vartypes->{$varcanon})) {
# Ok
} elsif (exists($deprecated->{$varname}) || exists($deprecated->{$varcanon})) {
# Ok
} else {
$line->log_warning("${varname} is defined but not used. Spelling mistake?");
}
}
if (!$is_internal && $varname =~ qr"^_") {
$line->log_warning("Variable names starting with an underscore are reserved for internal pkgsrc use.");
}
if ($varname eq "PERL5_PACKLIST" && defined($effective_pkgbase) && $effective_pkgbase =~ qr"^p5-(.*)") {
my ($guess) = ($1);
$guess =~ s/-/\//g;
$guess = "auto/${guess}/.packlist";
my ($ucvalue, $ucguess) = (uc($value), uc($guess));
if ($ucvalue ne $ucguess && $ucvalue ne "\${PERL5_SITEARCH\}/${ucguess}") {
$line->log_warning("Unusual value for PERL5_PACKLIST -- \"${guess}\" expected.");
}
}
if ($varname eq "CONFIGURE_ARGS" && $value =~ qr"=\$\{PREFIX\}/share/kde") {
$line->log_note("Please .include \"../../meta-pkgs/kde3/kde3.mk\" instead of this line.");
$line->explain_note(
"That file probably does many things automatically and consistently that",
"this package also does. When using kde3.mk, you can probably also leave",
"out some explicit dependencies.");
}
if ($varname eq "EVAL_PREFIX" && $value =~ qr"^([\w_]+)=") {
my ($eval_varname) = ($1);
# This assignment will define the variable named
# $eval_varname. It is marked as known in the current
# file.
$mkctx_vardef->{$eval_varname} = $line;
}
if ($varname eq "PYTHON_VERSIONS_ACCEPTED") {
checkline_decreasing_order($line, $varname, $value);
}
if (defined($comment) && $comment eq "# defined" && $varname !~ qr".*(?:_MK|_COMMON)$") {
$line->log_note("Please use \"# empty\", \"# none\" or \"yes\" instead of \"# defined\".");
$line->explain_note(
"The value #defined says something about the state of the variable, but",
"not what that _means_. In some cases a variable that is defined means",
"\"yes\", in other cases it is an empty list (which is also only the",
"state of the variable), whose meaning could be described with \"none\".",
"It is this meaning that should be described.");
}
if ($value =~ qr"\$\{(PKGNAME|PKGVERSION)[:\}]") {
my ($pkgvarname) = ($1);
if ($varname =~ qr"^PKG_.*_REASON$") {
# ok
} elsif ($varname =~ qr"^(?:DIST_SUBDIR|WRKSRC)$") {
$line->log_warning("${pkgvarname} should not be used in ${varname}, as it sometimes includes the PKGREVISION. Please use ${pkgvarname}_NOREV instead.");
} else {
$opt_debug_misc and $line->log_debug("Use of PKGNAME in ${varname}.");
}
}
if (exists(get_deprecated_map()->{$varname})) {
$line->log_warning("Definition of ${varname} is deprecated. ".get_deprecated_map()->{$varname});
} elsif (exists(get_deprecated_map()->{$varcanon})) {
$line->log_warning("Definition of ${varname} is deprecated. ".get_deprecated_map()->{$varcanon});
}
if ($varname =~ qr"^SITES_") {
$line->log_warning("SITES_* is deprecated. Please use SITES.* instead.");
}
if ($value =~ qr"^[^=]\@comment") {
$line->log_warning("Please don't use \@comment in ${varname}.");
$line->explain_warning(
"Here you are defining a variable containing \@comment. As this value",
"typically includes a space as the last character you probably also used",
"quotes around the variable. This can lead to confusion when adding this",
"variable to PLIST_SUBST, as all other variables are quoted using the :Q",
"operator when they are appended. As it is hard to check whether a",
"variable that is appended to PLIST_SUBST is already quoted or not, you",
"should not have pre-quoted variables at all. To solve this, you should",
"directly use PLIST_SUBST+= ${varname}=${value} or use any other",
"variable for collecting the list of PLIST substitutions and later",
"append that variable with PLIST_SUBST+= \${MY_PLIST_SUBST}.");
}
use constant op_to_use_time => {
":=" => VUC_TIME_LOAD,
"!=" => VUC_TIME_LOAD,
"=" => VUC_TIME_RUN,
"+=" => VUC_TIME_RUN,
"?=" => VUC_TIME_RUN
};
$used_vars = extract_used_variables($line, $value);
my $vuc = PkgLint::VarUseContext->new(
op_to_use_time->{$op},
get_variable_type($line, $varname),
VUC_SHELLWORD_UNKNOWN, # XXX: maybe PLAIN?
VUC_EXTENT_UNKNOWN
);
foreach my $used_var (@{$used_vars}) {
checkline_mk_varuse($line, $used_var, "", $vuc);
}
}
#
# Procedures to check an array of lines.
#
sub checklines_trailing_empty_lines($) {
my ($lines) = @_;
my ($last, $max);
$max = $#{$lines} + 1;
for ($last = $max; $last > 1 && $lines->[$last - 1]->text eq ""; ) {
$last--;
}
if ($last != $max) {
$lines->[$last]->log_note("Trailing empty lines.");
}
}
sub checklines_package_Makefile_varorder($) {
my ($lines) = @_;
return unless $opt_warn_varorder;
use enum qw(once optional many);
my (@sections) = (
[ "Initial comments", once,
[
]
],
[ "Unsorted stuff, part 1", once,
[
[ "DISTNAME", once ],
[ "PKGNAME", optional ],
[ "PKGREVISION", optional ],
[ "SVR4_PKGNAME", optional ],
[ "CATEGORIES", once ],
[ "MASTER_SITES", once ],
[ "DIST_SUBDIR", optional ],
[ "EXTRACT_SUFX", optional ],
[ "DISTFILES", many ],
[ "SITES.*", many ],
]
],
[ "Distribution patches", optional,
[
[ "PATCH_SITES", optional ], # or once?
[ "PATCH_SITE_SUBDIR", optional ],
[ "PATCHFILES", optional ], # or once?
[ "PATCH_DIST_ARGS", optional ],
[ "PATCH_DIST_STRIP", optional ],
[ "PATCH_DIST_CAT", optional ],
]
],
[ "Unsorted stuff, part 2", once,
[
[ "MAINTAINER", once ],
[ "HOMEPAGE", optional ],
[ "COMMENT", once ],
]
],
[ "Legal issues", optional,
[
[ "LICENSE", once ],
[ "RESTRICTED", optional ],
[ "NO_BIN_ON_CDROM", optional ],
[ "NO_BIN_ON_FTP", optional ],
[ "NO_SRC_ON_CDROM", optional ],
[ "NO_SRC_ON_FTP", optional ],
]
],
[ "Technical restrictions", optional,
[
[ "NOT_FOR_PLATFORM", many ],
[ "ONLY_FOR_PLATFORM", many ],
[ "NOT_FOR_COMPILER", many ],
[ "ONLY_FOR_COMPILER", many ],
[ "NOT_FOR_UNPRIVILEGED", optional ],
[ "ONLY_FOR_UNPRIVILEGED", optional ],
]
],
[ "Dependencies", optional,
[
[ "BUILD_DEPENDS", many ],
[ "DEPENDS", many ],
]
]
);
if (!defined($seen_Makefile_common) || $seen_Makefile_common) {
return;
}
my ($lineno, $sectindex, $varindex) = (0, -1, 0);
my ($next_section, $vars, $below, $below_what) = (true, undef, {}, undef);
# If the current section is optional but contains non-optional
# fields, the complete section may be skipped as long as there
# has not been a non-optional variable.
my $may_skip_section = false;
# In each iteration, one of the following becomes true:
# - new.lineno > old.lineno
# - new.sectindex > old.sectindex
# - new.sectindex == old.sectindex && new.varindex > old.varindex
# - new.next_section == true && old.next_section == false
while ($lineno <= $#{$lines}) {
my $line = $lines->[$lineno];
my $text = $line->text;
$opt_debug_misc and $line->log_debug("[varorder] section ${sectindex} variable ${varindex}.");
if ($next_section) {
$next_section = false;
$sectindex++;
last if ($sectindex > $#sections);
$vars = $sections[$sectindex]->[2];
$may_skip_section = ($sections[$sectindex]->[1] == optional);
$varindex = 0;
}
if ($text =~ qr"^#") {
$lineno++;
} elsif ($line->has("varcanon")) {
my $varcanon = $line->get("varcanon");
if (exists($below->{$varcanon})) {
if (defined($below->{$varcanon})) {
$line->log_warning("${varcanon} appears too late. Please put it below $below->{$varcanon}.");
} else {
$line->log_warning("${varcanon} appears too late. It should be the very first definition.");
}
$lineno++;
next;
}
while ($varindex <= $#{$vars} && $varcanon ne $vars->[$varindex]->[0] && ($vars->[$varindex]->[1] != once || $may_skip_section)) {
if ($vars->[$varindex]->[1] == once) {
$may_skip_section = false;
}
$below->{$vars->[$varindex]->[0]} = $below_what;
$varindex++;
}
if ($varindex > $#{$vars}) {
if ($sections[$sectindex]->[1] != optional) {
$line->log_warning("Empty line expected.");
}
$next_section = true;
} elsif ($varcanon ne $vars->[$varindex]->[0]) {
$line->log_warning("Expected " . $vars->[$varindex]->[0] . ", but found " . $varcanon . ".");
$lineno++;
} else {
if ($vars->[$varindex]->[1] != many) {
$below->{$vars->[$varindex]->[0]} = $below_what;
$varindex++;
}
$lineno++;
}
$below_what = $varcanon;
} else {
while ($varindex <= $#{$vars}) {
if ($vars->[$varindex]->[1] == once && !$may_skip_section) {
$line->log_warning($vars->[$varindex]->[0] . " should be set here.");
}
$below->{$vars->[$varindex]->[0]} = $below_what;
$varindex++;
}
$next_section = true;
if ($text eq "") {
$below_what = "the previous empty line";
$lineno++;
}
}
}
}
sub checklines_mk($) {
my ($lines) = @_;
my ($allowed_targets) = ({});
my ($substcontext) = PkgLint::SubstContext->new();
assert(@{$lines} != 0, "checklines_mk may only be called with non-empty lines.");
$opt_debug_trace and log_debug($lines->[0]->fname, NO_LINES, "checklines_mk()");
# Define global variables for the Makefile context.
$mkctx_indentations = [0];
$mkctx_target = undef;
$mkctx_for_variables = {};
$mkctx_vardef = {};
$mkctx_build_defs = {};
$mkctx_tools = {%{get_predefined_tool_names()}};
foreach my $prefix (qw(pre do post)) {
foreach my $action (qw(fetch extract patch tools wrapper configure build test install package clean)) {
$allowed_targets->{"${prefix}-${action}"} = true;
}
}
#
# In the first pass, all additions to BUILD_DEFS and USE_TOOLS
# are collected to make the order of the definitions irrelevant.
#
foreach my $line (@{$lines}) {
if ($line->has("is_varassign") && $line->get("varname") eq "BUILD_DEFS") {
foreach my $varname (split(qr"\s+", $line->get("value"))) {
$mkctx_build_defs->{$varname} = true;
$opt_debug_misc and $line->log_debug("${varname} is added to BUILD_DEFS.");
}
}
if ($line->has("is_varassign") && $line->get("varname") eq "USE_TOOLS") {
foreach my $tool (split(qr"\s+", $line->get("value"))) {
$mkctx_tools->{$tool} = true;
$opt_debug_misc and $line->log_debug("${tool} is added to USE_TOOLS.");
}
}
}
#
# In the second pass, all "normal" checks are done.
#
if (0 <= $#{$lines}) {
checkline_rcsid_regex($lines->[0], qr"^#\s+", "# ");
}
foreach my $line (@{$lines}) {
my $text = $line->text;
checkline_trailing_whitespace($line);
checkline_spellcheck($line);
if ($line->has("is_empty")) {
$substcontext->check_end($line);
} elsif ($line->has("is_comment")) {
# No further checks.
} elsif ($text =~ regex_varassign) {
my ($varname, $op, undef, $comment) = ($1, $2, $3, $4);
my $space1 = substr($text, $+[1], $-[2] - $+[1]);
my $align = substr($text, $+[2], $-[3] - $+[2]);
my $value = $line->get("value");
if ($align !~ qr"^(\t*|[ ])$") {
$opt_warn_space && $line->log_note("Alignment of variable values should be done with tabs, not spaces.");
my $prefix = "${varname}${space1}${op}";
my $aligned_len = tablen("${prefix}${align}");
if ($aligned_len % 8 == 0) {
my $tabalign = ("\t" x (($aligned_len - tablen($prefix) + 7) / 8));
$line->replace("${prefix}${align}", "${prefix}${tabalign}");
}
}
checkline_mk_varassign($line, $varname, $op, $value, $comment);
$substcontext->check_varassign($line, $varname, $op, $value);
} elsif ($text =~ regex_mk_shellcmd) {
my ($shellcmd) = ($1);
checkline_mk_shellcmd($line, $shellcmd);
} elsif ($text =~ regex_mk_include) {
my ($includefile) = ($1);
$opt_debug_include and $line->log_debug("includefile=${includefile}");
checkline_relative_path($line, $includefile);
if ($includefile =~ qr"../Makefile$") {
$line->log_error("Other Makefiles must not be included.");
$line->explain_warning(
"If you want to include portions of another Makefile, extract",
"the common parts and put them into a Makefile.common. After",
"that, both this one and the other package should include the",
"Makefile.common.");
}
if ($includefile eq "../../mk/bsd.prefs.mk") {
if ($line->fname =~ qr"buildlink3\.mk$") {
$line->log_note("For efficiency reasons, please include bsd.fast.prefs.mk instead of bsd.prefs.mk.");
}
$seen_bsd_prefs_mk = true;
} elsif ($includefile eq "../../mk/bsd.fast.prefs.mk") {
$seen_bsd_prefs_mk = true;
}
if ($includefile =~ qr"/x11-links/buildlink3\.mk$") {
$line->log_error("${includefile} must not be included directly. Include \"../../mk/x11.buildlink3.mk\" instead.");
}
if ($includefile =~ qr"/intltool/buildlink3\.mk$") {
$line->log_warning("Please say \"USE_TOOLS+= intltool\" instead of this line.");
}
if ($includefile =~ qr"(.*)/builtin\.mk$") {
my ($dir) = ($1);
$line->log_error("${includefile} must not be included directly. Include \"${dir}/buildlink3.mk\" instead.");
}
} elsif ($text =~ regex_mk_sysinclude) {
my ($includefile, $comment) = ($1, $2);
# No further action.
} elsif ($text =~ regex_mk_cond) {
my ($indent, $directive, $args, $comment) = ($1, $2, $3, $4);
use constant regex_directives_with_args => qr"^(?:if|ifdef|ifndef|elif|for|undef)$";
if ($directive =~ qr"^(?:endif|endfor|elif|else)$") {
if ($#{$mkctx_indentations} >= 1) {
pop(@{$mkctx_indentations});
} else {
$line->log_error("Unmatched .${directive}.");
}
}
# Check the indentation
if ($indent ne " " x $mkctx_indentations->[-1]) {
$opt_warn_space and $line->log_note("This directive should be indented by ".$mkctx_indentations->[-1]." spaces.");
}
if ($directive eq "if" && $args =~ qr"^!defined\([\w]+_MK\)$") {
push(@{$mkctx_indentations}, $mkctx_indentations->[-1]);
} elsif ($directive =~ qr"^(?:if|ifdef|ifndef|for|elif|else)$") {
push(@{$mkctx_indentations}, $mkctx_indentations->[-1] + 2);
}
if ($directive =~ regex_directives_with_args && !defined($args)) {
$line->log_error("\".${directive}\" must be given some arguments.");
} elsif ($directive !~ regex_directives_with_args && defined($args)) {
$line->log_error("\".${directive}\" does not take arguments.");
if ($directive eq "else") {
$line->log_note("If you meant \"else if\", use \".elif\".");
}
} elsif ($directive eq "if" || $directive eq "elif") {
$opt_debug_unchecked and $line->log_debug("Unchecked conditional \"${args}\".");
} elsif ($directive eq "ifdef" || $directive eq "ifndef") {
if ($args =~ qr"\s") {
$line->log_error("The \".${directive}\" directive can only handle _one_ argument.");
} else {
$line->log_warning("The \".${directive}\" directive is deprecated. Please use \".if "
. (($directive eq "ifdef" ? "" : "!"))
. "defined(${args})\" instead.");
}
} elsif ($directive eq "for") {
if ($args =~ qr"^(\S+(?:\s*\S+)*?)\s+in\s+(.*)$") {
my ($vars, $values) = ($1, $2);
foreach my $var (split(qr"\s+", $vars)) {
if (!$is_internal && $var =~ qr"^_") {
$line->log_warning("Variable names starting with an underscore are reserved for internal pkgsrc use.");
}
if ($var =~ qr"^[_a-z][_a-z0-9]*$") {
# Fine.
} elsif ($var =~ qr"[A-Z]") {
$line->log_warning(".for variable names should not contain uppercase letters.");
} else {
$line->log_error("Invalid variable name \"${var}\".");
}
$mkctx_for_variables->{$var} = true;
}
# Check if any of the value's types is not guessed.
my $guessed = true;
foreach my $value (split(qr"\s+", $values)) { # XXX: too simple
if ($value =~ qr"^\$\{(.*)\}") {
my $type = get_variable_type($line, $1);
if (defined($type) && !$type->is_guessed()) {
$guessed = false;
}
}
}
my $for_loop_type = PkgLint::Type->new(
LK_INTERNAL,
"Unchecked",
[[qr".*", "pu"]],
$guessed
);
my $for_loop_context = PkgLint::VarUseContext->new(
VUC_TIME_LOAD,
$for_loop_type,
VUC_SHELLWORD_FOR,
VUC_EXTENT_WORD
);
foreach my $var (@{extract_used_variables($line, $values)}) {
checkline_mk_varuse($line, $var, "", $for_loop_context);
}
}
} elsif ($directive eq "undef" && defined($args)) {
foreach my $var (split(qr"\s+", $args)) {
if (exists($mkctx_for_variables->{$var})) {
$line->log_note("Using \".undef\" after a \".for\" loop is unnecessary.");
}
}
}
} elsif ($text =~ regex_mk_dependency) {
my ($targets, $dependencies) = ($1, $2);
$opt_debug_misc and $line->log_debug("targets=${targets}, dependencies=${dependencies}");
$mkctx_target = $targets;
foreach my $source (split(/\s+/, $dependencies)) {
if ($source eq ".PHONY") {
foreach my $target (split(/\s+/, $targets)) {
$allowed_targets->{$target} = true;
}
}
}
foreach my $target (split(/\s+/, $targets)) {
if ($target eq ".PHONY") {
foreach my $dep (split(qr"\s+", $dependencies)) {
$allowed_targets->{$dep} = true;
}
} elsif ($target eq ".ORDER") {
# TODO: Check for spelling mistakes.
} elsif (!exists($allowed_targets->{$target})) {
$line->log_warning("Unusual target \"${target}\".");
$line->explain_warning(
"If you really want to define your own targets, you can \"declare\"",
"them by inserting a \".PHONY: my-target\" line before this line. This",
"will tell make(1) to not interpret this target's name as a filename.");
}
}
} elsif ($text =~ qr"^\.\s*(\S*)") {
my ($directive) = ($1);
$line->log_error("Unknown directive \".${directive}\".");
} elsif ($text =~ qr"^ ") {
$line->log_warning("Makefile lines should not start with space characters.");
$line->explain_warning(
"If you want this line to contain a shell program, use a tab",
"character for indentation. Otherwise please remove the leading",
"white-space.");
} else {
$line->log_error("[Internal] Unknown line format: $text");
}
}
if (@{$lines} > 0) {
$substcontext->check_end($lines->[-1]);
}
checklines_trailing_empty_lines($lines);
if ($#{$mkctx_indentations} != 0) {
$lines->[-1]->log_error("Directive indentation is not 0, but ".$mkctx_indentations->[-1]." at EOF.");
}
# Clean up global variables.
$mkctx_for_variables = undef;
$mkctx_indentations = undef;
$mkctx_target = undef;
$mkctx_vardef = undef;
$mkctx_build_defs = undef;
$mkctx_tools = undef;
}
sub checklines_buildlink3_inclusion($) {
my ($lines) = @_;
my ($included_files);
assert(@{$lines} != 0, "The lines array must be non-empty.");
$opt_debug_trace and log_debug($lines->[0]->fname, NO_LINES, "checklines_buildlink3_inclusion()");
if (!defined($pkgctx_bl3)) {
return;
}
# Collect all the included buildlink3.mk files from the file.
$included_files = {};
foreach my $line (@{$lines}) {
if ($line->text =~ regex_mk_include) {
my ($file, $comment) = ($1, $2);
if ($file =~ qr"^\.\./\.\./(.*)/buildlink3\.mk") {
my ($bl3) = ($1);
$included_files->{$bl3} = $line;
if (!exists($pkgctx_bl3->{$bl3})) {
$line->log_warning("${bl3}/buildlink3.mk is included by this file but not by the package.");
}
}
}
}
# Print debugging messages for all buildlink3.mk files that are
# included by the package but not by this buildlink3.mk file.
foreach my $package_bl3 (sort(keys(%{$pkgctx_bl3}))) {
if (!exists($included_files->{$package_bl3})) {
$opt_debug_misc and $pkgctx_bl3->{$package_bl3}->log_debug("${package_bl3}/buildlink3.mk is included by the package but not by the buildlink3.mk file.");
}
}
}
#
# Procedures to check a single file.
#
sub checkfile_ALTERNATIVES($) {
my ($fname) = @_;
my ($lines);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_ALTERNATIVES()");
checkperms($fname);
if (!($lines = load_file($fname))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
}
sub checkfile_buildlink3_mk($) {
my ($fname) = @_;
my ($lines, $lineno, $m);
my ($bl_PKGBASE_line, $bl_PKGBASE);
my ($bl_pkgbase_line, $bl_pkgbase);
my ($abi_line, $abi_pkg, $abi_version);
my ($api_line, $api_pkg, $api_version);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_buildlink3_mk()");
checkperms($fname);
if (!($lines = load_lines($fname, true))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
if (@{$lines} == 0) {
log_error($fname, NO_LINES, "Must not be empty.");
return;
}
parselines_mk($lines);
checklines_mk($lines);
$lineno = 0;
# Header comments
while ($lineno <= $#{$lines} && (my $text = $lines->[$lineno]->text) =~ qr"^#") {
if ($text =~ qr"^# XXX") {
$lines->[$lineno]->log_note("Please read this comment and remove it if appropriate.");
}
$lineno++;
}
expect_empty_line($lines, \$lineno);
# This line does not belong here, but appears often.
if (expect($lines, \$lineno, qr"^BUILDLINK_DEPMETHOD\.(\S+)\?=.*$")) {
$lines->[$lineno - 1]->log_warning("This line belongs in the fourth paragraph.");
while ($lines->[$lineno]->text eq "") {
$lineno++;
}
}
# First paragraph: Reference counters.
if (!expect($lines, \$lineno, qr"^BUILDLINK_DEPTH:=\t+\$\{BUILDLINK_DEPTH\}\+$")) {
lines_log_warning($lines, $lineno, "Expected BUILDLINK_DEPTH:= \${BUILDLINK_DEPTH}+.");
return;
}
if (($m = expect($lines, \$lineno, qr"^(.*)_BUILDLINK3_MK:=\t+\$\{\1_BUILDLINK3_MK\}\+$"))) {
$bl_PKGBASE_line = $lines->[$lineno - 1];
$bl_PKGBASE = $m->text(1);
$opt_debug_misc and $bl_PKGBASE_line->log_debug("bl_PKGBASE=${bl_PKGBASE}");
} else {
lines_log_warning($lines, $lineno, "Expected {PKGNAME}_BUILDLINK3_MK:= \${{PKGNAME}_BUILDLINK3_MK}+.");
return;
}
expect_empty_line($lines, \$lineno);
# Second paragraph: Adding the dependency.
if (!expect($lines, \$lineno, qr"^\.if !empty\(BUILDLINK_DEPTH:M\+\)$")) {
if (!expect_text($lines, \$lineno, ".if \${BUILDLINK_DEPTH} == \"+\"")) {
return;
}
}
if (($m = expect($lines, \$lineno, qr"^BUILDLINK_DEPENDS\+=\t+(\S+)$"))) {
$bl_pkgbase_line = $lines->[$lineno - 1];
$bl_pkgbase = $m->text(1);
$opt_debug_misc and $bl_pkgbase_line->log_debug("bl_pkgbase=${bl_pkgbase}");
} else {
lines_log_warning($lines, $lineno, "BUILDLINK_DEPENDS line expected.");
return;
}
my $norm_bl_pkgbase = $bl_pkgbase;
$norm_bl_pkgbase =~ s/-/_/g;
$norm_bl_pkgbase = uc($norm_bl_pkgbase);
if ($norm_bl_pkgbase ne $bl_PKGBASE) {
$bl_PKGBASE_line->log_error("Package name mismatch between ${bl_PKGBASE} ...");
$bl_pkgbase_line->log_error("... and ${bl_pkgbase}.");
}
if (defined($effective_pkgbase) && $effective_pkgbase ne $bl_pkgbase) {
$bl_pkgbase_line->log_error("Package name mismatch between ${bl_pkgbase} ...");
$effective_pkgname_line->log_error("... and ${effective_pkgbase}.");
}
if (!expect_text($lines, \$lineno, ".endif")) {
return;
}
expect_empty_line($lines, \$lineno);
# Third paragraph: Duplicate elimination.
if (expect($lines, \$lineno, qr"^BUILDLINK_PACKAGES:=\t+\$\{BUILDLINK_PACKAGES:N\Q${bl_pkgbase}\E\}\s+\Q${bl_pkgbase}\E$")) {
# The compressed form of duplicate elimination.
} else {
if (!expect($lines, \$lineno, qr"^BUILDLINK_PACKAGES:=\t+\$\{BUILDLINK_PACKAGES:N\Q${bl_pkgbase}\E\}$")) {
lines_log_warning($lines, $lineno, "Expected BUILDLINK_PACKAGES:= \${BUILDLINK_PACKAGES:N${bl_pkgbase}} line.");
return;
}
if (!expect($lines, \$lineno, qr"^BUILDLINK_PACKAGES\+=\t+\Q${bl_pkgbase}\E$")) {
lines_log_warning($lines, $lineno, "Expected BUILDLINK_PACKAGES+= ${bl_pkgbase} line.");
return;
}
}
expect_text($lines, \$lineno, "BUILDLINK_ORDER:=\t\${BUILDLINK_ORDER} \${BUILDLINK_DEPTH}${bl_pkgbase}");
expect_empty_line($lines, \$lineno);
# Fourth paragraph: Package information.
if (!expect($lines, \$lineno, qr"^\.if !empty\(\Q${bl_PKGBASE}\E_BUILDLINK3_MK:M\+\)$")) {
if (!expect_text($lines, \$lineno, ".if \${${bl_PKGBASE}_BUILDLINK3_MK} == \"+\"")) {
return;
}
}
while (!expect($lines, \$lineno, qr"^\.endif.*$")) {
if ($lineno > $#{$lines}) {
lines_log_warning($lines, $lineno, "Expected .endif");
return;
}
my $line = $lines->[$lineno];
if (($m = expect($lines, \$lineno, regex_varassign))) {
my ($varname, $value) = ($m->text(1), $m->text(3));
my $do_check = false;
if ($varname eq "BUILDLINK_ABI_DEPENDS.${bl_pkgbase}") {
$abi_line = $line;
if ($value =~ regex_dependency_gt) {
($abi_pkg, $abi_version) = ($1, $2);
} elsif ($value =~ regex_dependency_wildcard) {
($abi_pkg) = ($1);
} else {
$opt_debug_unchecked and $line->log_debug("Unchecked dependency pattern \"${value}\".");
}
$do_check = true;
}
if ($varname eq "BUILDLINK_API_DEPENDS.${bl_pkgbase}") {
$api_line = $line;
if ($value =~ regex_dependency_gt) {
($api_pkg, $api_version) = ($1, $2);
} elsif ($value =~ regex_dependency_wildcard) {
($api_pkg) = ($1);
} else {
$opt_debug_unchecked and $line->log_debug("Unchecked dependency pattern \"${value}\".");
}
$do_check = true;
}
if ($do_check && defined($abi_pkg) && defined($api_pkg)) {
if ($abi_pkg ne $api_pkg) {
$abi_line->log_warning("Package name mismatch between ${abi_pkg} ...");
$api_line->log_warning("... and ${api_pkg}.");
}
}
if ($do_check && defined($abi_version) && defined($api_version)) {
if (!dewey_cmp($abi_version, ">=", $api_version)) {
$abi_line->log_warning("ABI version (${abi_version}) should be at least ...");
$api_line->log_warning("... API version (${api_version}).");
}
}
if ($varname =~ qr"^BUILDLINK_[\w_]+\.(.*)$") {
my ($varparam) = ($1);
if ($varparam ne $bl_pkgbase) {
$line->log_warning("Only buildlink variables for ${bl_pkgbase}, not ${varparam} may be set in this file.");
}
}
# TODO: More checks.
} elsif (expect($lines, \$lineno, qr"^(?:#.*)?$")) {
# Comments and empty lines are fine here.
} else {
$opt_debug_unchecked and lines_log_warning($lines, $lineno, "Unchecked line in fourth paragraph.");
$lineno++;
}
}
if (!defined($api_line)) {
$lines->[$lineno - 1]->log_warning("Definition of BUILDLINK_API_DEPENDS is missing.");
}
expect_empty_line($lines, \$lineno);
# Fifth paragraph (optional): Dependencies.
my $have_dependencies = false;
my $need_empty_line = false;
while (true) {
if (expect($lines, \$lineno, qr"^\.\s*include \"\.\./\.\./([^/]+/[^/]+)/buildlink3\.mk\"$")
|| expect($lines, \$lineno, qr"^\.\s*include \"\.\./\.\./mk/(\S+)\.buildlink3\.mk\"$")
|| expect($lines, \$lineno, qr"^\.if !empty\(PKG_BUILD_OPTIONS\.\Q${bl_pkgbase}\E:M\S+\)$")
|| expect($lines, \$lineno, qr"^\.endif$")) {
$have_dependencies = true;
$need_empty_line = true;
} elsif ($have_dependencies && expect($lines, \$lineno, qr"^$")) {
$need_empty_line = false;
} else {
last;
}
}
if ($need_empty_line) {
expect_empty_line($lines, \$lineno);
}
# Sixth paragraph: Reference counter.
if (!expect($lines, \$lineno, qr"^BUILDLINK_DEPTH:=\t+\$\{BUILDLINK_DEPTH:S/\+\$//\}$")) {
lines_log_warning($lines, $lineno, "Expected BUILDLINK_DEPTH:= \${BUILDLINK_DEPTH:S/+\$//}.");
explain_warning($lines, $lineno,
"Everything besides the .include lines for the buildlink3.mk files of",
"dependencies should go between the .if !empty({PKGNAME}_BUILDLINK3_MK)",
"and the corresponding .endif.");
return;
}
if ($lineno <= $#{$lines}) {
$lines->[$lineno]->log_warning("The file should end here.");
}
checklines_buildlink3_inclusion($lines);
}
sub checkfile_DESCR($) {
my ($fname) = @_;
my ($maxchars, $maxlines) = (80, 24);
my ($lines);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_DESCR()");
checkperms($fname);
if (!($lines = load_file($fname))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
if (@{$lines} == 0) {
log_error($fname, NO_LINE_NUMBER, "Must not be empty.");
return;
}
foreach my $line (@{$lines}) {
checkline_length($line, $maxchars);
checkline_trailing_whitespace($line);
checkline_valid_characters($line, regex_validchars);
checkline_spellcheck($line);
if ($line->text =~ qr"\$\{") {
$line->log_warning("Variables are not expanded in the DESCR file.");
}
}
checklines_trailing_empty_lines($lines);
if (@{$lines} > $maxlines) {
my $line = $lines->[$maxlines];
$line->log_warning("File too long (should be no more than $maxlines lines).");
$line->explain_warning(
"A common terminal size is 80x25 characters. The DESCR file should",
"fit on one screen. It is also intended to give a _brief_ summary",
"about the package's contents.");
}
autofix($lines);
}
sub checkfile_distinfo($) {
my ($fname) = @_;
my ($lines, %in_distinfo, $current_fname, $state, $patches_dir);
my ($di_is_committed);
use enum qw(:DIS_ start=0 SHA1=0 RMD160 Size);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_distinfo()");
$di_is_committed = is_committed($fname);
checkperms($fname);
if (!($lines = load_file($fname))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
if (@{$lines} == 0) {
log_error($fname, NO_LINE_NUMBER, "Must not be empty.");
return;
}
checkline_rcsid($lines->[0], "");
if (1 <= $#{$lines} && $lines->[1]->text ne "") {
$lines->[1]->log_note("Empty line expected.");
$lines->[1]->explain_note("This is merely for aesthetical purposes.");
}
$patches_dir = $patchdir;
if (!defined($patches_dir) && -d "${current_dir}/patches") {
$patches_dir = "patches";
} else {
# it stays undefined.
}
$current_fname = undef;
$state = DIS_start;
foreach my $line (@{$lines}[2..$#{$lines}]) {
if ($line->text !~ qr"^(\w+) \(([^)]+)\) = (.*)(?: bytes)?$") {
$line->log_error("Unknown line type.");
next;
}
my ($alg, $chksum_fname, $sum) = ($1, $2, $3);
my $is_patch = (($chksum_fname =~ qr"^patch-[A-Za-z0-9]+$") ? true : false);
if ($chksum_fname !~ qr"^\w") {
$line->log_error("All file names should start with a letter.");
}
# Inter-package check for differing distfile checksums.
if ($opt_check_global && !$is_patch) {
# Note: Perl-specific auto-population.
if (exists($ipc_distinfo->{$alg}->{$chksum_fname})) {
my $other = $ipc_distinfo->{$alg}->{$chksum_fname};
if ($other->[1] eq $sum) {
# Fine.
} else {
$line->log_error("The ${alg} checksum for ${chksum_fname} differs ...");
$other->[0]->log_error("... from this one.");
}
} else {
$ipc_distinfo->{$alg}->{$chksum_fname} = [$line, $sum];
}
}
if ($alg eq "MD5") {
$line->log_error("MD5 checksums are obsolete.");
$line->explain_error(
"Run \"".conf_make." makedistinfo\" to regenerate the distinfo file.");
next;
}
if ($state == DIS_SHA1) {
if ($alg eq "SHA1") {
$state = ($is_patch ? DIS_start : DIS_RMD160);
$current_fname = $chksum_fname;
} else {
$line->log_warning("Expected an SHA1 checksum.");
}
} elsif ($state == DIS_RMD160) {
$state = DIS_start;
if ($alg eq "RMD160") {
if ($chksum_fname eq $current_fname) {
$state = DIS_Size;
} else {
$line->log_warning("Expected an RMD160 checksum for ${current_fname}, not for ${chksum_fname}.");
}
} else {
if ($chksum_fname eq $current_fname) {
# This is an error because this really should be fixed.
$line->log_error("Expected an RMD160 checksum, not ${alg} for ${chksum_fname}.");
} else {
$line->log_warning("Expected an RMD160 checksum for ${current_fname}, not ${alg} for ${chksum_fname}.");
}
}
} elsif ($state == DIS_Size) {
$state = DIS_start;
if ($alg eq "Size") {
if ($chksum_fname ne $current_fname) {
$line->log_warning("Expected a Size checksum for ${current_fname}, not for ${chksum_fname}.");
}
} else {
if ($chksum_fname eq $current_fname) {
$line->log_warning("Expected a Size checksum, not ${alg} for ${chksum_fname}.");
} else {
$line->log_warning("Expected a Size checksum for ${current_fname}, not ${alg} for ${chksum_fname}.");
}
}
}
if ($is_patch && defined($patches_dir)) {
my $fname = "${current_dir}/${patches_dir}/${chksum_fname}";
if ($di_is_committed && !is_committed($fname)) {
$line->log_warning("${patches_dir}/${chksum_fname} is registered in distinfo but not added to CVS.");
}
if (open(PATCH, "<", $fname)) {
my $data = "";
foreach my $patchline (<PATCH>) {
$data .= $patchline unless $patchline =~ qr"\$NetBSD";
}
close(PATCH);
my $chksum = Digest::SHA1::sha1_hex($data);
if ($sum ne $chksum) {
$line->log_error("${alg} checksum of ${chksum_fname} differs (expected ${sum}, got ${chksum}). Rerun '".conf_make." makepatchsum'.");
}
} elsif (!$hack_php_patches) {
$line->log_warning("${chksum_fname} does not exist.");
$line->explain_warning(
"All patches that are mentioned in a distinfo file should actually exist.",
"What's the use of a checksum if there is no file to check?");
}
}
$in_distinfo{$chksum_fname} = true;
}
checklines_trailing_empty_lines($lines);
if (defined($patches_dir)) {
foreach my $patch (<${current_dir}/${patches_dir}/patch-*>) {
$patch = basename($patch);
if (!exists($in_distinfo{$patch})) {
log_error($fname, NO_LINE_NUMBER, "$patch is not recorded. Rerun '".conf_make." makepatchsum'.");
}
}
}
}
sub checkfile_extra($) {
my ($fname) = @_;
my ($lines);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_extra()");
$lines = load_file($fname);
if (!$lines) {
log_error($fname, NO_LINE_NUMBER, "Could not be read.");
return;
}
checklines_trailing_empty_lines($lines);
checkperms($fname);
}
sub checkfile_INSTALL($) {
my ($fname) = @_;
my ($lines);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_INSTALL()");
checkperms($fname);
if (!($lines = load_file($fname))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
}
sub checkfile_MESSAGE($) {
my ($fname) = @_;
my ($lines);
my @explanation = (
"A MESSAGE file should consist of a header line, having 75 \"=\"",
"characters, followed by a line containing only the RCS Id, then an",
"empty line, your text and finally the footer line, which is the",
"same as the header line.");
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_MESSAGE()");
checkperms($fname);
if (!($lines = load_file($fname))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
if (@{$lines} < 3) {
log_warning($fname, NO_LINE_NUMBER, "File too short.");
explain_warning($fname, NO_LINE_NUMBER, @explanation);
return;
}
if ($lines->[0]->text ne "=" x 75) {
$lines->[0]->log_warning("Expected a line of exactly 75 \"=\" characters.");
explain_warning($fname, NO_LINE_NUMBER, @explanation);
}
checkline_rcsid($lines->[1], "");
foreach my $line (@{$lines}) {
checkline_length($line, 80);
checkline_trailing_whitespace($line);
checkline_valid_characters($line, regex_validchars);
checkline_spellcheck($line);
}
if ($lines->[-1]->text ne "=" x 75) {
$lines->[-1]->log_warning("Expected a line of exactly 75 \"=\" characters.");
explain_warning($fname, NO_LINE_NUMBER, @explanation);
}
checklines_trailing_empty_lines($lines);
}
sub checkfile_mk($) {
my ($fname) = @_;
my ($lines);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_mk()");
checkperms($fname);
if (!($lines = load_lines($fname, true))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
parselines_mk($lines);
checklines_mk($lines);
autofix($lines);
}
sub checkfile_package_Makefile($$$) {
my ($fname, $whole, $lines) = @_;
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_package_Makefile(..., ...)");
checkperms($fname);
if (!exists($pkgctx_vardef->{"PLIST_SRC"})
&& defined($pkgdir)
&& !-f "${current_dir}/$pkgdir/PLIST"
&& !-f "${current_dir}/$pkgdir/PLIST.common") {
log_warning($fname, NO_LINE_NUMBER, "Neither PLIST nor PLIST.common exist, and PLIST_SRC is unset. Are you sure PLIST handling is ok?");
}
if (exists($pkgctx_vardef->{"NO_CHECKSUM"}) && is_emptydir("${current_dir}/${patchdir}")) {
if (-f "${current_dir}/${distinfo_file}") {
log_warning("${current_dir}/${distinfo_file}", NO_LINE_NUMBER, "This file should not exist if NO_CHECKSUM is set.");
}
} else {
if (!-f "${current_dir}/${distinfo_file}") {
log_warning("${current_dir}/${distinfo_file}", NO_LINE_NUMBER, "File not found. Please run '".conf_make." makesum'.");
}
}
if ($whole =~ /etc\/rc\.d/) {
log_warning($fname, NO_LINE_NUMBER, "Please use the RCD_SCRIPTS mechanism to install rc.d scripts automatically to \${RCD_SCRIPTS_EXAMPLEDIR}.");
}
if (exists($pkgctx_vardef->{"REPLACE_PERL"}) && exists($pkgctx_vardef->{"NO_CONFIGURE"})) {
$pkgctx_vardef->{"REPLACE_PERL"}->log_warning("REPLACE_PERL is ignored when ...");
$pkgctx_vardef->{"NO_CONFIGURE"}->log_warning("... NO_CONFIGURE is set.");
}
if (exists($pkgctx_vardef->{"RESTRICTED"}) && !exists($pkgctx_vardef->{"LICENSE"})) {
$pkgctx_vardef->{"RESTRICTED"}->log_error("Restricted packages must have a LICENSE.");
}
if (exists($pkgctx_vardef->{"GNU_CONFIGURE"}) && exists($pkgctx_vardef->{"USE_LANGUAGES"})) {
my $languages_line = $pkgctx_vardef->{"USE_LANGUAGES"};
my $value = $languages_line->get("value");
if ($languages_line->has("comment") && $languages_line->get("comment") =~ qr"(?:^|\s+)c(?:\s+|$)"i) {
# Don't emit a warning, since the comment
# probably contains a statement that C is
# really not needed.
} elsif ($value !~ qr"(?:^|\s+)(?:c|c99|objc)(?:\s+|$)") {
$pkgctx_vardef->{"GNU_CONFIGURE"}->log_warning("GNU_CONFIGURE almost always needs a C compiler, ...");
$languages_line->log_warning("... but \"c\" is not added to USE_LANGUAGES.");
}
}
my $distname_line = $pkgctx_vardef->{"DISTNAME"};
my $pkgname_line = $pkgctx_vardef->{"PKGNAME"};
my $distname = defined($distname_line) ? $distname_line->get("value") : undef;
my $pkgname = defined($pkgname_line) ? $pkgname_line->get("value") : undef;
# Let's do some tricks to get the proper value of the package
# name more often.
if (defined($distname) && defined($pkgname)) {
$pkgname =~ s/\$\{DISTNAME\}/$distname/;
}
if (defined($pkgname) && defined($distname) && ($pkgname eq $distname || $pkgname eq "\${DISTNAME}")) {
$pkgname_line->log_note("PKGNAME is \${DISTNAME} by default. You don't need to define PKGNAME.");
}
if (!defined($pkgname) && defined($distname) && $distname !~ regex_unresolved && $distname !~ regex_pkgname) {
$distname_line->log_warning("As DISTNAME is not a valid package name, please define the PKGNAME explicitly.");
}
($effective_pkgname, $effective_pkgname_line, $effective_pkgbase, $effective_pkgversion)
= (defined($pkgname) && $pkgname !~ regex_unresolved && $pkgname =~ regex_pkgname) ? ($pkgname, $pkgname_line, $1, $2)
: (defined($distname) && $distname !~ regex_unresolved && $distname =~ regex_pkgname) ? ($distname, $distname_line, $1, $2)
: (undef, undef, undef, undef);
if (defined($effective_pkgname_line)) {
$opt_debug_misc and $effective_pkgname_line->log_debug("Effective name=${effective_pkgname} base=${effective_pkgbase} version=${effective_pkgversion}.");
}
if (!exists($pkgctx_vardef->{"COMMENT"})) {
log_warning($fname, NO_LINE_NUMBER, "No COMMENT given.");
}
if (exists($pkgctx_vardef->{"USE_IMAKE"}) && exists($pkgctx_vardef->{"USE_X11"})) {
$pkgctx_vardef->{"USE_IMAKE"}->log_note("USE_IMAKE makes ...");
$pkgctx_vardef->{"USE_X11"}->log_note("... USE_X11 superfluous.");
}
if (defined($effective_pkgbase)) {
foreach my $suggested_update (@{get_suggested_package_updates()}) {
my ($line, $suggbase, $suggver, $suggcomm) = @{$suggested_update};
my $comment = (defined($suggcomm) ? " (${suggcomm})" : "");
next unless $effective_pkgbase eq $suggbase;
if (dewey_cmp($effective_pkgversion, "<", $suggver)) {
$effective_pkgname_line->log_warning("This package should be updated to ${suggver}${comment}.");
}
if (dewey_cmp($effective_pkgversion, "==", $suggver)) {
$effective_pkgname_line->log_note("The update request to ${suggver} from doc/TODO${comment} has been done.");
}
if (dewey_cmp($effective_pkgversion, ">", $suggver)) {
$effective_pkgname_line->log_note("This package is newer than the update request to ${suggver}${comment}.");
}
}
}
checklines_mk($lines);
checklines_package_Makefile_varorder($lines);
autofix($lines);
}
sub checkfile_patch($) {
my ($fname) = @_;
my ($strings);
my ($state, $redostate, $nextstate, $dellines, $addlines, $hunks);
my ($seen_comment, $current_fname, $current_ftype, $patched_files);
my ($leading_context_lines, $trailing_context_lines, $context_scanning_leading);
# Abbreviations used:
# style: [c] = context diff, [u] = unified diff
# scope: [f] = file, [h] = hunk, [l] = line
# action: [d] = delete, [m] = modify, [a] = add, [c] = context
use constant re_patch_rcsid => qr"^\$.*\$$";
use constant re_patch_text => qr"^(.+)$";
use constant re_patch_empty => qr"^$";
use constant re_patch_cfd => qr"^\*\*\*\s(\S+)(.*)$";
use constant re_patch_cfa => qr"^---\s(\S+)(.*)$";
use constant re_patch_ch => qr"^\*{15}(.*)$";
use constant re_patch_chd => qr"^\*{3}\s(\d+)(?:,(\d+))?\s\*{4}$";
use constant re_patch_cha => qr"^-{3}\s(\d+)(?:,(\d+))?\s-{4}$";
use constant re_patch_cld => qr"^(?:-\s(.*))?$";
use constant re_patch_clm => qr"^(?:!\s(.*))?$";
use constant re_patch_cla => qr"^(?:\+\s(.*))?$";
use constant re_patch_clc => qr"^(?:\s\s(.*))?$";
use constant re_patch_ufd => qr"^---\s(\S+)(?:\s+(.*))?$";
use constant re_patch_ufa => qr"^\+{3}\s(\S+)(?:\s+(.*))?$";
use constant re_patch_uh => qr"^\@\@\s-(?:(\d+),)?(\d+)\s\+(?:(\d+),)?(\d+)\s\@\@(.*)$";
use constant re_patch_uld => qr"^-(.*)$";
use constant re_patch_ula => qr"^\+(.*)$";
use constant re_patch_ulc => qr"^\s(.*)$";
use constant re_patch_ulnonl => qr"^\\ No newline at end of file$";
use enum qw(:PST_
START CENTER TEXT
CFA CH CHD CLD0 CLD CLA0 CLA
UFA UH UL
);
my ($s, $line, $m);
my $check_text = sub($) {
my ($text) = @_;
if ($text =~ qr"(\$(Author|Date|Header|Id|Locker|Log|Name|RCSfile|Revision|Source|State|$opt_rcsidstring)(?::[^\$]*|\$))") {
my ($tag) = ($2);
if ($text =~ re_patch_uh) {
$line->log_warning("Found RCS tag \"\$${tag}\$\". Please remove it.");
$line->set_text($1);
} else {
$line->log_warning("Found RCS tag \"\$${tag}\$\". Please remove it by reducing the number of context lines using pkgdiff or \"diff -U[210]\".");
}
}
};
my $check_contents = sub() {
if ($m->has(1)) {
$check_text->($m->text(1));
}
};
my $check_added_contents = sub() {
my $text;
return unless $m->has(1);
$text = $m->text(1);
checkline_cpp_macro_names($line, $text);
checkline_spellcheck($line);
# XXX: This check is not as accurate as the similar one in
# checkline_mk_shelltext().
if (defined($current_fname)) {
if ($current_ftype eq "shell" || $current_ftype eq "make") {
my ($mm, $rest) = match_all($text, $regex_shellword);
foreach my $m (@{$mm}) {
my $shellword = $m->text(1);
if ($shellword =~ qr"^#") {
last;
}
checkline_mk_absolute_pathname($line, $shellword);
}
} elsif ($current_ftype eq "source") {
checkline_source_absolute_pathname($line, $text);
} elsif ($current_ftype eq "configure") {
if ($text =~ qr": Avoid regenerating within pkgsrc$") {
$line->log_error("This code must not be included in patches.");
$line->explain_error(
"It is generated automatically by pkgsrc after the patch phase.");
}
} elsif ($current_ftype eq "ignore") {
# Ignore it.
} else {
checkline_other_absolute_pathname($line, $text);
}
}
};
my $check_hunk_end = sub($$$) {
my ($deldelta, $adddelta, $newstate) = @_;
if ($deldelta > 0 && $dellines == 0) {
$redostate = $newstate;
if (defined($addlines) && $addlines > 0) {
$line->log_error("Expected ${addlines} more lines to be added.");
}
} elsif ($adddelta > 0 && $addlines == 0) {
$redostate = $newstate;
if (defined($dellines) && $dellines > 0) {
$line->log_error("Expected ${dellines} more lines to be deleted.");
}
} else {
if (defined($context_scanning_leading)) {
if ($deldelta != 0 && $adddelta != 0) {
if ($context_scanning_leading) {
$leading_context_lines++;
} else {
$trailing_context_lines++;
}
} else {
if ($context_scanning_leading) {
$context_scanning_leading = false;
} else {
$trailing_context_lines = 0;
}
}
}
if ($deldelta != 0) {
$dellines -= $deldelta;
}
if ($adddelta != 0) {
$addlines -= $adddelta;
}
if (!((defined($dellines) && $dellines > 0) ||
(defined($addlines) && $addlines > 0))) {
if (defined($context_scanning_leading)) {
if ($leading_context_lines != $trailing_context_lines) {
$opt_debug_patches and $line->log_warning("The hunk that ends here does not have as many leading (${leading_context_lines}) as trailing (${trailing_context_lines}) lines of context.");
}
}
$nextstate = $newstate;
}
}
};
my $check_hunk_line = sub($$$$) {
my ($deldelta, $adddelta, $newstate, $check_added) = @_;
$check_contents->();
$check_hunk_end->($deldelta, $adddelta, $newstate);
if ($check_added) {
$check_added_contents->();
}
};
my $transitions =
[ [PST_START, re_patch_rcsid, PST_CENTER, sub() {
checkline_rcsid($line, "");
}], [PST_START, undef, PST_CENTER, sub() {
checkline_rcsid($line, "");
}], [PST_CENTER, re_patch_empty, PST_TEXT, sub() {
#
}], [PST_TEXT, re_patch_cfd, PST_CFA, sub() {
if (!$seen_comment) {
#$opt_warn_style and $line->log_warning("Comment expected.");
}
$line->log_warning("Please use unified diffs (diff -u) for patches.");
}], [PST_TEXT, re_patch_ufd, PST_UFA, sub() {
if (!$seen_comment) {
#$opt_warn_style and $line->log_warning("Comment expected.");
}
}], [PST_TEXT, re_patch_text, PST_TEXT, sub() {
$seen_comment = true;
}], [PST_TEXT, re_patch_empty, PST_TEXT, sub() {
#
}], [PST_TEXT, undef, PST_TEXT, sub() {
#
}], [PST_CENTER, re_patch_cfd, PST_CFA, sub() {
if ($seen_comment) {
$opt_warn_space and $line->log_note("Empty line expected.");
} else {
#$opt_warn_style and $line->log_warning("Comment expected.");
}
$line->log_warning("Please use unified diffs (diff -u) for patches.");
}], [PST_CENTER, re_patch_ufd, PST_UFA, sub() {
if ($seen_comment) {
$opt_warn_space and $line->log_note("Empty line expected.");
} else {
#$opt_warn_style and $line->log_warning("Comment expected.");
}
}], [PST_CENTER, undef, PST_TEXT, sub() {
$opt_warn_space and $line->log_note("Empty line expected.");
}], [PST_CFA, re_patch_cfa, PST_CH, sub() {
$current_fname = $m->text(1);
$current_ftype = get_filetype($line, $current_fname);
$opt_debug_patches and $line->log_debug("fname=$current_fname ftype=$current_ftype");
$patched_files++;
$hunks = 0;
}], [PST_CH, re_patch_ch, PST_CHD, sub() {
$hunks++;
}], [PST_CHD, re_patch_chd, PST_CLD0, sub() {
$dellines = ($m->has(2))
? (1 + $m->text(2) - $m->text(1))
: ($m->text(1));
}], [PST_CLD0, re_patch_clc, PST_CLD, sub() {
$check_hunk_line->(1, 0, PST_CLD0, false);
}], [PST_CLD0, re_patch_cld, PST_CLD, sub() {
$check_hunk_line->(1, 0, PST_CLD0, false);
}], [PST_CLD0, re_patch_clm, PST_CLD, sub() {
$check_hunk_line->(1, 0, PST_CLD0, false);
}], [PST_CLD, re_patch_clc, PST_CLD, sub() {
$check_hunk_line->(1, 0, PST_CLD0, false);
}], [PST_CLD, re_patch_cld, PST_CLD, sub() {
$check_hunk_line->(1, 0, PST_CLD0, false);
}], [PST_CLD, re_patch_clm, PST_CLD, sub() {
$check_hunk_line->(1, 0, PST_CLD0, false);
}], [PST_CLD, undef, PST_CLD0, sub() {
if ($dellines != 0) {
$line->log_warning("Invalid number of deleted lines (${dellines} missing).");
}
}], [PST_CLD0, re_patch_cha, PST_CLA0, sub() {
$dellines = undef;
$addlines = ($m->has(2))
? (1 + $m->text(2) - $m->text(1))
: ($m->text(1));
}], [PST_CLA0, re_patch_clc, PST_CLA, sub() {
$check_hunk_line->(0, 1, PST_CH, true);
}], [PST_CLA0, re_patch_clm, PST_CLA, sub() {
$check_hunk_line->(0, 1, PST_CH, true);
}], [PST_CLA0, re_patch_cla, PST_CLA, sub() {
$check_hunk_line->(0, 1, PST_CH, true);
}], [PST_CLA, re_patch_clc, PST_CLA, sub() {
$check_hunk_line->(0, 1, PST_CH, true);
}], [PST_CLA, re_patch_clm, PST_CLA, sub() {
$check_hunk_line->(0, 1, PST_CH, true);
}], [PST_CLA, re_patch_cla, PST_CLA, sub() {
$check_hunk_line->(0, 1, PST_CH, true);
}], [PST_CLA, undef, PST_CLA0, sub() {
if ($addlines != 0) {
$line->log_warning("Invalid number of added lines (${addlines} missing).");
}
}], [PST_CLA0, undef, PST_CH, sub() {
#
}], [PST_CH, undef, PST_TEXT, sub() {
#
}], [PST_UFA, re_patch_ufa, PST_UH, sub() {
$current_fname = $m->text(1);
$current_ftype = get_filetype($line, $current_fname);
$opt_debug_patches and $line->log_debug("fname=$current_fname ftype=$current_ftype");
$patched_files++;
$hunks = 0;
}], [PST_UH, re_patch_uh, PST_UL, sub() {
$dellines = ($m->has(1) ? $m->text(2) : 1);
$addlines = ($m->has(3) ? $m->text(4) : 1);
$check_text->($line->text);
if ($line->text =~ qr"\r$") {
$line->log_error("The hunk header must not end with a CR character.");
$line->explain_error(
"The MacOS X patch utility cannot handle these.");
}
$hunks++;
$context_scanning_leading = (($m->has(1) && $m->text(1) ne "1") ? true : undef);
$leading_context_lines = 0;
$trailing_context_lines = 0;
}], [PST_UL, re_patch_uld, PST_UL, sub() {
$check_hunk_line->(1, 0, PST_UH, false);
}], [PST_UL, re_patch_ula, PST_UL, sub() {
$check_hunk_line->(0, 1, PST_UH, true);
}], [PST_UL, re_patch_ulc, PST_UL, sub() {
$check_hunk_line->(1, 1, PST_UH, true);
}], [PST_UL, re_patch_ulnonl, PST_UL, sub() {
#
}], [PST_UL, re_patch_empty, PST_UL, sub() {
$opt_warn_space and $line->log_note("Leading white-space missing in hunk.");
$check_hunk_line->(1, 1, PST_UH, false);
}], [PST_UL, undef, PST_UH, sub() {
if ($dellines != 0 || $addlines != 0) {
$line->log_warning("Unexpected end of hunk (-${dellines},+${addlines} expected).");
}
}], [PST_UH, undef, PST_TEXT, sub() {
($hunks != 0) || $line->log_warning("No hunks for file ${current_fname}.");
}]];
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_patch()");
checkperms($fname);
if (!($strings = PkgLint::FileUtil::load_strings($fname, false))) {
log_error($fname, NO_LINE_NUMBER, "Could not be read.");
return;
}
if (@{$strings} == 0) {
log_error($fname, NO_LINE_NUMBER, "Must not be empty.");
return;
}
$state = PST_START;
$dellines = undef;
$addlines = undef;
$patched_files = 0;
$seen_comment = false;
$current_fname = undef;
$current_ftype = undef;
$hunks = undef;
for (my $lineno = 0; $lineno <= $#{$strings}; ) {
$s = $strings->[$lineno];
$line = $s->line;
my $text = $line->text;
$opt_debug_patches and $line->log_debug("[${state} ${patched_files}/".($hunks||0)."/-".($dellines||0)."+".($addlines||0)."] $text");
my $found = false;
foreach my $t (@{$transitions}) {
if ($state == $t->[0]) {
if (!defined($t->[1])) {
$m = undef;
} elsif ($text =~ $t->[1]) {
$opt_debug_patches and $line->log_debug($t->[1]);
$m = PkgLint::SimpleMatch->new($text, \@-, \@+);
} else {
next;
}
$redostate = undef;
$nextstate = $t->[2];
$t->[3]->();
if (defined($redostate)) {
$state = $redostate;
} else {
$state = $nextstate;
if (defined($t->[1])) {
$lineno++;
}
}
$found = true;
last;
}
}
if (!$found) {
$line->log_error("Parse error: state=${state}");
$state = PST_TEXT;
$lineno++;
}
}
while ($state != PST_TEXT) {
$opt_debug_patches and log_debug($fname, "EOF", "[${state} ${patched_files}/".($hunks||0)."/-".($dellines||0)."+".($addlines||0)."]");
my $found = false;
foreach my $t (@{$transitions}) {
if ($state == $t->[0] && !defined($t->[1])) {
my $newstate;
$m = undef;
$redostate = undef;
$nextstate = $t->[2];
$t->[3]->();
$newstate = (defined($redostate)) ? $redostate : $nextstate;
if ($newstate == $state) {
log_fatal($fname, "EOF", "Internal error in the patch transition table.");
}
$state = $newstate;
$found = true;
last;
}
}
if (!$found) {
log_error($fname, "EOF", "Parse error: state=${state}");
$state = PST_TEXT;
}
}
if ($patched_files > 1) {
log_warning($fname, NO_LINE_NUMBER, "Contains patches for $patched_files files, should be only one.");
} elsif ($patched_files == 0) {
log_error($fname, NO_LINE_NUMBER, "Contains no patch.");
}
checklines_trailing_empty_lines(strings_to_lines($strings));
}
sub checkfile_PLIST($) {
my ($fname) = @_;
my ($lines, $last_file_seen, $all_files);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile_PLIST()");
checkperms($fname);
if (!($lines = load_file($fname))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
if (@{$lines} == 0) {
log_error($fname, NO_LINE_NUMBER, "Must not be empty.");
return;
}
checkline_rcsid($lines->[0], "\@comment ");
# Get the list of all files from the PLIST.
$all_files = {};
foreach my $line (@{$lines}) {
my $text = $line->text;
if ($text =~ qr"^[\w\$]") {
$all_files->{$text} = $line;
}
}
foreach my $line (@{$lines}) {
my $text = $line->text;
checkline_trailing_whitespace($line);
# @foo directives.
if ($text =~ /^(?:\$\{[\w_]+\})?\@([a-z]+)\s+(.*)/) {
my ($cmd, $arg) = ($1, $2);
if ($cmd eq "unexec" && $arg =~ qr"^(rmdir|\$\{RMDIR\} \%D/)(.*)") {
my ($rmdir, $rest) = ($1, $2);
if ($rest !~ qr"(?:true|\$\{TRUE\})") {
$line->log_warning("Please use \"\@dirrm\" instead of \"\@unexec rmdir\".");
}
} elsif (($cmd eq "exec" || $cmd eq "unexec")) {
if ($arg =~ /(?:install-info|\$\{INSTALL_INFO\})/) {
$line->log_warning("\@exec/unexec install-info is deprecated.");
} elsif ($arg =~ /ldconfig/ && $arg !~ qr"/usr/bin/true") {
$line->log_error("ldconfig must be used with \"||/usr/bin/true\".");
}
} elsif ($cmd eq "comment") {
# nothing to do
} elsif ($cmd eq "dirrm") {
my @ids = get_shared_dir_ids($line, $arg);
if (@ids == 0) {
# Nothing to do
} elsif (@ids == 1) {
$line->log_warning("Please add \"USE_DIRS+= $ids[0]\" to the package Makefile and remove this line.");
} else {
my $s = join(" or ", map { "\"USE_DIRS+= $_\"" } @ids);
$line->log_warning("Please add $s to the package Makefile and remove this line.");
}
} else {
$line->log_warning("Unknown PLIST directive \"\@$cmd\".");
}
# Pathnames.
} elsif ($text =~ qr"^([A-Za-z0-9\$].*)/([^/]+)$") {
my ($dirname, $basename) = ($1, $2);
if ($opt_warn_plist_sort && $text =~ qr"^\w" && $text !~ regex_unresolved) {
if (defined($last_file_seen)) {
if ($last_file_seen gt $text) {
$line->log_warning("${text} should be sorted before ${last_file_seen}.");
}
}
$last_file_seen = $text;
}
if ($dirname =~ qr"^bin/") {
$line->log_warning("The bin/ directory should not have subdirectories.");
} elsif ($dirname eq "bin") {
if (exists($all_files->{"man/man1/${basename}.1"})) {
# Fine.
} elsif (exists($all_files->{"man/man6/${basename}.6"})) {
# Fine.
} elsif (exists($all_files->{"\${IMAKE_MAN_DIR}/${basename}.\${IMAKE_MANNEWSUFFIX}"})) {
# Fine.
} else {
$opt_warn_extra and $line->log_warning("Manual page missing for bin/${basename}.");
}
} elsif ($text =~ qr"^doc/") {
$line->log_error("Documentation must be installed under share/doc, not doc.");
} elsif ($text =~ qr"^etc/rc\.d/") {
$line->log_error("RCD_SCRIPTS must not be registered in the PLIST. Please use the RCD_SCRIPTS framework.");
} elsif ($text =~ qr"^etc/") {
my $f = "mk/pkginstall/bsd.pkginstall.mk";
assert(-f "${cwd_pkgsrcdir}/${f}", "${cwd_pkgsrcdir}/${f} is not a regular file.");
$line->log_error("Configuration files must not be registered in the PLIST. Please use the CONF_FILES framework, which is described in ${f}.");
} elsif ($text =~ qr"^include/.*\.(?:h|hpp)$") {
# Fine.
} elsif ($text eq "info/dir") {
$line->log_error("\"info/dir\" must not be listed. Use install-info to add/remove an entry.");
} elsif ($text =~ qr"^info/.+$") {
if (defined($pkgctx_vardef) && !exists($pkgctx_vardef->{"INFO_FILES"})) {
$line->log_warning("Packages that install info files should set INFO_FILES.");
}
} elsif (defined($effective_pkgbase) && $text =~ qr"^lib/\Q${effective_pkgbase}\E/") {
# Fine.
} elsif ($text =~ qr"^lib/locale/") {
$line->log_error("\"lib/locale\" must not be listed. Use \${PKGLOCALEDIR}/locale and set USE_PKGLOCALEDIR instead.");
} elsif ($text =~ qr"^(lib/(?:.*/)*)([^/]+)\.(so|a|la)$") {
my ($dir, $lib, $ext) = ($1, $2, $3);
if ($dir eq "lib/" && $lib !~ qr"^lib") {
$opt_warn_extra and $line->log_warning("Library filename does not start with \"lib\".");
}
if ($ext eq "la") {
if (defined($pkgctx_vardef) && !exists($pkgctx_vardef->{"USE_LIBTOOL"})) {
$line->log_warning("Packages that install libtool libraries should define USE_LIBTOOL.");
}
}
} elsif ($text =~ qr"^man/(cat|man)(\w+)/(.*?)\.(\w+)(\.gz)?$") {
my ($cat_or_man, $section, $manpage, $ext, $gz) = ($1, $2, $3, $4, $5);
if ($section !~ qr"^[\dln]$") {
$line->log_warning("Unknown section \"${section}\" for manual page.");
}
if ($cat_or_man eq "cat" && !exists($all_files->{"man/man${section}/${manpage}.${section}"})) {
$line->log_warning("Preformatted manual page without unformatted one.");
}
if ($cat_or_man eq "cat") {
if ($ext ne "0") {
$line->log_warning("Preformatted manual pages should end in \".0\".");
}
} else {
if ($section ne $ext) {
$line->log_warning("Mismatch between the section (${section}) and extension (${ext}) of the manual page.");
}
}
if (defined($gz)) {
$line->log_note("The .gz extension is unnecessary for manual pages.");
$line->explain_note(
"Whether the manual pages are installed in compressed form or not is",
"configured by the pkgsrc user. Compression and decompression takes place",
"automatically, no matter if the .gz extension is mentioned in the PLIST",
"or not.");
}
} elsif ($text =~ qr"^man/cat") {
$line->log_warning("Invalid filename \"${text}\" for preformatted manual page.");
} elsif ($text =~ qr"^man/man") {
$line->log_warning("Invalid filename \"${text}\" for unformatted manual page.");
} elsif ($text =~ qr"^sbin/(.*)") {
my ($binname) = ($1);
if (!exists($all_files->{"man/man8/${binname}.8"})) {
$opt_warn_extra and $line->log_warning("Manual page missing for sbin/${binname}.");
}
} elsif ($dirname eq "share/aclocal" && $basename =~ qr"\.m4$") {
# Fine.
} elsif ($text =~ qr"^share/doc/html/") {
$opt_warn_plist_depr and $line->log_warning("Use of \"share/doc/html\" is deprecated. Use \"share/doc/\${PKGBASE}\" instead.");
} elsif (defined($effective_pkgbase) && $text =~ qr"^share/doc/\Q${effective_pkgbase}\E/") {
# Fine.
} elsif (defined($effective_pkgbase) && $text =~ qr"^share/examples/\Q${effective_pkgbase}\E/") {
# Fine.
} elsif (defined($effective_pkgbase) && $text =~ qr"^share/\Q${effective_pkgbase}\E/") {
# Fine.
} elsif ($text =~ qr"^share/locale/[\w\@_]+/LC_MESSAGES/[^/]+\.mo$") {
# Fine.
} elsif ($text =~ qr"^share/man/") {
$line->log_warning("Man pages should be installed into man/, not share/man/.");
} else {
$opt_debug_unchecked and $line->log_debug("Unchecked pathname \"${text}\".");
}
if ($text =~ /\${PKGLOCALEDIR}/ && defined($pkgctx_vardef) && !exists($pkgctx_vardef->{"USE_PKGLOCALEDIR"})) {
$line->log_warning("PLIST contains \${PKGLOCALEDIR}, but USE_PKGLOCALEDIR was not found.");
}
if ($text =~ qr"/CVS/") {
$line->log_warning("CVS files should not be in the PLIST.");
}
if ($text =~ qr"\.orig$") {
$line->log_warning(".orig files should not be in the PLIST.");
}
if ($text =~ qr"/perllocal\.pod$") {
$line->log_warning("perllocal.pod files should not be in the PLIST.");
$line->explain_warning(
"This file is handled automatically by the INSTALL/DEINSTALL scripts,",
"since its contents changes frequently.");
}
if ($text =~ qr"^(.*)(\.a|\.so[0-9.]*)$") {
my ($basename, $ext) = ($1, $2);
if (exists($all_files->{"${basename}.la"})) {
$line->log_warning("Redundant library found. The libtool library is in line " . $all_files->{"${basename}.la"}->lines . ".");
}
}
} elsif ($text =~ qr"^\$\{[\w_]+\}$") {
# A variable on its own line.
} else {
$line->log_error("Unknown line type.");
}
}
checklines_trailing_empty_lines($lines);
autofix($lines);
}
sub checkfile($) {
my ($fname) = @_;
my ($st, $basename);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkfile()");
$basename = basename($fname);
if ($basename =~ qr"^(?:work.*|.*~|.*\.orig|.*\.rej)$") {
if ($opt_import) {
log_error($fname, NO_LINE_NUMBER, "Must be cleaned up before committing the package.");
}
return;
}
if (!($st = lstat($fname))) {
log_error($fname, NO_LINE_NUMBER, "$!");
return;
}
if (S_ISDIR($st->mode)) {
if ($basename eq "files" || $basename eq "patches" || $basename eq "CVS") {
# Ok
} elsif (!is_emptydir($fname)) {
log_warning($fname, NO_LINE_NUMBER, "Unknown directory name.");
}
} elsif (S_ISLNK($st->mode)) {
if ($basename !~ qr"^work") {
log_warning($fname, NO_LINE_NUMBER, "Unknown symlink name.");
}
} elsif (!S_ISREG($st->mode)) {
log_error($fname, NO_LINE_NUMBER, "Only files and directories are allowed in pkgsrc.");
} elsif ($basename eq "ALTERNATIVES") {
$opt_check_ALTERNATIVES and checkfile_ALTERNATIVES($fname);
} elsif ($basename eq "buildlink3.mk") {
$opt_check_bl3 and checkfile_buildlink3_mk($fname);
} elsif ($basename =~ qr"^(?:.*\.mk|Makefile.*)$") {
$opt_check_mk and checkfile_mk($fname);
} elsif ($basename =~ qr"^DESCR") {
$opt_check_DESCR and checkfile_DESCR($fname);
} elsif ($basename =~ qr"^distinfo") {
$opt_check_distinfo and checkfile_distinfo($fname);
} elsif ($basename eq "DEINSTALL" || $basename eq "INSTALL") {
$opt_check_INSTALL and checkfile_INSTALL($fname);
} elsif ($basename =~ qr"^MESSAGE") {
$opt_check_MESSAGE and checkfile_MESSAGE($fname);
} elsif ($basename =~ qr"^patch-[A-Za-z0-9]*$") {
$opt_check_patches and checkfile_patch($fname);
} elsif ($fname =~ qr"(?:^|/)patches/manual-[^/]*$") {
$opt_debug_unchecked and log_debug($fname, NO_LINE_NUMBER, "Unchecked file \"${fname}\".");
} elsif ($fname =~ qr"(?:^|/)patches/[^/]*$") {
log_warning($fname, NO_LINE_NUMBER, "Patch files should be named \"patch-\", followed by letters and digits only.");
} elsif ($basename =~ qr"^PLIST") {
$opt_check_PLIST and checkfile_PLIST($fname);
} elsif ($basename eq "TODO" || $basename eq "README") {
# Ok
} elsif (!-T $fname) {
log_warning($fname, NO_LINE_NUMBER, "Unexpectedly found a binary file.");
} else {
log_warning($fname, NO_LINE_NUMBER, "Unexpected file found.");
$opt_check_extra and checkfile_extra($fname);
}
}
sub my_split($$) {
my ($delimiter, $s) = @_;
my ($pos, $next, @result);
$pos = 0;
for ($pos = 0; $pos != -1; $pos = $next) {
$next = index($s, $delimiter, $pos);
push @result, (($next == -1) ? substr($s, $pos) : substr($s, $pos, $next - $pos));
if ($next != -1) {
$next += length($delimiter);
}
}
return @result;
}
# Checks that the files in the directory are in sync with CVS's status.
#
sub checkdir_CVS($) {
my ($fname) = @_;
my $cvs_entries = load_file("$fname/CVS/Entries");
my $cvs_entries_log = load_file("$fname/CVS/Entries.Log");
return unless $cvs_entries;
foreach my $line (@$cvs_entries) {
my ($type, $fname, $mtime, $date, $empty, $tag, $undef) = my_split("/", $line->text);
next if ($type eq "D" && !defined($fname));
assert($type eq "" || $type eq "D", "Unknown line format: " . $line->text);
assert(defined($tag), "Unknown line format: " . $line->text);
assert(defined($empty) && $empty eq "", "Unknown line format: " . $line->text);
assert(!defined($undef), "Unknown line format: " . $line->text);
}
}
#
# Procedures to check a directory including the files in it.
#
sub checkdir_root() {
my ($fname) = "${current_dir}/Makefile";
my ($lines, $prev_subdir, @subdirs);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkdir_root()");
if (!($lines = load_lines($fname, true))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
parselines_mk($lines);
if (0 <= $#{$lines}) {
checkline_rcsid_regex($lines->[0], qr"#\s+", "# ");
}
foreach my $line (@{$lines}) {
if ($line->text =~ qr"^(#?)SUBDIR\s*\+=(\s*)(\S+)\s*(?:#\s*(.*?)\s*|)$") {
my ($comment_flag, $indentation, $subdir, $comment) = ($1, $2, $3, $4);
if ($comment_flag eq "#" && (!defined($comment) || $comment eq "")) {
$line->log_warning("${subdir} commented out without giving a reason.");
}
if ($indentation ne "\t") {
$line->log_warning("Indentation should be a single tab character.");
}
if ($subdir =~ qr"\$" || !-f "${current_dir}/${subdir}/Makefile") {
next;
}
if (defined($prev_subdir) && $subdir eq $prev_subdir) {
$line->log_error("${subdir} must only appear once.");
} elsif (defined($prev_subdir) && $subdir lt $prev_subdir) {
$line->log_warning("${subdir} should come before ${prev_subdir}.");
} else {
# correctly ordered
}
$prev_subdir = $subdir;
if ($comment_flag eq "") {
push(@subdirs, "${current_dir}/${subdir}");
}
}
}
checklines_mk($lines);
if ($opt_recursive) {
push(@todo_items, @subdirs);
}
}
sub checkdir_category() {
my $fname = "${current_dir}/Makefile";
my ($lines, $lineno);
$opt_debug_trace and log_debug($fname, NO_LINES, "checkdir_category()");
if (!($lines = load_lines($fname, true))) {
log_error($fname, NO_LINE_NUMBER, "Cannot be read.");
return;
}
parselines_mk($lines);
$lineno = 0;
# The first line must contain the RCS Id
if ($lineno <= $#{$lines} && checkline_rcsid_regex($lines->[$lineno], qr"#\s+", "# ")) {
$lineno++;
}
# Then, arbitrary comments may follow
while ($lineno <= $#{$lines} && $lines->[$lineno]->text =~ qr"^#") {
$lineno++;
}
# Then we need an empty line
expect_empty_line($lines, \$lineno);
# Then comes the COMMENT line
if ($lineno <= $#{$lines} && $lines->[$lineno]->text =~ qr"^COMMENT=\t*(.*)") {
my ($comment) = ($1);
checkline_valid_characters_in_variable($lines->[$lineno], qr"[-\040'(),/0-9A-Za-z]");
$lineno++;
} else {
$lines->[$lineno]->log_error("COMMENT= line expected.");
}
# Then we need an empty line
expect_empty_line($lines, \$lineno);
# And now to the most complicated part of the category Makefiles,
# the (hopefully) sorted list of SUBDIRs. The first step is to
# collect the SUBDIRs in the Makefile and in the file system.
my (@f_subdirs, @m_subdirs);
@f_subdirs = sort(get_subdirs($current_dir));
my $prev_subdir = undef;
while ($lineno <= $#{$lines}) {
my $line = $lines->[$lineno];
if ($line->text =~ qr"^(#?)SUBDIR\+=(\s*)(\S+)\s*(?:#\s*(.*?)\s*|)$") {
my ($comment_flag, $indentation, $subdir, $comment) = ($1, $2, $3, $4);
if ($comment_flag eq "#" && (!defined($comment) || $comment eq "")) {
$line->log_warning("${subdir} commented out without giving a reason.");
}
if ($indentation ne "\t") {
$line->log_warning("Indentation should be a single tab character.");
}
if (defined($prev_subdir) && $subdir eq $prev_subdir) {
$line->log_error("${subdir} must only appear once.");
} elsif (defined($prev_subdir) && $subdir lt $prev_subdir) {
$line->log_warning("${subdir} should come before ${prev_subdir}.");
} else {
# correctly ordered
}
push(@m_subdirs, [$subdir, $line, $comment_flag ? false : true]);
$prev_subdir = $subdir;
$lineno++;
} else {
if ($line->text ne "") {
$line->log_error("SUBDIR+= line or empty line expected.");
}
last;
}
}
# To prevent unnecessary warnings about subdirectories that are
# in one list, but not in the other, we generate the sets of
# subdirs of each list.
my (%f_check, %m_check);
foreach my $f (@f_subdirs) { $f_check{$f} = true; }
foreach my $m (@m_subdirs) { $m_check{$m->[0]} = true; }
my ($f_index, $f_atend, $f_neednext, $f_current) = (0, false, true, undef, undef);
my ($m_index, $m_atend, $m_neednext, $m_current) = (0, false, true, undef, undef);
my ($line, $m_recurse);
my (@subdirs);
while (!($m_atend && $f_atend)) {
if (!$m_atend && $m_neednext) {
$m_neednext = false;
if ($m_index > $#m_subdirs) {
$m_atend = true;
$line = $lines->[$lineno];
next;
} else {
$m_current = $m_subdirs[$m_index]->[0];
$line = $m_subdirs[$m_index]->[1];
$m_recurse = $m_subdirs[$m_index]->[2];
$m_index++;
}
}
if (!$f_atend && $f_neednext) {
$f_neednext = false;
if ($f_index > $#f_subdirs) {
$f_atend = true;
next;
} else {
$f_current = $f_subdirs[$f_index++];
}
}
if (!$f_atend && ($m_atend || $f_current lt $m_current)) {
if (!exists($m_check{$f_current})) {
$line->log_error("${f_current} exists in the file system, but not in the Makefile.");
$line->append_before("SUBDIR+=\t${f_current}");
}
$f_neednext = true;
} elsif (!$m_atend && ($f_atend || $m_current lt $f_current)) {
if (!exists($f_check{$m_current})) {
$line->log_error("${m_current} exists in the Makefile, but not in the file system.");
$line->delete();
}
$m_neednext = true;
} else { # $f_current eq $m_current
$f_neednext = true;
$m_neednext = true;
if ($m_recurse) {
push(@subdirs, "${current_dir}/${m_current}");
}
}
}
# the wip category Makefile may have its own targets for generating
# indexes and READMEs. Just skip them.
if ($is_wip) {
while ($lineno <= $#{$lines} - 2) {
$lineno++;
}
}
# Then we need an empty line
if ($lineno <= $#{$lines} && $lines->[$lineno]->text eq "") {
$lineno++;
} else {
$lines->[$lineno]->log_error("Empty line expected.");
}
# And, last but not least, the .include line
my $final_line = ".include \"../mk/bsd.pkg.subdir.mk\"";
if ($lineno <= $#{$lines} && $lines->[$lineno]->text eq $final_line) {
$lineno++;
} else {
$lines->[$lineno]->log_error("Expected this: ${final_line}.");
}
if ($lineno <= $#{$lines}) {
$lines->[$lineno]->log_error("The file should end here.");
}
checklines_mk($lines);
autofix($lines);
if ($opt_recursive) {
unshift(@todo_items, @subdirs);
}
}
sub checkdir_package() {
my ($whole, $lines, $have_distinfo, $have_patches);
# Initialize global variables
$pkgdir = undef;
$filesdir = "files";
$patchdir = "patches";
$distinfo_file = "distinfo";
$effective_pkgname = undef;
$effective_pkgbase = undef;
$effective_pkgversion = undef;
$effective_pkgname_line = undef;
$hack_php_patches = false;
$seen_bsd_prefs_mk = false;
$pkgctx_vardef = {%{get_userdefined_variables()}};
$pkgctx_varuse = {};
$pkgctx_bl3 = {};
$seen_Makefile_common = false;
# we need to handle the Makefile first to get some variables
if (!load_package_Makefile("${current_dir}/Makefile", \$whole, \$lines)) {
log_error("${current_dir}/Makefile", NO_LINE_NUMBER, "Cannot be read.");
goto cleanup;
}
my @files = <${current_dir}/*>;
if ($pkgdir ne ".") {
push(@files, <${current_dir}/${pkgdir}/*>);
}
if ($opt_check_extra) {
push(@files, <${current_dir}/${filesdir}/*>);
}
push(@files, <${current_dir}/${patchdir}/*>);
if ($distinfo_file !~ qr"^(?:\./)?distinfo$") {
push(@files, "${current_dir}/${distinfo_file}");
}
$have_distinfo = false;
$have_patches = false;
# Determine the used variables before checking any of the
# Makefile fragments.
foreach my $fname (@files) {
if ($fname =~ qr"^((?:.*/)?Makefile\..*|.*\.mk)$"
&& (defined(my $lines = load_lines($fname, true)))) {
parselines_mk($lines);
determine_used_variables($lines);
}
}
foreach my $fname (@files) {
if ($fname eq "${current_dir}/Makefile") {
$opt_check_Makefile and checkfile_package_Makefile($fname, $whole, $lines);
} else {
checkfile($fname);
}
if ($fname =~ qr"/patches/patch-[A-Za-z0-9]*$") {
$have_patches = true;
} elsif ($fname =~ qr"/distinfo$") {
$have_distinfo = true;
}
}
if ($opt_check_distinfo && $opt_check_patches) {
if ($have_patches && ! $have_distinfo) {
log_warning("${current_dir}/$distinfo_file", NO_LINE_NUMBER, "File not found. Please run '".conf_make." makepatchsum'.");
}
}
if (!is_emptydir("${current_dir}/scripts")) {
log_warning("${current_dir}/scripts", NO_LINE_NUMBER, "This directory and its contents are deprecated! Please call the script(s) explicitly from the corresponding target(s) in the pkg's Makefile.");
}
cleanup:
# Clean up global variables.
$pkgdir = undef;
$filesdir = undef;
$patchdir = undef;
$distinfo_file = undef;
$effective_pkgname = undef;
$effective_pkgbase = undef;
$effective_pkgversion = undef;
$effective_pkgname_line = undef;
$hack_php_patches = undef;
$seen_bsd_prefs_mk = undef;
$pkgctx_vardef = undef;
$pkgctx_varuse = undef;
$pkgctx_bl3 = undef;
$seen_Makefile_common = undef;
}
#
# Selecting the proper checking procedures for a directory entry.
#
sub checkitem($) {
my ($item) = @_;
my ($st, $is_dir, $is_reg);
if (!($st = lstat($item))) {
log_error($item, NO_LINE_NUMBER, "Does not exist.");
return;
}
$is_dir = S_ISDIR($st->mode);
$is_reg = S_ISREG($st->mode);
if (!$is_reg && !$is_dir) {
log_error($item, NO_LINE_NUMBER, "Must be a file or directory.");
return;
}
$current_dir = $is_dir ? $item : dirname($item);
my $abs_current_dir = Cwd::abs_path($current_dir);
$is_wip = !$opt_import && ($abs_current_dir =~ qr"/wip(?:/|$)");
$is_internal = ($abs_current_dir =~ qr"/mk(?:/|$)");
# Determine the root directory of pkgsrc. By only overwriting
# the global variable $cwd_pkgsrcdir when we are checking inside
# a pkgsrc tree, the user can specify a tree with the
# --pkgsrcdir option and then check files outside of any pkgsrc
# tree.
$cur_pkgsrcdir = undef;
foreach my $d (".", "..", "../..", "../../..") {
if (-f "${current_dir}/${d}/mk/bsd.pkg.mk") {
$cur_pkgsrcdir = $d;
}
}
if (!defined($cwd_pkgsrcdir) && defined($cur_pkgsrcdir)) {
$cwd_pkgsrcdir = "${current_dir}/${cur_pkgsrcdir}";
}
if (!defined($cwd_pkgsrcdir)) {
log_error($item, NO_LINE_NUMBER, "Cannot determine the pkgsrc root directory.");
return;
}
check_pkglint_version(); # (needs $cwd_pkgsrcdir)
if ($is_dir) {
checkdir_CVS($item);
}
if ($is_reg) {
checkfile($item);
} elsif (!defined($cur_pkgsrcdir)) {
log_error($item, NO_LINES, "Cannot check directories outside a pkgsrc tree.");
} elsif ($cur_pkgsrcdir eq "../..") {
checkdir_package();
} elsif ($cur_pkgsrcdir eq "..") {
checkdir_category();
} elsif ($cur_pkgsrcdir eq ".") {
checkdir_root();
} else {
log_error($item, NO_LINE_NUMBER, "Don't know how to check this directory.");
}
}
#
# The main program
#
sub main() {
$| = true;
parse_command_line();
@todo_items = (@ARGV != 0) ? @ARGV : (".");
while (@todo_items != 0) {
checkitem(shift(@todo_items));
}
PkgLint::Logging::print_summary_and_exit($opt_quiet);
}
main();
|