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
|
/*
===========================================================================
Doom 3 GPL Source Code
Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
This file is part of the Doom 3 GPL Source Code ("Doom 3 Source Code").
Doom 3 Source Code 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 3 of the License, or
(at your option) any later version.
Doom 3 Source Code 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 Doom 3 Source Code. If not, see <http://www.gnu.org/licenses/>.
In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code. If not, please request a copy in writing from id Software at the address below.
If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
===========================================================================
*/
#ifdef WIN32
#include <io.h> // for _read
#else
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#endif
#include "sys/platform.h"
#ifdef ID_ENABLE_CURL
#include <curl/curl.h>
#endif
#include "idlib/hashing/MD4.h"
#include "framework/Licensee.h"
#include "framework/Unzip.h"
#include "framework/EventLoop.h"
#include "framework/DeclEntityDef.h"
#include "framework/DeclManager.h"
#include "framework/FileSystem.h"
/*
=============================================================================
DOOM FILESYSTEM
All of Doom's data access is through a hierarchical file system, but the contents of
the file system can be transparently merged from several sources.
A "relativePath" is a reference to game file data, which must include a terminating zero.
"..", "\\", and ":" are explicitly illegal in qpaths to prevent any references
outside the Doom directory system.
The "base path" is the path to the directory holding all the game directories and
usually the executable. It defaults to the current directory, but can be overridden
with "+set fs_basepath c:\doom" on the command line. The base path cannot be modified
at all after startup.
The "save path" is the path to the directory where game files will be saved. It defaults
to the base path, but can be overridden with a "+set fs_savepath c:\doom" on the
command line. Any files that are created during the game (demos, screenshots, etc.) will
be created reletive to the save path.
The "cd path" is the path to an alternate hierarchy that will be searched if a file
is not located in the base path. A user can do a partial install that copies some
data to a base path created on their hard drive and leave the rest on the cd. It defaults
to the current directory, but it can be overridden with "+set fs_cdpath g:\doom" on the
command line.
The "dev path" is the path to an alternate hierarchy where the editors and tools used
during development (Radiant, AF editor, dmap, runAAS) will write files to. It defaults to
the cd path, but can be overridden with a "+set fs_devpath c:\doom" on the command line.
If a user runs the game directly from a CD, the base path would be on the CD. This
should still function correctly, but all file writes will fail (harmlessly).
The "base game" is the directory under the paths where data comes from by default, and
can be either "base" or "demo".
The "current game" may be the same as the base game, or it may be the name of another
directory under the paths that should be searched for files before looking in the base
game. The game directory is set with "+set fs_game myaddon" on the command line. This is
the basis for addons.
No other directories outside of the base game and current game will ever be referenced by
filesystem functions.
To save disk space and speed up file loading, directory trees can be collapsed into zip
files. The files use a ".pk4" extension to prevent users from unzipping them accidentally,
but otherwise they are simply normal zip files. A game directory can have multiple zip
files of the form "pak0.pk4", "pak1.pk4", etc. Zip files are searched in decending order
from the highest number to the lowest, and will always take precedence over the filesystem.
This allows a pk4 distributed as a patch to override all existing data.
Because we will have updated executables freely available online, there is no point to
trying to restrict demo / oem versions of the game with code changes. Demo / oem versions
should be exactly the same executables as release versions, but with different data that
automatically restricts where game media can come from to prevent add-ons from working.
After the paths are initialized, Doom will look for the product.txt file. If not found
and verified, the game will run in restricted mode. In restricted mode, only files
contained in demo/pak0.pk4 will be available for loading, and only if the zip header is
verified to not have been modified. A single exception is made for DoomConfig.cfg. Files
can still be written out in restricted mode, so screenshots and demos are allowed.
Restricted mode can be tested by setting "+set fs_restrict 1" on the command line, even
if there is a valid product.txt under the basepath or cdpath.
If the "fs_copyfiles" cvar is set to 1, then every time a file is sourced from the cd
path, it will be copied over to the save path. This is a development aid to help build
test releases and to copy working sets of files.
If the "fs_copyfiles" cvar is set to 2, any file found in fs_cdpath that is newer than
it's fs_savepath version will be copied to fs_savepath (in addition to the fs_copyfiles 1
behaviour).
If the "fs_copyfiles" cvar is set to 3, files from both basepath and cdpath will be copied
over to the save path. This is useful when copying working sets of files mainly from base
path with an additional cd path (which can be a slower network drive for instance).
If the "fs_copyfiles" cvar is set to 4, files that exist in the cd path but NOT the base path
will be copied to the save path
NOTE: fs_copyfiles and case sensitivity. On fs_caseSensitiveOS 0 filesystems ( win32 ), the
copied files may change casing when copied over.
The relative path "sound/newstuff/test.wav" would be searched for in the following places:
for save path, dev path, base path, cd path:
for current game, base game:
search directory
search zip files
downloaded files, to be written to save path + current game's directory
The filesystem can be safely shutdown and reinitialized with different
basedir / cddir / game combinations, but all other subsystems that rely on it
(sound, video) must also be forced to restart.
"fs_caseSensitiveOS":
This cvar is set on operating systems that use case sensitive filesystems (Linux and OSX)
It is a common situation to have the media reference filenames, whereas the file on disc
only matches in a case-insensitive way. When "fs_caseSensitiveOS" is set, the filesystem
will always do a case insensitive search.
IMPORTANT: This only applies to files, and not to directories. There is no case-insensitive
matching of directories. All directory names should be lowercase, when "com_developer" is 1,
the filesystem will warn when it catches bad directory situations (regardless of the
"fs_caseSensitiveOS" setting)
When bad casing in directories happen and "fs_caseSensitiveOS" is set, BuildOSPath will
attempt to correct the situation by forcing the path to lowercase. This assumes the media
is stored all lowercase.
"additional mod path search":
fs_game_base can be used to set an additional search path
in search order, fs_game, fs_game_base, BASEGAME
for instance to base a mod of D3 + D3XP assets, fs_game mymod, fs_game_base d3xp
=============================================================================
*/
// define to fix special-cases for GetPackStatus so that files that shipped in
// the wrong place for Doom 3 don't break pure servers.
#define DOOM3_PURE_SPECIAL_CASES
typedef bool (*pureExclusionFunc_t)( const struct pureExclusion_s &excl, int l, const idStr &name );
typedef struct pureExclusion_s {
int nameLen;
int extLen;
const char * name;
const char * ext;
pureExclusionFunc_t func;
} pureExclusion_t;
bool excludeExtension( const pureExclusion_t &excl, int l, const idStr &name ) {
if ( l > excl.extLen && !idStr::Icmp( name.c_str() + l - excl.extLen, excl.ext ) ) {
return true;
}
return false;
}
bool excludePathPrefixAndExtension( const pureExclusion_t &excl, int l, const idStr &name ) {
if ( l > excl.nameLen && !idStr::Icmp( name.c_str() + l - excl.extLen, excl.ext ) && !name.IcmpPrefixPath( excl.name ) ) {
return true;
}
return false;
}
bool excludeFullName( const pureExclusion_t &excl, int l, const idStr &name ) {
if ( l == excl.nameLen && !name.Icmp( excl.name ) ) {
return true;
}
return false;
}
static pureExclusion_t pureExclusions[] = {
{ 0, 0, NULL, "/", excludeExtension },
{ 0, 0, NULL, "\\", excludeExtension },
{ 0, 0, NULL, ".pda", excludeExtension },
{ 0, 0, NULL, ".gui", excludeExtension },
{ 0, 0, NULL, ".pd", excludeExtension },
{ 0, 0, NULL, ".lang", excludeExtension },
{ 0, 0, "sound/VO", ".ogg", excludePathPrefixAndExtension },
{ 0, 0, "sound/VO", ".wav", excludePathPrefixAndExtension },
#if defined DOOM3_PURE_SPECIAL_CASES
// add any special-case files or paths for pure servers here
{ 0, 0, "sound/ed/marscity/vo_intro_cutscene.ogg", NULL, excludeFullName },
{ 0, 0, "sound/weapons/soulcube/energize_01.ogg", NULL, excludeFullName },
{ 0, 0, "sound/xian/creepy/vocal_fx", ".ogg", excludePathPrefixAndExtension },
{ 0, 0, "sound/xian/creepy/vocal_fx", ".wav", excludePathPrefixAndExtension },
{ 0, 0, "sound/feedback", ".ogg", excludePathPrefixAndExtension },
{ 0, 0, "sound/feedback", ".wav", excludePathPrefixAndExtension },
{ 0, 0, "guis/assets/mainmenu/chnote.tga", NULL, excludeFullName },
{ 0, 0, "sound/levels/alphalabs2/uac_better_place.ogg", NULL, excludeFullName },
{ 0, 0, "textures/bigchars.tga", NULL, excludeFullName },
{ 0, 0, "dds/textures/bigchars.dds", NULL, excludeFullName },
{ 0, 0, "fonts", ".tga", excludePathPrefixAndExtension },
{ 0, 0, "dds/fonts", ".dds", excludePathPrefixAndExtension },
{ 0, 0, "default.cfg", NULL, excludeFullName },
// russian zpak001.pk4
{ 0, 0, "fonts", ".dat", excludePathPrefixAndExtension },
{ 0, 0, "guis/temp.guied", NULL, excludeFullName },
#endif
{ 0, 0, NULL, NULL, NULL }
};
// ensures that lengths for pure exclusions are correct
class idInitExclusions {
public:
idInitExclusions() {
for ( int i = 0; pureExclusions[i].func != NULL; i++ ) {
if ( pureExclusions[i].name ) {
pureExclusions[i].nameLen = idStr::Length( pureExclusions[i].name );
}
if ( pureExclusions[i].ext ) {
pureExclusions[i].extLen = idStr::Length( pureExclusions[i].ext );
}
}
}
};
static idInitExclusions initExclusions;
#define MAX_ZIPPED_FILE_NAME 2048
#define FILE_HASH_SIZE 1024
typedef struct fileInPack_s {
idStr name; // name of the file
ZPOS64_T pos; // file info position in zip
struct fileInPack_s * next; // next file in the hash
} fileInPack_t;
typedef enum {
PURE_UNKNOWN = 0, // need to run the pak through GetPackStatus
PURE_NEUTRAL, // neutral regarding pureness. gets in the pure list if referenced
PURE_ALWAYS, // always referenced - for pak* named files, unless NEVER
PURE_NEVER // VO paks. may be referenced, won't be in the pure lists
} pureStatus_t;
typedef struct {
idList<int> depends;
idList<idDict *> mapDecls;
} addonInfo_t;
typedef struct {
idStr pakFilename; // c:\doom\base\pak0.pk4
unzFile handle;
int checksum;
int numfiles;
int length;
bool referenced;
bool addon; // this is an addon pack - addon_search tells if it's 'active'
bool addon_search; // is in the search list
addonInfo_t *addon_info;
pureStatus_t pureStatus;
bool isNew; // for downloaded paks
fileInPack_t *hashTable[FILE_HASH_SIZE];
fileInPack_t *buildBuffer;
} pack_t;
typedef struct {
idStr path; // c:\doom
idStr gamedir; // base
} directory_t;
typedef struct searchpath_s {
pack_t * pack; // only one of pack / dir will be non NULL
directory_t * dir;
struct searchpath_s *next;
} searchpath_t;
// search flags when opening a file
#define FSFLAG_SEARCH_DIRS ( 1 << 0 )
#define FSFLAG_SEARCH_PAKS ( 1 << 1 )
#define FSFLAG_PURE_NOREF ( 1 << 2 )
#define FSFLAG_SEARCH_ADDONS ( 1 << 4 )
// 3 search path (fs_savepath fs_basepath fs_cdpath)
// + .jpg and .tga
#define MAX_CACHED_DIRS 6
// how many OSes to handle game paks for ( we don't have to know them precisely )
#define BINARY_CONFIG "binary.conf"
#define ADDON_CONFIG "addon.conf"
class idDEntry : public idStrList {
public:
idDEntry() {}
virtual ~idDEntry() {}
bool Matches( const char *directory, const char *extension ) const;
void Init( const char *directory, const char *extension, const idStrList &list );
void Clear( void );
private:
idStr directory;
idStr extension;
};
class idFileSystemLocal : public idFileSystem {
public:
idFileSystemLocal( void );
virtual void Init( void );
virtual void StartBackgroundDownloadThread( void );
virtual void Restart( void );
virtual void Shutdown( bool reloading );
virtual bool IsInitialized( void ) const;
virtual bool PerformingCopyFiles( void ) const;
virtual idModList * ListMods( void );
virtual void FreeModList( idModList *modList );
virtual idFileList * ListFiles( const char *relativePath, const char *extension, bool sort = false, bool fullRelativePath = false, const char* gamedir = NULL );
virtual idFileList * ListFilesTree( const char *relativePath, const char *extension, bool sort = false, const char* gamedir = NULL );
virtual void FreeFileList( idFileList *fileList );
virtual const char * OSPathToRelativePath( const char *OSPath );
virtual const char * RelativePathToOSPath( const char *relativePath, const char *basePath );
virtual const char * BuildOSPath( const char *base, const char *game, const char *relativePath );
virtual void CreateOSPath( const char *OSPath );
virtual bool FileIsInPAK( const char *relativePath );
virtual void UpdatePureServerChecksums( void );
virtual fsPureReply_t SetPureServerChecksums( const int pureChecksums[ MAX_PURE_PAKS ], int missingChecksums[ MAX_PURE_PAKS ] );
virtual void GetPureServerChecksums( int checksums[ MAX_PURE_PAKS ] );
virtual void SetRestartChecksums( const int pureChecksums[ MAX_PURE_PAKS ] );
virtual void ClearPureChecksums( void );
virtual int ReadFile( const char *relativePath, void **buffer, ID_TIME_T *timestamp );
virtual void FreeFile( void *buffer );
virtual int WriteFile( const char *relativePath, const void *buffer, int size, const char *basePath = "fs_savepath" );
virtual void RemoveFile( const char *relativePath );
virtual idFile * OpenFileReadFlags( const char *relativePath, int searchFlags, pack_t **foundInPak = NULL, bool allowCopyFiles = true, const char* gamedir = NULL );
virtual idFile * OpenFileRead( const char *relativePath, bool allowCopyFiles = true, const char* gamedir = NULL );
virtual idFile * OpenFileWrite( const char *relativePath, const char *basePath = "fs_savepath" );
virtual idFile * OpenFileAppend( const char *relativePath, bool sync = false, const char *basePath = "fs_basepath" );
virtual idFile * OpenFileByMode( const char *relativePath, fsMode_t mode );
virtual idFile * OpenExplicitFileRead( const char *OSPath );
virtual idFile * OpenExplicitFileWrite( const char *OSPath );
virtual void CloseFile( idFile *f );
virtual void BackgroundDownload( backgroundDownload_t *bgl );
virtual void ResetReadCount( void ) { readCount = 0; }
virtual void AddToReadCount( int c ) { readCount += c; }
virtual int GetReadCount( void ) { return readCount; }
virtual void FindDLL( const char *basename, char dllPath[ MAX_OSPATH ] );
virtual void ClearDirCache( void );
virtual bool HasD3XP( void );
virtual bool RunningD3XP( void );
virtual void CopyFile( const char *fromOSPath, const char *toOSPath );
virtual int ValidateDownloadPakForChecksum( int checksum, char path[ MAX_STRING_CHARS ] );
virtual idFile * MakeTemporaryFile( void );
virtual int AddZipFile( const char *path );
virtual findFile_t FindFile( const char *path, bool scheduleAddons );
virtual int GetNumMaps();
virtual const idDict * GetMapDecl( int i );
virtual void FindMapScreenshot( const char *path, char *buf, int len );
virtual bool FilenameCompare( const char *s1, const char *s2 ) const;
static void Dir_f( const idCmdArgs &args );
static void DirTree_f( const idCmdArgs &args );
static void Path_f( const idCmdArgs &args );
static void TouchFile_f( const idCmdArgs &args );
static void TouchFileList_f( const idCmdArgs &args );
private:
friend int BackgroundDownloadThread( void *pexit );
searchpath_t * searchPaths;
int readCount; // total bytes read
int loadCount; // total files read
int loadStack; // total files in memory
idStr gameFolder; // this will be a single name without separators
searchpath_t *addonPaks; // not loaded up, but we saw them
idDict mapDict; // for GetMapDecl
static idCVar fs_debug;
static idCVar fs_restrict;
static idCVar fs_copyfiles;
static idCVar fs_basepath;
static idCVar fs_configpath;
static idCVar fs_savepath;
static idCVar fs_cdpath;
static idCVar fs_devpath;
static idCVar fs_game;
static idCVar fs_game_base;
static idCVar fs_caseSensitiveOS;
static idCVar fs_searchAddons;
backgroundDownload_t * backgroundDownloads;
backgroundDownload_t defaultBackgroundDownload;
xthreadInfo backgroundThread;
bool backgroundThread_exit;
idList<pack_t *> serverPaks;
bool loadedFileFromDir; // set to true once a file was loaded from a directory - can't switch to pure anymore
idList<int> restartChecksums; // used during a restart to set things in right order
idList<int> addonChecksums; // list of checksums that should go to the search list directly ( for restarts )
idDEntry dir_cache[ MAX_CACHED_DIRS ]; // fifo
int dir_cache_index;
int dir_cache_count;
int d3xp; // 0: didn't check, -1: not installed, 1: installed
private:
void ReplaceSeparators( idStr &path, char sep = PATHSEPERATOR_CHAR );
int HashFileName( const char *fname ) const;
int ListOSFiles( const char *directory, const char *extension, idStrList &list );
FILE * OpenOSFile( const char *name, const char *mode, idStr *caseSensitiveName = NULL );
FILE * OpenOSFileCorrectName( idStr &path, const char *mode );
int DirectFileLength( FILE *o );
void CopyFile( idFile *src, const char *toOSPath );
int AddUnique( const char *name, idStrList &list, idHashIndex &hashIndex ) const;
void GetExtensionList( const char *extension, idStrList &extensionList ) const;
int GetFileList( const char *relativePath, const idStrList &extensions, idStrList &list, idHashIndex &hashIndex, bool fullRelativePath, const char* gamedir = NULL );
int GetFileListTree( const char *relativePath, const idStrList &extensions, idStrList &list, idHashIndex &hashIndex, const char* gamedir = NULL );
pack_t * LoadZipFile( const char *zipfile );
void AddGameDirectory( const char *path, const char *dir );
void SetupGameDirectories( const char *gameName );
void Startup( void );
// some files can be obtained from directories without compromising si_pure
bool FileAllowedFromDir( const char *path );
// searches all the paks, no pure check
pack_t * GetPackForChecksum( int checksum, bool searchAddons = false );
// searches all the paks, no pure check
pack_t * FindPakForFileChecksum( const char *relativePath, int fileChecksum, bool bReference );
idFile_InZip * ReadFileFromZip( pack_t *pak, fileInPack_t *pakFile, const char *relativePath );
int GetFileChecksum( idFile *file );
pureStatus_t GetPackStatus( pack_t *pak );
addonInfo_t * ParseAddonDef( const char *buf, const int len );
void FollowAddonDependencies( pack_t *pak );
static size_t CurlWriteFunction( void *ptr, size_t size, size_t nmemb, void *stream );
// curl_progress_callback in curl.h
static int CurlProgressFunction( void *clientp, double dltotal, double dlnow, double ultotal, double ulnow );
};
idCVar idFileSystemLocal::fs_restrict( "fs_restrict", "", CVAR_SYSTEM | CVAR_INIT | CVAR_BOOL, "" );
idCVar idFileSystemLocal::fs_debug( "fs_debug", "0", CVAR_SYSTEM | CVAR_INTEGER, "", 0, 2, idCmdSystem::ArgCompletion_Integer<0,2> );
idCVar idFileSystemLocal::fs_copyfiles( "fs_copyfiles", "0", CVAR_SYSTEM | CVAR_INIT | CVAR_INTEGER, "", 0, 4, idCmdSystem::ArgCompletion_Integer<0,3> );
idCVar idFileSystemLocal::fs_basepath( "fs_basepath", "", CVAR_SYSTEM | CVAR_INIT, "" );
idCVar idFileSystemLocal::fs_configpath( "fs_configpath", "", CVAR_SYSTEM | CVAR_INIT, "" );
idCVar idFileSystemLocal::fs_savepath( "fs_savepath", "", CVAR_SYSTEM | CVAR_INIT, "" );
idCVar idFileSystemLocal::fs_cdpath( "fs_cdpath", "", CVAR_SYSTEM | CVAR_INIT, "" );
idCVar idFileSystemLocal::fs_devpath( "fs_devpath", "", CVAR_SYSTEM | CVAR_INIT, "" );
idCVar idFileSystemLocal::fs_game( "fs_game", "", CVAR_SYSTEM | CVAR_INIT | CVAR_SERVERINFO, "mod path" );
idCVar idFileSystemLocal::fs_game_base( "fs_game_base", "", CVAR_SYSTEM | CVAR_INIT | CVAR_SERVERINFO, "alternate mod path, searched after the main fs_game path, before the basedir" );
#if defined(__AROS__) || defined(WIN32)
idCVar idFileSystemLocal::fs_caseSensitiveOS( "fs_caseSensitiveOS", "0", CVAR_SYSTEM | CVAR_BOOL, "" );
#else
idCVar idFileSystemLocal::fs_caseSensitiveOS( "fs_caseSensitiveOS", "1", CVAR_SYSTEM | CVAR_BOOL, "" );
#endif
idCVar idFileSystemLocal::fs_searchAddons( "fs_searchAddons", "0", CVAR_SYSTEM | CVAR_BOOL, "search all addon pk4s ( disables addon functionality )" );
idFileSystemLocal fileSystemLocal;
idFileSystem * fileSystem = &fileSystemLocal;
/*
================
idFileSystemLocal::idFileSystemLocal
================
*/
idFileSystemLocal::idFileSystemLocal( void ) {
searchPaths = NULL;
readCount = 0;
loadCount = 0;
loadStack = 0;
dir_cache_index = 0;
dir_cache_count = 0;
d3xp = 0;
loadedFileFromDir = false;
memset( &backgroundThread, 0, sizeof( backgroundThread ) );
backgroundThread_exit = false;
addonPaks = NULL;
}
/*
================
idFileSystemLocal::HashFileName
return a hash value for the filename
================
*/
int idFileSystemLocal::HashFileName( const char *fname ) const {
int i;
int hash;
char letter;
hash = 0;
i = 0;
while( fname[i] != '\0' ) {
letter = idStr::ToLower( fname[i] );
if ( letter == '.' ) {
break; // don't include extension
}
if ( letter == '\\' ) {
letter = '/'; // damn path names
}
hash += (int)(letter) * (i+119);
i++;
}
hash &= (FILE_HASH_SIZE-1);
return hash;
}
/*
===========
idFileSystemLocal::FilenameCompare
Ignore case and separator char distinctions
RETURNS false WHEN EQUAL THIS IS SO STUPID IT HURTS!
===========
*/
bool idFileSystemLocal::FilenameCompare( const char *s1, const char *s2 ) const {
int c1, c2;
do {
c1 = *s1++;
c2 = *s2++;
if ( c1 >= 'a' && c1 <= 'z' ) {
c1 -= ('a' - 'A');
}
if ( c2 >= 'a' && c2 <= 'z' ) {
c2 -= ('a' - 'A');
}
if ( c1 == '\\' || c1 == ':' ) {
c1 = '/';
}
if ( c2 == '\\' || c2 == ':' ) {
c2 = '/';
}
if ( c1 != c2 ) {
return true; // strings not equal
}
} while( c1 );
return false; // strings are equal
}
/*
================
idFileSystemLocal::OpenOSFile
optional caseSensitiveName is set to case sensitive file name as found on disc (fs_caseSensitiveOS only)
================
*/
FILE *idFileSystemLocal::OpenOSFile( const char *fileName, const char *mode, idStr *caseSensitiveName ) {
int i;
FILE *fp;
idStr fpath, entry;
idStrList list;
#ifndef WIN32
// some systems will let you fopen a directory
struct stat buf;
if ( stat( fileName, &buf ) != -1 && !S_ISREG(buf.st_mode) ) {
return NULL;
}
#endif
fp = fopen( fileName, mode );
if ( !fp && fs_caseSensitiveOS.GetBool() ) {
fpath = fileName;
fpath.StripFilename();
fpath.StripTrailing( PATHSEPERATOR_CHAR );
if ( ListOSFiles( fpath, NULL, list ) == -1 ) {
return NULL;
}
for ( i = 0; i < list.Num(); i++ ) {
entry = fpath + PATHSEPERATOR_CHAR + list[i];
if ( !entry.Icmp( fileName ) ) {
fp = fopen( entry, mode );
if ( fp ) {
if ( caseSensitiveName ) {
*caseSensitiveName = entry;
caseSensitiveName->StripPath();
}
if ( fs_debug.GetInteger() ) {
common->Printf( "idFileSystemLocal::OpenFileRead: changed %s to %s\n", fileName, entry.c_str() );
}
break;
} else {
// not supposed to happen if ListOSFiles is doing it's job correctly
common->Warning( "idFileSystemLocal::OpenFileRead: fs_caseSensitiveOS 1 could not open %s", entry.c_str() );
}
}
}
} else if ( caseSensitiveName ) {
*caseSensitiveName = fileName;
caseSensitiveName->StripPath();
}
return fp;
}
/*
================
idFileSystemLocal::OpenOSFileCorrectName
================
*/
FILE *idFileSystemLocal::OpenOSFileCorrectName( idStr &path, const char *mode ) {
idStr caseName;
FILE *f = OpenOSFile( path.c_str(), mode, &caseName );
if ( f ) {
path.StripFilename();
path += PATHSEPERATOR_STR;
path += caseName;
}
return f;
}
/*
================
idFileSystemLocal::DirectFileLength
================
*/
int idFileSystemLocal::DirectFileLength( FILE *o ) {
int pos;
int end;
pos = ftell( o );
fseek( o, 0, SEEK_END );
end = ftell( o );
fseek( o, pos, SEEK_SET );
return end;
}
/*
============
idFileSystemLocal::CreateOSPath
Creates any directories needed to store the given filename
============
*/
void idFileSystemLocal::CreateOSPath( const char *OSPath ) {
char *ofs;
// make absolutely sure that it can't back up the path
// FIXME: what about c: ?
if ( strstr( OSPath, ".." ) || strstr( OSPath, "::" ) ) {
#ifdef _DEBUG
common->DPrintf( "refusing to create relative path \"%s\"\n", OSPath );
#endif
return;
}
idStr path( OSPath );
for( ofs = &path[ 1 ]; *ofs ; ofs++ ) {
if ( *ofs == PATHSEPERATOR_CHAR ) {
// create the directory
*ofs = 0;
Sys_Mkdir( path );
*ofs = PATHSEPERATOR_CHAR;
}
}
}
/*
=================
idFileSystemLocal::CopyFile
Copy a fully specified file from one place to another
=================
*/
void idFileSystemLocal::CopyFile( const char *fromOSPath, const char *toOSPath ) {
FILE *f;
int len;
byte *buf;
common->Printf( "copy %s to %s\n", fromOSPath, toOSPath );
f = OpenOSFile( fromOSPath, "rb" );
if ( !f ) {
return;
}
fseek( f, 0, SEEK_END );
len = ftell( f );
fseek( f, 0, SEEK_SET );
buf = (byte *)Mem_Alloc( len );
if ( fread( buf, 1, len, f ) != (unsigned int)len ) {
common->FatalError( "short read in idFileSystemLocal::CopyFile()\n" );
}
fclose( f );
CreateOSPath( toOSPath );
f = OpenOSFile( toOSPath, "wb" );
if ( !f ) {
common->Printf( "could not create destination file\n" );
Mem_Free( buf );
return;
}
if ( fwrite( buf, 1, len, f ) != (unsigned int)len ) {
common->FatalError( "short write in idFileSystemLocal::CopyFile()\n" );
}
fclose( f );
Mem_Free( buf );
}
/*
=================
idFileSystemLocal::CopyFile
=================
*/
void idFileSystemLocal::CopyFile( idFile *src, const char *toOSPath ) {
FILE *f;
int len;
byte *buf;
common->Printf( "copy %s to %s\n", src->GetName(), toOSPath );
src->Seek( 0, FS_SEEK_END );
len = src->Tell();
src->Seek( 0, FS_SEEK_SET );
buf = (byte *)Mem_Alloc( len );
if ( src->Read( buf, len ) != len ) {
common->FatalError( "Short read in idFileSystemLocal::CopyFile()\n" );
}
CreateOSPath( toOSPath );
f = OpenOSFile( toOSPath, "wb" );
if ( !f ) {
common->Printf( "could not create destination file\n" );
Mem_Free( buf );
return;
}
if ( fwrite( buf, 1, len, f ) != (unsigned int)len ) {
common->FatalError( "Short write in idFileSystemLocal::CopyFile()\n" );
}
fclose( f );
Mem_Free( buf );
}
/*
====================
idFileSystemLocal::ReplaceSeparators
Fix things up differently for win/unix/mac
====================
*/
void idFileSystemLocal::ReplaceSeparators( idStr &path, char sep ) {
char *s;
for( s = &path[ 0 ]; *s ; s++ ) {
if ( *s == '/' || *s == '\\' ) {
*s = sep;
}
}
}
/*
===================
idFileSystemLocal::BuildOSPath
===================
*/
const char *idFileSystemLocal::BuildOSPath( const char *base, const char *game, const char *relativePath ) {
static char OSPath[MAX_STRING_CHARS];
idStr newPath;
if ( fs_caseSensitiveOS.GetBool() || com_developer.GetBool() ) {
// extract the path, make sure it's all lowercase
idStr testPath, fileName;
sprintf( testPath, "%s/%s", game , relativePath );
testPath.StripFilename();
if ( testPath.HasUpper() ) {
common->DPrintf( "Non-portable: path contains uppercase characters: %s\n", testPath.c_str() );
// attempt a fixup on the fly
if ( fs_caseSensitiveOS.GetBool() ) {
testPath.ToLower();
fileName = relativePath;
fileName.StripPath();
sprintf( newPath, "%s/%s/%s", base, testPath.c_str(), fileName.c_str() );
ReplaceSeparators( newPath );
common->DPrintf( "Fixed up to %s\n", newPath.c_str() );
idStr::Copynz( OSPath, newPath, sizeof( OSPath ) );
return OSPath;
}
}
}
idStr strBase = base;
strBase.StripTrailing( '/' );
strBase.StripTrailing( '\\' );
sprintf( newPath, "%s/%s/%s", strBase.c_str(), game, relativePath );
ReplaceSeparators( newPath );
idStr::Copynz( OSPath, newPath, sizeof( OSPath ) );
return OSPath;
}
/*
================
idFileSystemLocal::OSPathToRelativePath
takes a full OS path, as might be found in data from a media creation
program, and converts it to a relativePath by stripping off directories
Returns false if the osPath tree doesn't match any of the existing
search paths.
================
*/
const char *idFileSystemLocal::OSPathToRelativePath( const char *OSPath ) {
static char relativePath[MAX_STRING_CHARS];
const char *s, *base;
// skip a drive letter?
// search for anything with "base" in it
// Ase files from max may have the form of:
// "//Purgatory/purgatory/doom/base/models/mapobjects/bitch/hologirl.tga"
// which won't match any of our drive letter based search paths
// look for the first complete directory name
base = strstr( OSPath, BASE_GAMEDIR );
while ( base ) {
char c1 = '\0', c2;
if ( base > OSPath ) {
c1 = *(base - 1);
}
c2 = *( base + strlen( BASE_GAMEDIR ) );
if ( ( c1 == '/' || c1 == '\\' ) && ( c2 == '/' || c2 == '\\' ) ) {
break;
}
base = strstr( base + 1, BASE_GAMEDIR );
}
// fs_game and fs_game_base support - look for first complete name with a mod path
// ( fs_game searched before fs_game_base )
const char *fsgame = NULL;
int igame = 0;
for ( igame = 0; igame < 2; igame++ ) {
if ( igame == 0 ) {
fsgame = fs_game.GetString();
} else if ( igame == 1 ) {
fsgame = fs_game_base.GetString();
}
if ( base == NULL && fsgame && strlen( fsgame ) ) {
base = strstr( OSPath, fsgame );
while ( base ) {
char c1 = '\0', c2;
if ( base > OSPath ) {
c1 = *(base - 1);
}
c2 = *( base + strlen( fsgame ) );
if ( ( c1 == '/' || c1 == '\\' ) && ( c2 == '/' || c2 == '\\' ) ) {
break;
}
base = strstr( base + 1, fsgame );
}
}
}
if ( base ) {
s = strstr( base, "/" );
if ( !s ) {
s = strstr( base, "\\" );
}
if ( s ) {
strcpy( relativePath, s + 1 );
if ( fs_debug.GetInteger() > 1 ) {
common->Printf( "idFileSystem::OSPathToRelativePath: %s becomes %s\n", OSPath, relativePath );
}
return relativePath;
}
}
common->Warning( "idFileSystem::OSPathToRelativePath failed on %s", OSPath );
strcpy( relativePath, "" );
return relativePath;
}
/*
=====================
idFileSystemLocal::RelativePathToOSPath
Returns a fully qualified path that can be used with stdio libraries
=====================
*/
const char *idFileSystemLocal::RelativePathToOSPath( const char *relativePath, const char *basePath ) {
const char *path = cvarSystem->GetCVarString( basePath );
if ( !path[0] ) {
path = fs_savepath.GetString();
}
return BuildOSPath( path, gameFolder, relativePath );
}
/*
=================
idFileSystemLocal::RemoveFile
=================
*/
void idFileSystemLocal::RemoveFile( const char *relativePath ) {
idStr OSPath;
if ( fs_devpath.GetString()[0] ) {
OSPath = BuildOSPath( fs_devpath.GetString(), gameFolder, relativePath );
remove( OSPath );
}
OSPath = BuildOSPath( fs_savepath.GetString(), gameFolder, relativePath );
remove( OSPath );
ClearDirCache();
}
/*
================
idFileSystemLocal::FileIsInPAK
================
*/
bool idFileSystemLocal::FileIsInPAK( const char *relativePath ) {
searchpath_t *search;
pack_t *pak;
fileInPack_t *pakFile;
int hash;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( !relativePath ) {
common->FatalError( "idFileSystemLocal::FileIsInPAK: NULL 'relativePath' parameter passed\n" );
}
// qpaths are not supposed to have a leading slash
if ( relativePath[0] == '/' || relativePath[0] == '\\' ) {
relativePath++;
}
// make absolutely sure that it can't back up the path.
// The searchpaths do guarantee that something will always
// be prepended, so we don't need to worry about "c:" or "//limbo"
if ( strstr( relativePath, ".." ) || strstr( relativePath, "::" ) ) {
return false;
}
//
// search through the path, one element at a time
//
hash = HashFileName( relativePath );
for ( search = searchPaths; search; search = search->next ) {
// is the element a pak file?
if ( search->pack && search->pack->hashTable[hash] ) {
// disregard if it doesn't match one of the allowed pure pak files - or is a localization file
if ( serverPaks.Num() ) {
GetPackStatus( search->pack );
if ( search->pack->pureStatus != PURE_NEVER && !serverPaks.Find( search->pack ) ) {
continue; // not on the pure server pak list
}
}
// look through all the pak file elements
pak = search->pack;
pakFile = pak->hashTable[hash];
do {
// case and separator insensitive comparisons
if ( !FilenameCompare( pakFile->name, relativePath ) ) {
return true;
}
pakFile = pakFile->next;
} while( pakFile != NULL );
}
}
return false;
}
/*
============
idFileSystemLocal::ReadFile
Filename are relative to the search path
a null buffer will just return the file length and time without loading
timestamp can be NULL if not required
============
*/
int idFileSystemLocal::ReadFile( const char *relativePath, void **buffer, ID_TIME_T *timestamp ) {
idFile * f;
byte * buf;
int len;
bool isConfig;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( !relativePath || !relativePath[0] ) {
common->FatalError( "idFileSystemLocal::ReadFile with empty name\n" );
}
if ( timestamp ) {
*timestamp = FILE_NOT_FOUND_TIMESTAMP;
}
if ( buffer ) {
*buffer = NULL;
}
buf = NULL; // quiet compiler warning
// if this is a .cfg file and we are playing back a journal, read
// it from the journal file
if ( strstr( relativePath, ".cfg" ) == relativePath + strlen( relativePath ) - 4 ) {
isConfig = true;
if ( eventLoop && eventLoop->JournalLevel() == 2 ) {
int r;
loadCount++;
loadStack++;
common->DPrintf( "Loading %s from journal file.\n", relativePath );
len = 0;
r = eventLoop->com_journalDataFile->Read( &len, sizeof( len ) );
if ( r != sizeof( len ) ) {
*buffer = NULL;
return -1;
}
buf = (byte *)Mem_ClearedAlloc(len+1);
*buffer = buf;
r = eventLoop->com_journalDataFile->Read( buf, len );
if ( r != len ) {
common->FatalError( "Read from journalDataFile failed" );
}
// guarantee that it will have a trailing 0 for string operations
buf[len] = 0;
return len;
}
} else {
isConfig = false;
}
// look for it in the filesystem or pack files
f = OpenFileRead( relativePath, ( buffer != NULL ) );
if ( f == NULL ) {
if ( buffer ) {
*buffer = NULL;
}
return -1;
}
len = f->Length();
if ( timestamp ) {
*timestamp = f->Timestamp();
}
if ( !buffer ) {
CloseFile( f );
return len;
}
loadCount++;
loadStack++;
buf = (byte *)Mem_ClearedAlloc(len+1);
*buffer = buf;
f->Read( buf, len );
// guarantee that it will have a trailing 0 for string operations
buf[len] = 0;
CloseFile( f );
// if we are journalling and it is a config file, write it to the journal file
if ( isConfig && eventLoop && eventLoop->JournalLevel() == 1 ) {
common->DPrintf( "Writing %s to journal file.\n", relativePath );
eventLoop->com_journalDataFile->Write( &len, sizeof( len ) );
eventLoop->com_journalDataFile->Write( buf, len );
eventLoop->com_journalDataFile->Flush();
}
return len;
}
/*
=============
idFileSystemLocal::FreeFile
=============
*/
void idFileSystemLocal::FreeFile( void *buffer ) {
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( !buffer ) {
common->FatalError( "idFileSystemLocal::FreeFile( NULL )" );
}
loadStack--;
Mem_Free( buffer );
}
/*
============
idFileSystemLocal::WriteFile
Filenames are relative to the search path
============
*/
int idFileSystemLocal::WriteFile( const char *relativePath, const void *buffer, int size, const char *basePath ) {
idFile *f;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( !relativePath || !buffer ) {
common->FatalError( "idFileSystemLocal::WriteFile: NULL parameter" );
}
f = idFileSystemLocal::OpenFileWrite( relativePath, basePath );
if ( !f ) {
common->Printf( "Failed to open %s\n", relativePath );
return -1;
}
size = f->Write( buffer, size );
CloseFile( f );
return size;
}
/*
=================
idFileSystemLocal::ParseAddonDef
=================
*/
addonInfo_t *idFileSystemLocal::ParseAddonDef( const char *buf, const int len ) {
idLexer src;
idToken token, token2;
addonInfo_t *info;
src.LoadMemory( buf, len, "<addon.conf>" );
src.SetFlags( DECL_LEXER_FLAGS );
if ( !src.SkipUntilString( "addonDef" ) ) {
src.Warning( "ParseAddonDef: no addonDef" );
return NULL;
}
if ( !src.ReadToken( &token ) ) {
src.Warning( "Expected {" );
return NULL;
}
info = new addonInfo_t;
// read addonDef
while ( 1 ) {
if ( !src.ReadToken( &token ) ) {
delete info;
return NULL;
}
if ( !token.Icmp( "}" ) ) {
break;
}
if ( token.type != TT_STRING ) {
src.Warning( "Expected quoted string, but found '%s'", token.c_str() );
delete info;
return NULL;
}
int checksum;
if ( sscanf( token.c_str(), "0x%x", &checksum ) != 1 && sscanf( token.c_str(), "%x", &checksum ) != 1 ) {
src.Warning( "Could not parse checksum '%s'", token.c_str() );
delete info;
return NULL;
}
info->depends.Append( checksum );
}
// read any number of mapDef entries
while ( 1 ) {
if ( !src.SkipUntilString( "mapDef" ) ) {
return info;
}
if ( !src.ReadToken( &token ) ) {
src.Warning( "Expected map path" );
info->mapDecls.DeleteContents( true );
delete info;
return NULL;
}
idDict *dict = new idDict;
dict->Set( "path", token.c_str() );
if ( !src.ReadToken( &token ) ) {
src.Warning( "Expected {" );
info->mapDecls.DeleteContents( true );
delete dict;
delete info;
return NULL;
}
while ( 1 ) {
if ( !src.ReadToken( &token ) ) {
break;
}
if ( !token.Icmp( "}" ) ) {
break;
}
if ( token.type != TT_STRING ) {
src.Warning( "Expected quoted string, but found '%s'", token.c_str() );
info->mapDecls.DeleteContents( true );
delete dict;
delete info;
return NULL;
}
if ( !src.ReadToken( &token2 ) ) {
src.Warning( "Unexpected end of file" );
info->mapDecls.DeleteContents( true );
delete dict;
delete info;
return NULL;
}
if ( dict->FindKey( token ) ) {
src.Warning( "'%s' already defined", token.c_str() );
}
dict->Set( token, token2 );
}
info->mapDecls.Append( dict );
}
assert( false );
return NULL;
}
/*
=================
idFileSystemLocal::LoadZipFile
=================
*/
pack_t *idFileSystemLocal::LoadZipFile( const char *zipfile ) {
fileInPack_t * buildBuffer;
pack_t * pack;
unzFile uf;
int err;
unz_global_info64 gi;
char filename_inzip[MAX_ZIPPED_FILE_NAME];
unz_file_info64 file_info;
int i;
int hash;
int fs_numHeaderLongs;
int * fs_headerLongs;
FILE *f;
int len;
int confHash;
fileInPack_t *pakFile;
f = OpenOSFile( zipfile, "rb" );
if ( !f ) {
return NULL;
}
fseek( f, 0, SEEK_END );
len = ftell( f );
fclose( f );
fs_numHeaderLongs = 0;
uf = unzOpen( zipfile );
err = unzGetGlobalInfo64( uf, &gi );
if ( err != UNZ_OK ) {
return NULL;
}
buildBuffer = new fileInPack_t[gi.number_entry];
pack = new pack_t;
for( i = 0; i < FILE_HASH_SIZE; i++ ) {
pack->hashTable[i] = NULL;
}
pack->pakFilename = zipfile;
pack->handle = uf;
pack->numfiles = gi.number_entry;
pack->buildBuffer = buildBuffer;
pack->referenced = false;
pack->addon = false;
pack->addon_search = false;
pack->addon_info = NULL;
pack->pureStatus = PURE_UNKNOWN;
pack->isNew = false;
pack->length = len;
unzGoToFirstFile(uf);
fs_headerLongs = (int *)Mem_ClearedAlloc( gi.number_entry * sizeof(int) );
for ( i = 0; i < (int)gi.number_entry; i++ ) {
err = unzGetCurrentFileInfo64( uf, &file_info, filename_inzip, sizeof(filename_inzip), NULL, 0, NULL, 0 );
if ( err != UNZ_OK ) {
break;
}
if ( file_info.uncompressed_size > 0 ) {
fs_headerLongs[fs_numHeaderLongs++] = LittleInt( file_info.crc );
}
hash = HashFileName( filename_inzip );
buildBuffer[i].name = filename_inzip;
buildBuffer[i].name.ToLower();
buildBuffer[i].name.BackSlashesToSlashes();
// store the file position in the zip
buildBuffer[i].pos = unzGetOffset64( uf );
// add the file to the hash
buildBuffer[i].next = pack->hashTable[hash];
pack->hashTable[hash] = &buildBuffer[i];
// go to the next file in the zip
unzGoToNextFile(uf);
}
// ignore all binary paks
confHash = HashFileName(BINARY_CONFIG);
for (pakFile = pack->hashTable[confHash]; pakFile; pakFile = pakFile->next) {
if (!FilenameCompare(pakFile->name, BINARY_CONFIG)) {
unzClose(uf);
delete[] buildBuffer;
delete pack;
Mem_Free( fs_headerLongs );
return NULL;
}
}
// check if this is an addon pak
pack->addon = false;
confHash = HashFileName( ADDON_CONFIG );
for ( pakFile = pack->hashTable[confHash]; pakFile; pakFile = pakFile->next ) {
if ( !FilenameCompare( pakFile->name, ADDON_CONFIG ) ) {
pack->addon = true;
idFile_InZip *file = ReadFileFromZip( pack, pakFile, ADDON_CONFIG );
// may be just an empty file if you don't bother about the mapDef
if ( file && file->Length() ) {
char *buf;
buf = new char[ file->Length() + 1 ];
file->Read( (void *)buf, file->Length() );
buf[ file->Length() ] = '\0';
pack->addon_info = ParseAddonDef( buf, file->Length() );
delete[] buf;
}
if ( file ) {
CloseFile( file );
}
break;
}
}
pack->checksum = MD4_BlockChecksum( fs_headerLongs, 4 * fs_numHeaderLongs );
pack->checksum = LittleInt( pack->checksum );
Mem_Free( fs_headerLongs );
return pack;
}
/*
===============
idFileSystemLocal::AddZipFile
adds a downloaded pak file to the list so we can work out what we have and what we still need
the isNew flag is set to true, indicating that we cannot add this pak to the search lists without a restart
===============
*/
int idFileSystemLocal::AddZipFile( const char *path ) {
idStr fullpath = fs_savepath.GetString();
pack_t *pak;
searchpath_t *search, *last;
fullpath.AppendPath( path );
pak = LoadZipFile( fullpath );
if ( !pak ) {
common->Warning( "AddZipFile %s failed\n", path );
return 0;
}
// insert the pak at the end of the search list - temporary until we restart
pak->isNew = true;
search = new searchpath_t;
search->dir = NULL;
search->pack = pak;
search->next = NULL;
last = searchPaths;
while ( last->next ) {
last = last->next;
}
last->next = search;
common->Printf( "Appended pk4 %s with checksum 0x%x\n", pak->pakFilename.c_str(), pak->checksum );
return pak->checksum;
}
/*
===============
idFileSystemLocal::AddUnique
===============
*/
int idFileSystemLocal::AddUnique( const char *name, idStrList &list, idHashIndex &hashIndex ) const {
int i, hashKey;
hashKey = hashIndex.GenerateKey( name );
for ( i = hashIndex.First( hashKey ); i >= 0; i = hashIndex.Next( i ) ) {
if ( list[i].Icmp( name ) == 0 ) {
return i;
}
}
i = list.Append( name );
hashIndex.Add( hashKey, i );
return i;
}
/*
===============
idFileSystemLocal::GetExtensionList
===============
*/
void idFileSystemLocal::GetExtensionList( const char *extension, idStrList &extensionList ) const {
int s, e, l;
l = idStr::Length( extension );
s = 0;
while( 1 ) {
e = idStr::FindChar( extension, '|', s, l );
if ( e != -1 ) {
extensionList.Append( idStr( extension, s, e ) );
s = e + 1;
} else {
extensionList.Append( idStr( extension, s, l ) );
break;
}
}
}
/*
===============
idFileSystemLocal::GetFileList
Does not clear the list first so this can be used to progressively build a file list.
When 'sort' is true only the new files added to the list are sorted.
===============
*/
int idFileSystemLocal::GetFileList( const char *relativePath, const idStrList &extensions, idStrList &list, idHashIndex &hashIndex, bool fullRelativePath, const char* gamedir ) {
searchpath_t * search;
fileInPack_t * buildBuffer;
int i, j;
int pathLength;
int length;
const char * name;
pack_t * pak;
idStr work;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( !extensions.Num() ) {
return 0;
}
if ( !relativePath ) {
return 0;
}
pathLength = strlen( relativePath );
if ( pathLength ) {
pathLength++; // for the trailing '/'
}
// search through the path, one element at a time, adding to list
for( search = searchPaths; search != NULL; search = search->next ) {
if ( search->dir ) {
if(gamedir && strlen(gamedir)) {
if(search->dir->gamedir != gamedir) {
continue;
}
}
idStrList sysFiles;
idStr netpath;
netpath = BuildOSPath( search->dir->path, search->dir->gamedir, relativePath );
for ( i = 0; i < extensions.Num(); i++ ) {
// scan for files in the filesystem
ListOSFiles( netpath, extensions[i], sysFiles );
// if we are searching for directories, remove . and ..
if ( extensions[i][0] == '/' && extensions[i][1] == 0 ) {
sysFiles.Remove( "." );
sysFiles.Remove( ".." );
}
for( j = 0; j < sysFiles.Num(); j++ ) {
// unique the match
if ( fullRelativePath ) {
work = relativePath;
work += "/";
work += sysFiles[j];
AddUnique( work, list, hashIndex );
}
else {
AddUnique( sysFiles[j], list, hashIndex );
}
}
}
} else if ( search->pack ) {
// look through all the pak file elements
// exclude any extra packs if we have server paks to search
if ( serverPaks.Num() ) {
GetPackStatus( search->pack );
if ( search->pack->pureStatus != PURE_NEVER && !serverPaks.Find( search->pack ) ) {
continue; // not on the pure server pak list
}
}
pak = search->pack;
buildBuffer = pak->buildBuffer;
for( i = 0; i < pak->numfiles; i++ ) {
length = buildBuffer[i].name.Length();
// if the name is not long anough to at least contain the path
if ( length <= pathLength ) {
continue;
}
name = buildBuffer[i].name;
// check for a path match without the trailing '/'
if ( pathLength && idStr::Icmpn( name, relativePath, pathLength - 1 ) != 0 ) {
continue;
}
// ensure we have a path, and not just a filename containing the path
if ( name[ pathLength ] == '\0' || name[pathLength - 1] != '/' ) {
continue;
}
// make sure the file is not in a subdirectory
for ( j = pathLength; name[j+1] != '\0'; j++ ) {
if ( name[j] == '/' ) {
break;
}
}
if ( name[j+1] ) {
continue;
}
// check for extension match
for ( j = 0; j < extensions.Num(); j++ ) {
if ( length >= extensions[j].Length() && extensions[j].Icmp( name + length - extensions[j].Length() ) == 0 ) {
break;
}
}
if ( j >= extensions.Num() ) {
continue;
}
// unique the match
if ( fullRelativePath ) {
work = relativePath;
work += "/";
work += name + pathLength;
work.StripTrailing( '/' );
AddUnique( work, list, hashIndex );
} else {
work = name + pathLength;
work.StripTrailing( '/' );
AddUnique( work, list, hashIndex );
}
}
}
}
return list.Num();
}
/*
===============
idFileSystemLocal::ListFiles
===============
*/
idFileList *idFileSystemLocal::ListFiles( const char *relativePath, const char *extension, bool sort, bool fullRelativePath, const char* gamedir ) {
idHashIndex hashIndex( 4096, 4096 );
idStrList extensionList;
idFileList *fileList = new idFileList;
fileList->basePath = relativePath;
GetExtensionList( extension, extensionList );
GetFileList( relativePath, extensionList, fileList->list, hashIndex, fullRelativePath, gamedir );
if ( sort ) {
idStrListSortPaths( fileList->list );
}
return fileList;
}
/*
===============
idFileSystemLocal::GetFileListTree
===============
*/
int idFileSystemLocal::GetFileListTree( const char *relativePath, const idStrList &extensions, idStrList &list, idHashIndex &hashIndex, const char* gamedir ) {
int i;
idStrList slash, folders( 128 );
idHashIndex folderHashIndex( 1024, 128 );
// recurse through the subdirectories
slash.Append( "/" );
GetFileList( relativePath, slash, folders, folderHashIndex, true, gamedir );
for ( i = 0; i < folders.Num(); i++ ) {
if ( folders[i][0] == '.' ) {
continue;
}
if ( folders[i].Icmp( relativePath ) == 0 ){
continue;
}
GetFileListTree( folders[i], extensions, list, hashIndex, gamedir );
}
// list files in the current directory
GetFileList( relativePath, extensions, list, hashIndex, true, gamedir );
return list.Num();
}
/*
===============
idFileSystemLocal::ListFilesTree
===============
*/
idFileList *idFileSystemLocal::ListFilesTree( const char *relativePath, const char *extension, bool sort, const char* gamedir ) {
idHashIndex hashIndex( 4096, 4096 );
idStrList extensionList;
idFileList *fileList = new idFileList();
fileList->basePath = relativePath;
fileList->list.SetGranularity( 4096 );
GetExtensionList( extension, extensionList );
GetFileListTree( relativePath, extensionList, fileList->list, hashIndex, gamedir );
if ( sort ) {
idStrListSortPaths( fileList->list );
}
return fileList;
}
/*
===============
idFileSystemLocal::FreeFileList
===============
*/
void idFileSystemLocal::FreeFileList( idFileList *fileList ) {
delete fileList;
}
/*
===============
idFileSystemLocal::ListMods
===============
*/
idModList *idFileSystemLocal::ListMods( void ) {
int i;
const int MAX_DESCRIPTION = 256;
char desc[ MAX_DESCRIPTION ];
idStrList dirs;
idStrList pk4s;
idModList *list = new idModList;
const char *search[ 4 ];
int isearch;
search[0] = fs_savepath.GetString();
search[1] = fs_devpath.GetString();
search[2] = fs_basepath.GetString();
search[3] = fs_cdpath.GetString();
for ( isearch = 0; isearch < 4; isearch++ ) {
// skip empty cdpath or such, so we don't search C:\ or / -_-
if ( search[ isearch ][ 0 ] == '\0' ) {
continue;
}
dirs.Clear();
pk4s.Clear();
// scan for directories
ListOSFiles( search[ isearch ], "/", dirs );
dirs.Remove( "." );
dirs.Remove( ".." );
dirs.Remove( "base" );
dirs.Remove( "pb" );
// see if there are any pk4 files in each directory
for( i = 0; i < dirs.Num(); i++ ) {
idStr gamepath = BuildOSPath( search[ isearch ], dirs[ i ], "" );
ListOSFiles( gamepath, ".pk4", pk4s );
if ( pk4s.Num() ) {
if ( !list->mods.Find( dirs[ i ] ) ) {
// D3 1.3 #31, only list d3xp if the pak is present
if ( dirs[ i ].Icmp( "d3xp" ) || HasD3XP() ) {
list->mods.Append( dirs[ i ] );
}
}
}
}
}
list->mods.Sort();
// read the descriptions for each mod - search all paths
for ( i = 0; i < list->mods.Num(); i++ ) {
for ( isearch = 0; isearch < 4; isearch++ ) {
idStr descfile = BuildOSPath( search[ isearch ], list->mods[ i ], "description.txt" );
FILE *f = OpenOSFile( descfile, "r" );
if ( f ) {
if ( fgets( desc, MAX_DESCRIPTION, f ) ) {
list->descriptions.Append( desc );
fclose( f );
break;
} else {
common->DWarning( "Error reading %s", descfile.c_str() );
fclose( f );
continue;
}
}
}
if ( isearch == 4 ) {
list->descriptions.Append( list->mods[ i ] );
}
}
list->mods.Insert( "" );
list->descriptions.Insert( "dhewm 3" );
assert( list->mods.Num() == list->descriptions.Num() );
return list;
}
/*
===============
idFileSystemLocal::FreeModList
===============
*/
void idFileSystemLocal::FreeModList( idModList *modList ) {
delete modList;
}
/*
===============
idDEntry::Matches
===============
*/
bool idDEntry::Matches(const char *directory, const char *extension) const {
if ( !idDEntry::directory.Icmp( directory ) && !idDEntry::extension.Icmp( extension ) ) {
return true;
}
return false;
}
/*
===============
idDEntry::Init
===============
*/
void idDEntry::Init( const char *directory, const char *extension, const idStrList &list ) {
idDEntry::directory = directory;
idDEntry::extension = extension;
idStrList::operator=(list);
}
/*
===============
idDEntry::Clear
===============
*/
void idDEntry::Clear( void ) {
directory.Clear();
extension.Clear();
idStrList::Clear();
}
/*
===============
idFileSystemLocal::ListOSFiles
call to the OS for a listing of files in an OS directory
optionally, perform some caching of the entries
===============
*/
int idFileSystemLocal::ListOSFiles( const char *directory, const char *extension, idStrList &list ) {
int i, j, ret;
if ( !extension ) {
extension = "";
}
if ( !fs_caseSensitiveOS.GetBool() ) {
return Sys_ListFiles( directory, extension, list );
}
// try in cache
i = dir_cache_index - 1;
while( i >= dir_cache_index - dir_cache_count ) {
j = (i+MAX_CACHED_DIRS) % MAX_CACHED_DIRS;
if ( dir_cache[j].Matches( directory, extension ) ) {
if ( fs_debug.GetInteger() ) {
//common->Printf( "idFileSystemLocal::ListOSFiles: cache hit: %s\n", directory );
}
list = dir_cache[j];
return list.Num();
}
i--;
}
if ( fs_debug.GetInteger() ) {
//common->Printf( "idFileSystemLocal::ListOSFiles: cache miss: %s\n", directory );
}
ret = Sys_ListFiles( directory, extension, list );
if ( ret == -1 ) {
return -1;
}
// push a new entry
dir_cache[dir_cache_index].Init( directory, extension, list );
dir_cache_index = (dir_cache_index + 1) % MAX_CACHED_DIRS;
if ( dir_cache_count < MAX_CACHED_DIRS ) {
dir_cache_count++;
}
return ret;
}
/*
================
idFileSystemLocal::Dir_f
================
*/
void idFileSystemLocal::Dir_f( const idCmdArgs &args ) {
idStr relativePath;
idStr extension;
idFileList *fileList;
int i;
if ( args.Argc() < 2 || args.Argc() > 3 ) {
common->Printf( "usage: dir <directory> [extension]\n" );
return;
}
if ( args.Argc() == 2 ) {
relativePath = args.Argv( 1 );
extension = "";
}
else {
relativePath = args.Argv( 1 );
extension = args.Argv( 2 );
if ( extension[0] != '.' ) {
common->Warning( "extension should have a leading dot" );
}
}
relativePath.BackSlashesToSlashes();
relativePath.StripTrailing( '/' );
common->Printf( "Listing of %s/*%s\n", relativePath.c_str(), extension.c_str() );
common->Printf( "---------------\n" );
fileList = fileSystemLocal.ListFiles( relativePath, extension );
for ( i = 0; i < fileList->GetNumFiles(); i++ ) {
common->Printf( "%s\n", fileList->GetFile( i ) );
}
common->Printf( "%d files\n", fileList->list.Num() );
fileSystemLocal.FreeFileList( fileList );
}
/*
================
idFileSystemLocal::DirTree_f
================
*/
void idFileSystemLocal::DirTree_f( const idCmdArgs &args ) {
idStr relativePath;
idStr extension;
idFileList *fileList;
int i;
if ( args.Argc() < 2 || args.Argc() > 3 ) {
common->Printf( "usage: dirtree <directory> [extension]\n" );
return;
}
if ( args.Argc() == 2 ) {
relativePath = args.Argv( 1 );
extension = "";
}
else {
relativePath = args.Argv( 1 );
extension = args.Argv( 2 );
if ( extension[0] != '.' ) {
common->Warning( "extension should have a leading dot" );
}
}
relativePath.BackSlashesToSlashes();
relativePath.StripTrailing( '/' );
common->Printf( "Listing of %s/*%s /s\n", relativePath.c_str(), extension.c_str() );
common->Printf( "---------------\n" );
fileList = fileSystemLocal.ListFilesTree( relativePath, extension );
for ( i = 0; i < fileList->GetNumFiles(); i++ ) {
common->Printf( "%s\n", fileList->GetFile( i ) );
}
common->Printf( "%d files\n", fileList->list.Num() );
fileSystemLocal.FreeFileList( fileList );
}
/*
============
idFileSystemLocal::Path_f
============
*/
void idFileSystemLocal::Path_f( const idCmdArgs &args ) {
searchpath_t *sp;
idStr status;
common->Printf( "Current search path:\n" );
for ( sp = fileSystemLocal.searchPaths; sp; sp = sp->next ) {
if ( sp->pack ) {
if ( com_developer.GetBool() ) {
sprintf( status, "%s (%i files - 0x%x %s", sp->pack->pakFilename.c_str(), sp->pack->numfiles, sp->pack->checksum, sp->pack->referenced ? "referenced" : "not referenced" );
if ( sp->pack->addon ) {
status += " - addon)\n";
} else {
status += ")\n";
}
common->Printf( status.c_str() );
} else {
common->Printf( "%s (%i files)\n", sp->pack->pakFilename.c_str(), sp->pack->numfiles );
}
if ( fileSystemLocal.serverPaks.Num() ) {
if ( fileSystemLocal.serverPaks.Find( sp->pack ) ) {
common->Printf( " on the pure list\n" );
} else {
common->Printf( " not on the pure list\n" );
}
}
} else {
common->Printf( "%s/%s\n", sp->dir->path.c_str(), sp->dir->gamedir.c_str() );
}
}
// show addon packs that are *not* in the search lists
common->Printf( "Addon pk4s:\n" );
for ( sp = fileSystemLocal.addonPaks; sp; sp = sp->next ) {
if ( com_developer.GetBool() ) {
common->Printf( "%s (%i files - 0x%x)\n", sp->pack->pakFilename.c_str(), sp->pack->numfiles, sp->pack->checksum );
} else {
common->Printf( "%s (%i files)\n", sp->pack->pakFilename.c_str(), sp->pack->numfiles );
}
}
}
/*
============
idFileSystemLocal::TouchFile_f
The only purpose of this function is to allow game script files to copy
arbitrary files furing an "fs_copyfiles 1" run.
============
*/
void idFileSystemLocal::TouchFile_f( const idCmdArgs &args ) {
idFile *f;
if ( args.Argc() != 2 ) {
common->Printf( "Usage: touchFile <file>\n" );
return;
}
f = fileSystemLocal.OpenFileRead( args.Argv( 1 ) );
if ( f ) {
fileSystemLocal.CloseFile( f );
}
}
/*
============
idFileSystemLocal::TouchFileList_f
Takes a text file and touches every file in it, use one file per line.
============
*/
void idFileSystemLocal::TouchFileList_f( const idCmdArgs &args ) {
if ( args.Argc() != 2 ) {
common->Printf( "Usage: touchFileList <filename>\n" );
return;
}
const char *buffer = NULL;
idParser src( LEXFL_NOFATALERRORS | LEXFL_NOSTRINGCONCAT | LEXFL_ALLOWMULTICHARLITERALS | LEXFL_ALLOWBACKSLASHSTRINGCONCAT );
if ( fileSystem->ReadFile( args.Argv( 1 ), ( void** )&buffer, NULL ) && buffer ) {
src.LoadMemory( buffer, strlen( buffer ), args.Argv( 1 ) );
if ( src.IsLoaded() ) {
idToken token;
while( src.ReadToken( &token ) ) {
common->Printf( "%s\n", token.c_str() );
session->UpdateScreen();
idFile *f = fileSystemLocal.OpenFileRead( token );
if ( f ) {
fileSystemLocal.CloseFile( f );
}
}
}
}
}
/*
================
idFileSystemLocal::AddGameDirectory
Sets gameFolder, adds the directory to the head of the search paths, then loads any pk4 files.
================
*/
void idFileSystemLocal::AddGameDirectory( const char *path, const char *dir ) {
int i;
searchpath_t * search;
pack_t * pak;
idStr pakfile;
idStrList pakfiles;
// check if the search path already exists
for ( search = searchPaths; search; search = search->next ) {
// if this element is a pak file
if ( !search->dir ) {
continue;
}
if ( search->dir->path.Cmp( path ) == 0 && search->dir->gamedir.Cmp( dir ) == 0 ) {
return;
}
}
gameFolder = dir;
//
// add the directory to the search path
//
search = new searchpath_t;
search->dir = new directory_t;
search->pack = NULL;
search->dir->path = path;
search->dir->gamedir = dir;
search->next = searchPaths;
searchPaths = search;
// find all pak files in this directory
pakfile = BuildOSPath( path, dir, "" );
pakfile[ pakfile.Length() - 1 ] = 0; // strip the trailing slash
ListOSFiles( pakfile, ".pk4", pakfiles );
// sort them so that later alphabetic matches override
// earlier ones. This makes pak1.pk4 override pak0.pk4
pakfiles.Sort();
for ( i = 0; i < pakfiles.Num(); i++ ) {
pakfile = BuildOSPath( path, dir, pakfiles[i] );
pak = LoadZipFile( pakfile );
if ( !pak ) {
continue;
}
// insert the pak after the directory it comes from
search = new searchpath_t;
search->dir = NULL;
search->pack = pak;
search->next = searchPaths->next;
searchPaths->next = search;
common->Printf( "Loaded pk4 %s with checksum 0x%x\n", pakfile.c_str(), pak->checksum );
}
}
/*
================
idFileSystemLocal::SetupGameDirectories
Takes care of the correct search order.
================
*/
void idFileSystemLocal::SetupGameDirectories( const char *gameName ) {
// setup cdpath
if ( fs_cdpath.GetString()[0] ) {
AddGameDirectory( fs_cdpath.GetString(), gameName );
}
// setup basepath
if ( fs_basepath.GetString()[0] ) {
AddGameDirectory( fs_basepath.GetString(), gameName );
}
// setup devpath
if ( fs_devpath.GetString()[0] ) {
AddGameDirectory( fs_devpath.GetString(), gameName );
}
// setup savepath
if ( fs_savepath.GetString()[0] ) {
AddGameDirectory( fs_savepath.GetString(), gameName );
}
// setup configpath
if ( fs_configpath.GetString()[0] ) {
AddGameDirectory( fs_configpath.GetString(), gameName );
}
}
/*
===============
idFileSystemLocal::FollowDependencies
===============
*/
void idFileSystemLocal::FollowAddonDependencies( pack_t *pak ) {
assert( pak );
if ( !pak->addon_info || !pak->addon_info->depends.Num() ) {
return;
}
int i, num = pak->addon_info->depends.Num();
for ( i = 0; i < num; i++ ) {
pack_t *deppak = GetPackForChecksum( pak->addon_info->depends[ i ], true );
if ( deppak ) {
// make sure it hasn't been marked for search already
if ( !deppak->addon_search ) {
// must clean addonChecksums as we go
int addon_index = addonChecksums.FindIndex( deppak->checksum );
if ( addon_index >= 0 ) {
addonChecksums.RemoveIndex( addon_index );
}
deppak->addon_search = true;
common->Printf( "Addon pk4 %s 0x%x depends on pak %s 0x%x, will be searched\n",
pak->pakFilename.c_str(), pak->checksum,
deppak->pakFilename.c_str(), deppak->checksum );
FollowAddonDependencies( deppak );
}
} else {
common->Printf( "Addon pk4 %s 0x%x depends on unknown pak 0x%x\n",
pak->pakFilename.c_str(), pak->checksum, pak->addon_info->depends[ i ] );
}
}
}
/*
================
idFileSystemLocal::Startup
================
*/
void idFileSystemLocal::Startup( void ) {
searchpath_t **search;
int i;
pack_t *pak;
int addon_index;
common->Printf( "----- Initializing File System -----\n" );
if ( restartChecksums.Num() ) {
common->Printf( "restarting in pure mode with %d pak files\n", restartChecksums.Num() );
}
if ( addonChecksums.Num() ) {
common->Printf( "restarting filesystem with %d addon pak file(s) to include\n", addonChecksums.Num() );
}
SetupGameDirectories( BASE_GAMEDIR );
// fs_game_base override
if ( fs_game_base.GetString()[0] &&
idStr::Icmp( fs_game_base.GetString(), BASE_GAMEDIR ) ) {
SetupGameDirectories( fs_game_base.GetString() );
}
// fs_game override
if ( fs_game.GetString()[0] &&
idStr::Icmp( fs_game.GetString(), BASE_GAMEDIR ) &&
idStr::Icmp( fs_game.GetString(), fs_game_base.GetString() ) ) {
SetupGameDirectories( fs_game.GetString() );
}
// currently all addons are in the search list - deal with filtering out and dependencies now
// scan through and deal with dependencies
search = &searchPaths;
while ( *search ) {
if ( !( *search )->pack || !( *search )->pack->addon ) {
search = &( ( *search )->next );
continue;
}
pak = ( *search )->pack;
if ( fs_searchAddons.GetBool() ) {
// when we have fs_searchAddons on we should never have addonChecksums
assert( !addonChecksums.Num() );
pak->addon_search = true;
search = &( ( *search )->next );
continue;
}
addon_index = addonChecksums.FindIndex( pak->checksum );
if ( addon_index >= 0 ) {
assert( !pak->addon_search ); // any pak getting flagged as addon_search should also have been removed from addonChecksums already
pak->addon_search = true;
addonChecksums.RemoveIndex( addon_index );
FollowAddonDependencies( pak );
}
search = &( ( *search )->next );
}
// now scan to filter out addons not marked addon_search
search = &searchPaths;
while ( *search ) {
if ( !( *search )->pack || !( *search )->pack->addon ) {
search = &( ( *search )->next );
continue;
}
assert( !( *search )->dir );
pak = ( *search )->pack;
if ( pak->addon_search ) {
common->Printf( "Addon pk4 %s with checksum 0x%x is on the search list\n",
pak->pakFilename.c_str(), pak->checksum );
search = &( ( *search )->next );
} else {
// remove from search list, put in addons list
searchpath_t *paksearch = *search;
*search = ( *search )->next;
paksearch->next = addonPaks;
addonPaks = paksearch;
common->Printf( "Addon pk4 %s with checksum 0x%x is on addon list\n",
pak->pakFilename.c_str(), pak->checksum );
}
}
// all addon paks found and accounted for
assert( !addonChecksums.Num() );
addonChecksums.Clear(); // just in case
if ( restartChecksums.Num() ) {
search = &searchPaths;
while ( *search ) {
if ( !( *search )->pack ) {
search = &( ( *search )->next );
continue;
}
if ( ( i = restartChecksums.FindIndex( ( *search )->pack->checksum ) ) != -1 ) {
if ( i == 0 ) {
// this pak is the next one in the pure search order
serverPaks.Append( ( *search )->pack );
restartChecksums.RemoveIndex( 0 );
if ( !restartChecksums.Num() ) {
break; // early out, we're done
}
search = &( ( *search )->next );
continue;
} else {
// this pak will be on the pure list, but order is not right yet
searchpath_t *aux;
aux = ( *search )->next;
if ( !aux ) {
// last of the list can't be swapped back
if ( fs_debug.GetBool() ) {
common->Printf( "found pure checksum %x at index %d, but the end of search path is reached\n", ( *search )->pack->checksum, i );
idStr checks;
checks.Clear();
for ( i = 0; i < serverPaks.Num(); i++ ) {
checks += va( "%p ", serverPaks[ i ] );
}
common->Printf( "%d pure paks - %s \n", serverPaks.Num(), checks.c_str() );
checks.Clear();
for ( i = 0; i < restartChecksums.Num(); i++ ) {
checks += va( "%x ", restartChecksums[ i ] );
}
common->Printf( "%d paks left - %s\n", restartChecksums.Num(), checks.c_str() );
}
common->FatalError( "Failed to restart with pure mode restrictions for server connect" );
}
// put this search path at the end of the list
searchpath_t *search_end;
search_end = ( *search )->next;
while ( search_end->next ) {
search_end = search_end->next;
}
search_end->next = *search;
*search = ( *search )->next;
search_end->next->next = NULL;
continue;
}
}
// this pak is not on the pure list
search = &( ( *search )->next );
}
// the list must be empty
if ( restartChecksums.Num() ) {
if ( fs_debug.GetBool() ) {
idStr checks;
checks.Clear();
for ( i = 0; i < serverPaks.Num(); i++ ) {
checks += va( "%p ", serverPaks[ i ] );
}
common->Printf( "%d pure paks - %s \n", serverPaks.Num(), checks.c_str() );
checks.Clear();
for ( i = 0; i < restartChecksums.Num(); i++ ) {
checks += va( "%x ", restartChecksums[ i ] );
}
common->Printf( "%d paks left - %s\n", restartChecksums.Num(), checks.c_str() );
}
common->FatalError( "Failed to restart with pure mode restrictions for server connect" );
}
}
// add our commands
cmdSystem->AddCommand( "dir", Dir_f, CMD_FL_SYSTEM, "lists a folder", idCmdSystem::ArgCompletion_FileName );
cmdSystem->AddCommand( "dirtree", DirTree_f, CMD_FL_SYSTEM, "lists a folder with subfolders" );
cmdSystem->AddCommand( "path", Path_f, CMD_FL_SYSTEM, "lists search paths" );
cmdSystem->AddCommand( "touchFile", TouchFile_f, CMD_FL_SYSTEM, "touches a file" );
cmdSystem->AddCommand( "touchFileList", TouchFileList_f, CMD_FL_SYSTEM, "touches a list of files" );
// print the current search paths
Path_f( idCmdArgs() );
}
/*
=====================
idFileSystemLocal::UpdatePureServerChecksums
=====================
*/
void idFileSystemLocal::UpdatePureServerChecksums( void ) {
searchpath_t *search;
int i;
pureStatus_t status;
serverPaks.Clear();
for ( search = searchPaths; search; search = search->next ) {
// is the element a referenced pak file?
if ( !search->pack ) {
continue;
}
status = GetPackStatus( search->pack );
if ( status == PURE_NEVER ) {
continue;
}
if ( status == PURE_NEUTRAL && !search->pack->referenced ) {
continue;
}
serverPaks.Append( search->pack );
if ( serverPaks.Num() >= MAX_PURE_PAKS ) {
common->FatalError( "MAX_PURE_PAKS ( %d ) exceeded\n", MAX_PURE_PAKS );
}
}
if ( fs_debug.GetBool() ) {
idStr checks;
for ( i = 0; i < serverPaks.Num(); i++ ) {
checks += va( "%x ", serverPaks[ i ]->checksum );
}
common->Printf( "set pure list - %d paks ( %s)\n", serverPaks.Num(), checks.c_str() );
}
}
/*
=====================
idFileSystemLocal::GetPackForChecksum
=====================
*/
pack_t* idFileSystemLocal::GetPackForChecksum( int checksum, bool searchAddons ) {
searchpath_t *search;
for ( search = searchPaths; search; search = search->next ) {
if ( !search->pack ) {
continue;
}
if ( search->pack->checksum == checksum ) {
return search->pack;
}
}
if ( searchAddons ) {
for ( search = addonPaks; search; search = search->next ) {
assert( search->pack && search->pack->addon );
if ( search->pack->checksum == checksum ) {
return search->pack;
}
}
}
return NULL;
}
/*
===============
idFileSystemLocal::ValidateDownloadPakForChecksum
===============
*/
int idFileSystemLocal::ValidateDownloadPakForChecksum( int checksum, char path[ MAX_STRING_CHARS ] ) {
int i;
idStrList testList;
idStr name;
idStr relativePath;
pack_t *pak = GetPackForChecksum( checksum );
if ( !pak ) {
return 0;
}
// validate this pak for a potential download
// ignore pak*.pk4 for download. those are reserved to distribution and cannot be downloaded
name = pak->pakFilename;
name.StripPath();
if ( strstr( name.c_str(), "pak" ) == name.c_str() ) {
common->DPrintf( "%s is not a donwloadable pak\n", pak->pakFilename.c_str() );
return 0;
}
// extract a path that includes the fs_game: != OSPathToRelativePath
testList.Append( fs_savepath.GetString() );
testList.Append( fs_devpath.GetString() );
testList.Append( fs_basepath.GetString() );
testList.Append( fs_cdpath.GetString() );
for ( i = 0; i < testList.Num(); i ++ ) {
if ( testList[ i ].Length() && !testList[ i ].Icmpn( pak->pakFilename, testList[ i ].Length() ) ) {
relativePath = pak->pakFilename.c_str() + testList[ i ].Length() + 1;
break;
}
}
if ( i == testList.Num() ) {
common->Warning( "idFileSystem::ValidateDownloadPak: failed to extract relative path for %s", pak->pakFilename.c_str() );
return 0;
}
idStr::Copynz( path, relativePath, MAX_STRING_CHARS );
return pak->length;
}
/*
=====================
idFileSystemLocal::ClearPureChecksums
=====================
*/
void idFileSystemLocal::ClearPureChecksums( void ) {
common->DPrintf( "Cleared pure server lock\n" );
serverPaks.Clear();
}
/*
=====================
idFileSystemLocal::SetPureServerChecksums
set the pure paks according to what the server asks
if that's not possible, identify why and build an answer
can be:
loadedFileFromDir - some files were loaded from directories instead of paks (a restart in pure pak-only is required)
missing/wrong checksums - some pak files would need to be installed/updated (downloaded for instance)
some pak files currently referenced are not referenced by the server
wrong order - if the pak order doesn't match, means some stuff could have been loaded from somewhere else
server referenced files are prepended to the list if possible ( that doesn't break pureness )
DLL:
the checksum of the pak containing the DLL is maintained seperately, the server can send different replies by OS
=====================
*/
fsPureReply_t idFileSystemLocal::SetPureServerChecksums( const int pureChecksums[ MAX_PURE_PAKS ], int missingChecksums[ MAX_PURE_PAKS ] ) {
pack_t *pack;
int i, j, imissing;
bool success = true;
bool canPrepend = true;
imissing = 0;
missingChecksums[ 0 ] = 0;
if ( pureChecksums[ 0 ] == 0 ) {
ClearPureChecksums();
return PURE_OK;
}
if ( !serverPaks.Num() ) {
// there was no pure lockdown yet - lock to what we already have
UpdatePureServerChecksums();
}
i = 0; j = 0;
while ( pureChecksums[ i ] ) {
if ( j < serverPaks.Num() && serverPaks[ j ]->checksum == pureChecksums[ i ] ) {
canPrepend = false; // once you start matching into the list there is no prepending anymore
i++; j++; // the pak is matched, is in the right order, continue..
} else {
pack = GetPackForChecksum( pureChecksums[ i ], true );
if ( pack && pack->addon && !pack->addon_search ) {
// this is an addon pack, and it's not on our current search list
// setting success to false meaning that a restart including this addon is required
if ( fs_debug.GetBool() ) {
common->Printf( "pak %s checksumed 0x%x is on addon list. Restart required.\n", pack->pakFilename.c_str(), pack->checksum );
}
success = false;
}
if ( pack && pack->isNew ) {
// that's a downloaded pack, we will need to restart
if ( fs_debug.GetBool() ) {
common->Printf( "pak %s checksumed 0x%x is a newly downloaded file. Restart required.\n", pack->pakFilename.c_str(), pack->checksum );
}
success = false;
}
if ( pack ) {
if ( canPrepend ) {
// we still have a chance
if ( fs_debug.GetBool() ) {
common->Printf( "prepend pak %s checksumed 0x%x at index %d\n", pack->pakFilename.c_str(), pack->checksum, j );
}
// NOTE: there is a light possibility this adds at the end of the list if UpdatePureServerChecksums didn't set anything
serverPaks.Insert( pack, j );
i++; j++; // continue..
} else {
success = false;
if ( fs_debug.GetBool() ) {
// verbose the situation
if ( serverPaks.Find( pack ) ) {
common->Printf( "pak %s checksumed 0x%x is in the pure list at wrong index. Current index is %d, found at %d\n", pack->pakFilename.c_str(), pack->checksum, j, serverPaks.FindIndex( pack ) );
} else {
common->Printf( "pak %s checksumed 0x%x can't be added to pure list because of search order\n", pack->pakFilename.c_str(), pack->checksum );
}
}
i++; // advance server checksums only
}
} else {
// didn't find a matching checksum
success = false;
missingChecksums[ imissing++ ] = pureChecksums[ i ];
missingChecksums[ imissing ] = 0;
if ( fs_debug.GetBool() ) {
common->Printf( "checksum not found - 0x%x\n", pureChecksums[ i ] );
}
i++; // advance the server checksums only
}
}
}
while ( j < serverPaks.Num() ) {
success = false; // just in case some extra pak files are referenced at the end of our local list
if ( fs_debug.GetBool() ) {
common->Printf( "pak %s checksumed 0x%x is an extra reference at the end of local pure list\n", serverPaks[ j ]->pakFilename.c_str(), serverPaks[ j ]->checksum );
}
j++;
}
// we reply to missing after DLL check so it can be part of the list
if ( imissing ) {
return PURE_MISSING;
}
// one last check
if ( loadedFileFromDir ) {
success = false;
if ( fs_debug.GetBool() ) {
common->Printf( "SetPureServerChecksums: there are files loaded from dir\n" );
}
}
return ( success ? PURE_OK : PURE_RESTART );
}
/*
=====================
idFileSystemLocal::GetPureServerChecksums
=====================
*/
void idFileSystemLocal::GetPureServerChecksums( int checksums[ MAX_PURE_PAKS ] ) {
int i;
for ( i = 0; i < serverPaks.Num(); i++ ) {
checksums[ i ] = serverPaks[ i ]->checksum;
}
checksums[ i ] = 0;
}
/*
=====================
idFileSystemLocal::SetRestartChecksums
=====================
*/
void idFileSystemLocal::SetRestartChecksums( const int pureChecksums[ MAX_PURE_PAKS ] ) {
int i;
pack_t *pack;
restartChecksums.Clear();
i = 0;
while ( pureChecksums[ i ] ) {
pack = GetPackForChecksum( pureChecksums[ i ], true );
if ( !pack ) {
common->FatalError( "SetRestartChecksums failed: no pak for checksum 0x%x\n", pureChecksums[i] );
}
if ( pack->addon && addonChecksums.FindIndex( pack->checksum ) < 0 ) {
// can't mark it pure if we're not even gonna search it :-)
addonChecksums.Append( pack->checksum );
}
restartChecksums.Append( pureChecksums[ i ] );
i++;
}
}
/*
================
idFileSystemLocal::Init
Called only at inital startup, not when the filesystem
is resetting due to a game change
================
*/
void idFileSystemLocal::Init( void ) {
// allow command line parms to override our defaults
// we have to specially handle this, because normal command
// line variable sets don't happen until after the filesystem
// has already been initialized
common->StartupVariable( "fs_basepath", false );
common->StartupVariable( "fs_configpath", false );
common->StartupVariable( "fs_savepath", false );
common->StartupVariable( "fs_cdpath", false );
common->StartupVariable( "fs_devpath", false );
common->StartupVariable( "fs_game", false );
common->StartupVariable( "fs_game_base", false );
common->StartupVariable( "fs_copyfiles", false );
common->StartupVariable( "fs_restrict", false );
common->StartupVariable( "fs_searchAddons", false );
idStr path;
if (fs_basepath.GetString()[0] == '\0' && Sys_GetPath(PATH_BASE, path))
fs_basepath.SetString(path);
if (fs_savepath.GetString()[0] == '\0' && Sys_GetPath(PATH_SAVE, path))
fs_savepath.SetString(path);
if (fs_configpath.GetString()[0] == '\0' && Sys_GetPath(PATH_CONFIG, path))
fs_configpath.SetString(path);
if ( fs_devpath.GetString()[0] == '\0' ) {
#ifdef WIN32
fs_devpath.SetString( fs_cdpath.GetString()[0] ? fs_cdpath.GetString() : fs_basepath.GetString() );
#else
fs_devpath.SetString( fs_savepath.GetString() );
#endif
}
// try to start up normally
Startup( );
// spawn a thread to handle background file reads
StartBackgroundDownloadThread();
if ( ReadFile( "default.cfg", NULL, NULL ) <= 0 ) {
// DG: the demo gamedata is in demo/ instead of base/. to make it "just work", add a fallback for that
if(fs_game.GetString()[0] == '\0' || idStr::Icmp(fs_game.GetString(), BASE_GAMEDIR) == 0) {
common->Warning("Couldn't find default.cfg in %s/, trying again with demo/\n", BASE_GAMEDIR);
fs_game.SetString("demo");
fs_game_base.SetString("demo");
Restart();
} else {
// if we can't find default.cfg, assume that the paths are
// busted and error out now, rather than getting an unreadable
// graphics screen when the font fails to load
// Dedicated servers can run with no outside files at all
common->FatalError( "Couldn't load default.cfg" );
}
}
}
/*
================
idFileSystemLocal::Restart
================
*/
void idFileSystemLocal::Restart( void ) {
// free anything we currently have loaded
Shutdown( true );
Startup( );
// spawn a thread to handle background file reads
StartBackgroundDownloadThread();
// if we can't find default.cfg, assume that the paths are
// busted and error out now, rather than getting an unreadable
// graphics screen when the font fails to load
if ( ReadFile( "default.cfg", NULL, NULL ) <= 0 ) {
common->FatalError( "Couldn't load default.cfg" );
}
}
/*
================
idFileSystemLocal::Shutdown
Frees all resources and closes all files
================
*/
void idFileSystemLocal::Shutdown( bool reloading ) {
searchpath_t *sp, *next, *loop;
backgroundThread_exit = true;
Sys_TriggerEvent();
Sys_DestroyThread(backgroundThread);
backgroundThread_exit = false;
gameFolder.Clear();
serverPaks.Clear();
if ( !reloading ) {
restartChecksums.Clear();
addonChecksums.Clear();
}
loadedFileFromDir = false;
ClearDirCache();
// free everything - loop through searchPaths and addonPaks
for ( loop = searchPaths; loop; loop == searchPaths ? loop = addonPaks : loop = NULL ) {
for ( sp = loop; sp; sp = next ) {
next = sp->next;
if ( sp->pack ) {
unzClose( sp->pack->handle );
delete [] sp->pack->buildBuffer;
if ( sp->pack->addon_info ) {
sp->pack->addon_info->mapDecls.DeleteContents( true );
delete sp->pack->addon_info;
}
delete sp->pack;
}
if ( sp->dir ) {
delete sp->dir;
}
delete sp;
}
}
// any FS_ calls will now be an error until reinitialized
searchPaths = NULL;
addonPaks = NULL;
cmdSystem->RemoveCommand( "path" );
cmdSystem->RemoveCommand( "dir" );
cmdSystem->RemoveCommand( "dirtree" );
cmdSystem->RemoveCommand( "touchFile" );
mapDict.Clear();
}
/*
================
idFileSystemLocal::IsInitialized
================
*/
bool idFileSystemLocal::IsInitialized( void ) const {
return ( searchPaths != NULL );
}
/*
=================================================================================
Opening files
=================================================================================
*/
/*
===========
idFileSystemLocal::FileAllowedFromDir
===========
*/
bool idFileSystemLocal::FileAllowedFromDir( const char *path ) {
unsigned int l;
l = strlen( path );
if ( !strcmp( path + l - 4, ".cfg" ) // for config files
|| !strcmp( path + l - 4, ".dat" ) // for journal files
|| !strcmp( path + l - 4, ".dll" ) // dynamic modules are handled a different way for pure
|| !strcmp( path + l - 3, ".so" )
|| ( l > 6 && !strcmp( path + l - 6, ".dylib" ) )
|| ( l > 10 && !strcmp( path + l - 10, ".scriptcfg" ) ) // configuration script, such as map cycle
#if ID_PURE_ALLOWDDS
|| !strcmp( path + l - 4, ".dds" )
#endif
) {
// note: cd and xp keys, as well as config.spec are opened through an explicit OS path and don't hit this
return true;
}
// savegames
if ( strstr( path, "savegames" ) == path &&
( !strcmp( path + l - 4, ".tga" ) || !strcmp( path + l -4, ".txt" ) || !strcmp( path + l - 5, ".save" ) ) ) {
return true;
}
// screen shots
if ( strstr( path, "screenshots" ) == path && !strcmp( path + l - 4, ".tga" ) ) {
return true;
}
// objective tgas
if ( strstr( path, "maps/game" ) == path &&
!strcmp( path + l - 4, ".tga" ) ) {
return true;
}
// splash screens extracted from addons
if ( strstr( path, "guis/assets/splash/addon" ) == path &&
!strcmp( path + l -4, ".tga" ) ) {
return true;
}
return false;
}
/*
===========
idFileSystemLocal::GetPackStatus
===========
*/
pureStatus_t idFileSystemLocal::GetPackStatus( pack_t *pak ) {
int i, l, hashindex;
fileInPack_t *file;
bool abrt;
idStr name;
if ( pak->pureStatus != PURE_UNKNOWN ) {
return pak->pureStatus;
}
// check content for PURE_NEVER
i = 0;
file = pak->buildBuffer;
for ( hashindex = 0; hashindex < FILE_HASH_SIZE; hashindex++ ) {
abrt = false;
file = pak->hashTable[ hashindex ];
while ( file ) {
abrt = true;
l = file->name.Length();
for ( int j = 0; pureExclusions[j].func != NULL; j++ ) {
if ( pureExclusions[j].func( pureExclusions[j], l, file->name ) ) {
abrt = false;
break;
}
}
if ( abrt ) {
common->DPrintf( "pak '%s' candidate for pure: '%s'\n", pak->pakFilename.c_str(), file->name.c_str() );
break;
}
file = file->next;
i++;
}
if ( abrt ) {
break;
}
}
if ( i == pak->numfiles ) {
pak->pureStatus = PURE_NEVER;
return PURE_NEVER;
}
// check pak name for PURE_ALWAYS
pak->pakFilename.ExtractFileName( name );
if ( !name.IcmpPrefixPath( "pak" ) ) {
pak->pureStatus = PURE_ALWAYS;
return PURE_ALWAYS;
}
pak->pureStatus = PURE_NEUTRAL;
return PURE_NEUTRAL;
}
/*
===========
idFileSystemLocal::ReadFileFromZip
===========
*/
idFile_InZip * idFileSystemLocal::ReadFileFromZip( pack_t *pak, fileInPack_t *pakFile, const char *relativePath ) {
// relativePath == pakFile->name according to FilenameCompare()
// pakFile->Pos is position of that file within the zip
// set position in pk4 file to the file (in the zip/pk4) we want a handle on
unzSetOffset64( pak->handle, pakFile->pos );
// clone handle and assign a new internal filestream to zip file to it
unzFile uf = unzReOpen( pak->pakFilename, pak->handle );
if ( uf == NULL ) {
common->FatalError( "Couldn't reopen %s", pak->pakFilename.c_str() );
}
// the following stuff is needed to get the uncompress filesize (for file->fileSize)
char filename_inzip[MAX_ZIPPED_FILE_NAME];
unz_file_info64 file_info;
int err = unzGetCurrentFileInfo64( uf, &file_info, filename_inzip, sizeof(filename_inzip), NULL, 0, NULL, 0 );
if ( err != UNZ_OK ) {
common->FatalError( "Couldn't get file info for %s in %s, pos %llu", relativePath, pak->pakFilename.c_str(), pakFile->pos );
}
// create idFile_InZip and set fields accordingly
idFile_InZip *file = new idFile_InZip();
file->z = uf;
file->name = relativePath;
file->fullPath = pak->pakFilename + "/" + relativePath;
file->zipFilePos = pakFile->pos;
file->fileSize = file_info.uncompressed_size;
return file;
}
/*
===========
idFileSystemLocal::OpenFileReadFlags
Finds the file in the search path, following search flag recommendations
Returns filesize and an open FILE pointer.
Used for streaming data out of either a
separate file or a ZIP file.
===========
*/
idFile *idFileSystemLocal::OpenFileReadFlags( const char *relativePath, int searchFlags, pack_t **foundInPak, bool allowCopyFiles, const char* gamedir ) {
searchpath_t * search;
idStr netpath;
pack_t * pak;
fileInPack_t * pakFile;
directory_t * dir;
int hash;
FILE * fp;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( !relativePath ) {
common->FatalError( "idFileSystemLocal::OpenFileRead: NULL 'relativePath' parameter passed\n" );
}
if ( foundInPak ) {
*foundInPak = NULL;
}
// qpaths are not supposed to have a leading slash
if ( relativePath[0] == '/' || relativePath[0] == '\\' ) {
relativePath++;
}
// make absolutely sure that it can't back up the path.
// The searchpaths do guarantee that something will always
// be prepended, so we don't need to worry about "c:" or "//limbo"
if ( strstr( relativePath, ".." ) || strstr( relativePath, "::" ) ) {
return NULL;
}
// edge case
if ( relativePath[0] == '\0' ) {
return NULL;
}
// make sure the doomkey file is only readable by game at initialization
// any other time the key should only be accessed in memory using the provided functions
if( common->IsInitialized() && ( idStr::Icmp( relativePath, CDKEY_FILE ) == 0 || idStr::Icmp( relativePath, XPKEY_FILE ) == 0 ) ) {
return NULL;
}
//
// search through the path, one element at a time
//
hash = HashFileName( relativePath );
for ( search = searchPaths; search; search = search->next ) {
if ( search->dir && ( searchFlags & FSFLAG_SEARCH_DIRS ) ) {
// check a file in the directory tree
// if we are running restricted, the only files we
// will allow to come from the directory are .cfg files
if ( fs_restrict.GetBool() || serverPaks.Num() ) {
if ( !FileAllowedFromDir( relativePath ) ) {
continue;
}
}
dir = search->dir;
if(gamedir && strlen(gamedir)) {
if(dir->gamedir != gamedir) {
continue;
}
}
netpath = BuildOSPath( dir->path, dir->gamedir, relativePath );
fp = OpenOSFileCorrectName( netpath, "rb" );
if ( !fp ) {
continue;
}
idFile_Permanent *file = new idFile_Permanent();
file->o = fp;
file->name = relativePath;
file->fullPath = netpath;
file->mode = ( 1 << FS_READ );
file->fileSize = DirectFileLength( file->o );
if ( fs_debug.GetInteger() ) {
common->Printf( "idFileSystem::OpenFileRead: %s (found in '%s/%s')\n", relativePath, dir->path.c_str(), dir->gamedir.c_str() );
}
if ( !loadedFileFromDir && !FileAllowedFromDir( relativePath ) ) {
if ( restartChecksums.Num() ) {
common->FatalError( "'%s' loaded from directory: Failed to restart with pure mode restrictions for server connect", relativePath );
}
common->DPrintf( "filesystem: switching to pure mode will require a restart. '%s' loaded from directory.\n", relativePath );
loadedFileFromDir = true;
}
// if fs_copyfiles is set
if ( allowCopyFiles && fs_copyfiles.GetInteger() ) {
idStr copypath;
idStr name;
copypath = BuildOSPath( fs_savepath.GetString(), dir->gamedir, relativePath );
netpath.ExtractFileName( name );
copypath.StripFilename( );
copypath += PATHSEPERATOR_STR;
copypath += name;
bool isFromCDPath = !dir->path.Cmp( fs_cdpath.GetString() );
bool isFromSavePath = !dir->path.Cmp( fs_savepath.GetString() );
bool isFromBasePath = !dir->path.Cmp( fs_basepath.GetString() );
switch ( fs_copyfiles.GetInteger() ) {
case 1:
// copy from cd path only
if ( isFromCDPath ) {
CopyFile( netpath, copypath );
}
break;
case 2:
// from cd path + timestamps
if ( isFromCDPath ) {
CopyFile( netpath, copypath );
} else if ( isFromSavePath || isFromBasePath ) {
idStr sourcepath;
sourcepath = BuildOSPath( fs_cdpath.GetString(), dir->gamedir, relativePath );
FILE *f1 = OpenOSFile( sourcepath, "r" );
if ( f1 ) {
ID_TIME_T t1 = Sys_FileTimeStamp( f1 );
fclose( f1 );
FILE *f2 = OpenOSFile( copypath, "r" );
if ( f2 ) {
ID_TIME_T t2 = Sys_FileTimeStamp( f2 );
fclose( f2 );
if ( t1 > t2 ) {
CopyFile( sourcepath, copypath );
}
}
}
}
break;
case 3:
if ( isFromCDPath || isFromBasePath ) {
CopyFile( netpath, copypath );
}
break;
case 4:
if ( isFromCDPath && !isFromBasePath ) {
CopyFile( netpath, copypath );
}
break;
}
}
return file;
} else if ( search->pack && ( searchFlags & FSFLAG_SEARCH_PAKS ) ) {
if ( !search->pack->hashTable[hash] ) {
continue;
}
// disregard if it doesn't match one of the allowed pure pak files
if ( serverPaks.Num() ) {
GetPackStatus( search->pack );
if ( search->pack->pureStatus != PURE_NEVER && !serverPaks.Find( search->pack ) ) {
continue; // not on the pure server pak list
}
}
// look through all the pak file elements
pak = search->pack;
for ( pakFile = pak->hashTable[hash]; pakFile; pakFile = pakFile->next ) {
// case and separator insensitive comparisons
if ( !FilenameCompare( pakFile->name, relativePath ) ) {
idFile_InZip *file = ReadFileFromZip( pak, pakFile, relativePath );
if ( foundInPak ) {
*foundInPak = pak;
}
if ( !pak->referenced && !( searchFlags & FSFLAG_PURE_NOREF ) ) {
// mark this pak referenced
if ( fs_debug.GetInteger( ) ) {
common->Printf( "idFileSystem::OpenFileRead: %s -> adding %s to referenced paks\n", relativePath, pak->pakFilename.c_str() );
}
pak->referenced = true;
}
if ( fs_debug.GetInteger( ) ) {
common->Printf( "idFileSystem::OpenFileRead: %s (found in '%s')\n", relativePath, pak->pakFilename.c_str() );
}
return file;
}
}
}
}
if ( searchFlags & FSFLAG_SEARCH_ADDONS ) {
for ( search = addonPaks; search; search = search->next ) {
assert( search->pack );
fileInPack_t *pakFile;
pak = search->pack;
for ( pakFile = pak->hashTable[hash]; pakFile; pakFile = pakFile->next ) {
if ( !FilenameCompare( pakFile->name, relativePath ) ) {
idFile_InZip *file = ReadFileFromZip( pak, pakFile, relativePath );
if ( foundInPak ) {
*foundInPak = pak;
}
// we don't toggle pure on paks found in addons - they can't be used without a reloadEngine anyway
if ( fs_debug.GetInteger( ) ) {
common->Printf( "idFileSystem::OpenFileRead: %s (found in addon pk4 '%s')\n", relativePath, search->pack->pakFilename.c_str() );
}
return file;
}
}
}
}
if ( fs_debug.GetInteger( ) ) {
common->Printf( "Can't find %s\n", relativePath );
}
return NULL;
}
/*
===========
idFileSystemLocal::OpenFileRead
===========
*/
idFile *idFileSystemLocal::OpenFileRead( const char *relativePath, bool allowCopyFiles, const char* gamedir ) {
return OpenFileReadFlags( relativePath, FSFLAG_SEARCH_DIRS | FSFLAG_SEARCH_PAKS, NULL, allowCopyFiles, gamedir );
}
/*
===========
idFileSystemLocal::OpenFileWrite
===========
*/
idFile *idFileSystemLocal::OpenFileWrite( const char *relativePath, const char *basePath ) {
const char *path;
idStr OSpath;
idFile_Permanent *f;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
path = cvarSystem->GetCVarString( basePath );
if ( !path[0] ) {
path = fs_savepath.GetString();
}
OSpath = BuildOSPath( path, gameFolder, relativePath );
if ( fs_debug.GetInteger() ) {
common->Printf( "idFileSystem::OpenFileWrite: %s\n", OSpath.c_str() );
}
// if the dir we are writing to is in our current list, it will be outdated
// so just flush everything
ClearDirCache();
common->DPrintf( "writing to: %s\n", OSpath.c_str() );
CreateOSPath( OSpath );
f = new idFile_Permanent();
f->o = OpenOSFile( OSpath, "wb" );
if ( !f->o ) {
delete f;
return NULL;
}
f->name = relativePath;
f->fullPath = OSpath;
f->mode = ( 1 << FS_WRITE );
f->handleSync = false;
f->fileSize = 0;
return f;
}
/*
===========
idFileSystemLocal::OpenExplicitFileRead
===========
*/
idFile *idFileSystemLocal::OpenExplicitFileRead( const char *OSPath ) {
idFile_Permanent *f;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( fs_debug.GetInteger() ) {
common->Printf( "idFileSystem::OpenExplicitFileRead: %s\n", OSPath );
}
common->DPrintf( "idFileSystem::OpenExplicitFileRead - reading from: %s\n", OSPath );
f = new idFile_Permanent();
f->o = OpenOSFile( OSPath, "rb" );
if ( !f->o ) {
delete f;
return NULL;
}
f->name = OSPath;
f->fullPath = OSPath;
f->mode = ( 1 << FS_READ );
f->handleSync = false;
f->fileSize = DirectFileLength( f->o );
return f;
}
/*
===========
idFileSystemLocal::OpenExplicitFileWrite
===========
*/
idFile *idFileSystemLocal::OpenExplicitFileWrite( const char *OSPath ) {
idFile_Permanent *f;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
if ( fs_debug.GetInteger() ) {
common->Printf( "idFileSystem::OpenExplicitFileWrite: %s\n", OSPath );
}
common->DPrintf( "writing to: %s\n", OSPath );
CreateOSPath( OSPath );
f = new idFile_Permanent();
f->o = OpenOSFile( OSPath, "wb" );
if ( !f->o ) {
delete f;
return NULL;
}
f->name = OSPath;
f->fullPath = OSPath;
f->mode = ( 1 << FS_WRITE );
f->handleSync = false;
f->fileSize = 0;
return f;
}
/*
===========
idFileSystemLocal::OpenFileAppend
===========
*/
idFile *idFileSystemLocal::OpenFileAppend( const char *relativePath, bool sync, const char *basePath ) {
const char *path;
idStr OSpath;
idFile_Permanent *f;
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
path = cvarSystem->GetCVarString( basePath );
if ( !path[0] ) {
path = fs_savepath.GetString();
}
OSpath = BuildOSPath( path, gameFolder, relativePath );
CreateOSPath( OSpath );
if ( fs_debug.GetInteger() ) {
common->Printf( "idFileSystem::OpenFileAppend: %s\n", OSpath.c_str() );
}
f = new idFile_Permanent();
f->o = OpenOSFile( OSpath, "ab" );
if ( !f->o ) {
delete f;
return NULL;
}
f->name = relativePath;
f->fullPath = OSpath;
f->mode = ( 1 << FS_WRITE ) + ( 1 << FS_APPEND );
f->handleSync = sync;
f->fileSize = DirectFileLength( f->o );
return f;
}
/*
================
idFileSystemLocal::OpenFileByMode
================
*/
idFile *idFileSystemLocal::OpenFileByMode( const char *relativePath, fsMode_t mode ) {
if ( mode == FS_READ ) {
return OpenFileRead( relativePath );
}
if ( mode == FS_WRITE ) {
return OpenFileWrite( relativePath );
}
if ( mode == FS_APPEND ) {
return OpenFileAppend( relativePath, true );
}
common->FatalError( "idFileSystemLocal::OpenFileByMode: bad mode" );
return NULL;
}
/*
==============
idFileSystemLocal::CloseFile
==============
*/
void idFileSystemLocal::CloseFile( idFile *f ) {
if ( !searchPaths ) {
common->FatalError( "Filesystem call made without initialization\n" );
}
delete f;
}
/*
=================================================================================
back ground loading
=================================================================================
*/
/*
=================
idFileSystemLocal::CurlWriteFunction
=================
*/
size_t idFileSystemLocal::CurlWriteFunction( void *ptr, size_t size, size_t nmemb, void *stream ) {
backgroundDownload_t *bgl = (backgroundDownload_t *)stream;
if ( !bgl->f ) {
return size * nmemb;
}
#ifdef _WIN32
return _write( _fileno(static_cast<idFile_Permanent*>(bgl->f)->GetFilePtr()), ptr, size * nmemb );
#else
return fwrite( ptr, size, nmemb, static_cast<idFile_Permanent*>(bgl->f)->GetFilePtr() );
#endif
}
/*
=================
idFileSystemLocal::CurlProgressFunction
=================
*/
int idFileSystemLocal::CurlProgressFunction( void *clientp, double dltotal, double dlnow, double ultotal, double ulnow ) {
backgroundDownload_t *bgl = (backgroundDownload_t *)clientp;
if ( bgl->url.status == DL_ABORTING ) {
return 1;
}
bgl->url.dltotal = dltotal;
bgl->url.dlnow = dlnow;
return 0;
}
/*
===================
BackgroundDownload
Reads part of a file from a background thread.
===================
*/
int BackgroundDownloadThread( void *pexit ) {
bool *exit = (bool *)pexit;
while (!(*exit)) {
Sys_EnterCriticalSection();
backgroundDownload_t *bgl = fileSystemLocal.backgroundDownloads;
if ( !bgl ) {
Sys_LeaveCriticalSection();
Sys_WaitForEvent();
continue;
}
// remove this from the list
fileSystemLocal.backgroundDownloads = bgl->next;
Sys_LeaveCriticalSection();
bgl->next = NULL;
if ( bgl->opcode == DLTYPE_FILE ) {
// use the low level read function, because fread may allocate memory
#if defined(WIN32)
_read( _fileno(static_cast<idFile_Permanent*>(bgl->f)->GetFilePtr()), bgl->file.buffer, bgl->file.length );
#else
fread( bgl->file.buffer, bgl->file.length, 1, static_cast<idFile_Permanent*>(bgl->f)->GetFilePtr() );
#endif
bgl->completed = true;
} else {
#ifdef ID_ENABLE_CURL
// DLTYPE_URL
// use a local buffer for curl error since the size define is local
char error_buf[ CURL_ERROR_SIZE ];
bgl->url.dlerror[ 0 ] = '\0';
CURL *session = curl_easy_init();
CURLcode ret;
if ( !session ) {
bgl->url.dlstatus = CURLE_FAILED_INIT;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_ERRORBUFFER, error_buf );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_URL, bgl->url.url.c_str() );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_FAILONERROR, 1 );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_WRITEFUNCTION, idFileSystemLocal::CurlWriteFunction );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_WRITEDATA, bgl );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_NOPROGRESS, 0 );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_PROGRESSFUNCTION, idFileSystemLocal::CurlProgressFunction );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
ret = curl_easy_setopt( session, CURLOPT_PROGRESSDATA, bgl );
if ( ret ) {
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
bgl->url.dlnow = 0;
bgl->url.dltotal = 0;
bgl->url.status = DL_INPROGRESS;
ret = curl_easy_perform( session );
if ( ret ) {
Sys_Printf( "curl_easy_perform failed: %s\n", error_buf );
idStr::Copynz( bgl->url.dlerror, error_buf, MAX_STRING_CHARS );
bgl->url.dlstatus = ret;
bgl->url.status = DL_FAILED;
bgl->completed = true;
continue;
}
bgl->url.status = DL_DONE;
bgl->completed = true;
#else
bgl->url.status = DL_FAILED;
bgl->completed = true;
#endif
}
}
return 0;
}
/*
=================
idFileSystemLocal::StartBackgroundReadThread
=================
*/
void idFileSystemLocal::StartBackgroundDownloadThread() {
if ( !backgroundThread.threadHandle ) {
Sys_CreateThread( BackgroundDownloadThread, &backgroundThread_exit, backgroundThread, "backgroundDownload" );
} else {
common->Printf( "background thread already running\n" );
}
}
/*
=================
idFileSystemLocal::BackgroundDownload
=================
*/
void idFileSystemLocal::BackgroundDownload( backgroundDownload_t *bgl ) {
if ( bgl->opcode == DLTYPE_FILE ) {
if ( dynamic_cast<idFile_Permanent *>(bgl->f) ) {
// add the bgl to the background download list
Sys_EnterCriticalSection();
bgl->next = backgroundDownloads;
backgroundDownloads = bgl;
Sys_TriggerEvent();
Sys_LeaveCriticalSection();
} else {
// read zipped file directly
bgl->f->Seek( bgl->file.position, FS_SEEK_SET );
bgl->f->Read( bgl->file.buffer, bgl->file.length );
bgl->completed = true;
}
} else {
Sys_EnterCriticalSection();
bgl->next = backgroundDownloads;
backgroundDownloads = bgl;
Sys_TriggerEvent();
Sys_LeaveCriticalSection();
}
}
/*
=================
idFileSystemLocal::PerformingCopyFiles
=================
*/
bool idFileSystemLocal::PerformingCopyFiles( void ) const {
return fs_copyfiles.GetInteger() > 0;
}
/*
=================
idFileSystemLocal::FindPakForFileChecksum
=================
*/
pack_t *idFileSystemLocal::FindPakForFileChecksum( const char *relativePath, int findChecksum, bool bReference ) {
searchpath_t *search;
pack_t *pak;
fileInPack_t *pakFile;
int hash;
assert( !serverPaks.Num() );
hash = HashFileName( relativePath );
for ( search = searchPaths; search; search = search->next ) {
if ( search->pack && search->pack->hashTable[ hash ] ) {
pak = search->pack;
for ( pakFile = pak->hashTable[ hash ]; pakFile; pakFile = pakFile->next ) {
if ( !FilenameCompare( pakFile->name, relativePath ) ) {
idFile_InZip *file = ReadFileFromZip( pak, pakFile, relativePath );
if ( findChecksum == GetFileChecksum( file ) ) {
if ( fs_debug.GetBool() ) {
common->Printf( "found '%s' with checksum 0x%x in pak '%s'\n", relativePath, findChecksum, pak->pakFilename.c_str() );
}
if ( bReference ) {
pak->referenced = true;
// FIXME: use dependencies for pak references
}
CloseFile( file );
return pak;
} else if ( fs_debug.GetBool() ) {
common->Printf( "'%s' in pak '%s' has != checksum %x\n", relativePath, pak->pakFilename.c_str(), GetFileChecksum( file ) );
}
CloseFile( file );
}
}
}
}
if ( fs_debug.GetBool() ) {
common->Printf( "no pak file found for '%s' checksumed %x\n", relativePath, findChecksum );
}
return NULL;
}
/*
=================
idFileSystemLocal::GetFileChecksum
=================
*/
int idFileSystemLocal::GetFileChecksum( idFile *file ) {
int len, ret;
byte *buf;
file->Seek( 0, FS_SEEK_END );
len = file->Tell();
file->Seek( 0, FS_SEEK_SET );
buf = (byte *)Mem_Alloc( len );
if ( file->Read( buf, len ) != len ) {
common->FatalError( "Short read in idFileSystemLocal::GetFileChecksum()\n" );
}
ret = MD4_BlockChecksum( buf, len );
Mem_Free( buf );
return ret;
}
/*
=================
idFileSystemLocal::FindDLL
=================
*/
void idFileSystemLocal::FindDLL( const char *name, char _dllPath[ MAX_OSPATH ] ) {
idFile *dllFile = NULL;
char dllName[MAX_OSPATH];
idStr dllPath;
sys->DLL_GetFileName( name, dllName, MAX_OSPATH );
if (!serverPaks.Num() && Sys_GetPath(PATH_EXE, dllPath)) {
// from executable directory first - this is handy for developement
dllPath.StripFilename( );
dllPath.AppendPath( dllName );
dllFile = OpenExplicitFileRead( dllPath );
}
if ( !dllFile && !serverPaks.Num() )
dllFile = OpenFileReadFlags( dllName, FSFLAG_SEARCH_DIRS );
if ( dllFile ) {
dllPath = dllFile->GetFullPath( );
CloseFile( dllFile );
dllFile = NULL;
} else {
dllPath = "";
}
idStr::snPrintf( _dllPath, MAX_OSPATH, dllPath.c_str() );
}
/*
================
idFileSystemLocal::ClearDirCache
================
*/
void idFileSystemLocal::ClearDirCache( void ) {
int i;
dir_cache_index = 0;
dir_cache_count = 0;
for( i = 0; i < MAX_CACHED_DIRS; i++ ) {
dir_cache[ i ].Clear();
}
}
/*
===============
idFileSystemLocal::HasD3XP
===============
*/
bool idFileSystemLocal::HasD3XP( void ) {
int i;
idStrList dirs, pk4s;
idStr gamepath;
if ( d3xp == -1 ) {
return false;
} else if ( d3xp == 1 ) {
return true;
}
#if 0
// check for a d3xp directory with a pk4 file
// copied over from ListMods - only looks in basepath
ListOSFiles( fs_basepath.GetString(), "/", dirs );
for ( i = 0; i < dirs.Num(); i++ ) {
if ( dirs[i].Icmp( "d3xp" ) == 0 ) {
gamepath = BuildOSPath( fs_basepath.GetString(), dirs[ i ], "" );
ListOSFiles( gamepath, ".pk4", pk4s );
if ( pk4s.Num() ) {
d3xp = 1;
return true;
}
}
}
#else
// check for d3xp's d3xp/pak000.pk4 in any search path
// checking wether the pak is loaded by checksum wouldn't be enough:
// we may have a different fs_game right now but still need to reply that it's installed
const char *search[4];
idFile *pakfile;
search[0] = fs_savepath.GetString();
search[1] = fs_devpath.GetString();
search[2] = fs_basepath.GetString();
search[3] = fs_cdpath.GetString();
for ( i = 0; i < 4; i++ ) {
pakfile = OpenExplicitFileRead( BuildOSPath( search[ i ], "d3xp", "pak000.pk4" ) );
if ( pakfile ) {
CloseFile( pakfile );
d3xp = 1;
return true;
}
}
#endif
// if we didn't find a pk4 file then the user might have unpacked so look for default.cfg file
// that's the old way mostly used during developement. don't think it hurts to leave it there
ListOSFiles( fs_basepath.GetString(), "/", dirs );
for ( i = 0; i < dirs.Num(); i++ ) {
if ( dirs[i].Icmp( "d3xp" ) == 0 ) {
gamepath = BuildOSPath( fs_configpath.GetString(), dirs[ i ], "default.cfg" );
idFile* cfg = OpenExplicitFileRead(gamepath);
if(cfg) {
CloseFile(cfg);
d3xp = 1;
return true;
}
}
}
d3xp = -1;
return false;
}
/*
===============
idFileSystemLocal::RunningD3XP
===============
*/
bool idFileSystemLocal::RunningD3XP( void ) {
// TODO: mark the checksum of the gold XP and check for it being referenced ( for double mod support )
// a simple fs_game check should be enough for now..
if ( !idStr::Icmp( fs_game.GetString(), "d3xp" ) ||
!idStr::Icmp( fs_game_base.GetString(), "d3xp" ) ) {
return true;
}
return false;
}
/*
===============
idFileSystemLocal::MakeTemporaryFile
===============
*/
idFile * idFileSystemLocal::MakeTemporaryFile( void ) {
FILE *f = tmpfile();
if ( !f ) {
common->Warning( "idFileSystem::MakeTemporaryFile failed: %s", strerror( errno ) );
return NULL;
}
idFile_Permanent *file = new idFile_Permanent();
file->o = f;
file->name = "<tempfile>";
file->fullPath = "<tempfile>";
file->mode = ( 1 << FS_READ ) + ( 1 << FS_WRITE );
file->fileSize = 0;
return file;
}
/*
===============
idFileSystemLocal::FindFile
===============
*/
findFile_t idFileSystemLocal::FindFile( const char *path, bool scheduleAddons ) {
pack_t *pak;
idFile *f = OpenFileReadFlags( path, FSFLAG_SEARCH_DIRS | FSFLAG_SEARCH_PAKS | FSFLAG_SEARCH_ADDONS, &pak );
if ( !f ) {
return FIND_NO;
}
if ( !pak ) {
// found in FS, not even in paks
return FIND_YES;
}
// marking addons for inclusion on reload - may need to do that even when already in the search path
if ( scheduleAddons && pak->addon && addonChecksums.FindIndex( pak->checksum ) < 0 ) {
addonChecksums.Append( pak->checksum );
}
// an addon that's not on search list yet? that will require a restart
if ( pak->addon && !pak->addon_search ) {
delete f;
return FIND_ADDON;
}
delete f;
return FIND_YES;
}
/*
===============
idFileSystemLocal::GetNumMaps
account for actual decls and for addon maps
===============
*/
int idFileSystemLocal::GetNumMaps() {
int i;
searchpath_t *search = NULL;
int ret = declManager->GetNumDecls( DECL_MAPDEF );
// add to this all addon decls - coming from all addon packs ( searched or not )
for ( i = 0; i < 2; i++ ) {
if ( i == 0 ) {
search = searchPaths;
} else if ( i == 1 ) {
search = addonPaks;
}
for ( ; search ; search = search->next ) {
if ( !search->pack || !search->pack->addon || !search->pack->addon_info ) {
continue;
}
ret += search->pack->addon_info->mapDecls.Num();
}
}
return ret;
}
/*
===============
idFileSystemLocal::GetMapDecl
retrieve the decl dictionary, add a 'path' value
===============
*/
const idDict * idFileSystemLocal::GetMapDecl( int idecl ) {
int i;
const idDecl *mapDecl;
const idDeclEntityDef *mapDef;
int numdecls = declManager->GetNumDecls( DECL_MAPDEF );
searchpath_t *search = NULL;
if ( idecl < numdecls ) {
mapDecl = declManager->DeclByIndex( DECL_MAPDEF, idecl );
mapDef = static_cast<const idDeclEntityDef *>( mapDecl );
if ( !mapDef ) {
common->Error( "idFileSystemLocal::GetMapDecl %d: not found\n", idecl );
}
mapDict = mapDef->dict;
mapDict.Set( "path", mapDef->GetName() );
return &mapDict;
}
idecl -= numdecls;
for ( i = 0; i < 2; i++ ) {
if ( i == 0 ) {
search = searchPaths;
} else if ( i == 1 ) {
search = addonPaks;
}
for ( ; search ; search = search->next ) {
if ( !search->pack || !search->pack->addon || !search->pack->addon_info ) {
continue;
}
// each addon may have a bunch of map decls
if ( idecl < search->pack->addon_info->mapDecls.Num() ) {
mapDict = *search->pack->addon_info->mapDecls[ idecl ];
return &mapDict;
}
idecl -= search->pack->addon_info->mapDecls.Num();
assert( idecl >= 0 );
}
}
return NULL;
}
/*
===============
idFileSystemLocal::FindMapScreenshot
===============
*/
void idFileSystemLocal::FindMapScreenshot( const char *path, char *buf, int len ) {
idFile *file;
idStr mapname = path;
mapname.StripPath();
mapname.StripFileExtension();
idStr::snPrintf( buf, len, "guis/assets/splash/%s.tga", mapname.c_str() );
if ( ReadFile( buf, NULL, NULL ) == -1 ) {
// try to extract from an addon
file = OpenFileReadFlags( buf, FSFLAG_SEARCH_ADDONS );
if ( file ) {
// save it out to an addon splash directory
int dlen = file->Length();
char *data = new char[ dlen ];
file->Read( data, dlen );
CloseFile( file );
idStr::snPrintf( buf, len, "guis/assets/splash/addon/%s.tga", mapname.c_str() );
WriteFile( buf, data, dlen );
delete[] data;
} else {
idStr::Copynz( buf, "guis/assets/splash/pdtempa", len );
}
}
}
|