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
|
/* prefs.c
* Routines for handling preferences
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "config.h"
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <glib.h>
#include <stdio.h>
#include <wsutil/filesystem.h>
#include <epan/address.h>
#include <epan/addr_resolv.h>
#include <epan/oids.h>
#ifdef HAVE_GEOIP
#include <epan/geoip_db.h>
#endif
#include <epan/packet.h>
#include <epan/prefs.h>
#include <epan/proto.h>
#include <epan/strutil.h>
#include <epan/column.h>
#include "print.h"
#include <wsutil/file_util.h>
#include <epan/prefs-int.h>
#include <epan/uat-int.h>
#include "epan/filter_expressions.h"
#include "epan/wmem/wmem.h"
#include <epan/stats_tree.h>
/* Internal functions */
static module_t *find_subtree(module_t *parent, const char *tilte);
static module_t *prefs_register_module_or_subtree(module_t *parent,
const char *name, const char *title, const char *description, gboolean is_subtree,
void (*apply_cb)(void), gboolean use_gui);
static void prefs_register_modules(void);
static prefs_set_pref_e set_pref(gchar*, const gchar*, void *, gboolean);
static void free_col_info(GList *);
static void pre_init_prefs(void);
static gboolean prefs_is_column_visible(const gchar *cols_hidden, fmt_data *cfmt);
static gboolean parse_column_format(fmt_data *cfmt, const char *fmt);
static void try_convert_to_custom_column(gpointer *el_data);
#define IS_PREF_OBSOLETE(p) ((p) & PREF_OBSOLETE)
#define SET_PREF_OBSOLETE(p) ((p) |= PREF_OBSOLETE)
#define RESET_PREF_OBSOLETE(p) ((p) &= ~PREF_OBSOLETE)
#define PF_NAME "preferences"
#define OLD_GPF_NAME "wireshark.conf" /* old name for global preferences file */
static gboolean prefs_initialized = FALSE;
static gchar *gpf_path = NULL;
static gchar *cols_hidden_list = NULL;
/*
* XXX - variables to allow us to attempt to interpret the first
* "mgcp.{tcp,udp}.port" in a preferences file as
* "mgcp.{tcp,udp}.gateway_port" and the second as
* "mgcp.{tcp,udp}.callagent_port".
*/
static int mgcp_tcp_port_count;
static int mgcp_udp_port_count;
e_prefs prefs;
static const enum_val_t gui_ptree_line_style[] = {
{"NONE", "NONE", 0},
{"SOLID", "SOLID", 1},
{"DOTTED", "DOTTED", 2},
{"TABBED", "TABBED", 3},
{NULL, NULL, -1}
};
static const enum_val_t gui_ptree_expander_style[] = {
{"NONE", "NONE", 0},
{"SQUARE", "SQUARE", 1},
{"TRIANGLE", "TRIANGLE", 2},
{"CIRCULAR", "CIRCULAR", 3},
{NULL, NULL, -1}
};
static const enum_val_t gui_hex_dump_highlight_style[] = {
{"BOLD", "BOLD", 0},
{"INVERSE", "INVERSE", 1},
{NULL, NULL, -1}
};
static const enum_val_t gui_console_open_type[] = {
{"NEVER", "NEVER", console_open_never},
{"AUTOMATIC", "AUTOMATIC", console_open_auto},
{"ALWAYS", "ALWAYS", console_open_always},
{NULL, NULL, -1}
};
static const enum_val_t gui_version_placement_type[] = {
{"WELCOME", "WELCOME", version_welcome_only},
{"TITLE", "TITLE", version_title_only},
{"BOTH", "BOTH", version_both},
{"NEITHER", "NEITHER", version_neither},
{NULL, NULL, -1}
};
static const enum_val_t gui_fileopen_style[] = {
{"LAST_OPENED", "LAST_OPENED", 0},
{"SPECIFIED", "SPECIFIED", 1},
{NULL, NULL, -1}
};
/* GTK knows of two ways representing "both", vertical and horizontal aligned.
* as this may not work on other guis, we use only "both" in general here */
static const enum_val_t gui_toolbar_style[] = {
{"ICONS", "ICONS", 0},
{"TEXT", "TEXT", 1},
{"BOTH", "BOTH", 2},
{NULL, NULL, -1}
};
static const enum_val_t gui_layout_content[] = {
{"NONE", "NONE", 0},
{"PLIST", "PLIST", 1},
{"PDETAILS", "PDETAILS", 2},
{"PBYTES", "PBYTES", 3},
{NULL, NULL, -1}
};
static const enum_val_t gui_update_channel[] = {
{"DEVELOPMENT", "DEVELOPMENT", UPDATE_CHANNEL_DEVELOPMENT},
{"STABLE", "STABLE", UPDATE_CHANNEL_STABLE},
{NULL, NULL, -1}
};
#if defined(HAVE_PCAP_CREATE)
/* Can set monitor mode and buffer size. */
static gint num_capture_cols = 7;
static const gchar *capture_cols[7] = {
"INTERFACE",
"LINK",
"PMODE",
"SNAPLEN",
"MONITOR",
"BUFFER",
"FILTER"
};
#define CAPTURE_COL_TYPE_DESCRIPTION \
"Possible values: INTERFACE, LINK, PMODE, SNAPLEN, MONITOR, BUFFER, FILTER\n"
#elif defined(CAN_SET_CAPTURE_BUFFER_SIZE)
/* Can set buffer size but not monitor mode. */
static gint num_capture_cols = 6;
static const gchar *capture_cols[6] = {
"INTERFACE",
"LINK",
"PMODE",
"SNAPLEN",
"BUFFER",
"FILTER"
};
#define CAPTURE_COL_TYPE_DESCRIPTION \
"Possible values: INTERFACE, LINK, PMODE, SNAPLEN, BUFFER, FILTER\n"
#else
/* Can neither set buffer size nor monitor mode. */
static gint num_capture_cols = 5;
static const gchar *capture_cols[5] = {
"INTERFACE",
"LINK",
"PMODE",
"SNAPLEN",
"FILTER"
};
#define CAPTURE_COL_TYPE_DESCRIPTION \
"Possible values: INTERFACE, LINK, PMODE, SNAPLEN, FILTER\n"
#endif
static const enum_val_t gui_packet_list_elide_mode[] = {
{"LEFT", "LEFT", ELIDE_LEFT},
{"RIGHT", "RIGHT", ELIDE_RIGHT},
{"MIDDLE", "MIDDLE", ELIDE_MIDDLE},
{"NONE", "NONE", ELIDE_NONE},
{NULL, NULL, -1}
};
/*
* List of all modules with preference settings.
*/
static wmem_tree_t *prefs_modules = NULL;
/*
* List of all modules that should show up at the top level of the
* tree in the preference dialog box.
*/
static wmem_tree_t *prefs_top_level_modules = NULL;
/** Sets up memory used by proto routines. Called at program startup */
void
prefs_init(void)
{
memset(&prefs, 0, sizeof(prefs));
prefs_modules = wmem_tree_new(wmem_epan_scope());
prefs_top_level_modules = wmem_tree_new(wmem_epan_scope());
}
/*
* Free the strings for a string-like preference.
*/
static void
free_string_like_preference(pref_t *pref)
{
g_free(*pref->varp.string);
*pref->varp.string = NULL;
g_free(pref->default_val.string);
pref->default_val.string = NULL;
}
static void
free_pref(gpointer data, gpointer user_data _U_)
{
pref_t *pref = (pref_t *)data;
int type = pref->type;
/* we reset the PREF_OBSOLETE bit in order to allow the original preference to be freed */
RESET_PREF_OBSOLETE(type);
switch (type) {
case PREF_BOOL:
case PREF_ENUM:
case PREF_UINT:
case PREF_STATIC_TEXT:
case PREF_UAT:
case PREF_COLOR:
break;
case PREF_STRING:
case PREF_FILENAME:
case PREF_DIRNAME:
g_free(*pref->varp.string);
*pref->varp.string = NULL;
g_free(pref->default_val.string);
pref->default_val.string = NULL;
break;
case PREF_RANGE:
g_free(*pref->varp.range);
*pref->varp.range = NULL;
g_free(pref->default_val.range);
pref->default_val.range = NULL;
break;
case PREF_CUSTOM:
if (strcmp(pref->name, "columns") == 0)
pref->stashed_val.boolval = TRUE;
pref->custom_cbs.free_cb(pref);
break;
}
g_free(pref);
}
static guint
free_module_prefs(module_t *module, gpointer data _U_)
{
if (module->prefs) {
g_list_foreach(module->prefs, free_pref, NULL);
g_list_free(module->prefs);
}
module->prefs = NULL;
module->numprefs = 0;
if (module->submodules) {
prefs_modules_foreach_submodules(module, free_module_prefs, NULL);
}
/* We don't free the actual module: its submodules pointer points to
a wmem_tree and the module itself is stored in a wmem_tree
*/
return 0;
}
/** Frees memory used by proto routines. Called at program shutdown */
void
prefs_cleanup(void)
{
/* This isn't strictly necessary since we're exiting anyway, but let's
* do what clean up we can.
*/
prefs_modules_foreach(free_module_prefs, NULL);
}
/*
* Register a module that will have preferences.
* Specify the module under which to register it or NULL to register it
* at the top level, the name used for the module in the preferences file,
* the title used in the tab for it in a preferences dialog box, and a
* routine to call back when we apply the preferences.
*/
module_t *
prefs_register_module(module_t *parent, const char *name, const char *title,
const char *description, void (*apply_cb)(void),
const gboolean use_gui)
{
return prefs_register_module_or_subtree(parent, name, title, description,
FALSE, apply_cb, use_gui);
}
static void
prefs_deregister_module(module_t *parent, const char *name, const char *title)
{
/* Remove this module from the list of all modules */
module_t *module = (module_t *)wmem_tree_remove_string(prefs_modules, name, WMEM_TREE_STRING_NOCASE);
if (!module)
return;
if (parent == NULL) {
/* Remove from top */
wmem_tree_remove_string(prefs_top_level_modules, title, WMEM_TREE_STRING_NOCASE);
} else if (parent->submodules) {
/* Remove from parent */
wmem_tree_remove_string(parent->submodules, title, WMEM_TREE_STRING_NOCASE);
}
free_module_prefs(module, NULL);
wmem_free(wmem_epan_scope(), module);
}
/*
* Register a subtree that will have modules under it.
* Specify the module under which to register it or NULL to register it
* at the top level and the title used in the tab for it in a preferences
* dialog box.
*/
module_t *
prefs_register_subtree(module_t *parent, const char *title, const char *description,
void (*apply_cb)(void))
{
return prefs_register_module_or_subtree(parent, NULL, title, description,
TRUE, apply_cb,
parent ? parent->use_gui : FALSE);
}
static module_t *
prefs_register_module_or_subtree(module_t *parent, const char *name,
const char *title, const char *description,
gboolean is_subtree, void (*apply_cb)(void),
gboolean use_gui)
{
module_t *module;
const char *p;
guchar c;
/* this module may have been created as a subtree item previously */
if ((module = find_subtree(parent, title))) {
/* the module is currently a subtree */
module->name = name;
module->apply_cb = apply_cb;
module->description = description;
if (prefs_find_module(name) == NULL) {
wmem_tree_insert_string(prefs_modules, name, module,
WMEM_TREE_STRING_NOCASE);
}
return module;
}
module = wmem_new(wmem_epan_scope(), module_t);
module->name = name;
module->title = title;
module->description = description;
module->apply_cb = apply_cb;
module->prefs = NULL; /* no preferences, to start */
module->parent = parent;
module->submodules = NULL; /* no submodules, to start */
module->numprefs = 0;
module->prefs_changed = FALSE;
module->obsolete = FALSE;
module->use_gui = use_gui;
/*
* Do we have a module name?
*/
if (name != NULL) {
/*
* Yes.
* Make sure that only lower-case ASCII letters, numbers,
* underscores, hyphens, and dots appear in the name.
*
* Crash if there is, as that's an error in the code;
* you can make the title a nice string with capitalization,
* white space, punctuation, etc., but the name can be used
* on the command line, and shouldn't require quoting,
* shifting, etc.
*/
for (p = name; (c = *p) != '\0'; p++)
g_assert(g_ascii_islower(c) || g_ascii_isdigit(c) || c == '_' ||
c == '-' || c == '.');
/*
* Make sure there's not already a module with that
* name. Crash if there is, as that's an error in the
* code, and the code has to be fixed not to register
* more than one module with the same name.
*
* We search the list of all modules; the subtree stuff
* doesn't require preferences in subtrees to have names
* that reflect the subtree they're in (that would require
* protocol preferences to have a bogus "protocol.", or
* something such as that, to be added to all their names).
*/
g_assert(prefs_find_module(name) == NULL);
/*
* Insert this module in the list of all modules.
*/
wmem_tree_insert_string(prefs_modules, name, module, WMEM_TREE_STRING_NOCASE);
} else {
/*
* This has no name, just a title; check to make sure it's a
* subtree, and crash if it's not.
*/
g_assert(is_subtree);
}
/*
* Insert this module into the appropriate place in the display
* tree.
*/
if (parent == NULL) {
/*
* It goes at the top.
*/
wmem_tree_insert_string(prefs_top_level_modules, title, module, WMEM_TREE_STRING_NOCASE);
} else {
/*
* It goes into the list for this module.
*/
if (parent->submodules == NULL)
parent->submodules = wmem_tree_new(wmem_epan_scope());
wmem_tree_insert_string(parent->submodules, title, module, WMEM_TREE_STRING_NOCASE);
}
return module;
}
/*
* Register that a protocol has preferences.
*/
module_t *protocols_module = NULL;
module_t *
prefs_register_protocol(int id, void (*apply_cb)(void))
{
protocol_t *protocol;
/*
* Have we yet created the "Protocols" subtree?
*/
if (protocols_module == NULL) {
/*
* No. Register Protocols subtree as well as any preferences
* for non-dissector modules.
*/
pre_init_prefs();
prefs_register_modules();
}
protocol = find_protocol_by_id(id);
return prefs_register_module(protocols_module,
proto_get_protocol_filter_name(id),
proto_get_protocol_short_name(protocol),
proto_get_protocol_name(id), apply_cb, TRUE);
}
void
prefs_deregister_protocol (int id)
{
protocol_t *protocol = find_protocol_by_id(id);
prefs_deregister_module (protocols_module,
proto_get_protocol_filter_name(id),
proto_get_protocol_short_name(protocol));
}
module_t *
prefs_register_protocol_subtree(const char *subtree, int id, void (*apply_cb)(void))
{
protocol_t *protocol;
module_t *subtree_module;
module_t *new_module;
char *sep = NULL, *ptr = NULL, *orig = NULL;
/*
* Have we yet created the "Protocols" subtree?
* XXX - can we just do this by registering Protocols/{subtree}?
* If not, why not?
*/
if (protocols_module == NULL) {
/*
* No. Register Protocols subtree as well as any preferences
* for non-dissector modules.
*/
pre_init_prefs();
prefs_register_modules();
}
subtree_module = protocols_module;
if (subtree) {
/* take a copy of the buffer, orig keeps a base pointer while ptr
* walks through the string */
orig = ptr = g_strdup(subtree);
while (ptr && *ptr) {
if ((sep = strchr(ptr, '/')))
*sep++ = '\0';
if (!(new_module = find_subtree(subtree_module, ptr))) {
/*
* There's no such module; create it, with the description
* being the name (if it's later registered explicitly
* with a description, that will override it).
*/
ptr = wmem_strdup(wmem_epan_scope(), ptr),
new_module = prefs_register_subtree(subtree_module, ptr, ptr, NULL);
}
subtree_module = new_module;
ptr = sep;
}
g_free(orig);
}
protocol = find_protocol_by_id(id);
return prefs_register_module(subtree_module,
proto_get_protocol_filter_name(id),
proto_get_protocol_short_name(protocol),
proto_get_protocol_name(id), apply_cb, TRUE);
}
/*
* Register that a protocol used to have preferences but no longer does,
* by creating an "obsolete" module for it.
*/
module_t *
prefs_register_protocol_obsolete(int id)
{
module_t *module;
protocol_t *protocol;
/*
* Have we yet created the "Protocols" subtree?
*/
if (protocols_module == NULL) {
/*
* No. Register Protocols subtree as well as any preferences
* for non-dissector modules.
*/
pre_init_prefs();
prefs_register_modules();
}
protocol = find_protocol_by_id(id);
module = prefs_register_module(protocols_module,
proto_get_protocol_filter_name(id),
proto_get_protocol_short_name(protocol),
proto_get_protocol_name(id), NULL, TRUE);
module->obsolete = TRUE;
return module;
}
/*
* Register that a statistical tap has preferences.
*
* "name" is a name for the tap to use on the command line with "-o"
* and in preference files.
*
* "title" is a short human-readable name for the tap.
*
* "description" is a longer human-readable description of the tap.
*/
module_t *stats_module = NULL;
module_t *
prefs_register_stat(const char *name, const char *title,
const char *description, void (*apply_cb)(void))
{
/*
* Have we yet created the "Statistics" subtree?
*/
if (stats_module == NULL) {
/*
* No. Register Statistics subtree as well as any preferences
* for non-dissector modules.
*/
pre_init_prefs();
prefs_register_modules();
}
return prefs_register_module(stats_module, name, title, description,
apply_cb, TRUE);
}
module_t *
prefs_find_module(const char *name)
{
return (module_t *)wmem_tree_lookup_string(prefs_modules, name, WMEM_TREE_STRING_NOCASE);
}
static module_t *
find_subtree(module_t *parent, const char *name)
{
return (module_t *)wmem_tree_lookup_string(parent ? parent->submodules : prefs_top_level_modules, name, WMEM_TREE_STRING_NOCASE);
}
/*
* Call a callback function, with a specified argument, for each module
* in a list of modules. If the list is NULL, searches the top-level
* list in the display tree of modules. If any callback returns a
* non-zero value, we stop and return that value, otherwise we
* return 0.
*
* Ignores "obsolete" modules; their sole purpose is to allow old
* preferences for dissectors that no longer have preferences to be
* silently ignored in preference files. Does not ignore subtrees,
* as this can be used when walking the display tree of modules.
*/
typedef struct {
module_cb callback;
gpointer user_data;
guint ret;
} call_foreach_t;
static gboolean
call_foreach_cb(const void *key _U_, void *value, void *data)
{
module_t *module = (module_t*)value;
call_foreach_t *call_data = (call_foreach_t*)data;
if (!module->obsolete)
call_data->ret = (*call_data->callback)(module, call_data->user_data);
return (call_data->ret != 0);
}
static guint
prefs_module_list_foreach(wmem_tree_t *module_list, module_cb callback,
gpointer user_data)
{
call_foreach_t call_data;
if (module_list == NULL)
module_list = prefs_top_level_modules;
call_data.callback = callback;
call_data.user_data = user_data;
call_data.ret = 0;
wmem_tree_foreach(module_list, call_foreach_cb, &call_data);
return call_data.ret;
}
/*
* Returns TRUE if module has any submodules
*/
gboolean
prefs_module_has_submodules(module_t *module)
{
if (module->submodules == NULL) {
return FALSE;
}
if (wmem_tree_is_empty(module->submodules)) {
return FALSE;
}
return TRUE;
}
/*
* Call a callback function, with a specified argument, for each module
* in the list of all modules. (This list does not include subtrees.)
*
* Ignores "obsolete" modules; their sole purpose is to allow old
* preferences for dissectors that no longer have preferences to be
* silently ignored in preference files.
*/
guint
prefs_modules_foreach(module_cb callback, gpointer user_data)
{
return prefs_module_list_foreach(prefs_modules, callback, user_data);
}
/*
* Call a callback function, with a specified argument, for each submodule
* of specified modules. If the module is NULL, goes through the top-level
* list in the display tree of modules.
*
* Ignores "obsolete" modules; their sole purpose is to allow old
* preferences for dissectors that no longer have preferences to be
* silently ignored in preference files. Does not ignore subtrees,
* as this can be used when walking the display tree of modules.
*/
guint
prefs_modules_foreach_submodules(module_t *module, module_cb callback,
gpointer user_data)
{
return prefs_module_list_foreach((module)?module->submodules:prefs_top_level_modules, callback, user_data);
}
static gboolean
call_apply_cb(const void *key _U_, void *value, void *data _U_)
{
module_t *module = (module_t *)value;
if (module->obsolete)
return FALSE;
if (module->prefs_changed) {
if (module->apply_cb != NULL)
(*module->apply_cb)();
module->prefs_changed = FALSE;
}
if (module->submodules)
wmem_tree_foreach(module->submodules, call_apply_cb, NULL);
return FALSE;
}
/*
* Call the "apply" callback function for each module if any of its
* preferences have changed, and then clear the flag saying its
* preferences have changed, as the module has been notified of that
* fact.
*/
void
prefs_apply_all(void)
{
wmem_tree_foreach(prefs_modules, call_apply_cb, NULL);
}
/*
* Call the "apply" callback function for a specific module if any of
* its preferences have changed, and then clear the flag saying its
* preferences have changed, as the module has been notified of that
* fact.
*/
void
prefs_apply(module_t *module)
{
if (module && module->prefs_changed)
call_apply_cb(NULL, module, NULL);
}
/*
* Register a preference in a module's list of preferences.
* If it has a title, give it an ordinal number; otherwise, it's a
* preference that won't show up in the UI, so it shouldn't get an
* ordinal number (the ordinal should be the ordinal in the set of
* *visible* preferences).
*/
static pref_t *
register_preference(module_t *module, const char *name, const char *title,
const char *description, int type)
{
pref_t *preference;
const gchar *p;
preference = g_new(pref_t,1);
preference->name = name;
preference->title = title;
preference->description = description;
preference->type = type;
preference->gui = GUI_ALL; /* default */
if (title != NULL)
preference->ordinal = module->numprefs;
else
preference->ordinal = -1; /* no ordinal for you */
/*
* Make sure that only lower-case ASCII letters, numbers,
* underscores, and dots appear in the preference name.
*
* Crash if there is, as that's an error in the code;
* you can make the title and description nice strings
* with capitalization, white space, punctuation, etc.,
* but the name can be used on the command line,
* and shouldn't require quoting, shifting, etc.
*/
for (p = name; *p != '\0'; p++)
if (!(g_ascii_islower(*p) || g_ascii_isdigit(*p) || *p == '_' || *p == '.'))
g_error("Preference %s.%s contains invalid characters", module->name, name);
/*
* Make sure there's not already a preference with that
* name. Crash if there is, as that's an error in the
* code, and the code has to be fixed not to register
* more than one preference with the same name.
*/
if (prefs_find_preference(module, name) != NULL)
g_error("Preference %s has already been registered", name);
if ((!IS_PREF_OBSOLETE(type)) &&
/* Don't compare if it's a subtree */
(module->name != NULL)) {
/*
* Make sure the preference name doesn't begin with the
* module name, as that's redundant and Just Silly.
*/
if (!((strncmp(name, module->name, strlen(module->name)) != 0) ||
(((name[strlen(module->name)]) != '.') && ((name[strlen(module->name)]) != '_'))))
g_error("Preference %s begins with the module name", name);
}
/*
* There isn't already one with that name, so add the
* preference.
*/
module->prefs = g_list_append(module->prefs, preference);
if (title != NULL)
module->numprefs++;
return preference;
}
/*
* Find a preference in a module's list of preferences, given the module
* and the preference's name.
*/
typedef struct {
GList *list_entry;
const char *name;
module_t *submodule;
} find_pref_arg_t;
static gint
preference_match(gconstpointer a, gconstpointer b)
{
const pref_t *pref = (const pref_t *)a;
const char *name = (const char *)b;
return strcmp(name, pref->name);
}
static gboolean
module_find_pref_cb(const void *key _U_, void *value, void *data)
{
find_pref_arg_t* arg = (find_pref_arg_t*)data;
GList *list_entry;
module_t *module = (module_t *)value;
if (module == NULL)
return FALSE;
list_entry = g_list_find_custom(module->prefs, arg->name,
preference_match);
if (list_entry == NULL)
return FALSE;
arg->list_entry = list_entry;
arg->submodule = module;
return TRUE;
}
/* Tries to find a preference, setting containing_module to the (sub)module
* holding this preference. */
static struct preference *
prefs_find_preference_with_submodule(module_t *module, const char *name,
module_t **containing_module)
{
find_pref_arg_t arg;
GList *list_entry;
if (module == NULL)
return NULL; /* invalid parameters */
list_entry = g_list_find_custom(module->prefs, name,
preference_match);
arg.submodule = NULL;
if (list_entry == NULL)
{
arg.list_entry = NULL;
if (module->submodules != NULL)
{
arg.name = name;
wmem_tree_foreach(module->submodules, module_find_pref_cb, &arg);
}
list_entry = arg.list_entry;
}
if (list_entry == NULL)
return NULL; /* no such preference */
if (containing_module)
*containing_module = arg.submodule ? arg.submodule : module;
return (struct preference *) list_entry->data;
}
struct preference *
prefs_find_preference(module_t *module, const char *name)
{
return prefs_find_preference_with_submodule(module, name, NULL);
}
/*
* Returns TRUE if the given protocol has registered preferences
*/
gboolean
prefs_is_registered_protocol(const char *name)
{
module_t *m = prefs_find_module(name);
return (m != NULL && !m->obsolete);
}
/*
* Returns the module title of a registered protocol
*/
const char *
prefs_get_title_by_name(const char *name)
{
module_t *m = prefs_find_module(name);
return (m != NULL && !m->obsolete) ? m->title : NULL;
}
/*
* Register a preference with an unsigned integral value.
*/
void
prefs_register_uint_preference(module_t *module, const char *name,
const char *title, const char *description,
guint base, guint *var)
{
pref_t *preference;
preference = register_preference(module, name, title, description,
PREF_UINT);
preference->varp.uint = var;
preference->default_val.uint = *var;
g_assert(base > 0 && base != 1 && base < 37);
preference->info.base = base;
}
/*
* XXX Add a prefs_register_{uint16|port}_preference which sets max_value?
*/
/*
* Register a "custom" preference with a unsigned integral value.
* XXX - This should be temporary until we can find a better way
* to do "custom" preferences
*/
static void
prefs_register_uint_custom_preference(module_t *module, const char *name,
const char *title, const char *description,
struct pref_custom_cbs* custom_cbs, guint *var)
{
pref_t *preference;
preference = register_preference(module, name, title, description,
PREF_CUSTOM);
preference->custom_cbs = *custom_cbs;
preference->varp.uint = var;
preference->default_val.uint = *var;
}
/*
* Register a preference with an Boolean value.
*/
void
prefs_register_bool_preference(module_t *module, const char *name,
const char *title, const char *description,
gboolean *var)
{
pref_t *preference;
preference = register_preference(module, name, title, description,
PREF_BOOL);
preference->varp.boolp = var;
preference->default_val.boolval = *var;
}
/*
* Register a preference with an enumerated value.
*/
void
prefs_register_enum_preference(module_t *module, const char *name,
const char *title, const char *description,
gint *var, const enum_val_t *enumvals,
gboolean radio_buttons)
{
pref_t *preference;
preference = register_preference(module, name, title, description,
PREF_ENUM);
preference->varp.enump = var;
preference->default_val.enumval = *var;
preference->info.enum_info.enumvals = enumvals;
preference->info.enum_info.radio_buttons = radio_buttons;
}
static void
register_string_like_preference(module_t *module, const char *name,
const char *title, const char *description,
char **var, int type,
struct pref_custom_cbs* custom_cbs,
gboolean free_tmp)
{
pref_t *pref;
gchar *tmp;
pref = register_preference(module, name, title, description, type);
/*
* String preference values should be non-null (as you can't
* keep them null after using the preferences GUI, you can at best
* have them be null strings) and freeable (as we free them
* if we change them).
*
* If the value is a null pointer, make it a copy of a null
* string, otherwise make it a copy of the value.
*/
tmp = *var;
if (*var == NULL) {
*var = g_strdup("");
} else {
*var = g_strdup(*var);
}
if (free_tmp) {
g_free(tmp);
}
pref->varp.string = var;
pref->default_val.string = g_strdup(*var);
pref->stashed_val.string = NULL;
if (type == PREF_CUSTOM) {
g_assert(custom_cbs);
pref->custom_cbs = *custom_cbs;
}
}
/*
* For use by UI code that sets preferences.
*/
void
prefs_set_string_like_value(pref_t *pref, const gchar *value, gboolean *changed)
{
if (*pref->varp.string) {
if (strcmp(*pref->varp.string, value) != 0) {
*changed = TRUE;
g_free(*pref->varp.string);
*pref->varp.string = g_strdup(value);
}
} else if (value) {
*pref->varp.string = g_strdup(value);
}
}
/*
* Reset the value of a string-like preference.
*/
static void
reset_string_like_preference(pref_t *pref)
{
g_free(*pref->varp.string);
*pref->varp.string = g_strdup(pref->default_val.string);
}
/*
* Register a preference with a character-string value.
*/
void
prefs_register_string_preference(module_t *module, const char *name,
const char *title, const char *description,
const char **var)
{
DIAG_OFF(cast-qual)
register_string_like_preference(module, name, title, description,
(char **)var, PREF_STRING, NULL, FALSE);
DIAG_ON(cast-qual)
}
/*
* Register a preference with a file name (string) value.
*/
void
prefs_register_filename_preference(module_t *module, const char *name,
const char *title, const char *description,
const char **var)
{
DIAG_OFF(cast-qual)
register_string_like_preference(module, name, title, description,
(char **)var, PREF_FILENAME, NULL, FALSE);
DIAG_ON(cast-qual)
}
/*
* Register a preference with a directory name (string) value.
*/
void
prefs_register_directory_preference(module_t *module, const char *name,
const char *title, const char *description,
const char **var)
{
DIAG_OFF(cast-qual)
register_string_like_preference(module, name, title, description,
(char **)var, PREF_DIRNAME, NULL, FALSE);
DIAG_ON(cast-qual)
}
/*
* Register a preference with a ranged value.
*/
void
prefs_register_range_preference(module_t *module, const char *name,
const char *title, const char *description,
range_t **var, guint32 max_value)
{
pref_t *preference;
preference = register_preference(module, name, title, description,
PREF_RANGE);
preference->info.max_value = max_value;
/*
* Range preference values should be non-null (as you can't
* keep them null after using the preferences GUI, you can at best
* have them be empty ranges) and freeable (as we free them
* if we change them).
*
* If the value is a null pointer, make it an empty range.
*/
if (*var == NULL)
*var = range_empty();
preference->varp.range = var;
preference->default_val.range = range_copy(*var);
preference->stashed_val.range = NULL;
}
static gboolean
prefs_set_range_value_work(pref_t *pref, const gchar *value,
gboolean return_range_errors, gboolean *changed)
{
range_t *newrange;
if (range_convert_str_work(&newrange, value, pref->info.max_value,
return_range_errors) != CVT_NO_ERROR) {
return FALSE; /* number was bad */
}
if (!ranges_are_equal(*pref->varp.range, newrange)) {
*changed = TRUE;
g_free(*pref->varp.range);
*pref->varp.range = newrange;
} else {
g_free(newrange);
}
return TRUE;
}
/*
* For use by UI code that sets preferences.
*/
gboolean
prefs_set_range_value(pref_t *pref, const gchar *value, gboolean *changed)
{
return prefs_set_range_value_work(pref, value, TRUE, changed);
}
/*
* Register a static text 'preference'. It can be used to add explanatory
* text inline with other preferences in the GUI.
* Note: Static preferences are not saved to the preferences file.
*/
void
prefs_register_static_text_preference(module_t *module, const char *name,
const char *title,
const char *description)
{
register_preference(module, name, title, description, PREF_STATIC_TEXT);
}
/*
* Register a uat 'preference'. It adds a button that opens the uat's window in the
* preferences tab of the module.
*/
extern void
prefs_register_uat_preference(module_t *module, const char *name,
const char *title, const char *description,
uat_t* uat)
{
pref_t* preference = register_preference(module, name, title, description, PREF_UAT);
preference->varp.uat = uat;
}
/*
* Register a uat 'preference' for QT only. It adds a button that opens the uat's window in the
* preferences tab of the module.
*/
extern void
prefs_register_uat_preference_qt(module_t *module, const char *name,
const char *title, const char *description,
uat_t* uat)
{
pref_t* preference = register_preference(module, name, title, description, PREF_UAT);
preference->varp.uat = uat;
preference->gui = GUI_QT;
}
/*
* Register a color preference.
*/
void
prefs_register_color_preference(module_t *module, const char *name,
const char *title, const char *description,
color_t *color)
{
pref_t* preference = register_preference(module, name, title, description, PREF_COLOR);
preference->varp.colorp = color;
preference->default_val.color = *color;
}
/*
* Register a "custom" preference with a list.
* XXX - This should be temporary until we can find a better way
* to do "custom" preferences
*/
typedef void (*pref_custom_list_init_cb) (pref_t* pref, GList** value);
static void
prefs_register_list_custom_preference(module_t *module, const char *name,
const char *title, const char *description,
struct pref_custom_cbs* custom_cbs,
pref_custom_list_init_cb init_cb,
GList** list)
{
pref_t* preference = register_preference(module, name, title, description, PREF_CUSTOM);
preference->custom_cbs = *custom_cbs;
init_cb(preference, list);
}
/*
* Register a custom preference.
*/
void
prefs_register_custom_preference(module_t *module, const char *name,
const char *title, const char *description,
struct pref_custom_cbs* custom_cbs,
void **custom_data _U_)
{
pref_t* preference = register_preference(module, name, title, description, PREF_CUSTOM);
preference->custom_cbs = *custom_cbs;
/* XXX - wait until we can handle void** pointers
preference->custom_cbs.init_cb(preference, custom_data);
*/
}
/*
* Register a preference that used to be supported but no longer is.
*/
void
prefs_register_obsolete_preference(module_t *module, const char *name)
{
register_preference(module, name, NULL, NULL, PREF_OBSOLETE);
}
/*
* Check to see if a preference is obsolete.
*/
extern gboolean
prefs_get_preference_obsolete(pref_t *pref)
{
if (pref)
return (IS_PREF_OBSOLETE(pref->type) ? TRUE : FALSE);
return TRUE;
}
/*
* Make a preference obsolete.
*/
extern prefs_set_pref_e
prefs_set_preference_obsolete(pref_t *pref)
{
if (pref) {
SET_PREF_OBSOLETE(pref->type);
return PREFS_SET_OK;
}
return PREFS_SET_NO_SUCH_PREF;
}
#if 0
/* Return the value assigned to the given uint preference. */
guint
prefs_get_uint_preference(pref_t *pref)
{
if (pref && pref->type == PREF_UINT)
return *pref->varp.uint;
return 0;
}
#endif
/*
* Call a callback function, with a specified argument, for each preference
* in a given module.
*
* If any of the callbacks return a non-zero value, stop and return that
* value, otherwise return 0.
*/
guint
prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data)
{
GList *elem;
pref_t *pref;
guint ret;
for (elem = g_list_first(module->prefs); elem != NULL; elem = g_list_next(elem)) {
pref = (pref_t *)elem->data;
if (IS_PREF_OBSOLETE(pref->type)) {
/*
* This preference is no longer supported; it's
* not a real preference, so we don't call the
* callback for it (i.e., we treat it as if it
* weren't found in the list of preferences,
* and we weren't called in the first place).
*/
continue;
}
ret = (*callback)(pref, user_data);
if (ret != 0)
return ret;
}
return 0;
}
static const enum_val_t print_format_vals[] = {
{ "text", "Plain Text", PR_FMT_TEXT },
{ "postscript", "Postscript", PR_FMT_PS },
{ NULL, NULL, 0 }
};
static const enum_val_t print_dest_vals[] = {
#ifdef _WIN32
/* "PR_DEST_CMD" means "to printer" on Windows */
{ "command", "Printer", PR_DEST_CMD },
#else
{ "command", "Command", PR_DEST_CMD },
#endif
{ "file", "File", PR_DEST_FILE },
{ NULL, NULL, 0 }
};
static const enum_val_t st_sort_col_vals[] = {
{ "name", "Node name (topic/item)", ST_SORT_COL_NAME },
{ "count", "Item count", ST_SORT_COL_COUNT },
{ "average", "Average value of the node", ST_SORT_COL_AVG },
{ "min", "Minimum value of the node", ST_SORT_COL_MIN },
{ "max", "Maximum value of the node", ST_SORT_COL_MAX },
{ "burst", "Burst rate of the node", ST_SORT_COL_BURSTRATE },
{ NULL, NULL, 0 }
};
static void
stats_callback(void)
{
/* Test for a sane tap update interval */
if (prefs.tap_update_interval < 100 || prefs.tap_update_interval > 10000)
prefs.tap_update_interval = TAP_UPDATE_DEFAULT_INTERVAL;
#ifdef HAVE_LIBPORTAUDIO
/* Test for a sane max channels entry */
if (prefs.rtp_player_max_visible < 1 || prefs.rtp_player_max_visible > 10)
prefs.rtp_player_max_visible = RTP_PLAYER_DEFAULT_VISIBLE;
#endif
/* burst resolution can't be less than 1 (ms) */
if (prefs.st_burst_resolution < 1) {
prefs.st_burst_resolution = 1;
}
else if (prefs.st_burst_resolution > ST_MAX_BURSTRES) {
prefs.st_burst_resolution = ST_MAX_BURSTRES;
}
/* make sure burst window value makes sense */
if (prefs.st_burst_windowlen < prefs.st_burst_resolution) {
prefs.st_burst_windowlen = prefs.st_burst_resolution;
}
/* round burst window down to multiple of resolution */
prefs.st_burst_windowlen -= prefs.st_burst_windowlen%prefs.st_burst_resolution;
if ((prefs.st_burst_windowlen/prefs.st_burst_resolution) > ST_MAX_BURSTBUCKETS) {
prefs.st_burst_windowlen = prefs.st_burst_resolution*ST_MAX_BURSTBUCKETS;
}
}
static void
gui_callback(void)
{
/* Ensure there is at least one file count */
if (prefs.gui_recent_files_count_max == 0)
prefs.gui_recent_files_count_max = 10;
/* Ensure there is at least one display filter entry */
if (prefs.gui_recent_df_entries_max == 0)
prefs.gui_recent_df_entries_max = 10;
}
static void
gui_layout_callback(void)
{
if (prefs.gui_layout_type == layout_unused ||
prefs.gui_layout_type >= layout_type_max) {
/* XXX - report an error? It's not a syntax error - we'd need to
add a way of reporting a *semantic* error. */
prefs.gui_layout_type = layout_type_5;
}
}
/******************************************************
* All custom preference function callbacks
******************************************************/
static void custom_pref_no_cb(pref_t* pref _U_) {}
/*
* Console log level custom preference functions
*/
static void
console_log_level_reset_cb(pref_t* pref)
{
*pref->varp.uint = pref->default_val.uint;
}
static prefs_set_pref_e
console_log_level_set_cb(pref_t* pref, const gchar* value, gboolean* changed)
{
guint uval;
uval = (guint)strtoul(value, NULL, 10);
if (*pref->varp.uint != uval) {
*changed = TRUE;
*pref->varp.uint = uval;
}
if (*pref->varp.uint & (G_LOG_LEVEL_INFO|G_LOG_LEVEL_DEBUG)) {
/*
* GLib >= 2.32 drops INFO and DEBUG messages by default. Tell
* it not to do that.
*/
g_setenv("G_MESSAGES_DEBUG", "all", TRUE);
}
return PREFS_SET_OK;
}
static const char * console_log_level_type_name_cb(void) {
return "Log level";
}
static char * console_log_level_type_description_cb(void) {
return g_strdup_printf(
"Console log level (for debugging)\n"
"A bitmask of log levels:\n"
"ERROR = 4\n"
"CRITICAL = 8\n"
"WARNING = 16\n"
"MESSAGE = 32\n"
"INFO = 64\n"
"DEBUG = 128");
}
static gboolean console_log_level_is_default_cb(pref_t* pref) {
return *pref->varp.uint == pref->default_val.uint;
}
static char * console_log_level_to_str_cb(pref_t* pref, gboolean default_val) {
return g_strdup_printf("%u", default_val ? pref->default_val.uint : *pref->varp.uint);
}
/*
* Column preference functions
*/
#define PRS_COL_HIDDEN "column.hidden"
#define PRS_COL_FMT "column.format"
#define PRS_COL_NUM "column.number"
static module_t *gui_column_module = NULL;
static prefs_set_pref_e
column_hidden_set_cb(pref_t* pref, const gchar* value, gboolean* changed)
{
GList *clp;
fmt_data *cfmt;
pref_t *format_pref;
prefs_set_string_like_value(pref, value, changed);
/*
* Set the "visible" flag for the existing columns; we need to
* do this if we set PRS_COL_HIDDEN but don't set PRS_COL_FMT
* after setting it (which might be the case if, for example, we
* set PRS_COL_HIDDEN on the command line).
*/
format_pref = prefs_find_preference(gui_column_module, PRS_COL_FMT);
for (clp = *format_pref->varp.list; clp != NULL; clp = clp->next) {
cfmt = (fmt_data *)clp->data;
cfmt->visible = prefs_is_column_visible(*pref->varp.string, cfmt);
}
return PREFS_SET_OK;
}
static const char *
column_hidden_type_name_cb(void)
{
return "Packet list hidden columns";
}
static char *
column_hidden_type_description_cb(void)
{
return g_strdup("List all columns to hide in the packet list.");
}
static char *
column_hidden_to_str_cb(pref_t* pref, gboolean default_val)
{
GString *cols_hidden = g_string_new ("");
GList *clp;
fmt_data *cfmt;
pref_t *format_pref;
if (default_val)
return g_strdup(pref->default_val.string);
format_pref = prefs_find_preference(gui_column_module, PRS_COL_FMT);
clp = (format_pref) ? *format_pref->varp.list : NULL;
while (clp) {
gchar *prefs_fmt;
cfmt = (fmt_data *) clp->data;
if ((cfmt->fmt == COL_CUSTOM) && (cfmt->custom_fields)) {
prefs_fmt = g_strdup_printf("%s:%s:%d:%c",
col_format_to_string(cfmt->fmt),
cfmt->custom_fields,
cfmt->custom_occurrence,
cfmt->resolved ? 'R' : 'U');
} else {
prefs_fmt = g_strdup(col_format_to_string(cfmt->fmt));
}
if (!cfmt->visible) {
if (cols_hidden->len)
g_string_append (cols_hidden, ",");
g_string_append (cols_hidden, prefs_fmt);
}
g_free(prefs_fmt);
clp = clp->next;
}
return g_string_free (cols_hidden, FALSE);
}
static gboolean
column_hidden_is_default_cb(pref_t* pref)
{
char *cur_hidden_str = column_hidden_to_str_cb(pref, FALSE);
gboolean is_default = g_strcmp0(cur_hidden_str, pref->default_val.string) == 0;
g_free(cur_hidden_str);
return is_default;
}
/* Number of columns "preference". This is only used internally and is not written to the
* preference file
*/
static void
column_num_reset_cb(pref_t* pref)
{
*pref->varp.uint = pref->default_val.uint;
}
static prefs_set_pref_e
column_num_set_cb(pref_t* pref _U_, const gchar* value _U_, gboolean* changed _U_)
{
/* Don't write this to the preferences file */
return PREFS_SET_OK;
}
static const char *
column_num_type_name_cb(void)
{
return NULL;
}
static char *
column_num_type_description_cb(void)
{
return g_strdup("");
}
static gboolean
column_num_is_default_cb(pref_t* pref _U_)
{
return TRUE;
}
static char *
column_num_to_str_cb(pref_t* pref _U_, gboolean default_val _U_)
{
return g_strdup("");
}
/*
* Column format custom preference functions
*/
static void
column_format_init_cb(pref_t* pref, GList** value)
{
fmt_data *src_cfmt, *dest_cfmt;
GList *entry;
pref->varp.list = value;
pref->default_val.list = NULL;
for (entry = *pref->varp.list; entry != NULL; entry = g_list_next(entry)) {
src_cfmt = (fmt_data *)entry->data;
dest_cfmt = g_new(fmt_data,1);
dest_cfmt->title = g_strdup(src_cfmt->title);
dest_cfmt->fmt = src_cfmt->fmt;
if (src_cfmt->custom_fields) {
dest_cfmt->custom_fields = g_strdup(src_cfmt->custom_fields);
dest_cfmt->custom_occurrence = src_cfmt->custom_occurrence;
} else {
dest_cfmt->custom_fields = NULL;
dest_cfmt->custom_occurrence = 0;
}
dest_cfmt->visible = src_cfmt->visible;
dest_cfmt->resolved = src_cfmt->resolved;
pref->default_val.list = g_list_append(pref->default_val.list, dest_cfmt);
}
}
static void
column_format_free_cb(pref_t* pref)
{
free_col_info(*pref->varp.list);
free_col_info(pref->default_val.list);
}
static void
column_format_reset_cb(pref_t* pref)
{
fmt_data *src_cfmt, *dest_cfmt;
GList *entry;
pref_t *col_num_pref;
free_col_info(*pref->varp.list);
*pref->varp.list = NULL;
for (entry = pref->default_val.list; entry != NULL; entry = g_list_next(entry)) {
src_cfmt = (fmt_data *)entry->data;
dest_cfmt = g_new(fmt_data,1);
dest_cfmt->title = g_strdup(src_cfmt->title);
dest_cfmt->fmt = src_cfmt->fmt;
if (src_cfmt->custom_fields) {
dest_cfmt->custom_fields = g_strdup(src_cfmt->custom_fields);
dest_cfmt->custom_occurrence = src_cfmt->custom_occurrence;
} else {
dest_cfmt->custom_fields = NULL;
dest_cfmt->custom_occurrence = 0;
}
dest_cfmt->visible = src_cfmt->visible;
dest_cfmt->resolved = src_cfmt->resolved;
*pref->varp.list = g_list_append(*pref->varp.list, dest_cfmt);
}
col_num_pref = prefs_find_preference(gui_column_module, PRS_COL_NUM);
g_assert(col_num_pref != NULL); /* Should never happen */
column_num_reset_cb(col_num_pref);
}
static prefs_set_pref_e
column_format_set_cb(pref_t* pref, const gchar* value, gboolean* changed _U_)
{
GList *col_l, *col_l_elt;
fmt_data *cfmt;
gint llen;
pref_t *hidden_pref, *col_num_pref;
col_l = prefs_get_string_list(value);
if (col_l == NULL)
return PREFS_SET_SYNTAX_ERR;
if ((g_list_length(col_l) % 2) != 0) {
/* A title didn't have a matching format. */
prefs_clear_string_list(col_l);
return PREFS_SET_SYNTAX_ERR;
}
/* Check to make sure all column formats are valid. */
col_l_elt = g_list_first(col_l);
while (col_l_elt) {
fmt_data cfmt_check;
/* Go past the title. */
col_l_elt = col_l_elt->next;
/* Parse the format to see if it's valid. */
if (!parse_column_format(&cfmt_check, (char *)col_l_elt->data)) {
/* It's not a valid column format. */
prefs_clear_string_list(col_l);
return PREFS_SET_SYNTAX_ERR;
}
if (cfmt_check.fmt != COL_CUSTOM) {
/* Some predefined columns have been migrated to use custom columns.
* We'll convert these silently here */
try_convert_to_custom_column(&col_l_elt->data);
} else {
/* We don't need the custom column field on this pass. */
g_free(cfmt_check.custom_fields);
}
/* Go past the format. */
col_l_elt = col_l_elt->next;
}
/* They're all valid; process them. */
free_col_info(*pref->varp.list);
*pref->varp.list = NULL;
hidden_pref = prefs_find_preference(gui_column_module, PRS_COL_HIDDEN);
g_assert(hidden_pref != NULL); /* Should never happen */
col_num_pref = prefs_find_preference(gui_column_module, PRS_COL_NUM);
g_assert(col_num_pref != NULL); /* Should never happen */
llen = g_list_length(col_l);
*col_num_pref->varp.uint = llen / 2;
col_l_elt = g_list_first(col_l);
while (col_l_elt) {
cfmt = g_new(fmt_data,1);
cfmt->title = g_strdup((gchar *)col_l_elt->data);
col_l_elt = col_l_elt->next;
parse_column_format(cfmt, (char *)col_l_elt->data);
cfmt->visible = prefs_is_column_visible(*hidden_pref->varp.string, cfmt);
col_l_elt = col_l_elt->next;
*pref->varp.list = g_list_append(*pref->varp.list, cfmt);
}
prefs_clear_string_list(col_l);
free_string_like_preference(hidden_pref);
return PREFS_SET_OK;
}
static const char *
column_format_type_name_cb(void)
{
return "Packet list column format";
}
static char *
column_format_type_description_cb(void)
{
return g_strdup("Each pair of strings consists of a column title and its format");
}
static gboolean
column_format_is_default_cb(pref_t* pref)
{
GList *clp = *pref->varp.list,
*pref_col = g_list_first(clp),
*def_col = g_list_first(pref->default_val.list);
fmt_data *cfmt, *def_cfmt;
gboolean is_default = TRUE;
pref_t *col_num_pref;
/* See if the column data has changed from the default */
col_num_pref = prefs_find_preference(gui_column_module, PRS_COL_NUM);
if (col_num_pref && *col_num_pref->varp.uint != col_num_pref->default_val.uint) {
is_default = FALSE;
} else {
while (pref_col && def_col) {
cfmt = (fmt_data *) pref_col->data;
def_cfmt = (fmt_data *) def_col->data;
if ((g_strcmp0(cfmt->title, def_cfmt->title) != 0) ||
(cfmt->fmt != def_cfmt->fmt) ||
(((cfmt->fmt == COL_CUSTOM) && (cfmt->custom_fields)) &&
((g_strcmp0(cfmt->custom_fields, def_cfmt->custom_fields) != 0) ||
(cfmt->resolved != def_cfmt->resolved)))) {
is_default = FALSE;
break;
}
pref_col = pref_col->next;
def_col = def_col->next;
}
}
return is_default;
}
static char *
column_format_to_str_cb(pref_t* pref, gboolean default_val)
{
GList *pref_l = default_val ? pref->default_val.list : *pref->varp.list;
GList *clp = g_list_first(pref_l);
GList *col_l;
fmt_data *cfmt;
gchar *prefs_fmt;
char *column_format_str;
col_l = NULL;
while (clp) {
cfmt = (fmt_data *) clp->data;
col_l = g_list_append(col_l, g_strdup(cfmt->title));
if ((cfmt->fmt == COL_CUSTOM) && (cfmt->custom_fields)) {
prefs_fmt = g_strdup_printf("%s:%s:%d:%c",
col_format_to_string(cfmt->fmt),
cfmt->custom_fields,
cfmt->custom_occurrence,
cfmt->resolved ? 'R' : 'U');
} else {
prefs_fmt = g_strdup(col_format_to_string(cfmt->fmt));
}
col_l = g_list_append(col_l, prefs_fmt);
clp = clp->next;
}
column_format_str = join_string_list(col_l);
prefs_clear_string_list(col_l);
return column_format_str;
}
/****** Capture column custom preference functions ******/
/* This routine is only called when Wireshark is started, NOT when another profile is selected.
Copy the pref->capture_columns list (just loaded with the capture_cols[] struct values)
to prefs->default_val.list.
*/
static void
capture_column_init_cb(pref_t* pref, GList** capture_cols_values)
{
GList *ccv_list = *capture_cols_values,
*dlist = NULL;
/* */
while (ccv_list) {
dlist = g_list_append(dlist, g_strdup((gchar *)ccv_list->data));
ccv_list = ccv_list->next;
}
pref->default_val.list = dlist;
pref->varp.list = &prefs.capture_columns;
pref->stashed_val.boolval = FALSE;
}
/* Free the prefs->capture_columns list strings and remove the list entries.
Note that since pref->varp.list points to &prefs.capture_columns, it is
also freed.
*/
static void
capture_column_free_cb(pref_t* pref)
{
prefs_clear_string_list(prefs.capture_columns);
prefs.capture_columns = NULL;
if (pref->stashed_val.boolval == TRUE) {
prefs_clear_string_list(pref->default_val.list);
pref->default_val.list = NULL;
}
}
/* Copy pref->default_val.list to *pref->varp.list.
*/
static void
capture_column_reset_cb(pref_t* pref)
{
GList *vlist = NULL, *dlist;
/* Free the column name strings and remove the links from *pref->varp.list */
prefs_clear_string_list(*pref->varp.list);
for (dlist = pref->default_val.list; dlist != NULL; dlist = g_list_next(dlist)) {
vlist = g_list_append(vlist, g_strdup((gchar *)dlist->data));
}
*pref->varp.list = vlist;
}
static prefs_set_pref_e
capture_column_set_cb(pref_t* pref, const gchar* value, gboolean* changed _U_)
{
GList *col_l = prefs_get_string_list(value);
GList *col_l_elt;
gchar *col_name;
int i;
if (col_l == NULL)
return PREFS_SET_SYNTAX_ERR;
capture_column_free_cb(pref);
/* If value (the list of capture.columns read from preferences) is empty, set capture.columns
to the full list of valid capture column names. */
col_l_elt = g_list_first(col_l);
if (!(*(gchar *)col_l_elt->data)) {
for (i = 0; i < num_capture_cols; i++) {
col_name = g_strdup(capture_cols[i]);
prefs.capture_columns = g_list_append(prefs.capture_columns, col_name);
}
}
/* Verify that all the column names are valid. If not, use the entire list of valid columns.
*/
while (col_l_elt) {
gboolean found_match = FALSE;
col_name = (gchar *)col_l_elt->data;
for (i = 0; i < num_capture_cols; i++) {
if (strcmp(col_name, capture_cols[i])==0) {
found_match = TRUE;
break;
}
}
if (!found_match) {
/* One or more cols are invalid so use the entire list of valid cols. */
for (i = 0; i < num_capture_cols; i++) {
col_name = g_strdup(capture_cols[i]);
prefs.capture_columns = g_list_append(prefs.capture_columns, col_name);
}
pref->varp.list = &prefs.capture_columns;
prefs_clear_string_list(col_l);
return PREFS_SET_SYNTAX_ERR;
}
col_l_elt = col_l_elt->next;
}
col_l_elt = g_list_first(col_l);
while (col_l_elt) {
col_name = (gchar *)col_l_elt->data;
prefs.capture_columns = g_list_append(prefs.capture_columns, col_name);
col_l_elt = col_l_elt->next;
}
pref->varp.list = &prefs.capture_columns;
g_list_free(col_l);
return PREFS_SET_OK;
}
static const char *
capture_column_type_name_cb(void)
{
return "Column list";
}
static char *
capture_column_type_description_cb(void)
{
return g_strdup(
"List of columns to be displayed in the capture options dialog.\n"
CAPTURE_COL_TYPE_DESCRIPTION);
}
static gboolean
capture_column_is_default_cb(pref_t* pref)
{
GList *pref_col = g_list_first(prefs.capture_columns),
*def_col = g_list_first(pref->default_val.list);
gboolean is_default = TRUE;
/* See if the column data has changed from the default */
while (pref_col && def_col) {
if (strcmp((gchar *)pref_col->data, (gchar *)def_col->data) != 0) {
is_default = FALSE;
break;
}
pref_col = pref_col->next;
def_col = def_col->next;
}
/* Ensure the same column count */
if (((pref_col == NULL) && (def_col != NULL)) ||
((pref_col != NULL) && (def_col == NULL)))
is_default = FALSE;
return is_default;
}
static char *
capture_column_to_str_cb(pref_t* pref, gboolean default_val)
{
GList *pref_l = default_val ? pref->default_val.list : prefs.capture_columns;
GList *clp = g_list_first(pref_l);
GList *col_l = NULL;
gchar *col;
char *capture_column_str;
while (clp) {
col = (gchar *) clp->data;
col_l = g_list_append(col_l, g_strdup(col));
clp = clp->next;
}
capture_column_str = join_string_list(col_l);
prefs_clear_string_list(col_l);
return capture_column_str;
}
static prefs_set_pref_e
colorized_frame_set_cb(pref_t* pref, const gchar* value, gboolean* changed)
{
prefs_set_string_like_value(pref, value, changed);
return PREFS_SET_OK;
}
static const char *
colorized_frame_type_name_cb(void)
{
/* Don't write the colors of the 10 easy-access-colorfilters to the preferences
* file until the colors can be changed in the GUI. Currently this is not really
* possible since the STOCK-icons for these colors are hardcoded.
*
* XXX Find a way to change the colors of the STOCK-icons on the fly and then
* add these 10 colors to the list of colors that can be changed through
* the preferences.
*
*/
return NULL;
}
static char *
colorized_frame_type_description_cb(void)
{
return g_strdup("");
}
static gboolean
colorized_frame_is_default_cb(pref_t* pref _U_)
{
return TRUE;
}
static char *
colorized_frame_to_str_cb(pref_t* pref _U_, gboolean default_val _U_)
{
return g_strdup("");
}
/*
* Register all non-dissector modules' preferences.
*/
static module_t *gui_module = NULL;
static module_t *gui_color_module = NULL;
static module_t *nameres_module = NULL;
static void
prefs_register_modules(void)
{
module_t *printing, *capture_module, *console_module,
*gui_layout_module, *gui_font_module;
#ifdef HAVE_EXTCAP
module_t *extcap_module;
#endif
struct pref_custom_cbs custom_cbs;
if (protocols_module != NULL) {
/* Already setup preferences */
return;
}
#ifdef HAVE_EXTCAP
/* GUI
* These are "simple" GUI preferences that can be read/written using the
* preference module API. These preferences still use their own
* configuration screens for access, but this cuts down on the
* preference "string compare list" in set_pref()
*/
extcap_module = prefs_register_module(NULL, "extcap", "Extcap Utilities",
"Extcap Utilities", NULL, FALSE);
/* Setting default value to true */
prefs.extcap_save_on_start = TRUE;
prefs_register_bool_preference(extcap_module, "gui_save_on_start",
"Save arguments on start of capture",
"Save arguments on start of capture",
&prefs.extcap_save_on_start);
#endif
/* GUI
* These are "simple" GUI preferences that can be read/written using the
* preference module API. These preferences still use their own
* configuration screens for access, but this cuts down on the
* preference "string compare list" in set_pref()
*/
gui_module = prefs_register_module(NULL, "gui", "User Interface",
"User Interface", &gui_callback, FALSE);
/* gui.console_open is placed first in the list so that any problems encountered
* in the following prefs can be displayed in the console window.
*/
prefs_register_enum_preference(gui_module, "console_open",
"Open a console window",
"Open a console window (Windows only)",
(gint*)(void*)(&prefs.gui_console_open), gui_console_open_type, FALSE);
prefs_register_obsolete_preference(gui_module, "scrollbar_on_right");
prefs_register_obsolete_preference(gui_module, "packet_list_sel_browse");
prefs_register_obsolete_preference(gui_module, "protocol_tree_sel_browse");
prefs_register_bool_preference(gui_module, "tree_view_altern_colors",
"Alternating colors in TreeViews",
"Alternating colors in TreeViews?",
&prefs.gui_altern_colors);
prefs_register_bool_preference(gui_module, "expert_composite_eyecandy",
"Display Icons on Expert Composite Dialog Tabs",
"Display Icons on Expert Composite Dialog Tabs?",
&prefs.gui_expert_composite_eyecandy);
prefs_register_bool_preference(gui_module, "filter_toolbar_show_in_statusbar",
"Place filter toolbar inside the statusbar",
"Place filter toolbar inside the statusbar?",
&prefs.filter_toolbar_show_in_statusbar);
prefs_register_enum_preference(gui_module, "protocol_tree_line_style",
"Protocol-tree line style",
"Protocol-tree line style",
&prefs.gui_ptree_line_style, gui_ptree_line_style, FALSE);
prefs_register_enum_preference(gui_module, "protocol_tree_expander_style",
"Protocol-tree expander style",
"Protocol-tree expander style",
&prefs.gui_ptree_expander_style, gui_ptree_expander_style, FALSE);
prefs_register_enum_preference(gui_module, "hex_dump_highlight_style",
"Hex dump highlight style",
"Hex dump highlight style",
&prefs.gui_hex_dump_highlight_style, gui_hex_dump_highlight_style, FALSE);
gui_column_module = prefs_register_subtree(gui_module, "Columns", "Columns", NULL);
custom_cbs.free_cb = free_string_like_preference;
custom_cbs.reset_cb = reset_string_like_preference;
custom_cbs.set_cb = column_hidden_set_cb;
custom_cbs.type_name_cb = column_hidden_type_name_cb;
custom_cbs.type_description_cb = column_hidden_type_description_cb;
custom_cbs.is_default_cb = column_hidden_is_default_cb;
custom_cbs.to_str_cb = column_hidden_to_str_cb;
register_string_like_preference(gui_column_module, PRS_COL_HIDDEN, "Packet list hidden columns",
"List all columns to hide in the packet list",
&cols_hidden_list, PREF_CUSTOM, &custom_cbs, FALSE);
custom_cbs.free_cb = column_format_free_cb;
custom_cbs.reset_cb = column_format_reset_cb;
custom_cbs.set_cb = column_format_set_cb;
custom_cbs.type_name_cb = column_format_type_name_cb;
custom_cbs.type_description_cb = column_format_type_description_cb;
custom_cbs.is_default_cb = column_format_is_default_cb;
custom_cbs.to_str_cb = column_format_to_str_cb;
prefs_register_list_custom_preference(gui_column_module, PRS_COL_FMT, "Packet list column format",
"Each pair of strings consists of a column title and its format", &custom_cbs,
column_format_init_cb, &prefs.col_list);
/* Number of columns. This is only used internally and is not written to the
* preference file
*/
custom_cbs.free_cb = custom_pref_no_cb;
custom_cbs.reset_cb = column_num_reset_cb;
custom_cbs.set_cb = column_num_set_cb;
custom_cbs.type_name_cb = column_num_type_name_cb;
custom_cbs.type_description_cb = column_num_type_description_cb;
custom_cbs.is_default_cb = column_num_is_default_cb;
custom_cbs.to_str_cb = column_num_to_str_cb;
prefs_register_uint_custom_preference(gui_column_module, PRS_COL_NUM, "Number of columns",
"Number of columns in col_list", &custom_cbs, &prefs.num_cols);
/* User Interface : Font */
gui_font_module = prefs_register_subtree(gui_module, "Font", "Font", NULL);
prefs_register_obsolete_preference(gui_font_module, "font_name");
register_string_like_preference(gui_font_module, "gtk2.font_name", "Font name",
"Font name for packet list, protocol tree, and hex dump panes. (GTK+)",
&prefs.gui_gtk2_font_name, PREF_STRING, NULL, TRUE);
register_string_like_preference(gui_font_module, "qt.font_name", "Font name",
"Font name for packet list, protocol tree, and hex dump panes. (Qt)",
&prefs.gui_qt_font_name, PREF_STRING, NULL, TRUE);
/* User Interface : Colors */
gui_color_module = prefs_register_subtree(gui_module, "Colors", "Colors", NULL);
prefs_register_color_preference(gui_color_module, "marked_frame.fg", "Color preferences for a marked frame",
"Color preferences for a marked frame", &prefs.gui_marked_fg);
prefs_register_color_preference(gui_color_module, "marked_frame.bg", "Color preferences for a marked frame",
"Color preferences for a marked frame", &prefs.gui_marked_bg);
prefs_register_color_preference(gui_color_module, "ignored_frame.fg", "Color preferences for a ignored frame",
"Color preferences for a ignored frame", &prefs.gui_ignored_fg);
prefs_register_color_preference(gui_color_module, "ignored_frame.bg", "Color preferences for a ignored frame",
"Color preferences for a ignored frame", &prefs.gui_ignored_bg);
prefs_register_color_preference(gui_color_module, "stream.client.fg", "TCP stream window color preference",
"TCP stream window color preference", &prefs.st_client_fg);
prefs_register_color_preference(gui_color_module, "stream.client.bg", "TCP stream window color preference",
"TCP stream window color preference", &prefs.st_client_bg);
prefs_register_color_preference(gui_color_module, "stream.server.fg", "TCP stream window color preference",
"TCP stream window color preference", &prefs.st_server_fg);
prefs_register_color_preference(gui_color_module, "stream.server.bg", "TCP stream window color preference",
"TCP stream window color preference", &prefs.st_server_bg);
custom_cbs.free_cb = free_string_like_preference;
custom_cbs.reset_cb = reset_string_like_preference;
custom_cbs.set_cb = colorized_frame_set_cb;
custom_cbs.type_name_cb = colorized_frame_type_name_cb;
custom_cbs.type_description_cb = colorized_frame_type_description_cb;
custom_cbs.is_default_cb = colorized_frame_is_default_cb;
custom_cbs.to_str_cb = colorized_frame_to_str_cb;
register_string_like_preference(gui_column_module, "colorized_frame.fg", "Colorized Foreground",
"Filter Colorized Foreground",
&prefs.gui_colorized_fg, PREF_CUSTOM, &custom_cbs, TRUE);
custom_cbs.free_cb = free_string_like_preference;
custom_cbs.reset_cb = reset_string_like_preference;
custom_cbs.set_cb = colorized_frame_set_cb;
custom_cbs.type_name_cb = colorized_frame_type_name_cb;
custom_cbs.type_description_cb = colorized_frame_type_description_cb;
custom_cbs.is_default_cb = colorized_frame_is_default_cb;
custom_cbs.to_str_cb = colorized_frame_to_str_cb;
register_string_like_preference(gui_column_module, "colorized_frame.bg", "Colorized Background",
"Filter Colorized Background",
&prefs.gui_colorized_bg, PREF_CUSTOM, &custom_cbs, TRUE);
prefs_register_color_preference(gui_color_module, "color_filter_bg.valid", "Valid color filter background",
"Valid color filter background", &prefs.gui_text_valid);
prefs_register_color_preference(gui_color_module, "color_filter_bg.invalid", "Invalid color filter background",
"Invalid color filter background", &prefs.gui_text_invalid);
prefs_register_color_preference(gui_color_module, "color_filter_bg.deprecated", "Deprecated color filter background",
"Deprecated color filter background", &prefs.gui_text_deprecated);
prefs_register_enum_preference(gui_module, "fileopen.style",
"Where to start the File Open dialog box",
"Where to start the File Open dialog box",
&prefs.gui_fileopen_style, gui_fileopen_style, FALSE);
prefs_register_uint_preference(gui_module, "recent_files_count.max",
"The max. number of items in the open recent files list",
"The max. number of items in the open recent files list",
10,
&prefs.gui_recent_files_count_max);
prefs_register_uint_preference(gui_module, "recent_display_filter_entries.max",
"The max. number of entries in the display filter list",
"The max. number of entries in the display filter list",
10,
&prefs.gui_recent_df_entries_max);
register_string_like_preference(gui_module, "fileopen.dir", "Start Directory",
"Directory to start in when opening File Open dialog.",
&prefs.gui_fileopen_dir, PREF_DIRNAME, NULL, TRUE);
prefs_register_obsolete_preference(gui_module, "fileopen.remembered_dir");
prefs_register_uint_preference(gui_module, "fileopen.preview",
"The preview timeout in the File Open dialog",
"The preview timeout in the File Open dialog",
10,
&prefs.gui_fileopen_preview);
prefs_register_bool_preference(gui_module, "ask_unsaved",
"Ask to save unsaved capture files",
"Ask to save unsaved capture files?",
&prefs.gui_ask_unsaved);
prefs_register_bool_preference(gui_module, "find_wrap",
"Wrap to beginning/end of file during search",
"Wrap to beginning/end of file during search?",
&prefs.gui_find_wrap);
prefs_register_bool_preference(gui_module, "use_pref_save",
"Settings dialogs use a save button",
"Settings dialogs use a save button?",
&prefs.gui_use_pref_save);
prefs_register_bool_preference(gui_module, "geometry.save.position",
"Save window position at exit",
"Save window position at exit?",
&prefs.gui_geometry_save_position);
prefs_register_bool_preference(gui_module, "geometry.save.size",
"Save window size at exit",
"Save window size at exit?",
&prefs.gui_geometry_save_size);
prefs_register_bool_preference(gui_module, "geometry.save.maximized",
"Save window maximized state at exit",
"Save window maximized state at exit?",
&prefs.gui_geometry_save_maximized);
/* GTK+ only */
prefs_register_bool_preference(gui_module, "macosx_style",
"Use OS X style",
"Use OS X style (OS X with native GTK only)?",
&prefs.gui_macosx_style);
prefs_register_obsolete_preference(gui_module, "geometry.main.x");
prefs_register_obsolete_preference(gui_module, "geometry.main.y");
prefs_register_obsolete_preference(gui_module, "geometry.main.width");
prefs_register_obsolete_preference(gui_module, "geometry.main.height");
prefs_register_obsolete_preference(gui_module, "toolbar_main_show");
prefs_register_enum_preference(gui_module, "toolbar_main_style",
"Main Toolbar style",
"Main Toolbar style",
&prefs.gui_toolbar_main_style, gui_toolbar_style, FALSE);
prefs_register_enum_preference(gui_module, "toolbar_filter_style",
"Filter Toolbar style",
"Filter Toolbar style",
&prefs.gui_toolbar_filter_style, gui_toolbar_style, FALSE);
register_string_like_preference(gui_module, "webbrowser", "The path to the webbrowser",
"The path to the webbrowser (Ex: mozilla)",
&prefs.gui_webbrowser, PREF_STRING, NULL, TRUE);
prefs_register_bool_preference(gui_module, "update.enabled",
"Check for updates",
"Check for updates (Windows only)",
&prefs.gui_update_enabled);
prefs_register_enum_preference(gui_module, "update.channel",
"Update channel",
"The type of update to fetch. You should probably leave this set to UPDATE_CHANNEL_STABLE.",
(gint*)(void*)(&prefs.gui_update_channel), gui_update_channel, FALSE);
prefs_register_uint_preference(gui_module, "update.interval",
"How often to check for software updates",
"How often to check for software updates in seconds",
10,
&prefs.gui_update_interval);
register_string_like_preference(gui_module, "window_title", "Custom window title",
"Custom window title to be appended to the existing title\n%P = profile name\n%V = version info",
&prefs.gui_window_title, PREF_STRING, NULL, TRUE);
register_string_like_preference(gui_module, "prepend_window_title", "Custom window title prefix",
"Custom window title to be prepended to the existing title\n%P = profile name\n%V = version info",
&prefs.gui_prepend_window_title, PREF_STRING, NULL, TRUE);
register_string_like_preference(gui_module, "start_title", "Custom start page title",
"Custom start page title",
&prefs.gui_start_title, PREF_STRING, NULL, TRUE);
prefs_register_enum_preference(gui_module, "version_placement",
"Show version in the start page and/or main screen's title bar",
"Show version in the start page and/or main screen's title bar",
(gint*)(void*)(&prefs.gui_version_placement), gui_version_placement_type, FALSE);
prefs_register_bool_preference(gui_module, "auto_scroll_on_expand",
"Automatically scroll the recently expanded item",
"Automatically scroll the recently expanded item",
&prefs.gui_auto_scroll_on_expand);
prefs_register_uint_preference(gui_module, "auto_scroll_percentage",
"The percentage down the view the recently expanded item should be scrolled",
"The percentage down the view the recently expanded item should be scrolled",
10,
&prefs.gui_auto_scroll_percentage);
/* User Interface : Layout */
gui_layout_module = prefs_register_subtree(gui_module, "Layout", "Layout", gui_layout_callback);
prefs_register_uint_preference(gui_layout_module, "layout_type",
"Layout type",
"Layout type (1-6)",
10,
(guint*)(void*)(&prefs.gui_layout_type));
prefs_register_enum_preference(gui_layout_module, "layout_content_1",
"Layout content of the pane 1",
"Layout content of the pane 1",
(gint*)(void*)(&prefs.gui_layout_content_1), gui_layout_content, FALSE);
prefs_register_enum_preference(gui_layout_module, "layout_content_2",
"Layout content of the pane 2",
"Layout content of the pane 2",
(gint*)(void*)(&prefs.gui_layout_content_2), gui_layout_content, FALSE);
prefs_register_enum_preference(gui_layout_module, "layout_content_3",
"Layout content of the pane 3",
"Layout content of the pane 3",
(gint*)(void*)(&prefs.gui_layout_content_3), gui_layout_content, FALSE);
prefs_register_bool_preference(gui_layout_module, "packet_list_separator.enabled",
"Enable Packet List Separator",
"Enable Packet List Separator",
&prefs.gui_qt_packet_list_separator);
prefs_register_bool_preference(gui_module, "packet_editor.enabled",
"Enable Packet Editor",
"Enable Packet Editor (Experimental)",
&prefs.gui_packet_editor);
prefs_register_enum_preference(gui_module, "packet_list_elide_mode",
"Elide mode",
"The position of \"...\" in packet list text.",
(gint*)(void*)(&prefs.gui_packet_list_elide_mode), gui_packet_list_elide_mode, FALSE);
prefs_register_bool_preference(gui_layout_module, "packet_list_show_related",
"Show Related Packets",
"Show related packet indicators in the first column",
&prefs.gui_packet_list_show_related);
prefs_register_bool_preference(gui_layout_module, "packet_list_show_minimap",
"Enable Intelligent Scroll Bar",
"Show the intelligent scroll bar (a minimap of packet list colors in the scrollbar)",
&prefs.gui_packet_list_show_minimap);
/* Console
* These are preferences that can be read/written using the
* preference module API. These preferences still use their own
* configuration screens for access, but this cuts down on the
* preference "string compare list" in set_pref()
*/
console_module = prefs_register_module(NULL, "console", "Console",
"Console logging and debugging output", NULL, FALSE);
custom_cbs.free_cb = custom_pref_no_cb;
custom_cbs.reset_cb = console_log_level_reset_cb;
custom_cbs.set_cb = console_log_level_set_cb;
custom_cbs.type_name_cb = console_log_level_type_name_cb;
custom_cbs.type_description_cb = console_log_level_type_description_cb;
custom_cbs.is_default_cb = console_log_level_is_default_cb;
custom_cbs.to_str_cb = console_log_level_to_str_cb;
prefs_register_uint_custom_preference(console_module, "log.level", "logging level",
"A bitmask of GLib log levels", &custom_cbs, &prefs.console_log_level);
/* Capture
* These are preferences that can be read/written using the
* preference module API. These preferences still use their own
* configuration screens for access, but this cuts down on the
* preference "string compare list" in set_pref()
*/
capture_module = prefs_register_module(NULL, "capture", "Capture",
"Capture preferences", NULL, FALSE);
register_string_like_preference(capture_module, "device", "Default capture device",
"Default capture device",
&prefs.capture_device, PREF_STRING, NULL, FALSE);
register_string_like_preference(capture_module, "devices_linktypes", "Interface link-layer header type",
"Interface link-layer header types (Ex: en0(1),en1(143),...)",
&prefs.capture_devices_linktypes, PREF_STRING, NULL, FALSE);
register_string_like_preference(capture_module, "devices_descr", "Interface descriptions",
"Interface descriptions (Ex: eth0(eth0 descr),eth1(eth1 descr),...)",
&prefs.capture_devices_descr, PREF_STRING, NULL, FALSE);
register_string_like_preference(capture_module, "devices_hide", "Hide interface",
"Hide interface? (Ex: eth0,eth3,...)",
&prefs.capture_devices_hide, PREF_STRING, NULL, FALSE);
register_string_like_preference(capture_module, "devices_monitor_mode", "Capture in monitor mode",
"By default, capture in monitor mode on interface? (Ex: eth0,eth3,...)",
&prefs.capture_devices_monitor_mode, PREF_STRING, NULL, FALSE);
#ifdef CAN_SET_CAPTURE_BUFFER_SIZE
register_string_like_preference(capture_module, "devices_buffersize", "Interface buffer size",
"Interface buffer size (Ex: en0(1),en1(143),...)",
&prefs.capture_devices_buffersize, PREF_STRING, NULL, FALSE);
#endif
register_string_like_preference(capture_module, "devices_snaplen", "Interface snap length",
"Interface snap length (Ex: en0(65535),en1(1430),...)",
&prefs.capture_devices_snaplen, PREF_STRING, NULL, FALSE);
register_string_like_preference(capture_module, "devices_pmode", "Interface promiscuous mode",
"Interface promiscuous mode (Ex: en0(0),en1(1),...)",
&prefs.capture_devices_pmode, PREF_STRING, NULL, FALSE);
prefs_register_bool_preference(capture_module, "prom_mode", "Capture in promiscuous mode",
"Capture in promiscuous mode?", &prefs.capture_prom_mode);
register_string_like_preference(capture_module, "devices_filter", "Interface capture filter",
"Interface capture filter (Ex: en0(tcp),en1(udp),...)",
&prefs.capture_devices_filter, PREF_STRING, NULL, FALSE);
prefs_register_bool_preference(capture_module, "pcap_ng", "Capture in Pcap-NG format",
"Capture in Pcap-NG format?", &prefs.capture_pcap_ng);
prefs_register_bool_preference(capture_module, "real_time_update", "Update packet list in real time during capture",
"Update packet list in real time during capture?", &prefs.capture_real_time);
/* We might want to make this a "recent" setting. */
prefs_register_bool_preference(capture_module, "auto_scroll", "Scroll packet list during capture",
"Scroll packet list during capture?", &prefs.capture_auto_scroll);
/* GTK+ only */
prefs_register_bool_preference(capture_module, "show_info", "Show capture info dialog while capturing",
"Show capture info dialog while capturing?", &prefs.capture_show_info);
prefs_register_obsolete_preference(capture_module, "syntax_check_filter");
custom_cbs.free_cb = capture_column_free_cb;
custom_cbs.reset_cb = capture_column_reset_cb;
custom_cbs.set_cb = capture_column_set_cb;
custom_cbs.type_name_cb = capture_column_type_name_cb;
custom_cbs.type_description_cb = capture_column_type_description_cb;
custom_cbs.is_default_cb = capture_column_is_default_cb;
custom_cbs.to_str_cb = capture_column_to_str_cb;
prefs_register_list_custom_preference(capture_module, "columns", "Capture options dialog column list",
"List of columns to be displayed", &custom_cbs, capture_column_init_cb, &prefs.capture_columns);
/* Name Resolution */
nameres_module = prefs_register_module(NULL, "nameres", "Name Resolution",
"Name Resolution", NULL, TRUE);
addr_resolve_pref_init(nameres_module);
oid_pref_init(nameres_module);
#ifdef HAVE_GEOIP
geoip_db_pref_init(nameres_module);
#endif
/* Printing */
printing = prefs_register_module(NULL, "print", "Printing",
"Printing", NULL, TRUE);
prefs_register_enum_preference(printing, "format",
"Format", "Can be one of \"text\" or \"postscript\"",
&prefs.pr_format, print_format_vals, TRUE);
prefs_register_enum_preference(printing, "destination",
"Print to", "Can be one of \"command\" or \"file\"",
&prefs.pr_dest, print_dest_vals, TRUE);
#ifndef _WIN32
register_string_like_preference(printing, "command", "Command",
"Output gets piped to this command when the destination is set to \"command\"",
&prefs.pr_cmd, PREF_STRING, NULL, TRUE);
#endif
register_string_like_preference(printing, "file", "File",
"This is the file that gets written to when the destination is set to \"file\"",
&prefs.pr_file, PREF_FILENAME, NULL, TRUE);
/* Statistics */
stats_module = prefs_register_module(NULL, "statistics", "Statistics",
"Statistics", &stats_callback, TRUE);
prefs_register_uint_preference(stats_module, "update_interval",
"Tap update interval in ms",
"Determines time between tap updates",
10,
&prefs.tap_update_interval);
#ifdef HAVE_LIBPORTAUDIO
prefs_register_uint_preference(stats_module, "rtp_player_max_visible",
"Max visible channels in RTP Player",
"Determines maximum height of RTP Player window",
10,
&prefs.rtp_player_max_visible);
#endif
prefs_register_bool_preference(stats_module, "st_enable_burstinfo",
"Enable the calculation of burst information",
"If enabled burst rates will be calcuted for statistics that use the stats_tree system. "
"Burst rates are calculated over a much shorter time interval than the rate column.",
&prefs.st_enable_burstinfo);
prefs_register_bool_preference(stats_module, "st_burst_showcount",
"Show burst count for item rather than rate",
"If selected the stats_tree statistics nodes will show the count of events "
"within the burst window instead of a burst rate. Burst rate is calculated "
"as number of events within burst window divided by the burst windown length.",
&prefs.st_burst_showcount);
prefs_register_uint_preference(stats_module, "st_burst_resolution",
"Burst rate resolution (ms)",
"Sets the duration of the time interval into which events are grouped when calculating "
"the burst rate. Higher resolution (smaller number) increases processing overhead.",
10,&prefs.st_burst_resolution);
prefs_register_uint_preference(stats_module, "st_burst_windowlen",
"Burst rate window size (ms)",
"Sets the duration of the sliding window during which the burst rate is "
"measured. Longer window relative to burst rate resolution increases "
"processing overhead. Will be truncated to a multiple of burst resolution.",
10,&prefs.st_burst_windowlen);
prefs_register_enum_preference(stats_module, "st_sort_defcolflag",
"Default sort column for stats_tree stats",
"Sets the default column by which stats based on the stats_tree "
"system is sorted.",
&prefs.st_sort_defcolflag, st_sort_col_vals, FALSE);
prefs_register_bool_preference(stats_module, "st_sort_defdescending",
"Default stats_tree sort order is descending",
"When selected, statistics based on the stats_tree system will by default "
"be sorted in descending order.",
&prefs.st_sort_defdescending);
prefs_register_bool_preference(stats_module, "st_sort_casesensitve",
"Case sensitive sort of stats_tree item names",
"When selected, the item/node names of statistics based on the stats_tree "
"system will be sorted taking case into account. Else the case of the name "
"will be ignored.",
&prefs.st_sort_casesensitve);
prefs_register_bool_preference(stats_module, "st_sort_rng_nameonly",
"Always sort 'range' nodes by name",
"When selected, the stats_tree nodes representing a range of values "
"(0-49, 50-100, etc.) will always be sorted by name (the range of the "
"node). Else range nodes are sorted by the same column as the rest of "
" the tree.",
&prefs.st_sort_rng_nameonly);
prefs_register_bool_preference(stats_module, "st_sort_rng_fixorder",
"Always sort 'range' nodes in ascending order",
"When selected, the stats_tree nodes representing a range of values "
"(0-49, 50-100, etc.) will always be sorted ascending; else it follows "
"the sort direction of the tree. Only effective if \"Always sort "
"'range' nodes by name\" is also selected.",
&prefs.st_sort_rng_fixorder);
prefs_register_bool_preference(stats_module, "st_sort_showfullname",
"Display the full stats_tree plug-in name",
"When selected, the full name (including menu path) of the stats_tree "
"plug-in is show in windows. If cleared the plug-in name is shown "
"without menu path (only the part of the name after last '/' character.)",
&prefs.st_sort_showfullname);
/* Protocols */
protocols_module = prefs_register_module(NULL, "protocols", "Protocols",
"Protocols", NULL, TRUE);
prefs_register_bool_preference(protocols_module, "display_hidden_proto_items",
"Display hidden protocol items",
"Display all hidden protocol items in the packet list.",
&prefs.display_hidden_proto_items);
prefs_register_bool_preference(protocols_module, "display_byte_fields_with_spaces",
"Display byte fields with a space character between bytes",
"Display all byte fields with a space character between each byte in the packet list.",
&prefs.display_byte_fields_with_spaces);
prefs_register_bool_preference(protocols_module, "enable_incomplete_dissectors_check",
"Look for incomplete dissectors",
"Look for dissectors that left some bytes undecoded.",
&prefs.enable_incomplete_dissectors_check);
/* Obsolete preferences
* These "modules" were reorganized/renamed to correspond to their GUI
* configuration screen within the preferences dialog
*/
/* taps is now part of the stats module */
prefs_register_module(NULL, "taps", "TAPS", "TAPS", NULL, FALSE);
/* packet_list is now part of the protocol (parent) module */
prefs_register_module(NULL, "packet_list", "PACKET_LIST", "PACKET_LIST", NULL, FALSE);
/* stream is now part of the gui module */
prefs_register_module(NULL, "stream", "STREAM", "STREAM", NULL, FALSE);
}
/* Parse through a list of comma-separated, possibly quoted strings.
Return a list of the string data. */
GList *
prefs_get_string_list(const gchar *str)
{
enum { PRE_STRING, IN_QUOT, NOT_IN_QUOT };
gint state = PRE_STRING, i = 0, j = 0;
gboolean backslash = FALSE;
guchar cur_c;
gchar *slstr = NULL;
GList *sl = NULL;
/* Allocate a buffer for the first string. */
slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
j = 0;
for (;;) {
cur_c = str[i];
if (cur_c == '\0') {
/* It's the end of the input, so it's the end of the string we
were working on, and there's no more input. */
if (state == IN_QUOT || backslash) {
/* We were in the middle of a quoted string or backslash escape,
and ran out of characters; that's an error. */
g_free(slstr);
prefs_clear_string_list(sl);
return NULL;
}
slstr[j] = '\0';
sl = g_list_append(sl, slstr);
break;
}
if (cur_c == '"' && ! backslash) {
switch (state) {
case PRE_STRING:
/* We hadn't yet started processing a string; this starts the
string, and we're now quoting. */
state = IN_QUOT;
break;
case IN_QUOT:
/* We're in the middle of a quoted string, and we saw a quotation
mark; we're no longer quoting. */
state = NOT_IN_QUOT;
break;
case NOT_IN_QUOT:
/* We're working on a string, but haven't seen a quote; we're
now quoting. */
state = IN_QUOT;
break;
default:
break;
}
} else if (cur_c == '\\' && ! backslash) {
/* We saw a backslash, and the previous character wasn't a
backslash; escape the next character.
This also means we've started a new string. */
backslash = TRUE;
if (state == PRE_STRING)
state = NOT_IN_QUOT;
} else if (cur_c == ',' && state != IN_QUOT && ! backslash) {
/* We saw a comma, and we're not in the middle of a quoted string
and it wasn't preceded by a backslash; it's the end of
the string we were working on... */
slstr[j] = '\0';
sl = g_list_append(sl, slstr);
/* ...and the beginning of a new string. */
state = PRE_STRING;
slstr = (gchar *) g_malloc(sizeof(gchar) * COL_MAX_LEN);
j = 0;
} else if (!g_ascii_isspace(cur_c) || state != PRE_STRING) {
/* Either this isn't a white-space character, or we've started a
string (i.e., already seen a non-white-space character for that
string and put it into the string).
The character is to be put into the string; do so if there's
room. */
if (j < COL_MAX_LEN) {
slstr[j] = cur_c;
j++;
}
/* If it was backslash-escaped, we're done with the backslash escape. */
backslash = FALSE;
}
i++;
}
return(sl);
}
char *join_string_list(GList *sl)
{
GString *joined_str = g_string_new("");
GList *cur, *first;
gchar *str;
gchar *quoted_str;
guint item_count = 0;
cur = first = g_list_first(sl);
while (cur) {
item_count++;
str = (gchar *)cur->data;
if (cur != first)
g_string_append_c(joined_str, ',');
if (item_count % 2) {
/* Wrap the line. */
g_string_append(joined_str, "\n\t");
} else
g_string_append_c(joined_str, ' ');
quoted_str = g_strescape(str, "");
g_string_append_printf(joined_str, "\"%s\"", quoted_str);
g_free(quoted_str);
cur = cur->next;
}
return g_string_free(joined_str, FALSE);
}
void
prefs_clear_string_list(GList *sl)
{
/* g_list_free_full() only exists since 2.28. */
g_list_foreach(sl, (GFunc)g_free, NULL);
g_list_free(sl);
}
/*
* Takes a string, a pointer to an array of "enum_val_t"s, and a default gint
* value.
* The array must be terminated by an entry with a null "name" string.
*
* If the string matches a "name" string in an entry, the value from that
* entry is returned.
*
* Otherwise, if a string matches a "description" string in an entry, the
* value from that entry is returned; we do that for backwards compatibility,
* as we used to have only a "name" string that was used both for command-line
* and configuration-file values and in the GUI (which meant either that
* the GUI had what might be somewhat cryptic values to select from or that
* the "-o" flag took long strings, often with spaces in them).
*
* Otherwise, the default value that was passed as the third argument is
* returned.
*/
static gint
find_val_for_string(const char *needle, const enum_val_t *haystack,
gint default_value)
{
int i;
for (i = 0; haystack[i].name != NULL; i++) {
if (g_ascii_strcasecmp(needle, haystack[i].name) == 0) {
return haystack[i].value;
}
}
for (i = 0; haystack[i].name != NULL; i++) {
if (g_ascii_strcasecmp(needle, haystack[i].description) == 0) {
return haystack[i].value;
}
}
return default_value;
}
/* Array of columns that have been migrated to custom columns */
struct deprecated_columns {
const gchar *col_fmt;
const gchar *col_expr;
};
static struct deprecated_columns migrated_columns[] = {
{ /* COL_COS_VALUE */ "%U", "vlan.priority" },
{ /* COL_CIRCUIT_ID */ "%c", "iax2.call" },
{ /* COL_BSSGP_TLLI */ "%l", "bssgp.tlli" },
{ /* COL_HPUX_SUBSYS */ "%H", "nettl.subsys" },
{ /* COL_HPUX_DEVID */ "%P", "nettl.devid" },
{ /* COL_FR_DLCI */ "%C", "fr.dlci" },
{ /* COL_REL_CONV_TIME */ "%rct", "tcp.time_relative" },
{ /* COL_DELTA_CONV_TIME */ "%dct", "tcp.time_delta" },
{ /* COL_OXID */ "%XO", "fc.ox_id" },
{ /* COL_RXID */ "%XR", "fc.rx_id" },
{ /* COL_SRCIDX */ "%Xd", "mdshdr.srcidx" },
{ /* COL_DSTIDX */ "%Xs", "mdshdr.dstidx" },
{ /* COL_DCE_CTX */ "%z", "dcerpc.cn_ctx_id" }
};
static gboolean
is_deprecated_column_format(const gchar* fmt)
{
guint haystack_idx;
for (haystack_idx = 0;
haystack_idx < G_N_ELEMENTS(migrated_columns);
++haystack_idx) {
if (strcmp(migrated_columns[haystack_idx].col_fmt, fmt) == 0) {
return TRUE;
}
}
return FALSE;
}
/* Preferences file format:
* - Configuration directives start at the beginning of the line, and
* are terminated with a colon.
* - Directives can be continued on the next line by preceding them with
* whitespace.
*
* Example:
# This is a comment line
print.command: lpr
print.file: /a/very/long/path/
to/wireshark-out.ps
*
*/
#define DEF_NUM_COLS 7
/*
* Parse a column format, filling in the relevant fields of a fmt_data.
*/
static gboolean
parse_column_format(fmt_data *cfmt, const char *fmt)
{
const gchar *cust_format = col_format_to_string(COL_CUSTOM);
size_t cust_format_len = strlen(cust_format);
gchar **cust_format_info;
char *p;
int col_fmt;
gchar *col_custom_fields = NULL;
long col_custom_occurrence = 0;
gboolean col_resolved = TRUE;
/*
* Is this a custom column?
*/
if ((strlen(fmt) > cust_format_len) && (fmt[cust_format_len] == ':') &&
strncmp(fmt, cust_format, cust_format_len) == 0) {
/* Yes. */
col_fmt = COL_CUSTOM;
cust_format_info = g_strsplit(&fmt[cust_format_len+1],":",3); /* add 1 for ':' */
col_custom_fields = g_strdup(cust_format_info[0]);
if (col_custom_fields && cust_format_info[1]) {
col_custom_occurrence = strtol(cust_format_info[1], &p, 10);
if (p == cust_format_info[1] || *p != '\0') {
/* Not a valid number. */
g_free(col_custom_fields);
g_strfreev(cust_format_info);
return FALSE;
}
}
if (col_custom_fields && cust_format_info[1] && cust_format_info[2]) {
col_resolved = (cust_format_info[2][0] == 'U') ? FALSE : TRUE;
}
g_strfreev(cust_format_info);
} else {
col_fmt = get_column_format_from_str(fmt);
if ((col_fmt == -1) && (!is_deprecated_column_format(fmt)))
return FALSE;
}
cfmt->fmt = col_fmt;
cfmt->custom_fields = col_custom_fields;
cfmt->custom_occurrence = (int)col_custom_occurrence;
cfmt->resolved = col_resolved;
return TRUE;
}
/* Initialize non-dissector preferences to wired-in default values Called
* at program startup and any time the profile changes. (The dissector
* preferences are assumed to be set to those values by the dissectors.)
* They may be overridden by the global preferences file or the user's
* preferences file.
*/
static void
init_prefs(void)
{
if (prefs_initialized)
return;
uat_load_all();
/*
* Ensure the "global" preferences have been initialized so the
* preference API has the proper default values to work from
*/
pre_init_prefs();
prefs_register_modules();
filter_expression_init();
prefs_initialized = TRUE;
}
/*
* Initialize non-dissector preferences used by the "register preference" API
* to default values so the default values can be used when registered.
*
* String, filename, and directory preferences will be g_freed so they must
* be g_mallocated.
*/
static void
pre_init_prefs(void)
{
int i;
gchar *col_name;
fmt_data *cfmt;
static const gchar *col_fmt[DEF_NUM_COLS*2] = {
"No.", "%m", "Time", "%t",
"Source", "%s", "Destination", "%d",
"Protocol", "%p", "Length", "%L",
"Info", "%i"};
prefs.pr_format = PR_FMT_TEXT;
prefs.pr_dest = PR_DEST_CMD;
if (prefs.pr_file) g_free(prefs.pr_file);
prefs.pr_file = g_strdup("wireshark.out");
if (prefs.pr_cmd) g_free(prefs.pr_cmd);
prefs.pr_cmd = g_strdup("lpr");
prefs.gui_altern_colors = FALSE;
prefs.gui_expert_composite_eyecandy = FALSE;
prefs.gui_ptree_line_style = 0;
prefs.gui_ptree_expander_style = 1;
prefs.gui_hex_dump_highlight_style = 1;
prefs.filter_toolbar_show_in_statusbar = FALSE;
prefs.gui_toolbar_main_style = TB_STYLE_ICONS;
prefs.gui_toolbar_filter_style = TB_STYLE_TEXT;
/* These will be g_freed, so they must be g_mallocated. */
if (prefs.gui_gtk2_font_name) g_free(prefs.gui_gtk2_font_name);
#ifdef _WIN32
prefs.gui_gtk2_font_name = g_strdup("Lucida Console 10");
#else
prefs.gui_gtk2_font_name = g_strdup("Monospace 10");
#endif
/* We try to find the best font in the Qt code */
if (prefs.gui_qt_font_name) g_free(prefs.gui_qt_font_name);
prefs.gui_qt_font_name = g_strdup("");
prefs.gui_marked_fg.red = 65535;
prefs.gui_marked_fg.green = 65535;
prefs.gui_marked_fg.blue = 65535;
prefs.gui_marked_bg.red = 0;
prefs.gui_marked_bg.green = 8224;
prefs.gui_marked_bg.blue = 10794;
prefs.gui_ignored_fg.red = 32767;
prefs.gui_ignored_fg.green = 32767;
prefs.gui_ignored_fg.blue = 32767;
prefs.gui_ignored_bg.red = 65535;
prefs.gui_ignored_bg.green = 65535;
prefs.gui_ignored_bg.blue = 65535;
if (prefs.gui_colorized_fg) g_free(prefs.gui_colorized_fg);
prefs.gui_colorized_fg = g_strdup("000000,000000,000000,000000,000000,000000,000000,000000,000000,000000");
if (prefs.gui_colorized_bg) g_free(prefs.gui_colorized_bg);
prefs.gui_colorized_bg = g_strdup("ffc0c0,ffc0ff,e0c0e0,c0c0ff,c0e0e0,c0ffff,c0ffc0,ffffc0,e0e0c0,e0e0e0");
prefs.st_client_fg.red = 32767;
prefs.st_client_fg.green = 0;
prefs.st_client_fg.blue = 0;
prefs.st_client_bg.red = 64507;
prefs.st_client_bg.green = 60909;
prefs.st_client_bg.blue = 60909;
prefs.st_server_fg.red = 0;
prefs.st_server_fg.green = 0;
prefs.st_server_fg.blue = 32767;
prefs.st_server_bg.red = 60909;
prefs.st_server_bg.green = 60909;
prefs.st_server_bg.blue = 64507;
prefs.gui_text_valid.red = 0xAFFF; /* light green */
prefs.gui_text_valid.green = 0xFFFF;
prefs.gui_text_valid.blue = 0xAFFF;
prefs.gui_text_invalid.red = 0xFFFF; /* light red */
prefs.gui_text_invalid.green = 0xAFFF;
prefs.gui_text_invalid.blue = 0xAFFF;
prefs.gui_text_deprecated.red = 0xFFFF; /* light yellow */
prefs.gui_text_deprecated.green = 0xFFFF;
prefs.gui_text_deprecated.blue = 0xAFFF;
prefs.gui_geometry_save_position = TRUE;
prefs.gui_geometry_save_size = TRUE;
prefs.gui_geometry_save_maximized= TRUE;
prefs.gui_macosx_style = TRUE;
prefs.gui_console_open = console_open_never;
prefs.gui_fileopen_style = FO_STYLE_LAST_OPENED;
prefs.gui_recent_df_entries_max = 10;
prefs.gui_recent_files_count_max = 10;
if (prefs.gui_fileopen_dir) g_free(prefs.gui_fileopen_dir);
prefs.gui_fileopen_dir = g_strdup(get_persdatafile_dir());
prefs.gui_fileopen_preview = 3;
prefs.gui_ask_unsaved = TRUE;
prefs.gui_find_wrap = TRUE;
prefs.gui_use_pref_save = FALSE;
prefs.gui_update_enabled = TRUE;
prefs.gui_update_channel = UPDATE_CHANNEL_STABLE;
prefs.gui_update_interval = 60*60*24; /* Seconds */
if (prefs.gui_webbrowser) g_free(prefs.gui_webbrowser);
prefs.gui_webbrowser = g_strdup("");
if (prefs.gui_window_title) g_free(prefs.gui_window_title);
prefs.gui_window_title = g_strdup("");
if (prefs.gui_prepend_window_title) g_free(prefs.gui_prepend_window_title);
prefs.gui_prepend_window_title = g_strdup("");
if (prefs.gui_start_title) g_free(prefs.gui_start_title);
prefs.gui_start_title = g_strdup("The World's Most Popular Network Protocol Analyzer");
prefs.gui_version_placement = version_welcome_only;
prefs.gui_auto_scroll_on_expand = FALSE;
prefs.gui_auto_scroll_percentage = 0;
prefs.gui_layout_type = layout_type_5;
prefs.gui_layout_content_1 = layout_pane_content_plist;
prefs.gui_layout_content_2 = layout_pane_content_pdetails;
prefs.gui_layout_content_3 = layout_pane_content_pbytes;
prefs.gui_packet_editor = FALSE;
prefs.gui_packet_list_elide_mode = ELIDE_RIGHT;
prefs.gui_packet_list_show_related = TRUE;
prefs.gui_packet_list_show_minimap = TRUE;
prefs.gui_qt_packet_list_separator = FALSE;
if (prefs.col_list) {
free_col_info(prefs.col_list);
prefs.col_list = NULL;
}
for (i = 0; i < DEF_NUM_COLS; i++) {
cfmt = g_new(fmt_data,1);
cfmt->title = g_strdup(col_fmt[i * 2]);
parse_column_format(cfmt, col_fmt[(i * 2) + 1]);
cfmt->visible = TRUE;
cfmt->resolved = TRUE;
cfmt->custom_fields = NULL;
cfmt->custom_occurrence = 0;
prefs.col_list = g_list_append(prefs.col_list, cfmt);
}
prefs.num_cols = DEF_NUM_COLS;
/* set the default values for the capture dialog box */
prefs.capture_prom_mode = TRUE;
#ifdef PCAP_NG_DEFAULT
prefs.capture_pcap_ng = TRUE;
#else
prefs.capture_pcap_ng = FALSE;
#endif
prefs.capture_real_time = TRUE;
prefs.capture_auto_scroll = TRUE;
prefs.capture_show_info = FALSE;
if (!prefs.capture_columns) {
/* First time through */
for (i = 0; i < num_capture_cols; i++) {
col_name = g_strdup(capture_cols[i]);
prefs.capture_columns = g_list_append(prefs.capture_columns, col_name);
}
}
prefs.console_log_level =
G_LOG_LEVEL_WARNING | G_LOG_LEVEL_CRITICAL | G_LOG_LEVEL_ERROR;
/* set the default values for the tap/statistics dialog box */
prefs.tap_update_interval = TAP_UPDATE_DEFAULT_INTERVAL;
prefs.rtp_player_max_visible = RTP_PLAYER_DEFAULT_VISIBLE;
prefs.st_enable_burstinfo = TRUE;
prefs.st_burst_showcount = FALSE;
prefs.st_burst_resolution = ST_DEF_BURSTRES;
prefs.st_burst_windowlen = ST_DEF_BURSTLEN;
prefs.st_sort_casesensitve = TRUE;
prefs.st_sort_rng_fixorder = TRUE;
prefs.st_sort_rng_nameonly = TRUE;
prefs.st_sort_defcolflag = ST_SORT_COL_COUNT;
prefs.st_sort_defdescending = TRUE;
prefs.st_sort_showfullname = FALSE;
prefs.display_hidden_proto_items = FALSE;
prefs.display_byte_fields_with_spaces = FALSE;
}
/*
* Reset a single dissector preference.
*/
static void
reset_pref(pref_t *pref)
{
int type;
if (!pref) return;
type = pref->type;
/*
* This preference is no longer supported; it's not a
* real preference, so we don't reset it (i.e., we
* treat it as if it weren't found in the list of
* preferences, and we weren't called in the first place).
*/
if (IS_PREF_OBSOLETE(type))
return;
else
RESET_PREF_OBSOLETE(type);
switch (type) {
case PREF_UINT:
*pref->varp.uint = pref->default_val.uint;
break;
case PREF_BOOL:
*pref->varp.boolp = pref->default_val.boolval;
break;
case PREF_ENUM:
/*
* For now, we save the "description" value, so that if we
* save the preferences older versions of Wireshark can at
* least read preferences that they supported; we support
* either the short name or the description when reading
* the preferences file or a "-o" option.
*/
*pref->varp.enump = pref->default_val.enumval;
break;
case PREF_STRING:
case PREF_FILENAME:
case PREF_DIRNAME:
reset_string_like_preference(pref);
break;
case PREF_RANGE:
g_free(*pref->varp.range);
*pref->varp.range = range_copy(pref->default_val.range);
break;
case PREF_STATIC_TEXT:
case PREF_UAT:
/* Nothing to do */
break;
case PREF_COLOR:
*pref->varp.colorp = pref->default_val.color;
break;
case PREF_CUSTOM:
pref->custom_cbs.reset_cb(pref);
break;
}
}
static void
reset_pref_cb(gpointer data, gpointer user_data _U_)
{
pref_t *pref = (pref_t *) data;
reset_pref(pref);
}
typedef struct {
module_t *module;
} reset_pref_arg_t;
/*
* Reset all preferences for a module.
*/
static gboolean
reset_module_prefs(const void *key _U_, void *value, void *data _U_)
{
reset_pref_arg_t arg;
arg.module = (module_t *)value;
g_list_foreach(arg.module->prefs, reset_pref_cb, &arg);
return FALSE;
}
/* Reset preferences */
void
prefs_reset(void)
{
prefs_initialized = FALSE;
g_free(prefs.saved_at_version);
prefs.saved_at_version = NULL;
/*
* Unload all UAT preferences.
*/
uat_unload_all();
/*
* Unload any loaded MIBs.
*/
oids_cleanup();
/*
* Free the filter expression list.
*/
filter_expression_free(*pfilter_expression_head);
*pfilter_expression_head = NULL;
/*
* Reset the non-dissector preferences.
*/
init_prefs();
/*
* Reset the non-UAT dissector preferences.
*/
wmem_tree_foreach(prefs_modules, reset_module_prefs, NULL);
}
/* Read the preferences file, fill in "prefs", and return a pointer to it.
If we got an error (other than "it doesn't exist") trying to read
the global preferences file, stuff the errno into "*gpf_errno_return"
and a pointer to the path of the file into "*gpf_path_return", and
return NULL.
If we got an error (other than "it doesn't exist") trying to read
the user's preferences file, stuff the errno into "*pf_errno_return"
and a pointer to the path of the file into "*pf_path_return", and
return NULL. */
e_prefs *
read_prefs(int *gpf_errno_return, int *gpf_read_errno_return,
char **gpf_path_return, int *pf_errno_return,
int *pf_read_errno_return, char **pf_path_return)
{
int err;
char *pf_path;
FILE *pf;
/* clean up libsmi structures before reading prefs */
oids_cleanup();
init_prefs();
/*
* If we don't already have the pathname of the global preferences
* file, construct it. Then, in either case, try to open the file.
*/
if (gpf_path == NULL) {
/*
* We don't have the path; try the new path first, and, if that
* file doesn't exist, try the old path.
*/
gpf_path = get_datafile_path(PF_NAME);
if ((pf = ws_fopen(gpf_path, "r")) == NULL && errno == ENOENT) {
/*
* It doesn't exist by the new name; try the old name.
*/
g_free(gpf_path);
gpf_path = get_datafile_path(OLD_GPF_NAME);
pf = ws_fopen(gpf_path, "r");
}
} else {
/*
* We have the path; try it.
*/
pf = ws_fopen(gpf_path, "r");
}
/*
* If we were able to open the file, read it.
* XXX - if it failed for a reason other than "it doesn't exist",
* report the error.
*/
*gpf_path_return = NULL;
if (pf != NULL) {
/*
* Start out the counters of "mgcp.{tcp,udp}.port" entries we've
* seen.
*/
mgcp_tcp_port_count = 0;
mgcp_udp_port_count = 0;
/* We succeeded in opening it; read it. */
err = read_prefs_file(gpf_path, pf, set_pref, NULL);
if (err != 0) {
/* We had an error reading the file; return the errno and the
pathname, so our caller can report the error. */
*gpf_errno_return = 0;
*gpf_read_errno_return = err;
*gpf_path_return = gpf_path;
}
fclose(pf);
} else {
/* We failed to open it. If we failed for some reason other than
"it doesn't exist", return the errno and the pathname, so our
caller can report the error. */
if (errno != ENOENT) {
*gpf_errno_return = errno;
*gpf_read_errno_return = 0;
*gpf_path_return = gpf_path;
}
}
/* Construct the pathname of the user's preferences file. */
pf_path = get_persconffile_path(PF_NAME, TRUE);
/* Read the user's preferences file, if it exists. */
*pf_path_return = NULL;
if ((pf = ws_fopen(pf_path, "r")) != NULL) {
/*
* Start out the counters of "mgcp.{tcp,udp}.port" entries we've
* seen.
*/
mgcp_tcp_port_count = 0;
mgcp_udp_port_count = 0;
/* We succeeded in opening it; read it. */
err = read_prefs_file(pf_path, pf, set_pref, NULL);
if (err != 0) {
/* We had an error reading the file; return the errno and the
pathname, so our caller can report the error. */
*pf_errno_return = 0;
*pf_read_errno_return = err;
*pf_path_return = pf_path;
} else
g_free(pf_path);
fclose(pf);
} else {
/* We failed to open it. If we failed for some reason other than
"it doesn't exist", return the errno and the pathname, so our
caller can report the error. */
if (errno != ENOENT) {
*pf_errno_return = errno;
*pf_read_errno_return = 0;
*pf_path_return = pf_path;
} else
g_free(pf_path);
}
/* load SMI modules if needed */
oids_init();
return &prefs;
}
/* read the preferences file (or similar) and call the callback
* function to set each key/value pair found */
int
read_prefs_file(const char *pf_path, FILE *pf,
pref_set_pair_cb pref_set_pair_fct, void *private_data)
{
enum {
START, /* beginning of a line */
IN_VAR, /* processing key name */
PRE_VAL, /* finished processing key name, skipping white space befor evalue */
IN_VAL, /* processing value */
IN_SKIP /* skipping to the end of the line */
} state = START;
int got_c;
GString *cur_val;
GString *cur_var;
gboolean got_val = FALSE;
gint fline = 1, pline = 1;
gchar hint[] = "(save preferences to remove this warning)";
gchar ver[128];
cur_val = g_string_new("");
cur_var = g_string_new("");
/* Try to read in the profile name in the first line of the preferences file. */
if (fscanf(pf, "# Configuration file for %127[^\r\n]", ver) == 1) {
/* Assume trailing period and remove it */
g_free(prefs.saved_at_version);
prefs.saved_at_version = g_strndup(ver, strlen(ver) - 1);
}
rewind(pf);
while ((got_c = ws_getc_unlocked(pf)) != EOF) {
if (got_c == '\r') {
/* Treat CR-LF at the end of a line like LF, so that if we're reading
* a Windows-format file on UN*X, we handle it the same way we'd handle
* a UN*X-format file. */
got_c = ws_getc_unlocked(pf);
if (got_c == EOF)
break;
if (got_c != '\n') {
/* Put back the character after the CR, and process the CR normally. */
ungetc(got_c, pf);
got_c = '\r';
}
}
if (got_c == '\n') {
state = START;
fline++;
continue;
}
switch (state) {
case START:
if (g_ascii_isalnum(got_c)) {
if (cur_var->len > 0) {
if (got_val) {
if (cur_val->len > 0) {
if (cur_val->str[cur_val->len-1] == ',') {
/*
* If the pref has a trailing comma, eliminate it.
*/
cur_val->str[cur_val->len-1] = '\0';
g_warning ("%s line %d: trailing comma in \"%s\" %s", pf_path, pline, cur_var->str, hint);
}
}
/* Call the routine to set the preference; it will parse
the value as appropriate.
Since we're reading a file, rather than processing
explicit user input, for range preferences, silently
lower values in excess of the range's maximum, rather
than reporting errors and failing. */
switch (pref_set_pair_fct(cur_var->str, cur_val->str, private_data, FALSE)) {
case PREFS_SET_OK:
break;
case PREFS_SET_SYNTAX_ERR:
g_warning ("Syntax error in preference \"%s\" at line %d of\n%s %s",
cur_var->str, pline, pf_path, hint);
break;
case PREFS_SET_NO_SUCH_PREF:
/*
* If "print.command" silently ignore it because it's valid
* on non-Win32 platforms.
*/
if (strcmp(cur_var->str, "print.command") != 0)
g_warning ("No such preference \"%s\" at line %d of\n%s %s",
cur_var->str, pline, pf_path, hint);
prefs.unknown_prefs = TRUE;
break;
case PREFS_SET_OBSOLETE:
if (strcmp(cur_var->str, "print.command") != 0)
/* If an attempt is made to save the preferences, a popup warning will be
displayed stating that obsolete prefs have been detected and the user will
be given the opportunity to save these prefs under a different profile name.
The prefs in question need to be listed in the console window so that the
user can make an informed choice.
*/
g_warning ("Obsolete preference \"%s\" at line %d of\n%s %s",
cur_var->str, pline, pf_path, hint);
prefs.unknown_prefs = TRUE;
break;
}
} else {
g_warning ("Incomplete preference at line %d: of\n%s %s", pline, pf_path, hint);
}
}
state = IN_VAR;
got_val = FALSE;
g_string_truncate(cur_var, 0);
g_string_append_c(cur_var, (gchar) got_c);
pline = fline;
} else if (g_ascii_isspace(got_c) && cur_var->len > 0 && got_val) {
state = PRE_VAL;
} else if (got_c == '#') {
state = IN_SKIP;
} else {
g_warning ("Malformed preference at line %d of\n%s %s", fline, pf_path, hint);
}
break;
case IN_VAR:
if (got_c != ':') {
g_string_append_c(cur_var, (gchar) got_c);
} else {
/* This is a colon (':') */
state = PRE_VAL;
g_string_truncate(cur_val, 0);
/*
* Set got_val to TRUE to accommodate prefs such as
* "gui.fileopen.dir" that do not require a value.
*/
got_val = TRUE;
}
break;
case PRE_VAL:
if (!g_ascii_isspace(got_c)) {
state = IN_VAL;
g_string_append_c(cur_val, (gchar) got_c);
}
break;
case IN_VAL:
g_string_append_c(cur_val, (gchar) got_c);
break;
case IN_SKIP:
break;
}
}
if (cur_var->len > 0) {
if (got_val) {
/* Call the routine to set the preference; it will parse
the value as appropriate.
Since we're reading a file, rather than processing
explicit user input, for range preferences, silently
lower values in excess of the range's maximum, rather
than reporting errors and failing. */
switch (pref_set_pair_fct(cur_var->str, cur_val->str, private_data, FALSE)) {
case PREFS_SET_OK:
break;
case PREFS_SET_SYNTAX_ERR:
g_warning ("Syntax error in preference %s at line %d of\n%s %s",
cur_var->str, pline, pf_path, hint);
break;
case PREFS_SET_NO_SUCH_PREF:
g_warning ("No such preference \"%s\" at line %d of\n%s %s",
cur_var->str, pline, pf_path, hint);
prefs.unknown_prefs = TRUE;
break;
case PREFS_SET_OBSOLETE:
prefs.unknown_prefs = TRUE;
break;
}
} else {
g_warning ("Incomplete preference at line %d of\n%s %s",
pline, pf_path, hint);
}
}
g_string_free(cur_val, TRUE);
g_string_free(cur_var, TRUE);
if (ferror(pf))
return errno;
else
return 0;
}
/*
* If we were handed a preference starting with "uat:", try to turn it into
* a valid uat entry.
*/
static gboolean
prefs_set_uat_pref(char *uat_entry) {
gchar *p, *colonp;
uat_t *uat;
gchar *err = NULL;
gboolean ret;
colonp = strchr(uat_entry, ':');
if (colonp == NULL)
return FALSE;
p = colonp;
*p++ = '\0';
/*
* Skip over any white space (there probably won't be any, but
* as we allow it in the preferences file, we might as well
* allow it here).
*/
while (g_ascii_isspace(*p))
p++;
if (*p == '\0') {
/*
* Put the colon back, so if our caller uses, in an
* error message, the string they passed us, the message
* looks correct.
*/
*colonp = ':';
return FALSE;
}
uat = uat_find(uat_entry);
*colonp = ':';
if (uat == NULL) {
return FALSE;
}
ret = uat_load_str(uat, p, &err);
g_free(err);
return ret;
}
/*
* Given a string of the form "<pref name>:<pref value>", as might appear
* as an argument to a "-o" option, parse it and set the preference in
* question. Return an indication of whether it succeeded or failed
* in some fashion.
*/
prefs_set_pref_e
prefs_set_pref(char *prefarg)
{
gchar *p, *colonp;
prefs_set_pref_e ret;
/*
* Set the counters of "mgcp.{tcp,udp}.port" entries we've
* seen to values that keep us from trying to interpret them
* as "mgcp.{tcp,udp}.gateway_port" or "mgcp.{tcp,udp}.callagent_port",
* as, from the command line, we have no way of guessing which
* the user had in mind.
*/
mgcp_tcp_port_count = -1;
mgcp_udp_port_count = -1;
colonp = strchr(prefarg, ':');
if (colonp == NULL)
return PREFS_SET_SYNTAX_ERR;
p = colonp;
*p++ = '\0';
/*
* Skip over any white space (there probably won't be any, but
* as we allow it in the preferences file, we might as well
* allow it here).
*/
while (g_ascii_isspace(*p))
p++;
if (*p == '\0') {
/*
* Put the colon back, so if our caller uses, in an
* error message, the string they passed us, the message
* looks correct.
*/
*colonp = ':';
return PREFS_SET_SYNTAX_ERR;
}
if (strcmp(prefarg, "uat")) {
ret = set_pref(prefarg, p, NULL, TRUE);
} else {
ret = prefs_set_uat_pref(p) ? PREFS_SET_OK : PREFS_SET_SYNTAX_ERR;
}
*colonp = ':'; /* put the colon back */
return ret;
}
/*
* Returns TRUE if the given device is hidden
*/
gboolean
prefs_is_capture_device_hidden(const char *name)
{
gchar *tok, *devices;
size_t len;
if (prefs.capture_devices_hide && name) {
devices = g_strdup (prefs.capture_devices_hide);
len = strlen (name);
for (tok = strtok (devices, ","); tok; tok = strtok(NULL, ",")) {
if (strlen (tok) == len && strcmp (name, tok) == 0) {
g_free (devices);
return TRUE;
}
}
g_free (devices);
}
return FALSE;
}
/*
* Returns TRUE if the given column is visible (not hidden)
*/
static gboolean
prefs_is_column_visible(const gchar *cols_hidden, fmt_data *cfmt)
{
gchar *tok, *cols;
fmt_data cfmt_hidden;
/*
* Do we have a list of hidden columns?
*/
if (cols_hidden) {
/*
* Yes - check the column against each of the ones in the
* list.
*/
cols = g_strdup(cols_hidden);
for (tok = strtok(cols, ","); tok; tok = strtok(NULL, ",")) {
tok = g_strstrip(tok);
/*
* Parse this column format.
*/
if (!parse_column_format(&cfmt_hidden, tok)) {
/*
* It's not valid; ignore it.
*/
continue;
}
/*
* Does it match the column?
*/
if (cfmt->fmt != cfmt_hidden.fmt) {
/* No. */
g_free(cfmt_hidden.custom_fields);
cfmt_hidden.custom_fields = NULL;
continue;
}
if (cfmt->fmt == COL_CUSTOM) {
/*
* A custom column has to have the
* same custom field and occurrence.
*/
if (cfmt_hidden.custom_fields && cfmt->custom_fields) {
if (strcmp(cfmt->custom_fields,
cfmt_hidden.custom_fields) != 0) {
/* Different fields. */
g_free(cfmt_hidden.custom_fields);
cfmt_hidden.custom_fields = NULL;
continue;
}
if (cfmt->custom_occurrence != cfmt_hidden.custom_occurrence) {
/* Different occurrences. */
g_free(cfmt_hidden.custom_fields);
cfmt_hidden.custom_fields = NULL;
continue;
}
}
}
/*
* OK, they match, so it's one of the hidden fields,
* hence not visible.
*/
g_free(cfmt_hidden.custom_fields);
g_free(cols);
return FALSE;
}
g_free(cols);
}
/*
* No - either there are no hidden columns or this isn't one
* of them - so it is visible.
*/
return TRUE;
}
/*
* Returns TRUE if the given device should capture in monitor mode by default
*/
gboolean
prefs_capture_device_monitor_mode(const char *name)
{
gchar *tok, *devices;
size_t len;
if (prefs.capture_devices_monitor_mode && name) {
devices = g_strdup (prefs.capture_devices_monitor_mode);
len = strlen (name);
for (tok = strtok (devices, ","); tok; tok = strtok(NULL, ",")) {
if (strlen (tok) == len && strcmp (name, tok) == 0) {
g_free (devices);
return TRUE;
}
}
g_free (devices);
}
return FALSE;
}
/*
* Returns TRUE if the user has marked this column as visible
*/
gboolean
prefs_capture_options_dialog_column_is_visible(const gchar *column)
{
GList *curr;
gchar *col;
for (curr = g_list_first(prefs.capture_columns); curr; curr = g_list_next(curr)) {
col = (gchar *)curr->data;
if (col && (g_ascii_strcasecmp(col, column) == 0)) {
return TRUE;
}
}
return FALSE;
}
#define PRS_GUI_FILTER_LABEL "gui.filter_expressions.label"
#define PRS_GUI_FILTER_EXPR "gui.filter_expressions.expr"
#define PRS_GUI_FILTER_ENABLED "gui.filter_expressions.enabled"
/*
* Extract the red, green, and blue components of a 24-bit RGB value
* and convert them from [0,255] to [0,65535].
*/
#define RED_COMPONENT(x) (guint16) (((((x) >> 16) & 0xff) * 65535 / 255))
#define GREEN_COMPONENT(x) (guint16) (((((x) >> 8) & 0xff) * 65535 / 255))
#define BLUE_COMPONENT(x) (guint16) ( (((x) & 0xff) * 65535 / 255))
char
string_to_name_resolve(const char *string, e_addr_resolve *name_resolve)
{
char c;
memset(name_resolve, 0, sizeof(e_addr_resolve));
while ((c = *string++) != '\0') {
switch (c) {
case 'm':
name_resolve->mac_name = TRUE;
break;
case 'n':
name_resolve->network_name = TRUE;
break;
case 'N':
name_resolve->use_external_net_name_resolver = TRUE;
break;
case 't':
name_resolve->transport_name = TRUE;
break;
case 'C':
/* DEPRECATED */
/* name_resolve->concurrent_dns */
break;
case 'd':
name_resolve->dns_pkt_addr_resolution = TRUE;
break;
case 'v':
name_resolve->vlan_name = TRUE;
break;
default:
/*
* Unrecognized letter.
*/
return c;
}
}
return '\0';
}
static void
try_convert_to_custom_column(gpointer *el_data)
{
guint haystack_idx;
gchar **fmt = (gchar **) el_data;
for (haystack_idx = 0;
haystack_idx < G_N_ELEMENTS(migrated_columns);
++haystack_idx) {
if (strcmp(migrated_columns[haystack_idx].col_fmt, *fmt) == 0) {
gchar *cust_col = g_strdup_printf("%%Cus:%s:0",
migrated_columns[haystack_idx].col_expr);
g_free(*fmt);
*fmt = cust_col;
}
}
}
static gboolean
deprecated_heur_dissector_pref(gchar *pref_name, const gchar *value)
{
struct heur_pref_name
{
const char* pref_name;
const char* short_name;
gboolean more_dissectors; /* For multiple dissectors controlled by the same preference */
};
struct heur_pref_name heur_prefs[] = {
{"acn.heuristic_acn", "acn_udp", 0},
{"bfcp.enable", "bfcp_tcp", 1},
{"bfcp.enable", "bfcp_udp", 0},
{"bt-dht.enable", "bittorrent_dht_udp", 0},
{"bt-utp.enable", "bt_utp_udp", 0},
{"cattp.enable", "cattp_udp", 0},
{"cfp.enable", "fp_eth", 0},
{"dicom.heuristic", "dicom_tcp", 0},
{"dnp3.heuristics", "dnp3_tcp", 1},
{"dnp3.heuristics", "dnp3_udp", 0},
{"dvb-s2_modeadapt.enable", "dvb_s2_udp", 0},
{"esl.enable", "esl_eth", 0},
{"fp.udp_heur", "fp_udp", 0},
{"gvsp.enable_heuristic", "gvsp_udp", 0},
{"hdcp2.enable", "hdcp2_tcp", 0},
{"hislip.enable_heuristic", "hislip_tcp", 0},
{"jxta.udp.heuristic", "jxta_udp", 0},
{"jxta.tcp.heuristic", "jxta_tcp", 0},
{"jxta.sctp.heuristic", "jxta_sctp", 0},
{"mac-lte.heuristic_mac_lte_over_udp", "mac_lte_udp", 0},
{"mbim.bulk_heuristic", "mbim_usb_bulk", 0},
{"norm.heuristic_norm", "rmt_norm_udp", 0},
{"openflow.heuristic", "openflow_tcp", 0},
{"pdcp-lte.heuristic_pdcp_lte_over_udp", "pdcp_lte_udp", 0},
{"rlc.heuristic_rlc_over_udp", "rlc_udp", 0},
{"rlc-lte.heuristic_rlc_lte_over_udp", "rlc_lte_udp", 0},
{"rtcp.heuristic_rtcp", "rtcp_udp", 1},
{"rtcp.heuristic_rtcp", "rtcp_stun", 0},
{"rtp.heuristic_rtp", "rtp_udp", 1},
{"rtp.heuristic_rtp", "rtp_stun", 0},
{"teredo.heuristic_teredo", "teredo_udp", 0},
{"vssmonitoring.use_heuristics", "vssmonitoring_eth", 0},
{"xml.heuristic", "xml_http", 1},
{"xml.heuristic", "xml_sip", 1},
{"xml.heuristic", "xml_media", 0},
{"xml.heuristic_tcp", "xml_tcp", 0},
{"xml.heuristic_udp", "xml_udp", 0},
};
unsigned int i;
heur_dtbl_entry_t* heuristic;
for (i = 0; i < sizeof(heur_prefs)/sizeof(struct heur_pref_name); i++)
{
if (strcmp(pref_name, heur_prefs[i].pref_name) == 0)
{
heuristic = find_heur_dissector_by_unique_short_name(heur_prefs[i].short_name);
if (heuristic != NULL) {
heuristic->enabled = ((g_ascii_strcasecmp(value, "true") == 0) ? TRUE : FALSE);
}
if (!heur_prefs[i].more_dissectors)
return TRUE;
}
}
return FALSE;
}
static prefs_set_pref_e
set_pref(gchar *pref_name, const gchar *value, void *private_data _U_,
gboolean return_range_errors)
{
unsigned long int cval;
guint uval;
gboolean bval;
gint enum_val;
char *p;
gchar *dotp, *last_dotp;
static gchar *filter_label = NULL;
static gboolean filter_enabled = FALSE;
gchar *filter_expr = NULL;
module_t *module, *containing_module;
pref_t *pref;
int type;
if (strcmp(pref_name, PRS_GUI_FILTER_LABEL) == 0) {
filter_label = g_strdup(value);
} else if (strcmp(pref_name, PRS_GUI_FILTER_ENABLED) == 0) {
filter_enabled = (strcmp(value, "TRUE") == 0) ? TRUE : FALSE;
} else if (strcmp(pref_name, PRS_GUI_FILTER_EXPR) == 0) {
filter_expr = g_strdup(value);
filter_expression_new(filter_label, filter_expr, filter_enabled);
g_free(filter_label);
g_free(filter_expr);
} else if (strcmp(pref_name, "gui.version_in_start_page") == 0) {
/* Convert deprecated value to closest current equivalent */
if (g_ascii_strcasecmp(value, "true") == 0) {
prefs.gui_version_placement = version_both;
} else {
prefs.gui_version_placement = version_neither;
}
} else if (strcmp(pref_name, "name_resolve") == 0 ||
strcmp(pref_name, "capture.name_resolve") == 0) {
/*
* Handle the deprecated name resolution options.
*
* "TRUE" and "FALSE", for backwards compatibility, are synonyms for
* RESOLV_ALL and RESOLV_NONE.
*
* Otherwise, we treat it as a list of name types we want to resolve.
*/
if (g_ascii_strcasecmp(value, "true") == 0) {
gbl_resolv_flags.mac_name = TRUE;
gbl_resolv_flags.network_name = TRUE;
gbl_resolv_flags.transport_name = TRUE;
}
else if (g_ascii_strcasecmp(value, "false") == 0) {
disable_name_resolution();
}
else {
/* start out with none set */
disable_name_resolution();
if (string_to_name_resolve(value, &gbl_resolv_flags) != '\0')
return PREFS_SET_SYNTAX_ERR;
}
} else if (deprecated_heur_dissector_pref(pref_name, value)) {
/* Handled within deprecated_heur_dissector_pref() if found */
} else {
/* Handle deprecated "global" options that don't have a module
* associated with them
*/
if ((strcmp(pref_name, "name_resolve_concurrency") == 0) ||
(strcmp(pref_name, "name_resolve_load_smi_modules") == 0) ||
(strcmp(pref_name, "name_resolve_suppress_smi_errors") == 0)) {
module = nameres_module;
dotp = pref_name;
} else {
/* To which module does this preference belong? */
module = NULL;
last_dotp = pref_name;
while (!module) {
dotp = strchr(last_dotp, '.');
if (dotp == NULL) {
/* Either there's no such module, or no module was specified.
In either case, that means there's no such preference. */
return PREFS_SET_NO_SUCH_PREF;
}
*dotp = '\0'; /* separate module and preference name */
module = prefs_find_module(pref_name);
/*
* XXX - "Diameter" rather than "diameter" was used in earlier
* versions of Wireshark; if we didn't find the module, and its name
* was "Diameter", look for "diameter" instead.
*
* In addition, the BEEP protocol used to be the BXXP protocol,
* so if we didn't find the module, and its name was "bxxp",
* look for "beep" instead.
*
* Also, the preferences for GTP v0 and v1 were combined under
* a single "gtp" heading, and the preferences for SMPP were
* moved to "smpp-gsm-sms" and then moved to "gsm-sms-ud".
* However, SMPP now has its own preferences, so we just map
* "smpp-gsm-sms" to "gsm-sms-ud", and then handle SMPP below.
*
* We also renamed "dcp" to "dccp", "x.25" to "x25", "x411" to "p1"
* and "nsip" to "gprs_ns".
*
* The SynOptics Network Management Protocol (SONMP) is now known by
* its modern name, the Nortel Discovery Protocol (NDP).
*/
if (module == NULL) {
if (strcmp(pref_name, "column") == 0)
module = gui_column_module;
else if (strcmp(pref_name, "Diameter") == 0)
module = prefs_find_module("diameter");
else if (strcmp(pref_name, "bxxp") == 0)
module = prefs_find_module("beep");
else if (strcmp(pref_name, "gtpv0") == 0 ||
strcmp(pref_name, "gtpv1") == 0)
module = prefs_find_module("gtp");
else if (strcmp(pref_name, "smpp-gsm-sms") == 0)
module = prefs_find_module("gsm-sms-ud");
else if (strcmp(pref_name, "dcp") == 0)
module = prefs_find_module("dccp");
else if (strcmp(pref_name, "x.25") == 0)
module = prefs_find_module("x25");
else if (strcmp(pref_name, "x411") == 0)
module = prefs_find_module("p1");
else if (strcmp(pref_name, "nsip") == 0)
module = prefs_find_module("gprs-ns");
else if (strcmp(pref_name, "sonmp") == 0)
module = prefs_find_module("ndp");
else if (strcmp(pref_name, "etheric") == 0 ||
strcmp(pref_name, "isup_thin") == 0) {
/* This protocol was removed 7. July 2009 */
return PREFS_SET_OBSOLETE;
}
if (module) {
g_warning ("Preference \"%s.%s\" has been converted to \"%s.%s.%s\"\n"
"Save your preferences to make this change permanent.",
pref_name, dotp+1, module->parent->name, pref_name, dotp+1);
prefs.unknown_prefs = TRUE;
}
}
*dotp = '.'; /* put the preference string back */
dotp++; /* skip past separator to preference name */
last_dotp = dotp;
}
}
/* The pref is located in the module or a submodule.
* Assume module, then search for a submodule holding the pref. */
containing_module = module;
pref = prefs_find_preference_with_submodule(module, dotp, &containing_module);
if (pref == NULL) {
prefs.unknown_prefs = TRUE;
/* "gui" prefix was added to column preferences for better organization
* within the preferences file
*/
if (module == gui_column_module) {
/* While this has a subtree, there is no apply callback, so no
* need to use prefs_find_preference_with_submodule to update
* containing_module. It would not be useful. */
pref = prefs_find_preference(module, pref_name);
}
else if (strcmp(module->name, "mgcp") == 0) {
/*
* XXX - "mgcp.display raw text toggle" and "mgcp.display dissect tree"
* rather than "mgcp.display_raw_text" and "mgcp.display_dissect_tree"
* were used in earlier versions of Wireshark; if we didn't find the
* preference, it was an MGCP preference, and its name was
* "display raw text toggle" or "display dissect tree", look for
* "display_raw_text" or "display_dissect_tree" instead.
*
* "mgcp.tcp.port" and "mgcp.udp.port" are harder to handle, as both
* the gateway and callagent ports were given those names; we interpret
* the first as "mgcp.{tcp,udp}.gateway_port" and the second as
* "mgcp.{tcp,udp}.callagent_port", as that's the order in which
* they were registered by the MCCP dissector and thus that's the
* order in which they were written to the preferences file. (If
* we're not reading the preferences file, but are handling stuff
* from a "-o" command-line option, we have no clue which the user
* had in mind - they should have used "mgcp.{tcp,udp}.gateway_port"
* or "mgcp.{tcp,udp}.callagent_port" instead.)
*/
if (strcmp(dotp, "display raw text toggle") == 0)
pref = prefs_find_preference(module, "display_raw_text");
else if (strcmp(dotp, "display dissect tree") == 0)
pref = prefs_find_preference(module, "display_dissect_tree");
else if (strcmp(dotp, "tcp.port") == 0) {
mgcp_tcp_port_count++;
if (mgcp_tcp_port_count == 1) {
/* It's the first one */
pref = prefs_find_preference(module, "tcp.gateway_port");
} else if (mgcp_tcp_port_count == 2) {
/* It's the second one */
pref = prefs_find_preference(module, "tcp.callagent_port");
}
/* Otherwise it's from the command line, and we don't bother
mapping it. */
} else if (strcmp(dotp, "udp.port") == 0) {
mgcp_udp_port_count++;
if (mgcp_udp_port_count == 1) {
/* It's the first one */
pref = prefs_find_preference(module, "udp.gateway_port");
} else if (mgcp_udp_port_count == 2) {
/* It's the second one */
pref = prefs_find_preference(module, "udp.callagent_port");
}
/* Otherwise it's from the command line, and we don't bother
mapping it. */
}
} else if (strcmp(module->name, "smb") == 0) {
/* Handle old names for SMB preferences. */
if (strcmp(dotp, "smb.trans.reassembly") == 0)
pref = prefs_find_preference(module, "trans_reassembly");
else if (strcmp(dotp, "smb.dcerpc.reassembly") == 0)
pref = prefs_find_preference(module, "dcerpc_reassembly");
} else if (strcmp(module->name, "ndmp") == 0) {
/* Handle old names for NDMP preferences. */
if (strcmp(dotp, "ndmp.desegment") == 0)
pref = prefs_find_preference(module, "desegment");
} else if (strcmp(module->name, "diameter") == 0) {
/* Handle old names for Diameter preferences. */
if (strcmp(dotp, "diameter.desegment") == 0)
pref = prefs_find_preference(module, "desegment");
} else if (strcmp(module->name, "pcli") == 0) {
/* Handle old names for PCLI preferences. */
if (strcmp(dotp, "pcli.udp_port") == 0)
pref = prefs_find_preference(module, "udp_port");
} else if (strcmp(module->name, "artnet") == 0) {
/* Handle old names for ARTNET preferences. */
if (strcmp(dotp, "artnet.udp_port") == 0)
pref = prefs_find_preference(module, "udp_port");
} else if (strcmp(module->name, "mapi") == 0) {
/* Handle old names for MAPI preferences. */
if (strcmp(dotp, "mapi_decrypt") == 0)
pref = prefs_find_preference(module, "decrypt");
} else if (strcmp(module->name, "fc") == 0) {
/* Handle old names for Fibre Channel preferences. */
if (strcmp(dotp, "reassemble_fc") == 0)
pref = prefs_find_preference(module, "reassemble");
else if (strcmp(dotp, "fc_max_frame_size") == 0)
pref = prefs_find_preference(module, "max_frame_size");
} else if (strcmp(module->name, "fcip") == 0) {
/* Handle old names for Fibre Channel-over-IP preferences. */
if (strcmp(dotp, "desegment_fcip_messages") == 0)
pref = prefs_find_preference(module, "desegment");
else if (strcmp(dotp, "fcip_port") == 0)
pref = prefs_find_preference(module, "target_port");
} else if (strcmp(module->name, "gtp") == 0) {
/* Handle old names for GTP preferences. */
if (strcmp(dotp, "gtpv0_port") == 0)
pref = prefs_find_preference(module, "v0_port");
else if (strcmp(dotp, "gtpv1c_port") == 0)
pref = prefs_find_preference(module, "v1c_port");
else if (strcmp(dotp, "gtpv1u_port") == 0)
pref = prefs_find_preference(module, "v1u_port");
else if (strcmp(dotp, "gtp_dissect_tpdu") == 0)
pref = prefs_find_preference(module, "dissect_tpdu");
else if (strcmp(dotp, "gtpv0_dissect_cdr_as") == 0)
pref = prefs_find_preference(module, "v0_dissect_cdr_as");
else if (strcmp(dotp, "gtpv0_check_etsi") == 0)
pref = prefs_find_preference(module, "v0_check_etsi");
else if (strcmp(dotp, "gtpv1_check_etsi") == 0)
pref = prefs_find_preference(module, "v1_check_etsi");
} else if (strcmp(module->name, "ip") == 0) {
/* Handle old names for IP preferences. */
if (strcmp(dotp, "ip_summary_in_tree") == 0)
pref = prefs_find_preference(module, "summary_in_tree");
} else if (strcmp(module->name, "iscsi") == 0) {
/* Handle old names for iSCSI preferences. */
if (strcmp(dotp, "iscsi_port") == 0)
pref = prefs_find_preference(module, "target_port");
} else if (strcmp(module->name, "lmp") == 0) {
/* Handle old names for LMP preferences. */
if (strcmp(dotp, "lmp_version") == 0)
pref = prefs_find_preference(module, "version");
} else if (strcmp(module->name, "mtp3") == 0) {
/* Handle old names for MTP3 preferences. */
if (strcmp(dotp, "mtp3_standard") == 0)
pref = prefs_find_preference(module, "standard");
else if (strcmp(dotp, "net_addr_format") == 0)
pref = prefs_find_preference(module, "addr_format");
} else if (strcmp(module->name, "nlm") == 0) {
/* Handle old names for NLM preferences. */
if (strcmp(dotp, "nlm_msg_res_matching") == 0)
pref = prefs_find_preference(module, "msg_res_matching");
} else if (strcmp(module->name, "ppp") == 0) {
/* Handle old names for PPP preferences. */
if (strcmp(dotp, "ppp_fcs") == 0)
pref = prefs_find_preference(module, "fcs_type");
else if (strcmp(dotp, "ppp_vj") == 0)
pref = prefs_find_preference(module, "decompress_vj");
} else if (strcmp(module->name, "rsvp") == 0) {
/* Handle old names for RSVP preferences. */
if (strcmp(dotp, "rsvp_process_bundle") == 0)
pref = prefs_find_preference(module, "process_bundle");
} else if (strcmp(module->name, "tcp") == 0) {
/* Handle old names for TCP preferences. */
if (strcmp(dotp, "tcp_summary_in_tree") == 0)
pref = prefs_find_preference(module, "summary_in_tree");
else if (strcmp(dotp, "tcp_analyze_sequence_numbers") == 0)
pref = prefs_find_preference(module, "analyze_sequence_numbers");
else if (strcmp(dotp, "tcp_relative_sequence_numbers") == 0)
pref = prefs_find_preference(module, "relative_sequence_numbers");
} else if (strcmp(module->name, "udp") == 0) {
/* Handle old names for UDP preferences. */
if (strcmp(dotp, "udp_summary_in_tree") == 0)
pref = prefs_find_preference(module, "summary_in_tree");
} else if (strcmp(module->name, "ndps") == 0) {
/* Handle old names for NDPS preferences. */
if (strcmp(dotp, "desegment_ndps") == 0)
pref = prefs_find_preference(module, "desegment_tcp");
} else if (strcmp(module->name, "http") == 0) {
/* Handle old names for HTTP preferences. */
if (strcmp(dotp, "desegment_http_headers") == 0)
pref = prefs_find_preference(module, "desegment_headers");
else if (strcmp(dotp, "desegment_http_body") == 0)
pref = prefs_find_preference(module, "desegment_body");
} else if (strcmp(module->name, "smpp") == 0) {
/* Handle preferences that moved from SMPP. */
module_t *new_module = prefs_find_module("gsm-sms-ud");
if (new_module) {
if (strcmp(dotp, "port_number_udh_means_wsp") == 0) {
pref = prefs_find_preference(new_module, "port_number_udh_means_wsp");
containing_module = new_module;
} else if (strcmp(dotp, "try_dissect_1st_fragment") == 0) {
pref = prefs_find_preference(new_module, "try_dissect_1st_fragment");
containing_module = new_module;
}
}
} else if (strcmp(module->name, "asn1") == 0) {
/* Handle old generic ASN.1 preferences (it's not really a
rename, as the new preferences support multiple ports,
but we might as well copy them over). */
if (strcmp(dotp, "tcp_port") == 0)
pref = prefs_find_preference(module, "tcp_ports");
else if (strcmp(dotp, "udp_port") == 0)
pref = prefs_find_preference(module, "udp_ports");
else if (strcmp(dotp, "sctp_port") == 0)
pref = prefs_find_preference(module, "sctp_ports");
} else if (strcmp(module->name, "llcgprs") == 0) {
if (strcmp(dotp, "ignore_cipher_bit") == 0)
pref = prefs_find_preference(module, "autodetect_cipher_bit");
} else if (strcmp(module->name, "erf") == 0) {
if (strcmp(dotp, "erfeth") == 0) {
/* Handle the old "erfeth" preference; map it to the new
"ethfcs" preference, and map the values to those for
the new preference. */
pref = prefs_find_preference(module, "ethfcs");
if (strcmp(value, "ethfcs") == 0 || strcmp(value, "Ethernet with FCS") == 0)
value = "TRUE";
else if (strcmp(value, "eth") == 0 || strcmp(value, "Ethernet") == 0)
value = "FALSE";
else if (strcmp(value, "raw") == 0 || strcmp(value, "Raw data") == 0)
value = "TRUE";
} else if (strcmp(dotp, "erfatm") == 0) {
/* Handle the old "erfatm" preference; map it to the new
"aal5_type" preference, and map the values to those for
the new preference. */
pref = prefs_find_preference(module, "aal5_type");
if (strcmp(value, "atm") == 0 || strcmp(value, "ATM") == 0)
value = "guess";
else if (strcmp(value, "llc") == 0 || strcmp(value, "LLC") == 0)
value = "llc";
else if (strcmp(value, "raw") == 0 || strcmp(value, "Raw data") == 0)
value = "guess";
} else if (strcmp(dotp, "erfhdlc") == 0) {
/* Handle the old "erfhdlc" preference; map it to the new
"hdlc_type" preference, and map the values to those for
the new preference. */
pref = prefs_find_preference(module, "hdlc_type");
if (strcmp(value, "chdlc") == 0 || strcmp(value, "Cisco HDLC") == 0)
value = "chdlc";
else if (strcmp(value, "ppp") == 0 || strcmp(value, "PPP serial") == 0)
value = "ppp";
else if (strcmp(value, "fr") == 0 || strcmp(value, "Frame Relay") == 0)
value = "frelay";
else if (strcmp(value, "mtp2") == 0 || strcmp(value, "SS7 MTP2") == 0)
value = "mtp2";
else if (strcmp(value, "raw") == 0 || strcmp(value, "Raw data") == 0)
value = "guess";
}
} else if (strcmp(module->name, "eth") == 0) {
/* "eth.qinq_ethertype" has been changed(restored) to "vlan.qinq.ethertype" */
if (strcmp(dotp, "qinq_ethertype") == 0) {
module_t *new_module = prefs_find_module("vlan");
if (new_module) {
pref = prefs_find_preference(new_module, "qinq_ethertype");
containing_module = new_module;
}
}
} else if (strcmp(module->name, "taps") == 0) {
/* taps preferences moved to "statistics" module */
if (strcmp(dotp, "update_interval") == 0 ||
strcmp(dotp, "rtp_player_max_visible") == 0)
pref = prefs_find_preference(stats_module, dotp);
} else if (strcmp(module->name, "packet_list") == 0) {
/* packet_list preferences moved to protocol module */
if (strcmp(dotp, "display_hidden_proto_items") == 0)
pref = prefs_find_preference(protocols_module, dotp);
} else if (strcmp(module->name, "stream") == 0) {
/* stream preferences moved to gui color module */
if ((strcmp(dotp, "client.fg") == 0) ||
(strcmp(dotp, "client.bg") == 0) ||
(strcmp(dotp, "server.fg") == 0) ||
(strcmp(dotp, "server.bg") == 0))
pref = prefs_find_preference(gui_color_module, pref_name);
} else if (strcmp(module->name, "nameres") == 0) {
if (strcmp(pref_name, "name_resolve_concurrency") == 0) {
pref = prefs_find_preference(nameres_module, pref_name);
} else if (strcmp(pref_name, "name_resolve_load_smi_modules") == 0) {
pref = prefs_find_preference(nameres_module, "load_smi_modules");
} else if (strcmp(pref_name, "name_resolve_suppress_smi_errors") == 0) {
pref = prefs_find_preference(nameres_module, "suppress_smi_errors");
}
}
}
if (pref == NULL)
return PREFS_SET_NO_SUCH_PREF; /* no such preference */
type = pref->type;
if (IS_PREF_OBSOLETE(type)) {
return PREFS_SET_OBSOLETE; /* no such preference any more */
} else {
RESET_PREF_OBSOLETE(type);
}
switch (type) {
case PREF_UINT:
/* XXX - give an error if it doesn't fit in a guint? */
uval = (guint)strtoul(value, &p, pref->info.base);
if (p == value || *p != '\0')
return PREFS_SET_SYNTAX_ERR; /* number was bad */
if (*pref->varp.uint != uval) {
containing_module->prefs_changed = TRUE;
*pref->varp.uint = uval;
}
break;
case PREF_BOOL:
/* XXX - give an error if it's neither "true" nor "false"? */
if (g_ascii_strcasecmp(value, "true") == 0)
bval = TRUE;
else
bval = FALSE;
if (*pref->varp.boolp != bval) {
containing_module->prefs_changed = TRUE;
*pref->varp.boolp = bval;
}
break;
case PREF_ENUM:
/* XXX - give an error if it doesn't match? */
enum_val = find_val_for_string(value, pref->info.enum_info.enumvals,
*pref->varp.enump);
if (*pref->varp.enump != enum_val) {
containing_module->prefs_changed = TRUE;
*pref->varp.enump = enum_val;
}
break;
case PREF_STRING:
case PREF_FILENAME:
case PREF_DIRNAME:
prefs_set_string_like_value(pref, value, &containing_module->prefs_changed);
break;
case PREF_RANGE:
{
if (!prefs_set_range_value_work(pref, value, return_range_errors,
&containing_module->prefs_changed))
return PREFS_SET_SYNTAX_ERR; /* number was bad */
break;
}
case PREF_COLOR:
{
cval = strtoul(value, NULL, 16);
if ((pref->varp.colorp->red != RED_COMPONENT(cval)) ||
(pref->varp.colorp->green != GREEN_COMPONENT(cval)) ||
(pref->varp.colorp->blue != BLUE_COMPONENT(cval))) {
containing_module->prefs_changed = TRUE;
pref->varp.colorp->red = RED_COMPONENT(cval);
pref->varp.colorp->green = GREEN_COMPONENT(cval);
pref->varp.colorp->blue = BLUE_COMPONENT(cval);
}
break;
}
case PREF_CUSTOM:
return pref->custom_cbs.set_cb(pref, value, &containing_module->prefs_changed);
case PREF_STATIC_TEXT:
case PREF_UAT:
{
break;
}
}
}
return PREFS_SET_OK;
}
typedef struct {
FILE *pf;
gboolean is_gui_module;
} write_gui_pref_arg_t;
const char *
prefs_pref_type_name(pref_t *pref)
{
const char *type_name = "[Unknown]";
int type;
if (!pref) {
return type_name; /* ...or maybe assert? */
}
type = pref->type;
if (IS_PREF_OBSOLETE(type)) {
type_name = "Obsolete";
} else {
RESET_PREF_OBSOLETE(type);
}
switch (type) {
case PREF_UINT:
switch (pref->info.base) {
case 10:
type_name = "Decimal";
break;
case 8:
type_name = "Octal";
break;
case 16:
type_name = "Hexadecimal";
break;
}
break;
case PREF_BOOL:
type_name = "Boolean";
break;
case PREF_ENUM:
type_name = "Choice";
break;
case PREF_STRING:
type_name = "String";
break;
case PREF_FILENAME:
type_name = "Filename";
break;
case PREF_DIRNAME:
type_name = "Directory";
break;
case PREF_RANGE:
type_name = "Range";
break;
case PREF_COLOR:
type_name = "Color";
break;
case PREF_CUSTOM:
if (pref->custom_cbs.type_name_cb)
return pref->custom_cbs.type_name_cb();
type_name = "Custom";
break;
case PREF_STATIC_TEXT:
type_name = "Static text";
break;
case PREF_UAT:
type_name = "UAT";
break;
}
return type_name;
}
char *
prefs_pref_type_description(pref_t *pref)
{
const char *type_desc = "An unknown preference type";
int type;
if (!pref) {
return g_strdup_printf("%s.", type_desc); /* ...or maybe assert? */
}
type = pref->type;
if (IS_PREF_OBSOLETE(type)) {
type_desc = "An obsolete preference";
} else {
RESET_PREF_OBSOLETE(type);
}
switch (type) {
case PREF_UINT:
switch (pref->info.base) {
case 10:
type_desc = "A decimal number";
break;
case 8:
type_desc = "An octal number";
break;
case 16:
type_desc = "A hexadecimal number";
break;
}
break;
case PREF_BOOL:
type_desc = "TRUE or FALSE (case-insensitive)";
break;
case PREF_ENUM:
{
const enum_val_t *enum_valp = pref->info.enum_info.enumvals;
GString *enum_str = g_string_new("One of: ");
while (enum_valp->name != NULL) {
g_string_append(enum_str, enum_valp->description);
enum_valp++;
if (enum_valp->name != NULL)
g_string_append(enum_str, ", ");
}
g_string_append(enum_str, "\n(case-insensitive).");
return g_string_free(enum_str, FALSE);
break;
}
case PREF_STRING:
type_desc = "A string";
break;
case PREF_FILENAME:
type_desc = "A path to a file";
break;
case PREF_DIRNAME:
type_desc = "A path to a directory";
break;
case PREF_RANGE:
{
type_desc = "A string denoting an positive integer range (e.g., \"1-20,30-40\")";
break;
}
case PREF_COLOR:
{
type_desc = "A six-digit hexadecimal RGB color triplet (e.g. fce94f)";
break;
}
case PREF_CUSTOM:
if (pref->custom_cbs.type_description_cb)
return pref->custom_cbs.type_description_cb();
type_desc = "A custom value";
break;
case PREF_STATIC_TEXT:
type_desc = "[Static text]";
break;
case PREF_UAT:
type_desc = "Configuration data stored in its own file";
break;
default:
break;
}
return g_strdup(type_desc);
}
static gboolean
prefs_pref_is_default(pref_t *pref)
{
int type;
if (!pref) return FALSE;
type = pref->type;
if (IS_PREF_OBSOLETE(type)) {
return FALSE;
} else {
RESET_PREF_OBSOLETE(type);
}
switch (type) {
case PREF_UINT:
if (pref->default_val.uint == *pref->varp.uint)
return TRUE;
break;
case PREF_BOOL:
if (pref->default_val.boolval == *pref->varp.boolp)
return TRUE;
break;
case PREF_ENUM:
if (pref->default_val.enumval == *pref->varp.enump)
return TRUE;
break;
case PREF_STRING:
case PREF_FILENAME:
case PREF_DIRNAME:
if (!(g_strcmp0(pref->default_val.string, *pref->varp.string)))
return TRUE;
break;
case PREF_RANGE:
{
if ((ranges_are_equal(pref->default_val.range, *pref->varp.range)))
return TRUE;
break;
}
case PREF_COLOR:
{
if ((pref->default_val.color.red == pref->varp.colorp->red) &&
(pref->default_val.color.green == pref->varp.colorp->green) &&
(pref->default_val.color.blue == pref->varp.colorp->blue))
return TRUE;
break;
}
case PREF_CUSTOM:
return pref->custom_cbs.is_default_cb(pref);
case PREF_STATIC_TEXT:
case PREF_UAT:
return FALSE;
/* g_assert_not_reached(); */
break;
}
return FALSE;
}
char *
prefs_pref_to_str(pref_t *pref, pref_source_t source) {
const char *pref_text = "[Unknown]";
void *valp; /* pointer to preference value */
color_t *pref_color;
gchar *tmp_value, *ret_value;
int type;
if (!pref) {
return g_strdup(pref_text);
}
switch (source) {
case pref_default:
valp = &pref->default_val;
/* valp = &boolval, &enumval, etc. are implied by union property */
pref_color = &pref->default_val.color;
break;
case pref_stashed:
valp = &pref->stashed_val;
/* valp = &boolval, &enumval, etc. are implied by union property */
pref_color = &pref->stashed_val.color;
break;
case pref_current:
valp = pref->varp.uint;
/* valp = boolval, enumval, etc. are implied by union property */
pref_color = pref->varp.colorp;
break;
default:
return g_strdup(pref_text);
}
type = pref->type;
if (IS_PREF_OBSOLETE(type)) {
pref_text = "[Obsolete]";
} else {
RESET_PREF_OBSOLETE(type);
}
switch (type) {
case PREF_UINT:
{
guint pref_uint = *(guint *) valp;
switch (pref->info.base) {
case 10:
return g_strdup_printf("%u", pref_uint);
case 8:
return g_strdup_printf("%#o", pref_uint);
case 16:
return g_strdup_printf("%#x", pref_uint);
}
break;
}
case PREF_BOOL:
return g_strdup((*(gboolean *) valp) ? "TRUE" : "FALSE");
case PREF_ENUM:
{
gint pref_enumval = *(gint *) valp;
/*
* For now, we return the "description" value, so that if we
* save the preferences older versions of Wireshark can at
* least read preferences that they supported; we support
* either the short name or the description when reading
* the preferences file or a "-o" option.
*/
const enum_val_t *enum_valp = pref->info.enum_info.enumvals;
while (enum_valp->name != NULL) {
if (enum_valp->value == pref_enumval)
return g_strdup(enum_valp->description);
enum_valp++;
}
break;
}
case PREF_STRING:
case PREF_FILENAME:
case PREF_DIRNAME:
return g_strdup(*(const char **) valp);
case PREF_RANGE:
/* Convert wmem to g_alloc memory */
tmp_value = range_convert_range(NULL, *(range_t **) valp);
ret_value = g_strdup(tmp_value);
wmem_free(NULL, tmp_value);
return ret_value;
case PREF_COLOR:
return g_strdup_printf("%02x%02x%02x",
(pref_color->red * 255 / 65535),
(pref_color->green * 255 / 65535),
(pref_color->blue * 255 / 65535));
case PREF_CUSTOM:
if (pref->custom_cbs.to_str_cb)
return pref->custom_cbs.to_str_cb(pref, source == pref_default ? TRUE : FALSE);
pref_text = "[Custom]";
break;
case PREF_STATIC_TEXT:
pref_text = "[Static text]";
break;
case PREF_UAT:
{
uat_t *uat = pref->varp.uat;
if (uat && uat->filename)
return g_strdup_printf("[Managed in the file \"%s\"]", uat->filename);
else
pref_text = "[Managed in an unknown file]";
break;
}
default:
break;
}
return g_strdup(pref_text);
}
/*
* Write out a single dissector preference.
*/
static void
write_pref(gpointer data, gpointer user_data)
{
pref_t *pref = (pref_t *)data;
write_pref_arg_t *arg = (write_pref_arg_t *)user_data;
gchar **desc_lines;
int i;
int type;
type = pref->type;
if (IS_PREF_OBSOLETE(type)) {
/*
* This preference is no longer supported; it's not a
* real preference, so we don't write it out (i.e., we
* treat it as if it weren't found in the list of
* preferences, and we weren't called in the first place).
*/
return;
} else {
RESET_PREF_OBSOLETE(type);
}
switch (type) {
case PREF_STATIC_TEXT:
case PREF_UAT:
/* Nothing to do; don't bother printing the description */
return;
default:
break;
}
if (pref->type != PREF_CUSTOM || pref->custom_cbs.type_name_cb() != NULL) {
/*
* The prefix will either be the module name or the parent
* name if it's a subtree
*/
const char *name_prefix = (arg->module->name != NULL) ? arg->module->name : arg->module->parent->name;
char *type_desc, *pref_text;
const char * def_prefix = prefs_pref_is_default(pref) ? "#" : "";
if (pref->type == PREF_CUSTOM) fprintf(arg->pf, "\n# %s", pref->custom_cbs.type_name_cb());
fprintf(arg->pf, "\n");
if (pref->description &&
(g_ascii_strncasecmp(pref->description,"", 2) != 0)) {
if (pref->type != PREF_CUSTOM) {
/* We get duplicate lines otherwise. */
desc_lines = g_strsplit(pref->description,"\n",0);
for (i = 0; desc_lines[i] != NULL; ++i) {
fprintf(arg->pf, "# %s\n", desc_lines[i]);
}
g_strfreev(desc_lines);
}
} else {
fprintf(arg->pf, "# No description\n");
}
type_desc = prefs_pref_type_description(pref);
desc_lines = g_strsplit(type_desc,"\n",0);
for (i = 0; desc_lines[i] != NULL; ++i) {
fprintf(arg->pf, "# %s\n", desc_lines[i]);
}
g_strfreev(desc_lines);
g_free(type_desc);
pref_text = prefs_pref_to_str(pref, pref_current);
fprintf(arg->pf, "%s%s.%s: ", def_prefix, name_prefix, pref->name);
desc_lines = g_strsplit(pref_text,"\n",0);
for (i = 0; desc_lines[i] != NULL; ++i) {
fprintf(arg->pf, "%s%s\n", i == 0 ? "" : def_prefix, desc_lines[i]);
}
if (i == 0) fprintf(arg->pf, "\n");
g_strfreev(desc_lines);
g_free(pref_text);
}
}
/*
* Write out all preferences for a module.
*/
static guint
write_module_prefs(module_t *module, gpointer user_data)
{
write_gui_pref_arg_t *gui_pref_arg = (write_gui_pref_arg_t*)user_data;
write_pref_arg_t arg;
/* The GUI module needs to be explicitly called out so it
can be written out of order */
if ((module == gui_module) && (gui_pref_arg->is_gui_module != TRUE))
return 0;
/* Write a header for the main modules and GUI sub-modules */
if (((module->parent == NULL) || (module->parent == gui_module)) &&
((prefs_module_has_submodules(module)) ||
(module->numprefs > 0) ||
(module->name == NULL))) {
if ((module->name == NULL) && (module->parent != NULL)) {
fprintf(gui_pref_arg->pf, "\n####### %s: %s ########\n", module->parent->title, module->title);
} else {
fprintf(gui_pref_arg->pf, "\n####### %s ########\n", module->title);
}
}
arg.module = module;
arg.pf = gui_pref_arg->pf;
g_list_foreach(arg.module->prefs, write_pref, &arg);
if (prefs_module_has_submodules(module))
return prefs_modules_foreach_submodules(module, write_module_prefs, user_data);
return 0;
}
/* Write out "prefs" to the user's preferences file, and return 0.
If the preferences file path is NULL, write to stdout.
If we got an error, stuff a pointer to the path of the preferences file
into "*pf_path_return", and return the errno. */
int
write_prefs(char **pf_path_return)
{
char *pf_path;
FILE *pf;
write_gui_pref_arg_t write_gui_pref_info;
/* Needed for "-G defaultprefs" */
init_prefs();
/* To do:
* - Split output lines longer than MAX_VAL_LEN
* - Create a function for the preference directory check/creation
* so that duplication can be avoided with filter.c
*/
if (pf_path_return != NULL) {
pf_path = get_persconffile_path(PF_NAME, TRUE);
if ((pf = ws_fopen(pf_path, "w")) == NULL) {
*pf_path_return = pf_path;
return errno;
}
g_free(pf_path);
} else {
pf = stdout;
}
fputs("# Configuration file for Wireshark " VERSION ".\n"
"#\n"
"# This file is regenerated each time preferences are saved within\n"
"# Wireshark. Making manual changes should be safe, however.\n"
"# Preferences that have been commented out have not been\n"
"# changed from their default value.\n", pf);
/*
* For "backwards compatibility" the GUI module is written first as it's
* at the top of the file. This is followed by all modules that can't
* fit into the preferences read/write API. Finally the remaining modules
* are written in alphabetical order (including of course the protocol preferences)
*/
write_gui_pref_info.pf = pf;
write_gui_pref_info.is_gui_module = TRUE;
write_module_prefs(gui_module, &write_gui_pref_info);
{
struct filter_expression *fe = *(struct filter_expression **)prefs.filter_expressions;
if (fe != NULL)
fprintf(pf, "\n####### Filter Expressions ########\n\n");
while (fe != NULL) {
if (fe->deleted == FALSE) {
fprintf(pf, "%s: %s\n", PRS_GUI_FILTER_LABEL, fe->label);
fprintf(pf, "%s: %s\n", PRS_GUI_FILTER_ENABLED,
fe->enabled == TRUE ? "TRUE" : "FALSE");
fprintf(pf, "%s: %s\n", PRS_GUI_FILTER_EXPR, fe->expression);
}
fe = fe->next;
}
}
write_gui_pref_info.is_gui_module = FALSE;
prefs_modules_foreach_submodules(NULL, write_module_prefs, &write_gui_pref_info);
fclose(pf);
/* XXX - catch I/O errors (e.g. "ran out of disk space") and return
an error indication, or maybe write to a new preferences file and
rename that file on top of the old one only if there are not I/O
errors. */
return 0;
}
/** The col_list is only partly managed by the custom preference API
* because its data is shared between multiple preferences, so
* it's freed here
*/
static void
free_col_info(GList *list)
{
fmt_data *cfmt;
GList *list_head = list;
while (list != NULL) {
cfmt = (fmt_data *)list->data;
g_free(cfmt->title);
g_free(cfmt->custom_fields);
g_free(cfmt);
list = g_list_next(list);
}
g_list_free(list_head);
}
/*
* Editor modelines
*
* Local Variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* ex: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/
|