Roxen.git/server/base_server/configuration.pike:6a6a8c7bf2a36582c89b96b99b41a72d6e2e10ce

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 // A vitual server's main configuration // Copyright © 1996 - 2000, Roxen IS. constant cvs_version = "$Id: configuration.pike,v 1.415 2001/01/29 05:47:58 per Exp $"; #include <module.h> #include <module_constants.h> #include <roxen.h> #include <request_trace.h> #define CATCH(P,X) do{mixed e;if(e=catch{X;})report_error("While "+P+"\n"+describe_backtrace(e));}while(0) // --- Locale defines --- //<locale-token project="roxen_start"> LOC_S </locale-token> //<locale-token project="roxen_config"> LOC_C </locale-token> //<locale-token project="roxen_message"> LOC_M </locale-token> //<locale-token project="roxen_config"> DLOCALE </locale-token> #define LOC_S(X,Y) _STR_LOCALE("roxen_start",X,Y) #define LOC_C(X,Y) _STR_LOCALE("roxen_config",X,Y) #define LOC_M(X,Y) _STR_LOCALE("roxen_message",X,Y) #define DLOCALE(X,Y) _DEF_LOCALE("roxen_config",X,Y) #ifdef THROTTLING_DEBUG #undef THROTTLING_DEBUG #define THROTTLING_DEBUG(X) werror("Throttling: "+X+"\n") #else #define THROTTLING_DEBUG(X) #endif #ifdef REQUEST_DEBUG # define REQUEST_WERR(X) werror("CONFIG: "+X+"\n") #else # define REQUEST_WERR(X) #endif /* A configuration.. */ inherit Configuration; inherit "basic_defvar"; // Trivial cache (actually, it's more or less identical to the 200+ // lines of C in HTTPLoop. But it does not have to bother with the // fact that more than one thread can be active in it at once. Also, // it does not have to delay free until all current connections using // the cache entry is done...) class DataCache { mapping(string:array(string|mapping(string:mixed))) cache = ([]); int current_size; int max_size; int max_file_size; int hits, misses; void flush() { current_size = 0; cache = ([]); } static void clear_some_cache() { array q = indices( cache ); if(!sizeof(q)) { current_size=0; return; } for( int i = 0; i<sizeof( q )/10; i++ ) expire_entry( q[random(sizeof(q))] ); } void expire_entry( string url ) { if( cache[ url ] ) { current_size -= strlen(cache[url][0]); m_delete( cache, url ); } } void set( string url, string data, mapping meta, int expire ) { if( strlen( data ) > max_size ) return; call_out( expire_entry, expire, url ); current_size += strlen( data ); cache[url] = ({ data, meta }); int n; while( (current_size > max_size) && (n++<10)) clear_some_cache(); } array(string|mapping(string:mixed)) get( string url ) { mixed res; if( res = cache[ url ] ) hits++; else misses++; return res; } void init_from_variables( ) { max_size = query( "data_cache_size" ) * 1024; max_file_size = query( "data_cache_file_max_size" ) * 1024; if( max_size < max_file_size ) max_size += max_file_size; int n; while( (current_size > max_size) && (n++<10)) clear_some_cache(); } static void create() { init_from_variables(); } } #include "rxml.pike"; constant store = roxen.store; constant retrieve = roxen.retrieve; constant remove = roxen.remove; int config_id; int get_config_id() { if(config_id) return config_id; for(int i=sizeof(roxen->configurations); i;) if(roxen->configurations[--i]->name==name) return config_id=i; } string get_doc_for( string region, string variable ) { RoxenModule module; if(variable[0] == '_') return 0; if((int)reverse(region)) return 0; if(module = find_module( region )) { if(module->variables[variable]) return module->variables[variable]->name()+ "\n"+module->variables[ variable ]->doc(); } if(variables[ variable ]) return variables[variable]->name()+ "\n"+variables[ variable ]->doc(); } string query_internal_location(RoxenModule|void mod) { return query("InternalLoc")+(mod?replace(otomod[mod]||"", "#", "!")+"/":""); } string query_name() { if(strlen(query("name"))) return query("name"); return name; } string comment() { return query("comment"); } /* A 'pri' is one of the ten priority objects. Each one holds a list * of modules for that priority. They are all merged into one list for * performance reasons later on. */ array (Priority) allocate_pris() { return allocate(10, Priority)(); } // The logging format used. This will probably move to the above // mentioned module in the future. private mapping (int:string) log_format = ([]); // A list of priority objects array (Priority) pri = allocate_pris(); public mapping modules = ([]); //! All enabled modules in this site. //! The format is "module":{ "copies":([ num:instance, ... ]) } public mapping (RoxenModule:string) otomod = ([]); //! A mapping from the module objects to module names // Caches to speed up the handling of the module search. // They are all sorted in priority order, and created by the functions // below. private array (function) url_module_cache, last_module_cache; private array (function) logger_module_cache, first_module_cache; private array (function) filter_module_cache; private array (array (string|function)) location_module_cache; private mapping (string:array (function)) file_extension_module_cache=([]); private mapping (string:array (RoxenModule)) provider_module_cache=([]); private array (RoxenModule) auth_module_cache, userdb_module_cache; // Call stop in all modules. void stop() { multiset allmods = mkmultiset (indices (otomod)); CATCH("stopping type modules", types_module && types_module->stop && types_module->stop()); allmods[types_module] = 0; CATCH("stopping directory module", dir_module && dir_module->stop && dir_module->stop()); allmods[dir_module] = 0; for(int i=0; i<10; i++) CATCH("stopping priority group", (pri[i] && pri[i]->stop && (allmods -= mkmultiset (pri[i]->stop())))); CATCH("stopping the logger", log_function && lambda(mixed m){ destruct(m); allmods[m] = 0; }(function_object(log_function))); foreach (indices (allmods), RoxenModule m) CATCH ("stopping unclassified module", m && m->stop && m->stop()); foreach( registered_urls, string url ) roxen.unregister_url(url); registered_urls = ({}); } string type_from_filename( string file, int|void to, string|void myext ) { array(string)|string tmp; if(!types_fun) return to?({ "application/octet-stream", 0 }):"application/octet-stream"; string ext=myext || Roxen.extension(file); if(tmp = types_fun(ext)) { mixed tmp2,nx; if(tmp[0] == "strip") { tmp2=file/"."; if(sizeof(tmp2) > 2) nx=tmp2[-2]; if(nx && (tmp2=types_fun(nx))) tmp[0] = tmp2[0]; else if(tmp2=types_fun("default")) tmp[0] = tmp2[0]; else tmp[0]="application/octet-stream"; } } else if(!(tmp = types_fun("default"))) { tmp = ({ "application/octet-stream", 0 }); } return to?tmp:tmp[0]; } array (RoxenModule) get_providers(string provides) //! Returns an array with all provider modules that provides "provides". { // This cache is cleared in the invalidate_cache() call. if(!provider_module_cache[provides]) { int i; provider_module_cache[provides] = ({ }); for(i = 9; i >= 0; i--) { foreach(indices(pri[i]->provider_modules), RoxenModule d) if(pri[i]->provider_modules[ d ][ provides ]) provider_module_cache[provides] += ({ d }); } } return provider_module_cache[provides]; } RoxenModule get_provider(string provides) //! Returns the first provider module that provides "provides". { array (RoxenModule) prov = get_providers(provides); if(sizeof(prov)) return prov[0]; return 0; } array(mixed) map_providers(string provides, string fun, mixed ... args) //! Maps the function "fun" over all matching provider modules. { array (RoxenModule) prov = get_providers(provides); array error; array a=({ }); mixed m; foreach(prov, RoxenModule mod) { if(!objectp(mod)) continue; if(functionp(mod[fun])) error = catch(m=mod[fun](@args)); if(arrayp(error)) { error[0] = "Error in map_providers(): "+error[0]; report_debug(describe_backtrace(error)); } else a += ({ m }); error = 0; } return a; } mixed call_provider(string provides, string fun, mixed ... args) //! Maps the function "fun" over all matching provider modules and //! returns the first positive response. { foreach(get_providers(provides), RoxenModule mod) { function f; if(objectp(mod) && functionp(f = mod[fun])) { mixed error; if (arrayp(error = catch { mixed ret; if (ret = f(@args)) { return ret; } })) { error[0] = "Error in call_provider(): "+error[0]; throw(error); } } } } array (function) file_extension_modules(string ext) { if(!file_extension_module_cache[ext]) { int i; file_extension_module_cache[ext] = ({ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d = pri[i]->file_extension_modules[ext]) foreach(d, p) file_extension_module_cache[ext] += ({ p->handle_file_extension }); } } return file_extension_module_cache[ext]; } array (function) url_modules() { if(!url_module_cache) { int i; url_module_cache=({ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d=pri[i]->url_modules) foreach(d, p) url_module_cache += ({ p->remap_url }); } } return url_module_cache; } static mapping api_module_cache = ([]); mapping api_functions(void|RequestID id) { return api_module_cache+([]); } array (function) logger_modules() { if(!logger_module_cache) { int i; logger_module_cache=({ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d=pri[i]->logger_modules) foreach(d, p) if(p->log) logger_module_cache += ({ p->log }); } } return logger_module_cache; } array (function) last_modules() { if(!last_module_cache) { int i; last_module_cache=({ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d=pri[i]->last_modules) foreach(d, p) if(p->last_resort) last_module_cache += ({ p->last_resort }); } } return last_module_cache; } #ifdef __NT__ static mixed strip_fork_information(RequestID id) { array a = id->not_query/"::"; id->not_query = a[0]; id->misc->fork_information = a[1..]; return 0; } #endif /* __NT__ */ array (function) first_modules() { if(!first_module_cache) { int i; first_module_cache=({ #ifdef __NT__ strip_fork_information, // Always first! #endif /* __NT__ */ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d=pri[i]->first_modules) { foreach(d, p) { if(p->first_try) { first_module_cache += ({ p->first_try }); } } } } } return first_module_cache; } array(UserDB) user_databases() { if( userdb_module_cache ) return userdb_module_cache; array tmp = ({}); foreach( values( modules ), mapping m ) foreach( values(m->copies), RoxenModule mo ) if( mo->module_type & MODULE_USERDB ) tmp += ({ ({ mo->query( "_priority" ), mo }) }); sort( tmp ); // tmp += ({ ({ 0, roxen->config_userdb_module }) }); return userdb_module_cache = reverse(column(tmp,1)); } array(AuthModule) auth_modules() { if( auth_module_cache ) return auth_module_cache; array tmp = ({}); foreach( values( modules ), mapping m ) foreach( values(m->copies), RoxenModule mo ) if( mo->module_type & MODULE_AUTH ) tmp += ({ ({ mo->query( "_priority" ), mo }) }); sort( tmp ); return auth_module_cache = reverse(column(tmp,1)); } array location_modules() //! Return an array of all location modules the request should be //! mapped through, by order of priority. { if(!location_module_cache) { int i; array new_location_module_cache=({ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d=pri[i]->location_modules) { array level_find_files = ({}); array level_locations = ({}); foreach(d, p) { string location; // FIXME: Should there be a catch() here? if(p->find_file && (location = p->query_location())) { level_find_files += ({ p->find_file }); level_locations += ({ location }); } } sort(map(level_locations, sizeof), level_locations, level_find_files); int j; for (j = sizeof(level_locations); j--;) { // Order after longest path first. new_location_module_cache += ({ ({ level_locations[j], level_find_files[j] }) }); } } } location_module_cache = new_location_module_cache; } return location_module_cache; } array(function) filter_modules() { if(!filter_module_cache) { int i; filter_module_cache=({ }); for(i=9; i>=0; i--) { array(RoxenModule) d; RoxenModule p; if(d=pri[i]->filter_modules) foreach(d, p) if(p->filter) filter_module_cache+=({ p->filter }); } } return filter_module_cache; } void init_log_file() { if(log_function) { // Free the old one. destruct(function_object(log_function)); log_function = 0; } // Only try to open the log file if logging is enabled!! if(query("Log")) { string logfile = query("LogFile"); if(strlen(logfile)) log_function = roxen.LogFile( logfile )->write; } } // Parse the logging format strings. private inline string fix_logging(string s) { sscanf(s, "%*[\t ]%s", s); return s; } private void parse_log_formats() { string b; array foo=query("LogFormat")/"\n"; foreach(foo, b) if(strlen(b) && b[0] != '#' && sizeof(b/":")>1) log_format[(int)(b/":")[0]] = fix_logging((b/":")[1..]*":"); } public void log(mapping file, RequestID request_id) { function f; // Call all logging functions foreach(logger_module_cache||logger_modules(), f) if( f( request_id, file ) ) return; if( !log_function ) return;// No file is open for logging. if(do_not_log_patterns && Roxen._match(request_id->remoteaddr, do_not_log_patterns)) return; string form; if(!(form=log_format[file->error])) form = log_format[0]; if(!form) return; roxen.run_log_format( form, log_function, request_id, file ); } public array(string) userinfo(string u, RequestID|void id) //! @note DEPRECATED COMPATIBILITY FUNCTION //! //! Fetches user information from the authentication module by calling //! its userinfo() method. Returns zero if no auth module was present. { User uid; foreach( user_databases(), UserDB m ) if( uid = m->find_user( u ) ) return uid->compat_userinfo(); } public array(string) userlist(RequestID|void id) //! @note DEPRECATED COMPATIBILITY FUNCTION //! //! Fetches the full list of valid usernames from the authentication //! module by calling its userlist() method. Returns zero if no auth //! module was present. { array(string) list = ({}); foreach( user_databases(), UserDB m ) list |= m->list_users(); return list; } public array(string) user_from_uid(int u, RequestID|void id) //! @note DEPRECATED COMPATIBILITY FUNCTION //! //! Return the user data for id u from the authentication module. The //! id parameter might be left out if FTP. Returns zero if no auth //! module was present. { User uid; foreach( user_databases(), UserDB m ) if( uid = m->find_user_from_uid( u ) ) return uid->compat_userinfo(); } UserDB find_user_database( string name ) //! Given a user database name, returns it if it exists in this //! configuration, otherwise returns 0. { foreach( user_databases(), UserDB m ) if( m->name == name ) return m; } AuthModule find_auth_module( string name ) //! Given a authentication method name, returns it if it exists in //! this configuration, otherwise returns 0. { foreach( auth_modules(), AuthModule m ) if( m->name == name ) return m; } User authenticate( RequestID id, UserDB|void database) //! Try to authenticate the request with users from the specified user //! database. If no @[database] is specified, all datbases in the //! current configuration are searched in priority order. //! //! The return value is the autenticated user. //! id->misc->authenticated_user is always set to the return value. { User u; foreach( auth_modules(), AuthModule method ) if( u = method->authenticate( id, database ) ) return id->misc->authenticated_user = u; } mapping authenticate_throw( RequestID id, string realm, UserDB|void database) //! Returns a reply mapping, similar to @[Roxen.http_rxml_reply] with //! friends. If no @[database] is specified, all datbases in the //! current configuration are searched in priority order. { mapping m; foreach( auth_modules(), AuthModule method ) if( m = method->authenticate_throw( id, realm, database ) ) return m; } User find_user( string user, RequestID|void id ) //! Tries to find the specified user in the currently available user //! databases. If id is specified, this function defaults to the //! database that the currently authenticated user came from, if any. //! //! The other user databases are processed in priority order { User uid; if( id->misc->authenticated_user && ( uid = id->misc->authenticated_user->database->find_user( user ) )) return uid; foreach( user_databases(), UserDB m ) if( uid = m->find_user( user ) ) return uid; } Group find_group( string group, RequestID|void id ) //! Tries to find the specified group in the currently available user //! databases. If id is specified, this function defaults to the //! database that the currently authenticated user came from, if any. //! //! The other user databases are processed in priority order { Group uid; if( id->misc->authenticated_user && ( uid = id->misc->authenticated_user->database->find_group( group ) )) return uid; foreach( user_databases(), UserDB m ) if( uid = m->find_group( group ) ) return uid; } public string last_modified_by(Stdio.File file, RequestID id) { Stat s; int uid; array u; if(objectp(file)) s=file->stat(); if(!s || sizeof(s)<5) return "A. Nonymous"; uid=s[5]; u=user_from_uid(uid, id); if(u) return u[0]; return "A. Nonymous"; } // Some clients does _not_ handle the magic 'internal-gopher-...'. // So, lets do it here instead. private mapping internal_gopher_image(string from) { sscanf(from, "%s.gif", from); sscanf(from, "%s.jpg", from); from -= "."; // Disallow "internal-gopher-..", it won't really do much harm, but a list of // all files in '..' might be retrieved (that is, the actual directory // file was sent to the browser) Stdio.File f = lopen("roxen-images/dir/"+from+".gif","r"); if (f) return (["file":f, "type":"image/gif", "stat":f->stat(),]); else return 0; // File not found. } private static int nest = 0; #ifdef MODULE_LEVEL_SECURITY private mapping misc_cache=([]); int|mapping check_security(function|RoxenModule a, RequestID id, void|int slevel) { array level; array seclevels; int ip_ok = 0; // Unknown int auth_ok = 0; // Unknown // NOTE: // ip_ok and auth_ok are three-state variables. // Valid contents for them are: // 0 Unknown state -- No such restriction encountered yet. // 1 May be bad -- Restriction encountered, and test failed. // ~0 OK -- Test passed. if(!(seclevels = misc_cache[ a ])) { RoxenModule mod = Roxen.get_owning_module (a); if(mod && mod->query_seclevels) misc_cache[ a ] = seclevels = ({ mod->query_seclevels(), mod->query("_seclvl"), mod->query("_sec_group") }); else { misc_cache[ a ] = seclevels = ({({}),0,"foo" }); } } // werror("check_security %O %d <-> %d%s\n", a, slevel, seclevels[1], // (seclevels[-1]=="foo"?" (No module found)":"")); if(slevel && (seclevels[1] > slevel)) // "Trustlevel" to low. return 1; if(!sizeof(seclevels[0])) return 0; // Ok if there are no patterns. mixed err; err = catch { foreach(seclevels[0], level) { switch(level[0]) { case MOD_ALLOW: // allow ip=... if(level[1](id->remoteaddr)) { ip_ok = ~0; // Match. It's ok. } else { ip_ok |= 1; // IP may be bad. } break; case MOD_DENY: // deny ip=... if(level[1](id->remoteaddr)) return Roxen.http_low_answer(403, "<h2> Access forbidden </h2>"); break; case MOD_USER: // allow user=... if(id->auth && id->auth[0] && level[1](id->auth[1])) { auth_ok = ~0; // Match. It's ok. } else { auth_ok |= 1; // Auth may be bad. } break; case MOD_PROXY_USER: // allow user=... if (ip_ok != 1) { // IP is OK as of yet. if(id->misc->proxyauth && id->misc->proxyauth[0] && level[1](id->misc->proxyauth[1])) return 0; return Roxen.http_proxy_auth_required(seclevels[2]); } else { // Bad IP. return 1; } break; case MOD_ACCEPT: // accept ip=... // Short-circuit version on allow. if(level[1](id->remoteaddr)) { // Match. It's ok. return 0; } else { ip_ok |= 1; // IP may be bad. } break; case MOD_ACCEPT_USER: // accept user=... // Short-circuit version on allow. if(id->auth && id->auth[0] && level[1](id->auth[1])) { // Match. It's ok. return 0; } else { if (id->auth) { auth_ok |= 1; // Auth may be bad. } else { // No auth yet, get some. return Roxen.http_auth_required(seclevels[2]); } } break; } } }; if (err) { report_error("check_security(): %s:\n%s\n", LOC_M(39, "Error during module security check"), describe_backtrace(err)); return 1; } if (ip_ok == 1) { // Bad IP. return 1; } else { // IP OK, or no IP restrictions. if (auth_ok == 1) { // Bad authentification. // Query for authentification. return Roxen.http_auth_required(seclevels[2]); } else { // No auth required, or authentification OK. return 0; } } } #endif // Empty all the caches above. void invalidate_cache() { last_module_cache = 0; filter_module_cache = 0; userdb_module_cache = 0; auth_module_cache = 0; first_module_cache = 0; url_module_cache = 0; location_module_cache = 0; logger_module_cache = 0; file_extension_module_cache = ([]); provider_module_cache = ([]); #ifdef MODULE_LEVEL_SECURITY if(misc_cache) misc_cache = ([ ]); #endif } // Empty all the caches above AND the ones in the loaded modules. void clear_memory_caches() { invalidate_cache(); foreach(indices(otomod), RoxenModule m) if (m && m->clear_memory_caches) if (mixed err = catch( m->clear_memory_caches() )) report_error("clear_memory_caches() "+ LOC_M(40, "failed for module %O:\n%s\n"), otomod[m], describe_backtrace(err)); } // Returns tuple < image, mime-type > static array(string) draw_saturation_bar(int hue,int brightness, int where) { Image.Image bar=Image.Image(30,256); for(int i=0;i<128;i++) { int j = i*2; bar->line(0,j,29,j,@hsv_to_rgb(hue,255-j,brightness)); bar->line(0,j+1,29,j+1,@hsv_to_rgb(hue,255-j,brightness)); } where = 255-where; bar->line(0,where,29,where, 255,255,255); #if constant(Image.JPEG) && constant(Image.JPEG.encode) return ({ Image.JPEG.encode(bar), "image/jpeg" }); #else return ({ Image.PNG.encode(bar), "image/png" }); #endif } // Inspired by the internal-gopher-... thingie, this is the images // from the administration interface. :-) private mapping internal_roxen_image( string from, RequestID id ) { sscanf(from, "%s.gif", from); sscanf(from, "%s.jpg", from); sscanf(from, "%s.xcf", from); sscanf(from, "%s.png", from); // Automatically generated colorbar. Used by wizard code... int hue,bright,w; if(sscanf(from, "%*s:%d,%d,%d", hue, bright,w)==4) { array bar = draw_saturation_bar(hue, bright, w); return Roxen.http_string_answer(bar[0], bar[1]); } Stdio.File f; if( !id->misc->internal_get ) if(f = lopen("roxen-images/"+from+".gif", "r")) return (["file":f, "type":"image/gif", "stat":f->stat()]); if(f = lopen("roxen-images/"+from+".png", "r")) return (["file":f, "type":"image/png", "stat":f->stat()]); if(f = lopen("roxen-images/"+from+".jpg", "r")) return (["file":f, "type":"image/jpeg", "stat":f->stat()]); if(f = lopen("roxen-images/"+from+".xcf", "r")) return (["file":f, "type":"image/x-gimp-image", "stat":f->stat()]); if(f = lopen("roxen-images/"+from+".gif", "r")) return (["file":f, "type":"image/gif", "stat":f->stat()]); // File not found. return 0; } mapping (mixed:function|int) locks = ([]); #ifdef THREADS // import Thread; mapping locked = ([]), thread_safe = ([]); mixed _lock(object|function f) { Thread.MutexKey key; function|int l; if (functionp(f)) { f = function_object(f); } if (l = locks[f]) { if (l != -1) { // Allow recursive locks. catch{ //werror("lock %O\n", f); locked[f]++; key = l(); }; } else thread_safe[f]++; } else if (f->thread_safe) { locks[f]=-1; thread_safe[f]++; } else { if (!locks[f]) { // Needed to avoid race-condition. l = Thread.Mutex()->lock; if (!locks[f]) { locks[f]=l; } } //werror("lock %O\n", f); locked[f]++; key = l(); } return key; } #define LOCK(X) key=_lock(X) #define UNLOCK() do{key=0;}while(0) #else #define LOCK(X) #define UNLOCK() #endif string examine_return_mapping(mapping m) { string res; if (m->extra_heads) m->extra_heads=mkmapping(Array.map(indices(m->extra_heads), lower_case), values(m->extra_heads)); else m->extra_heads=([]); switch (m->error||200) { case 302: // redirect if (m->extra_heads && (m->extra_heads->location)) res = sprintf("Returned redirect to %s ", m->extra_heads->location); else res = "Returned redirect, but no location header. "; break; case 401: if (m->extra_heads["www-authenticate"]) res = sprintf("Returned authentication failed: %s ", m->extra_heads["www-authenticate"]); else res = "Returned authentication failed. "; break; case 200: res = "Returned ok. "; break; default: res = sprintf("Returned %d. ", m->error); } if (!zero_type(m->len)) if (m->len<0) res += "No data "; else res += sprintf("%d bytes ", m->len); else if (stringp(m->data)) res += sprintf("%d bytes ", strlen(m->data)); else if (objectp(m->file)) if (catch { Stat a=m->file->stat(); res += sprintf("%d bytes ", a[1]-m->file->tell()); }) res += "? bytes "; if (m->data) res += "(static)"; else if (m->file) res += "(open file)"; if (stringp(m->extra_heads["content-type"]) || stringp(m->type)) { res += sprintf(" of %s", m->type||m->extra_heads["content-type"]); } res+=" "; return res; } mapping|int(-1..0) low_get_file(RequestID id, int|void no_magic) //! The function that actually tries to find the data requested. All //! modules except last and filter type modules are mapped, in order, //! and the first one that returns a suitable response is used. If //! `no_magic' is set to one, the internal magic roxen images and the //! <ref>find_internal()</ref> callbacks will be ignored. //! //! The return values 0 (no such file) and -1 (the data is a //! directory) are only returned when `no_magic' was set to 1; //! otherwise a result mapping is always generated. { #ifdef MODULE_LEVEL_SECURITY int slevel; #endif #ifdef THREADS Thread.MutexKey key; #endif TRACE_ENTER(sprintf("Request for %s", id->not_query), 0); string file=id->not_query; string loc; function funp; mixed tmp, tmp2; mapping|object(Stdio.File)|int fid; if(!no_magic) { #ifndef NO_INTERNAL_HACK // Find internal-foo-bar images // min length == 17 (/internal-roxen-?..) // This will save some time indeed. string type; if(sizeof(file) > 17 && #if ROXEN_COMPAT <= 2.1 (file[0] == '/') && sscanf(file, "%*s/internal-%s-%[^/]", type, loc) == 3 #else sscanf(file, "/internal-%s-%[^/]", type, loc) == 2 #endif ) { switch(type) { case "roxen": TRACE_LEAVE("Magic internal roxen image"); if(loc=="unit" || loc=="pixel-of-destiny") return (["data":"GIF89a\1\0\1\0\200ÿ\0ÀÀÀ\0\0\0!ù\4\1\0\0\0\0,\0\0\0\0\1\0\1\0\0\1\1""2\0;", "type":"image/gif" ]); if(has_prefix(loc, "pixel-")) return (["data":sprintf("GIF89a\1\0\1\0\200\0\0\0\0\0%c%c%c,\0\0\0\0\1\0\1\0\0\2\2L\1\0;", @parse_color(loc[6..])), "type":"image/gif" ]); return internal_roxen_image(loc, id); case "gopher": TRACE_LEAVE("Magic internal gopher image"); return internal_gopher_image(loc); } } #endif // Locate internal location resources. if(!search(file, query("InternalLoc"))) { TRACE_ENTER("Magic internal module location", 0); RoxenModule module; string name, rest; function find_internal; if(2==sscanf(file[strlen(query("InternalLoc"))..], "%s/%s", name, rest) && (module = find_module(replace(name, "!", "#"))) && (find_internal = module->find_internal)) { #ifdef MODULE_LEVEL_SECURITY if(tmp2 = check_security(find_internal, id, slevel)) if(intp(tmp2)) { TRACE_LEAVE("Permission to access module denied."); find_internal = 0; } else { TRACE_LEAVE(""); TRACE_LEAVE("Request denied."); return tmp2; } #endif if(find_internal) { TRACE_ENTER("Calling find_internal()...", find_internal); LOCK(find_internal); fid=find_internal( rest, id ); UNLOCK(); TRACE_LEAVE(sprintf("find_internal has returned %O", fid)); if(fid) { if(mappingp(fid)) { TRACE_LEAVE(""); TRACE_LEAVE(examine_return_mapping(fid)); return fid; } else { #ifdef MODULE_LEVEL_SECURITY int oslevel = slevel; slevel = misc_cache[ find_internal ][1]; // misc_cache from // check_security id->misc->seclevel = slevel; #endif if(objectp(fid)) TRACE_LEAVE("Returned open filedescriptor. " #ifdef MODULE_LEVEL_SECURITY +(slevel != oslevel? sprintf(" The security level is now %d.", slevel):"") #endif ); else TRACE_LEAVE("Returned directory indicator." #ifdef MODULE_LEVEL_SECURITY +(oslevel != slevel? sprintf(" The security level is now %d.", slevel):"") #endif ); } } else TRACE_LEAVE(""); } else TRACE_LEAVE(""); } else TRACE_LEAVE(""); } } // Well, this just _might_ be somewhat over-optimized, since it is // quite unreadable, but, you cannot win them all.. if(!fid) { #ifdef URL_MODULES // Map URL-modules foreach(url_module_cache||url_modules(), funp) { LOCK(funp); TRACE_ENTER("URL module", funp); tmp=funp( id, file ); UNLOCK(); if(mappingp(tmp)) { TRACE_LEAVE(""); TRACE_LEAVE("Returning data"); return tmp; } if(objectp( tmp )) { array err; nest ++; err = catch { if( nest < 20 ) tmp = (id->conf || this_object())->low_get_file( tmp, no_magic ); else { TRACE_LEAVE("Too deep recursion"); error("Too deep recursion in roxen::get_file() while mapping " +file+".\n"); } }; nest = 0; if(err) throw(err); TRACE_LEAVE(""); TRACE_LEAVE("Returning data"); return tmp; } TRACE_LEAVE(""); } #endif foreach(location_module_cache||location_modules(), tmp) { loc = tmp[0]; if(!search(file, loc)) { TRACE_ENTER(sprintf("Location module [%s] ", loc), tmp[1]); #ifdef MODULE_LEVEL_SECURITY if(tmp2 = check_security(tmp[1], id, slevel)) if(intp(tmp2)) { TRACE_LEAVE("Permission to access module denied."); continue; } else { TRACE_LEAVE(""); TRACE_LEAVE("Request denied."); return tmp2; } #endif TRACE_ENTER("Calling find_file()...", 0); LOCK(tmp[1]); fid=tmp[1]( file[ strlen(loc) .. ] + id->extra_extension, id); UNLOCK(); TRACE_LEAVE(""); if(fid) { id->virtfile = loc; if(mappingp(fid)) { TRACE_LEAVE(""); TRACE_LEAVE(examine_return_mapping(fid)); return fid; } else { #ifdef MODULE_LEVEL_SECURITY int oslevel = slevel; slevel = misc_cache[ tmp[1] ][1]; // misc_cache from // check_security id->misc->seclevel = slevel; #endif if(objectp(fid)) TRACE_LEAVE("Returned open filedescriptor." #ifdef MODULE_LEVEL_SECURITY +(slevel != oslevel? sprintf(" The security level is now %d.", slevel):"") #endif ); else TRACE_LEAVE("Returned directory indicator." #ifdef MODULE_LEVEL_SECURITY +(oslevel != slevel? sprintf(" The security level is now %d.", slevel):"") #endif ); break; } } else TRACE_LEAVE(""); } else if(strlen(loc)-1==strlen(file) && file+"/" == loc) { // This one is here to allow accesses to /local, even if // the mountpoint is /local/. It will slow things down, but... TRACE_ENTER("Automatic redirect to location_module.", tmp[1]); TRACE_LEAVE("Returning data"); // Keep query (if any). // FIXME: Should probably keep config <foo> string new_query = Roxen.http_encode_string(id->not_query) + "/" + (id->query?("?"+id->query):""); new_query=Roxen.add_pre_state(new_query, id->prestate); return Roxen.http_redirect(new_query, id); } } } if(fid == -1) { if(no_magic) { TRACE_LEAVE("No magic requested. Returning -1."); return -1; } if(dir_module) { LOCK(dir_module); TRACE_ENTER("Directory module", dir_module); fid = dir_module->parse_directory(id); UNLOCK(); } else { TRACE_LEAVE("No directory module. Returning 'no such file'"); return 0; } if(mappingp(fid)) { TRACE_LEAVE("Returning data"); return (mapping)fid; } } // Map the file extensions, but only if there is a file... if(objectp(fid) && (tmp = file_extension_modules(loc = Roxen.extension(id->not_query, id)))) { foreach(tmp, funp) { TRACE_ENTER(sprintf("Extension module [%s] ", loc), funp); #ifdef MODULE_LEVEL_SECURITY if(tmp=check_security(funp, id, slevel)) if(intp(tmp)) { TRACE_LEAVE("Permission to access module denied."); continue; } else { TRACE_LEAVE(""); TRACE_LEAVE("Permission denied"); return tmp; } #endif LOCK(funp); tmp=funp(fid, loc, id); UNLOCK(); if(tmp) { if(!objectp(tmp)) { TRACE_LEAVE(""); TRACE_LEAVE("Returning data"); return tmp; } if(fid && tmp != fid) destruct(fid); TRACE_LEAVE("Returned new open file"); fid = tmp; break; } else TRACE_LEAVE(""); } } if(objectp(fid)) { if(stringp(id->extension)) { id->not_query += id->extension; loc = Roxen.extension(id->not_query, id); } TRACE_ENTER("Content-type mapping module", types_module); tmp=type_from_filename(id->not_query, 1, loc); TRACE_LEAVE(tmp?sprintf("Returned type %s %s.", tmp[0], tmp[1]||"") : "Missing type."); if(tmp) { TRACE_LEAVE(""); return ([ "file":fid, "type":tmp[0], "encoding":tmp[1] ]); } TRACE_LEAVE(""); return ([ "file":fid, ]); } if(!fid) TRACE_LEAVE("Returned 'no such file'."); else TRACE_LEAVE("Returning data"); return fid; } mixed handle_request( RequestID id ) { function funp; mixed file; REQUEST_WERR("handle_request()"); foreach(first_module_cache||first_modules(), funp) { if(file = funp( id )) break; if(id->conf != this_object()) { REQUEST_WERR("handle_request(): Redirected (2)"); return id->conf->handle_request(id); } } if(!mappingp(file) && !mappingp(file = get_file(id))) { mixed ret; foreach(last_module_cache||last_modules(), funp) if(ret = funp(id)) break; if (ret == 1) { REQUEST_WERR("handle_request(): Recurse"); return handle_request(id); } file = ret; } REQUEST_WERR("handle_request(): Done"); return file; } mapping get_file(RequestID id, int|void no_magic, int|void internal_get) //! Return a result mapping for the id object at hand, mapping all //! modules, including the filter modules. This function is mostly a //! wrapper for <ref>low_get_file()</ref>. { int orig_internal_get = id->misc->internal_get; id->misc->internal_get = internal_get; mapping|int res; mapping res2; function tmp; res = low_get_file(id, no_magic); // finally map all filter type modules. // Filter modules are like TYPE_LAST modules, but they get called // for _all_ files. foreach(filter_module_cache||filter_modules(), tmp) { TRACE_ENTER("Filter module", tmp); if(res2=tmp(res,id)) { if(res && res->file && (res2->file != res->file)) destruct(res->file); TRACE_LEAVE("Rewrote result."); res=res2; } else TRACE_LEAVE(""); } id->misc->internal_get = orig_internal_get; return res; } array(string) find_dir(string file, RequestID id, void|int(0..1) verbose) { array dir; TRACE_ENTER(sprintf("List directory %O.", file), 0); if(!sizeof (file) || file[0] != '/') file = "/" + file; #ifdef URL_MODULES #ifdef THREADS Thread.MutexKey key; #endif // Map URL-modules foreach(url_modules(), function funp) { string of = id->not_query; id->not_query = file; LOCK(funp); TRACE_ENTER("URL module", funp); mixed remap=funp( id, file ); UNLOCK(); if(mappingp( remap )) { id->not_query=of; TRACE_LEAVE("Returned 'No thanks'."); TRACE_LEAVE(""); return 0; } if(objectp( remap )) { array err; nest ++; TRACE_LEAVE("Recursing"); file = id->not_query; err = catch { if( nest < 20 ) dir = (id->conf || this_object())->find_dir( file, id ); else error("Too deep recursion in roxen::find_dir() while mapping " +file+".\n"); }; nest = 0; TRACE_LEAVE(""); if(err) throw(err); return dir; } id->not_query=of; } #endif /* URL_MODULES */ array | mapping d; array(string) locks=({}); RoxenModule mod; string loc; foreach(location_modules(), array tmp) { loc = tmp[0]; if(!search(file, loc)) { /* file == loc + subpath */ TRACE_ENTER(sprintf("Location module [%s] ", loc), tmp[1]); #ifdef MODULE_LEVEL_SECURITY if(check_security(tmp[1], id)) { TRACE_LEAVE("Permission denied"); continue; } #endif mod=function_object(tmp[1]); if(d=mod->find_dir(file[strlen(loc)..], id)) { if(mappingp(d)) { if(d->files) { TRACE_LEAVE("Got exclusive directory."); TRACE_LEAVE(sprintf("Returning list of %d files.", sizeof(d->files))); return d->files; } else TRACE_LEAVE(""); } else { TRACE_LEAVE("Got files."); if(!dir) dir=({ }); dir |= d; } } else { if(verbose && mod->list_lock_files) locks |= mod->list_lock_files(); TRACE_LEAVE(""); } } else if((search(loc, file)==0) && (loc[strlen(file)-1]=='/') && (loc[0]==loc[-1]) && (loc[-1]=='/') && (function_object(tmp[1])->stat_file(".", id))) { /* loc == file + "/" + subpath + "/" * and stat_file(".") returns non-zero. */ TRACE_ENTER(sprintf("Location module [%s] ", loc), tmp[1]); loc=loc[strlen(file)..]; sscanf(loc, "%s/", loc); if (dir) { dir |= ({ loc }); } else { dir = ({ loc }); } TRACE_LEAVE("Added module mountpoint."); } } if(!dir) return verbose ? ({0})+locks : ([])[0]; if(sizeof(dir)) { TRACE_LEAVE(sprintf("Returning list of %d files.", sizeof(dir))); return dir; } TRACE_LEAVE("Returning 'No such directory'."); return 0; } // Stat a virtual file. array(int)|Stat stat_file(string file, RequestID id) { string loc; mixed s, tmp; #ifdef THREADS Thread.MutexKey key; #endif TRACE_ENTER(sprintf("Stat file %O.", file), 0); file=replace(file, "//", "/"); // "//" is really "/" here... #ifdef URL_MODULES // Map URL-modules foreach(url_modules(), function funp) { string of = id->not_query; id->not_query = file; TRACE_ENTER("URL module", funp); LOCK(funp); tmp=funp( id, file ); UNLOCK(); if(mappingp( tmp )) { id->not_query = of; TRACE_LEAVE(""); TRACE_LEAVE("Returned 'No thanks'."); return 0; } if(objectp( tmp )) { file = id->not_query; array err; nest ++; TRACE_LEAVE("Recursing"); err = catch { if( nest < 20 ) tmp = (id->conf || this_object())->stat_file( file, id ); else error("Too deep recursion in roxen::stat_file() while mapping " +file+".\n"); }; nest = 0; if(err) throw(err); TRACE_LEAVE(""); TRACE_LEAVE("Returning data"); return tmp; } TRACE_LEAVE(""); id->not_query = of; } #endif // Map location-modules. foreach(location_modules(), tmp) { loc = tmp[0]; if((file == loc) || ((file+"/")==loc)) { TRACE_ENTER(sprintf("Location module [%s] ", loc), tmp[1]); TRACE_LEAVE("Exact match."); TRACE_LEAVE(""); return ({ 0775, -3, 0, 0, 0, 0, 0 }); } if(!search(file, loc)) { TRACE_ENTER(sprintf("Location module [%s] ", loc), tmp[1]); #ifdef MODULE_LEVEL_SECURITY if(check_security(tmp[1], id)) { TRACE_LEAVE(""); TRACE_LEAVE("Permission denied"); continue; } #endif if(s=function_object(tmp[1])->stat_file(file[strlen(loc)..], id)) { TRACE_LEAVE(""); TRACE_LEAVE("Stat ok."); return s; } TRACE_LEAVE(""); } } TRACE_LEAVE("Returned 'no such file'."); } mapping error_file( RequestID id ) { string data = query("ZNoSuchFile"); NOCACHE(); #if ROXEN_COMPAT <= 2.1 data = replace(data,({"$File", "$Me"}), ({"&page.virtfile;", "&roxen.server;"})); #endif id->misc->defines = ([ " _error":404 ]); return Roxen.http_rxml_answer( data, id, 0, "text/html" ); } // this is not as trivial as it sounds. Consider gtext. :-) array open_file(string fname, string mode, RequestID id, void|int internal_get) { if( id->conf && (id->conf != this_object()) ) return id->conf->open_file( fname, mode, id, internal_get ); Configuration oc = id->conf; string oq = id->not_query; function funp; mapping|int(0..1) file; id->not_query = fname; foreach(first_modules(), funp) if(file = funp( id )) break; else if(id->conf && (id->conf != oc)) { return id->conf->open_file(fname, mode,id, internal_get); } fname = id->not_query; if(search(mode, "R")!=-1) // raw (as in not parsed..) { string f; mode -= "R"; if(f = real_file(fname, id)) { // werror("opening "+fname+" in raw mode.\n"); return ({ open(f, mode), ([]) }); } // return ({ 0, (["error":302]) }); } if(mode=="r") { if(!file) { file = get_file( id, 0, internal_get ); if(!file) { foreach(last_modules(), funp) if(file = funp( id )) break; if (file == 1) { // Recurse. return open_file(id->not_query, mode, id, internal_get); } } } if(!mappingp(file)) { if(id->misc->error_code) file = Roxen.http_low_answer(id->misc->error_code, "Failed" ); else if(id->method!="GET"&&id->method != "HEAD"&&id->method!="POST") file = Roxen.http_low_answer(501, "Not implemented."); else file = error_file( id ); id->not_query = oq; return ({ 0, file }); } if( file->data ) { file->file = StringFile(file->data); m_delete(file, "data"); } id->not_query = oq; return ({ file->file, file }); } id->not_query = oq; return ({ 0, (["error":501, "data":"Not implemented." ]) }); } mapping(string:array(mixed)) find_dir_stat(string file, RequestID id) { string loc; mapping(string:array(mixed)) dir = ([]); mixed d, tmp; file=replace(file, "//", "/"); if(!sizeof (file) || file[0] != '/') file = "/" + file; // FIXME: Should I append a "/" to file if missing? TRACE_ENTER(sprintf("Request for directory and stat's \"%s\".", file), 0); #ifdef URL_MODULES #ifdef THREADS Thread.MutexKey key; #endif // Map URL-modules foreach(url_modules(), function funp) { string of = id->not_query; id->not_query = file; LOCK(funp); TRACE_ENTER("URL module", funp); tmp=funp( id, file ); UNLOCK(); if(mappingp( tmp )) { id->not_query=of; #ifdef MODULE_DEBUG werror("conf->find_dir_stat(\"%s\"): url_module returned mapping:%O\n", file, tmp); #endif /* MODULE_DEBUG */ TRACE_LEAVE("Returned mapping."+sprintf("%O", tmp)); TRACE_LEAVE(""); return 0; } if(objectp( tmp )) { array err; nest ++; file = id->not_query; err = catch { if( nest < 20 ) tmp = (id->conf || this_object())->find_dir_stat( file, id ); else { TRACE_LEAVE("Too deep recursion"); error("Too deep recursion in roxen::find_dir_stat() while mapping " +file+".\n"); } }; nest = 0; if(err) throw(err); #ifdef MODULE_DEBUG werror("conf->find_dir_stat(\"%s\"): url_module returned object:\n", file); #endif /* MODULE_DEBUG */ TRACE_LEAVE("Returned object."); TRACE_LEAVE("Returning it."); return tmp; // FIXME: Return 0 instead? } id->not_query=of; TRACE_LEAVE(""); } #endif /* URL_MODULES */ foreach(location_modules(), tmp) { loc = tmp[0]; TRACE_ENTER(sprintf("Location module [%s] ", loc), 0); /* Note that only new entries are added. */ if(!search(file, loc)) { /* file == loc + subpath */ #ifdef MODULE_LEVEL_SECURITY if(check_security(tmp[1], id)) continue; #endif RoxenModule c = function_object(tmp[1]); string f = file[strlen(loc)..]; if (c->find_dir_stat) { TRACE_ENTER("Has find_dir_stat().", 0); if (d = c->find_dir_stat(f, id)) { TRACE_ENTER("Returned mapping."+sprintf("%O", d), c); dir = d | dir; TRACE_LEAVE(""); } TRACE_LEAVE(""); } else if(d = c->find_dir(f, id)) { TRACE_ENTER("Returned array.", 0); dir = mkmapping(d, Array.map(d, lambda(string fn) { return c->stat_file(f + fn, id); })) | dir; TRACE_LEAVE(""); } } else if(search(loc, file)==0 && loc[strlen(file)-1]=='/' && (loc[0]==loc[-1]) && loc[-1]=='/' && (function_object(tmp[1])->stat_file(".", id))) { /* loc == file + "/" + subpath + "/" * and stat_file(".") returns non-zero. */ TRACE_ENTER(sprintf("The file %O is on the path to the mountpoint %O.", file, loc), 0); loc=loc[strlen(file)..]; sscanf(loc, "%s/", loc); if (!dir[loc]) { dir[loc] = ({ 0775, -3, 0, 0, 0, 0, 0 }); } TRACE_LEAVE(""); } TRACE_LEAVE(""); } if(sizeof(dir)) return dir; } // Access a virtual file? array access(string file, RequestID id) { string loc; array s, tmp; file=replace(file, "//", "/"); // "//" is really "/" here... // Map location-modules. foreach(location_modules(), tmp) { loc = tmp[0]; if((file+"/")==loc) { #ifdef MODULE_LEVEL_SECURITY if(check_security(tmp[1], id)) continue; #endif if(s=function_object(tmp[1])->access("", id)) return s; } else if(!search(file, loc)) { #ifdef MODULE_LEVEL_SECURITY if(check_security(tmp[1], id)) continue; #endif if(s=function_object(tmp[1])->access(file[strlen(loc)..], id)) return s; } } return 0; } string real_file(string file, RequestID id) //! Return the _real_ filename of a virtual file, if any. { string loc; string s; array tmp; file=replace(file, "//", "/"); // "//" is really "/" here... if(!id) error("No id passed to real_file"); // Map location-modules. foreach(location_modules(), tmp) { loc = tmp[0]; if(!search(file, loc)) { #ifdef MODULE_LEVEL_SECURITY if(check_security(tmp[1], id)) continue; #endif if(s=function_object(tmp[1])->real_file(file[strlen(loc)..], id)) return s; } } } int|string try_get_file(string s, RequestID id, int|void status, int|void nocache, int|void not_internal) //! Convenience function used in quite a lot of modules. Tries to read //! a file into memory, and then returns the resulting string. //! //! NOTE: A 'file' can be a cgi script, which will be executed, //! resulting in a horrible delay. //! //! Unless the not_internal flag is set, this tries to get an external //! or internal file. Here "internal" means a file that never should be //! sent directly as a request response. E.g. an internal redirect to a //! different file is still considered "external" since its contents is //! sent directly to the client. Internal requests are recognized by //! the id->misc->internal_get flag being non-zero. { string res, q, cache_key; RequestID fake_id; mapping m; if(!objectp(id)) error("No ID passed to 'try_get_file'\n"); // id->misc->common makes it possible to pass information to // the originating request. if ( !id->misc ) id->misc = ([]); if ( !id->misc->common ) id->misc->common = ([]); fake_id = id->clone_me(); fake_id->misc->common = id->misc->common; fake_id->misc->internal_get = !not_internal; s = Roxen.fix_relative (s, id); if (fake_id->scan_for_query) // FIXME: If we're using e.g. ftp this doesn't exist. But the // right solution might be that clone_me() in an ftp id object // returns a vanilla (i.e. http) id instead when this function is // used. s = fake_id->scan_for_query (s); fake_id->raw_url=s; fake_id->not_query=s; if(!(m = get_file(fake_id,0,!not_internal))) { // Might be a PATH_INFO type URL. m_delete (fake_id->misc, "path_info"); array a = open_file( s, "r", fake_id, !not_internal ); if(a && a[0]) { m = a[1]; m->file = a[0]; } else { destruct (fake_id); return 0; } } CACHE( fake_id->misc->cacheable ); destruct (fake_id); if (!mappingp(m) && !objectp(m)) { report_error("try_get_file(%O, %O, %O, %O): m = %O is not a mapping.\n", s, id, status, nocache, m); return 0; } // Allow 2* and 3* error codes, not only a few specific ones. if (!(< 0,2,3 >)[m->error/100]) return 0; if(status) return 1; if(m->data) res = m->data; else res=""; m->data = 0; if( objectp(m->file) ) { res += m->file->read(); destruct(m->file); m->file = 0; } if(m->raw) { res -= "\r"; if(!sscanf(res, "%*s\n\n%s", res)) sscanf(res, "%*s\n%s", res); } return res; } int(0..1) is_file(string virt_path, RequestID id) //! Is `virt_path' a file in our virtual filesystem? { return !!stat_file(virt_path, id); } array registered_urls = ({}), failed_urls = ({ }); array do_not_log_patterns = 0; void start(int num) { // Note: This is run as root if roxen is started as root foreach( (registered_urls-query("URLs"))+failed_urls, string url ) { registered_urls -= ({ url }); roxen.unregister_url( url ); } failed_urls = ({ }); int st = gethrtime(); foreach( (query( "URLs" )-registered_urls), string url ) if( roxen.register_url( url, this_object() ) ) registered_urls += ({ url }); else failed_urls += ({ url }); if( !datacache ) datacache = DataCache( ); else datacache->init_from_variables(); parse_log_formats(); init_log_file(); do_not_log_patterns = query("NoLog"); if(!sizeof(do_not_log_patterns)) do_not_log_patterns = 0; } void save_me() { save_one( 0 ); } void save(int|void all) //! Save this configuration. If all is included, save all configuration //! global variables as well, otherwise only all module variables. { if(all) { store("spider#0", variables, 0, this_object()); start(2); } foreach(indices(modules), string modname) { foreach(indices(modules[modname]->copies), int i) { store(modname+"#"+i, modules[modname]->copies[i]->query(), 0, this_object()); catch(modules[modname]->copies[i]->start(2, this_object())); } } invalidate_cache(); } int save_one( RoxenModule o ) //! Save all variables in a given module. { mapping mod; if(!o) { store("spider#0", variables, 0, this_object()); start(2); return 1; } string q = otomod[ o ]; if( !q ) error("Invalid module"); store(q, o->query(), 0, this_object()); invalidate_cache(); mixed error; if( error = catch( o->start(2, this_object()) ) ) { if( objectp(error ) ) error = (array)error; if( sizeof(error)>1 && arrayp( error[1] ) ) { int i; for( i = 0; i<sizeof( error[1] ); i++ ) if( error[1][i][2] == save_one ) break; error[1] = error[1][i+1..]; } if( o->report_error ) o->report_error( "Call to start failed.\n"+describe_backtrace( error ) ); else report_error( "Call to start failed.\n"+describe_backtrace( error )); } invalidate_cache(); return 1; } RoxenModule reload_module( string modname ) { RoxenModule old_module = find_module( modname ); ModuleInfo mi = roxen.find_module( (modname/"#")[0] ); if( !old_module ) return 0; master()->clear_compilation_failures(); if( !old_module->fake ) { save_one( old_module ); master()->refresh_inherit( object_program( old_module ) ); master()->refresh( object_program( old_module ), 1 ); } catch( disable_module( modname, 1 ) ); RoxenModule nm; if( catch( nm = enable_module( modname, 0, 0, 1 ) ) || (nm == 0) ) enable_module( modname, (nm=old_module), mi, 1 ); else { foreach ((array) old_module->error_log, [string msg, array(int) times]) nm->error_log[msg] += times; ModuleInfo mi = roxen.find_module( (modname/"#")[0] ); catch( mi->update_with( nm,0 ) ); // This is sort of nessesary... nm->report_notice(LOC_C(11, "Reloaded %s.")+"\n", mi->get_name()); // It's possible e.g. in the admin interface that the module // being reloaded is in use for the current request, so delay it a // little. //call_out (destruct, 2, old_module); // Nope, can't do that since there are things like lookup caches // that count on that the old module object is gone before the new // is started. destruct (old_module); } call_start_callbacks( nm, mi, modules[ (modname/"#")[0] ] ); return nm; } #ifdef THREADS Thread.Mutex enable_modules_mutex = Thread.Mutex(); #define MODULE_LOCK \ Thread.MutexKey enable_modules_lock = enable_modules_mutex->lock (2) #else #define MODULE_LOCK #endif static int enable_module_batch_msgs; RoxenModule enable_module( string modname, RoxenModule|void me, ModuleInfo|void moduleinfo, int|void nostart ) { MODULE_LOCK; int id; ModuleCopies module; int pr; mixed err; int module_type; if( datacache ) datacache->flush(); if( sscanf(modname, "%s#%d", modname, id ) != 2 ) while( modules[ modname ] && modules[ modname ][ id ] ) id++; int start_time = gethrtime(); if( !moduleinfo ) { moduleinfo = roxen.find_module( modname ); if (!moduleinfo) { report_warning("Failed to load %s. The module probably " "doesn't exist in the module path.\n", modname); got_no_delayed_load = -1; return 0; } } string descr = moduleinfo->get_name() + (id ? " copy " + (id + 1) : ""); #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug(" %-43s... \b", descr ); else report_debug("Enabling " + descr + "\n"); #endif module = modules[ modname ]; if(!module) modules[ modname ] = module = ModuleCopies(); if( !me ) { if(err = catch(me = moduleinfo->instance(this_object()))) { #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bERROR\n"); if (err != "") { #endif string bt=describe_backtrace(err); report_error("enable_module(): " + LOC_M(41, "Error while initiating module copy of %s%s"), moduleinfo->get_name(), (bt ? ":\n"+bt : "\n")); #ifdef MODULE_DEBUG } #endif got_no_delayed_load = -1; return module[id]; } } if(module[id] && module[id] != me) { if( module[id]->stop ) catch( module[id]->stop() ); // if( err = catch( disable_module( modname+"#"+id ) ) ) // report_error(LOCALE->error_disabling_module(moduleinfo->get_name(), // describe_backtrace(err))); } me->set_configuration( this_object() ); module_type = moduleinfo->type; if (module_type & (MODULE_LOCATION|MODULE_EXTENSION| MODULE_CONFIG|MODULE_FILE_EXTENSION|MODULE_LOGGER| MODULE_URL|MODULE_LAST|MODULE_PROVIDER| MODULE_FILTER|MODULE_TAG|MODULE_FIRST)) { if(module_type != MODULE_CONFIG) { if (err = catch { me->defvar("_priority", 5, DLOCALE(12, "Priority"), TYPE_INT_LIST, DLOCALE(13, "The priority of the module. 9 is highest and 0 is lowest." " Modules with the same priority can be assumed to be " "called in random order"), ({0, 1, 2, 3, 4, 5, 6, 7, 8, 9})); }) { throw(err); } } #ifdef MODULE_LEVEL_SECURITY if( (module_type & ~(MODULE_LOGGER|MODULE_PROVIDER)) != 0 ) { me->defvar("_sec_group", "user", DLOCALE(14, "Security: Realm"), TYPE_STRING, DLOCALE(15, "The realm to use when requesting password from the " "client. Usually used as an informative message to the " "user.")); me->defvar("_seclevels", "", DLOCALE(16, "Security: Patterns"), TYPE_TEXT_FIELD, DLOCALE(17, "This is the 'security level=value' list. " "Each security level can be any or more from this list:" "<hr noshade=\"noshade\" />" "allow ip=IP/bits " "allow ip=IP:mask " "allow ip=pattern " "allow user=username,... " "deny ip=IP/bits " "deny ip=IP:mask " "deny ip=pattern " "<hr noshade=\"noshade\" />" "In patterns: * matches one or more characters, " "and ? matches one character." "In username: 'any' stands for any valid account " "(from .htaccess" " or an auth module. The default (used when _no_ " "entries are present) is 'allow ip=*', allowing" " everyone to access the module.")); if(!(module_type & MODULE_PROXY)) { me->defvar("_seclvl", 0, DLOCALE(18, "Security: Security level"), TYPE_INT, DLOCALE(305, "The modules security level is used to determine if a " " request should be handled by the module." "\n<h2>Security level vs Trust level</h2>" " Each module has a configurable security level." " Each request has an assigned trust level. Higher" " trust levels grants access to modules with higher" " security levels." "\n<h2>Definitions</h2><ul>" " <li>A requests initial Trust level is infinitely high.</li>" " <li> A request will only be handled by a module if its" " trust level is higher or equal to the" " security level of the module.</li>" " <li> Each time the request is handled by a module the" " trust level of the module will be set to the" " lower of its trust level and the modules" " security level, unless the security " " level of the module is 0, which is a special " " case and means that no change should be made.</li>" " </ul>" "\n<h2>Example</h2>" " Modules:<ul>" " <li> User filesystem, security level 1</li>" " <li> Filesystem module, security level 3</li>" " <li> CGI module, security level 2</li>" " </ul>" "\nA request handled by \"User filesystem\" is assigned" " a trust level of one after the security" " level of that module. That request can then not be" " handled by the \"CGI module\" since that module has a" " higher security level than the requests trust" " level." "\nOn the other hand, a request handled by the the" " \"Filsystem module\" could later be handled by the" " \"CGI module\".")); } else { me->definvisvar("_seclvl", -10, TYPE_INT); /* A very low one */ } } #endif } else { me->defvar("_priority", 0, "", TYPE_INT, "", 0, 1); } mapping(string:mixed) stored_vars = retrieve(modname + "#" + id, this_object()); int has_stored_vars = sizeof (stored_vars); // A little ugly, but it suffices. me->setvars(stored_vars); module[ id ] = me; otomod[ me ] = modname+"#"+id; if(!nostart) call_start_callbacks( me, moduleinfo, module ); #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bOK %6.1fms\n", (gethrtime()-start_time)/1000.0); #endif if( !enabled_modules[modname+"#"+id] ) { enabled_modules[modname+"#"+id] = 1; store( "EnabledModules", enabled_modules, 1, this_object()); } if (!has_stored_vars) store (modname + "#" + id, me->query(), 0, this_object()); if( me->no_delayed_load && got_no_delayed_load >= 0 ) got_no_delayed_load = 1; return me; } void call_start_callbacks( RoxenModule me, ModuleInfo moduleinfo, ModuleCopies module ) { if(!me) return; if(!moduleinfo) return; if(!module) return; call_low_start_callbacks( me, moduleinfo, module ); mixed err; if((me->start) && (err = catch( me->start(0, this_object()) ) ) ) { #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bERROR\n"); #endif string bt=describe_backtrace(err); report_error(LOC_M(41, "Error while initiating module copy of %s%s"), moduleinfo->get_name(), (bt ? ":\n"+bt : "\n")); got_no_delayed_load = -1; /* Clean up some broken references to this module. */ // m_delete(otomod, me); // m_delete(module->copies, search( module->copies, me )); // destruct(me); // return 0; } if( inited && me->ready_to_receive_requests ) if( mixed q = catch( me->ready_to_receive_requests( this_object() ) ) ) { #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bERROR\n"); #endif report_error( "While calling ready_to_receive_requests:\n"+ describe_backtrace( q ) ); got_no_delayed_load = -1; } } void call_low_start_callbacks( RoxenModule me, ModuleInfo moduleinfo, ModuleCopies module ) { if(!me) return; if(!moduleinfo) return; if(!module) return; int module_type = moduleinfo->type, pr; mixed err; if (err = catch(pr = me->query("_priority"))) { #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bERROR\n"); #endif string bt=describe_backtrace(err); report_error(LOC_M(41, "Error while initiating module copy of %s%s"), moduleinfo->get_name(), (bt ? ":\n"+bt : "\n")); pr = 3; } api_module_cache |= me->api_functions(); if(module_type & MODULE_EXTENSION) { report_error("%s is an MODULE_EXTENSION, that type is no " "longer available.\nPlease notify the modules writer.\n" "Suitable replacement types include MODULE_FIRST and " " MODULE_LAST.\n", moduleinfo->get_name()); } if(module_type & MODULE_FILE_EXTENSION) if (err = catch { array arr = me->query_file_extensions(); if (arrayp(arr)) { string foo; foreach( me->query_file_extensions(), foo ) if(pri[pr]->file_extension_modules[foo] ) pri[pr]->file_extension_modules[foo]+=({me}); else pri[pr]->file_extension_modules[foo]=({me}); } }) { #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bERROR\n"); #endif string bt=describe_backtrace(err); report_error(LOC_M(41, "Error while initiating module copy of %s%s"), moduleinfo->get_name(), (bt ? ":\n"+bt : "\n")); got_no_delayed_load = -1; } if(module_type & MODULE_PROVIDER) if (err = catch { mixed provs = me->query_provides(); if(stringp(provs)) provs = (< provs >); if(arrayp(provs)) provs = mkmultiset(provs); if (multisetp(provs)) { pri[pr]->provider_modules [ me ] = provs; } }) { #ifdef MODULE_DEBUG if (enable_module_batch_msgs) report_debug("\bERROR\n"); #endif string bt=describe_backtrace(err); report_error(LOC_M(41, "Error while initiating module copy of %s%s"), moduleinfo->get_name(), (bt ? ":\n"+bt : "\n")); got_no_delayed_load = -1; } if(module_type & MODULE_TYPES) { types_module = me; types_fun = me->type_from_extension; } if(module_type & MODULE_TAG) add_parse_module( me ); if(module_type & MODULE_DIRECTORIES) if (me->parse_directory) dir_module = me; if(module_type & MODULE_LOCATION) pri[pr]->location_modules += ({ me }); if(module_type & MODULE_LOGGER) pri[pr]->logger_modules += ({ me }); if(module_type & MODULE_URL) pri[pr]->url_modules += ({ me }); if(module_type & MODULE_LAST) pri[pr]->last_modules += ({ me }); if(module_type & MODULE_FILTER) pri[pr]->filter_modules += ({ me }); if(module_type & MODULE_FIRST) pri[pr]->first_modules += ({ me }); invalidate_cache(); } // Called from the administration interface. string check_variable(string name, mixed value) { switch(name) { // case "MyWorldLocation": // if(strlen(value)<7 || value[-1] != '/' || // !(sscanf(value,"%*s://%*s/")==2)) // return LOCALE->url_format(); // return 0; case "throttle": if (value) { THROTTLING_DEBUG("configuration: Starting throttler up"); throttler=.throttler(); throttler->throttle(query("throttle_fill_rate"), query("throttle_bucket_depth"), query("throttle_min_grant"), query("throttle_max_grant")); } else { if (throttler) { //check, or get a backtrace the first time it's set THROTTLING_DEBUG("configuration: Stopping throttler"); destruct(throttler); throttler=0; } } return 0; case "throttle_fill_rate": case "throttle_bucket_depth": case "throttle_min_grant": case "throttle_max_grant": THROTTLING_DEBUG("configuration: setting throttling parameter: "+ name+"="+value); throttler->throttle(query("throttle_fill_rate"), query("throttle_bucket_depth"), query("throttle_min_grant"), query("throttle_max_grant")); return 0; } } void module_changed( ModuleInfo moduleinfo, RoxenModule me ) { clean_up_for_module( moduleinfo, me ); call_low_start_callbacks( me, moduleinfo, modules[ moduleinfo->sname ] ); } void clean_up_for_module( ModuleInfo moduleinfo, RoxenModule me ) { int pr; if(moduleinfo->type & MODULE_FILE_EXTENSION) { string foo; for(pr=0; pr<10; pr++) foreach( indices (pri[pr]->file_extension_modules), foo ) pri[pr]->file_extension_modules[foo]-=({me}); } if(moduleinfo->type & MODULE_PROVIDER) { for(pr=0; pr<10; pr++) m_delete(pri[pr]->provider_modules, me); } if(moduleinfo->type & MODULE_TYPES) { types_module = 0; types_fun = 0; } if(moduleinfo->type & MODULE_TAG) remove_parse_module( me ); if( moduleinfo->type & MODULE_DIRECTORIES ) dir_module = 0; if( moduleinfo->type & MODULE_LOCATION ) for(pr=0; pr<10; pr++) pri[pr]->location_modules -= ({ me }); if( moduleinfo->type & MODULE_URL ) for(pr=0; pr<10; pr++) pri[pr]->url_modules -= ({ me }); if( moduleinfo->type & MODULE_LAST ) for(pr=0; pr<10; pr++) pri[pr]->last_modules -= ({ me }); if( moduleinfo->type & MODULE_FILTER ) for(pr=0; pr<10; pr++) pri[pr]->filter_modules -= ({ me }); if( moduleinfo->type & MODULE_FIRST ) { for(pr=0; pr<10; pr++) pri[pr]->first_modules -= ({ me }); } if( moduleinfo->type & MODULE_LOGGER ) for(pr=0; pr<10; pr++) pri[pr]->logger_modules -= ({ me }); } int disable_module( string modname, int|void nodest ) { MODULE_LOCK; RoxenModule me; int id, pr; sscanf(modname, "%s#%d", modname, id ); if( datacache ) datacache->flush(); ModuleInfo moduleinfo = roxen.find_module( modname ); mapping module = modules[ modname ]; string descr = moduleinfo->get_name() + (id ? " copy " + (id + 1) : ""); if(!module) { report_error("disable_module(): " + LOC_M(42, "Failed to disable module:\n" "No module by that name: \"%s\".\n"), modname); return 0; } me = module[id]; m_delete(module->copies, id); if(!sizeof(module->copies)) m_delete( modules, modname ); invalidate_cache(); if(!me) { report_error("disable_module(): " + LOC_M(43, "Failed to disable module \"%s\".\n"), descr); return 0; } if(me->stop) if (mixed err = catch (me->stop())) { string bt=describe_backtrace(err); report_error("disable_module(): " + LOC_M(44, "Error while disabling module %s%s"), descr, (bt ? ":\n"+bt : "\n")); } #ifdef MODULE_DEBUG report_debug("Disabling "+descr+"\n"); #endif clean_up_for_module( moduleinfo, me ); m_delete( enabled_modules, modname + "#" + id ); forcibly_added[ modname + "#" + id ] = 0; store( "EnabledModules",enabled_modules, 1, this_object()); if(!nodest) destruct(me); return 1; } RoxenModule find_module(string name) //! Return the module corresponding to the name (eg "rxmlparse", //! "rxmlparse#0" or "filesystem#1") or zero, if there was no such //! module. { int id; sscanf(name, "%s#%d", name, id); if(modules[name]) return modules[name]->copies[id]; return 0; } multiset forcibly_added = (<>); int add_modules( array(string) mods, int|void now ) { #ifdef MODULE_DEBUG int wr; #endif foreach (mods, string mod) { sscanf( mod, "%s#", mod ); if( ((now && !modules[ mod ]) || !enabled_modules[ mod+"#0" ] ) && !forcibly_added[ mod+"#0" ]) { #ifdef MODULE_DEBUG if( !wr++ ) if (enable_module_batch_msgs) report_debug("\b[ adding req module" + (sizeof (mods) > 1 ? "s" : "") + "\n"); else report_debug("Adding required module" + (sizeof (mods) > 1 ? "s" : "") + "\n"); #endif forcibly_added[ mod+"#0" ] = 1; enable_module( mod+"#0" ); } } #ifdef MODULE_DEBUG if( wr && enable_module_batch_msgs ) report_debug("] \b"); #endif } #if ROXEN_COMPAT < 2.2 // BEGIN SQL mapping(string:string) sql_urls = ([]); mapping sql_cache = ([]); Sql.Sql sql_cache_get(string what) { #ifdef THREADS if(sql_cache[what] && sql_cache[what][this_thread()]) return sql_cache[what][this_thread()]; if(!sql_cache[what]) sql_cache[what] = ([ this_thread():Sql.Sql( what ) ]); else sql_cache[what][ this_thread() ] = Sql.Sql( what ); return sql_cache[what][ this_thread() ]; #else /* !THREADS */ if(!sql_cache[what]) sql_cache[what] = Sql.Sql( what ); return sql_cache[what]; #endif } Sql.Sql sql_connect(string db) { if (sql_urls[db]) return sql_cache_get(sql_urls[db]); else return sql_cache_get(db); } // END SQL #endif // This is the most likely URL for a site. private string get_my_url() { string s; #if efun(gethostname) s = (gethostname()/".")[0] + "." + query("Domain"); s -= "\n"; #else s = "localhost"; #endif return "http://" + s + "/"; } array after_init_hooks = ({}); mixed add_init_hook( mixed what ) { if( inited ) call_out( what, 0, this_object() ); else after_init_hooks |= ({ what }); } static int got_no_delayed_load = 0; // 0 -> enabled delayed loading, 1 -> disable delayed loading, // -1 -> don't change. void fix_no_delayed_load_flag() { if( got_no_delayed_load >= 0 && query ("no_delayed_load") != got_no_delayed_load ) { set( "no_delayed_load", got_no_delayed_load ); save_one( 0 ); } } void enable_all_modules() { MODULE_LOCK; low_init( ); fix_no_delayed_load_flag(); } void low_init(void|int modules_already_enabled) { if( inited ) return; // already done int start_time = gethrtime(); if (!modules_already_enabled) report_debug("\nEnabling all modules for "+query_name()+"... \n"); add_parse_module( (object)this_object() ); if (!modules_already_enabled) { enabled_modules = retrieve("EnabledModules", this_object()); roxenloader.LowErrorContainer ec = roxenloader.LowErrorContainer(); roxenloader.push_compile_error_handler( ec ); array modules_to_process = indices( enabled_modules ); string tmp_string; array err; forcibly_added = (<>); enable_module_batch_msgs = 1; foreach( modules_to_process, tmp_string ) { if( !forcibly_added[ tmp_string ] ) if(err = catch( enable_module( tmp_string ))) { report_error(LOC_M(45, "Failed to enable the module %s. Skipping.\n%s"), tmp_string, describe_backtrace(err)); got_no_delayed_load = -1; } } enable_module_batch_msgs = 0; roxenloader.pop_compile_error_handler(); if( strlen( ec->get() ) ) report_error( "While enabling modules in "+name+":\n"+ec->get() ); if( strlen( ec->get_warnings() ) ) report_warning( "While enabling modules in "+name+":\n"+ec->get_warnings()); } foreach( ({this_object()})+indices( otomod ), RoxenModule mod ) if( mod->ready_to_receive_requests ) if( mixed q = catch( mod->ready_to_receive_requests( this_object() ) ) ) { report_error( "While calling ready_to_receive_requests in "+ otomod[mod]+":\n"+ describe_backtrace( q ) ); got_no_delayed_load = -1; } foreach( after_init_hooks, function q ) if( mixed w = catch( q(this_object()) ) ) { report_error( "While calling after_init_hook %O:\n%s", q, describe_backtrace( w ) ); got_no_delayed_load = -1; } after_init_hooks = ({}); inited = 1; if (!modules_already_enabled) report_notice(LOC_S(4, "All modules for %s enabled in %3.1f seconds") + "\n\n", query_name(), (gethrtime()-start_time)/1000000.0); } DataCache datacache; static void create(string config) { name=config; // int st = gethrtime(); roxen.add_permission( "Site:"+config, LOC_C(306,"Site")+": "+config ); // for now only theese two. In the future there might be more variables. defvar( "data_cache_size", 2048, DLOCALE(274, "Cache:Cache size"), TYPE_INT| VAR_PUBLIC, DLOCALE(275, "The size of the data cache used to speed up requests " "for commonly requested files, in KBytes")); defvar( "data_cache_file_max_size", 50, DLOCALE(276, "Cache:Max file size"), TYPE_INT | VAR_PUBLIC, DLOCALE(277, "The maximum size of a file that is to be considered for " "the cache")); defvar("default_server", 0, DLOCALE(20, "Default site"), TYPE_FLAG| VAR_PUBLIC, DLOCALE(21, "If true, this site will be selected in preference of " "other sites when virtual hosting is used and no host " "header is supplied, or the supplied host header does not " "match the address of any of the other servers.") ); defvar("comment", "", DLOCALE(22, "Site comment"), TYPE_TEXT_FIELD|VAR_MORE, DLOCALE(23, "This text will be visible in the administration " "interface, it can be quite useful to use as a memory helper.")); defvar("name", "", DLOCALE(24, "Site name"), TYPE_STRING|VAR_MORE| VAR_PUBLIC, DLOCALE(25, "This is the name that will be used in the administration " "interface. If this is left empty, the actual name of the " "site will be used.")); defvar("LogFormat", "404: $host $referer - [$cern_date] \"$method $resource $protocol\" 404 -\n" "500: $host $referer ERROR [$cern_date] \"$method $resource $protocol\" 500 -\n" "*: $host - - [$cern_date] \"$method $resource $protocol\" $response $length", DLOCALE(26, "Logging: Format"), TYPE_TEXT_FIELD|VAR_MORE, DLOCALE(27, "What format to use for logging. The syntax is:\n" "<pre>" "response-code or *: Log format for that response code\n\n" "Log format is normal characters, or one or more of the " "variables below:\n" "\n" "\\n \\t \\r -- As in C, newline, tab and linefeed\n" "$char(int) -- Insert the (1 byte) character specified by the integer.\n" "$wchar(int) -- Insert the (2 byte) word specified by the integer.\n" "$int(int) -- Insert the (4 byte) word specified by the integer.\n" "$^ -- Supress newline at the end of the logentry\n" "$host -- The remote host name, or ip number.\n" "$ip_number -- The remote ip number.\n" "$bin-ip_number -- The remote host id as a binary integer number.\n" "\n" "$cern_date -- Cern Common Log file format date.\n" "$bin-date -- Time, but as an 32 bit integer in network byteorder\n" "\n" "$method -- Request method\n" "$resource -- Resource identifier\n" "$full_resource -- Full requested resource, including any query fields\n" "$protocol -- The protocol used (normally HTTP/1.0)\n" "$response -- The response code sent\n" "$bin-response -- The response code sent as a binary short number\n" "$length -- The length of the data section of the reply\n" "$bin-length -- Same, but as an 32 bit integer in network byteorder\n" "$request-time -- The time the request took (seconds)\n" "$referer -- the header 'referer' from the request, or '-'.\n" "$user_agent -- the header 'User-Agent' from the request, or '-'.\n\n" "$user -- the name of the auth user used, if any\n" "$user_id -- A unique user ID, if cookies are supported,\n" " by the client, otherwise '0'\n" "</pre>"), 0, lambda(){ return !query("Log");}); defvar("Log", 1, DLOCALE(28, "Logging: Enabled"), TYPE_FLAG, DLOCALE(29, "Log requests")); // FIXME: Mention it is relative to getcwd(). Can not be localized in pike 7.0. defvar("LogFile", "$LOGDIR/"+Roxen.short_name(name)+"/Log", DLOCALE(30, "Logging: Log file"), TYPE_FILE, DLOCALE(31, "The log file. " "" "A file name. Some substitutions will be done:" "<pre>" "%y Year (e.g. '1997')\n" "%m Month (e.g. '08')\n" "%d Date (e.g. '10' for the tenth)\n" "%h Hour (e.g. '00')\n" "%H Hostname\n" "</pre>") ,0, lambda(){ return !query("Log");}); defvar("NoLog", ({ }), DLOCALE(32, "Logging: No Logging for"), TYPE_STRING_LIST|VAR_MORE, DLOCALE(33, "Don't log requests from hosts with an IP number which " "matches any of the patterns in this list. This also affects " "the access counter log."), 0, lambda(){ return !query("Log");}); defvar("Domain", roxen.get_domain(), DLOCALE(34, "Domain"), TYPE_STRING|VAR_PUBLIC, DLOCALE(35, "The domain name of the server. The domain name is used " "to generate default URLs, and to generate email addresses.")); defvar("MyWorldLocation", "http://"+gethostname()+"/", DLOCALE(36, "Primary Server URL"), TYPE_URL|VAR_PUBLIC, DLOCALE(37, "This is the main server URL, where your start page is " "located. Please note that you also have to configure the " "'URLs' variable.")); defvar("URLs", Variable.PortList( ({"http://*/"}), VAR_INITIAL, DLOCALE(38, "URLs"), DLOCALE(39, "Bind to these URLs. You can use '*' and '?' to perform" " globbing (using any of these will default to binding to " "all IP-numbers on your machine). The possible protocols " "are http, fhttp (a faster version of the normal HTTP " "protocol, but not 100% compatible with all modules) " "https, ftp, ftps, gopher and tetris."))); defvar("InternalLoc", "/_internal/", DLOCALE(40, "Internal module resource mountpoint"), TYPE_LOCATION|VAR_MORE|VAR_DEVELOPER, DLOCALE(41, "Some modules may want to create links to internal " "resources. This setting configures an internally handled " "location that can be used for such purposes. Simply select " "a location that you are not likely to use for regular " "resources.")); // Throttling-related variables defvar("throttle", 0, DLOCALE(42, "Throttling: Server; Enabled"),TYPE_FLAG, DLOCALE(43, "If set, per-server bandwidth throttling will be enabled. " "It will allow you to limit the total available bandwidth for " "this site. Bandwidth is assigned using a Token Bucket. " "The principle under which it works is: for each byte we send we use a token. " "Tokens are added to a repository at a constant rate. When there's not enough, " "we can't transmit. When there's too many, they \"spill\" and are lost.")); //TODO: move this explanation somewhere on the website and just put a link. defvar("throttle_fill_rate", 102400, DLOCALE(44, "Throttling: Server; Average available bandwidth"), TYPE_INT, DLOCALE(45, "This is the average bandwidth available to this site in " "bytes/sec (the bucket \"fill rate\")."), 0, arent_we_throttling_server); defvar("throttle_bucket_depth", 1024000, DLOCALE(46, "Throttling: Server; Bucket Depth"), TYPE_INT, DLOCALE(47, "This is the maximum depth of the bucket. After a long enough period " "of inactivity, a request will get this many unthrottled bytes of data, before " "throttling kicks back in. Set equal to the Fill Rate in order not to allow " "any data bursts. This value determines the length of the time over which the " "bandwidth is averaged."), 0, arent_we_throttling_server); defvar("throttle_min_grant", 1300, DLOCALE(48, "Throttling: Server; Minimum Grant"), TYPE_INT, DLOCALE(49, "When the bandwidth availability is below this value, connections will " "be delayed rather than granted minimal amounts of bandwidth. The purpose " "is to avoid sending too small packets (which would increase the IP overhead)."), 0, arent_we_throttling_server); defvar("throttle_max_grant", 14900, DLOCALE(50, "Throttling: Server; Maximum Grant"), TYPE_INT, DLOCALE(51, "This is the maximum number of bytes assigned in a single request " "to a connection. Keeping this number low will share bandwidth more evenly " "among the pending connections, but keeping it too low will increase IP " "overhead and (marginally) CPU usage. You'll want to set it just a tiny " "bit lower than any integer multiple of your network's MTU (typically 1500 " "for ethernet)."), 0, arent_we_throttling_server); defvar("req_throttle", 0, DLOCALE(52, "Throttling: Request; Enabled"), TYPE_FLAG, DLOCALE(53, "If set, per-request bandwidth throttling will be enabled.") ); defvar("req_throttle_min", 1024, DLOCALE(54, "Throttling: Request; Minimum guarranteed bandwidth"), TYPE_INT, DLOCALE(55, "The maximum bandwidth each connection (in bytes/sec) can use is determined " "combining a number of modules. But doing so can lead to too small " "or even negative bandwidths for particularly unlucky requests. This variable " "guarantees a minimum bandwidth for each request."), 0, arent_we_throttling_request); defvar("req_throttle_depth_mult", 60.0, DLOCALE(56, "Throttling: Request; Bucket Depth Multiplier"), TYPE_FLOAT, DLOCALE(57, "The average bandwidth available for each request will be determined by " "the modules combination. The bucket depth will be determined multiplying " "the rate by this factor."), 0, arent_we_throttling_request); defvar("404-files", ({ "404.inc" }), DLOCALE(307, "No such file message override files"), TYPE_STRING_LIST|VAR_PUBLIC, DLOCALE(308, "If no file match a given resource all directories above the" " wanted file is searched for one of the files in this list." "\n" "As an example, if the file /foo/bar/not_there.html is " "wanted, and this list contains the default value of 404.inc," " these files will be searched for, in this order: " " /foo/bar/404.inc, /foo/404.inc and /404.inc." ) ); class NoSuchFileOverride { // compatibility with old config-files. inherit Variable.Variable; int check_visibility( RequestID id, int more_mode, int expert_mode, int devel_mode, int initial, int|void variable_in_cfif ) { return 0; } void set( string newval ) { if( search(newval,"emit source=values") == -1 ) variables[ "404-message" ]->set( newval ); } void create() { ::create( #"<nooutput><emit source=values scope=ef variable='modvar.site.404-files'> <set variable='var.base' value=''/> <emit source='path'> <append variable='var.base' value='/&_.name;'/> <set variable='var.404' value='&var.base;/&ef.value;'/> <if exists='&var.404;'> <set variable='var.errfile' from='var.404'/> </if> </emit> </emit> </nooutput><if variable='var.errfile'><eval><insert file='&var.errfile;'/></eval></if><else><eval>&modvar.site.404-message:none;</eval></else>", 0, 0, 0 ); } }; defvar("ZNoSuchFile", NoSuchFileOverride() ); defvar("404-message", #" <html><head> <title>404 - Page not found</title> </head> <body alink=\"#000000\" bgcolor=\"#ffffff\" bottommargin=\"0\" leftmargin=\"0\" link=\"#ce5c00\" marginheight=\"2\" marginwidth=\"0\" rightmargin=\"0\" text=\"#333333\" topmargin=\"2\" vlink=\"#ce5c00\"> <if nserious=''><set variable='var.404' value='-sorry' /></if> <table width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"0\"> <tr> <td><img src=\"/internal-roxen-page-not-found&var.404;\" border=\"0\" alt=\"Page not found\" width=\"404\" hspace=\"2\" /></td> <td> </td> <td align=\"right\"> Roxen WebServer &roxen.base-version; </td> </tr> <tr> <td width=\"100%\" height=\"21\" colspan=\"3\" background=\"/internal-roxen-tile\"><img src=\"/internal-roxen-unit\" alt=\"\" /></td> </tr> </table> <h2> Unable to retrieve &page.virtfile;.</h2> <blockquote> If you feel that this is a configuration error, please contact the administrators of this webserver or the author of the <if referrer=''> <a href=\"&client.referrer;\">referring</a> </if><else> referring </else> page. </blockquote> </body> ", DLOCALE(58, "No such file message"), TYPE_TEXT_FIELD|VAR_PUBLIC, DLOCALE(59, "What to return when there is no resource or file " "available at a certain location.")); definvisvar( "no_delayed_load", 0, TYPE_FLAG|VAR_PUBLIC ); // werror("[defvar: %.1fms] ", (gethrtime()-st)/1000.0 ); // st = gethrtime(); setvars( retrieve("spider#0", this_object()) ); // werror("[restore: %.1fms] ", (gethrtime()-st)/1000.0 ); if (query("throttle")) { throttler=.throttler(); throttler->throttle(query("throttle_fill_rate"), query("throttle_bucket_depth"), query("throttle_min_grant"), query("throttle_max_grant")); } } static int arent_we_throttling_server () { return !query("throttle"); } static int arent_we_throttling_request() { return !query("req_throttle"); }

Roxen.git/ server/ base_server/ configuration.pike > 6a6a8c7bf2a36582c89b96b99b41a72d6e2e10ce [Annotate]