Roxen.git/server/base_server/prototypes.pike:4d0c6687a0b40fbfd57cedab9acec2a1ef95a943

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 // This file is part of Roxen WebServer. // Copyright © 2001 - 2004, Roxen IS. #include <stat.h> #include <config.h> #include <module.h> #include <variables.h> #include <module_constants.h> constant cvs_version="$Id: prototypes.pike,v 1.186 2006/09/27 15:07:34 mast Exp $"; #ifdef DAV_DEBUG #define DAV_WERROR(X...) werror(X) #else /* !DAV_DEBUG */ #define DAV_WERROR(X...) #endif /* DAV_DEBUG */ #ifdef VARY_DEBUG #define VARY_WERROR(X...) werror("VARY: " + X) #else #define VARY_WERROR(X...) #endif /* VARY_DEBUG */ // To avoid reference cycles. Set to the Roxen module object by // roxenloader.pike. object Roxen; // Externally visible identifiers in this file that shouldn't be added // as global constants by roxenloader.pike. constant ignore_identifiers = (< "cvs_version", "Roxen", "ignore_identifiers" >); static class Variable { constant is_variable = 1; constant type = "Basic"; string get_warnings(); int get_flags(); void set_flags( int flags ); int check_visibility( RequestID id, int more_mode, int expert_mode, int devel_mode, int initial, int|void variable_in_cfif ); void set_invisibility_check_callback( function(RequestID,Variable:int) cb ); function(Variable:void) get_changed_callback( ); void set_changed_callback( function(Variable:void) cb ); void add_changed_callback( function(Variable:void) cb ); function(RequestID,Variable:int) get_invisibility_check_callback() ; string doc( ); string name( ); string type_hint( ); mixed default_value(); void set_warning( string to ); int set( mixed to ); int low_set( mixed to ); mixed query(); int is_defaulted(); array(string|mixed) verify_set( mixed new_value ); mapping(string:string) get_form_vars( RequestID id ); mixed transform_from_form( string what ); void set_from_form( RequestID id ); string path(); void set_path( string to ); string render_form( RequestID id, void|mapping additional_args ); string render_view( RequestID id ); } class BasicDefvar { mapping(string:Variable) variables=([]); Variable getvar( string name ); int deflocaledoc( string locale, string variable, string name, string doc, mapping|void translate ); void set(string var, mixed value); int killvar(string var); void setvars( mapping (string:mixed) vars ); Variable defvar(string var, mixed value, mapping|string|void|object name, int|void type, mapping|string|void|object doc_str, mixed|void misc, int|function|void not_in_config, mapping|void option_translations); mixed query(string|void var, int|void ok); void definvisvar(string name, mixed value, int type, array|void misc); } class StringFile( string data, mixed|void _st ) { int offset; string _sprintf() { return "StringFile("+strlen(data)+","+offset+")"; } string read(int nbytes) { if(!nbytes) { offset = strlen(data); return data; } string d = data[offset..offset+nbytes-1]; offset += strlen(d); return d; } array stat() { if( _st ) return (array)_st; return ({ 0, strlen(data), time(), time(), time(), 0, 0, 0 }); } void write(mixed ... args) { throw( ({ "File not open for write\n", backtrace() }) ); } void seek(int to) { offset = to; } } class ModuleInfo { string sname; string filename; int last_checked; int type, multiple_copies; int|string locked; mapping(Configuration:int) config_locked; string get_name(); string get_description(); RoxenModule instance( object conf, void|int silent ); void save(); void update_with( RoxenModule mod, string what ); // NOTE: Throws strings. int init_module( string what ); int find_module( string sn ); int check (void|int force); } class ModuleCopies { mapping copies = ([]); mixed `[](mixed q ) { return copies[q]; } mixed `[]=(mixed q,mixed w ) { return copies[q]=w; } array _indices() { return indices(copies); } array _values() { return values(copies); } string _sprintf( ) { return "ModuleCopies("+sizeof(copies)+")"; } } // Simulate an import of useful stuff from Parser.XML.Tree. static constant SimpleNode = Parser.XML.Tree.SimpleNode; static constant SimpleRootNode = Parser.XML.Tree.SimpleRootNode; static constant SimpleHeaderNode = Parser.XML.Tree.SimpleHeaderNode; static constant SimpleTextNode = Parser.XML.Tree.SimpleTextNode; static constant SimpleElementNode = Parser.XML.Tree.SimpleElementNode; //! @appears DAVLock //! //! Container for information about an outstanding DAV lock. No field //! except @[owner] may change after the object has been created since //! filesystem modules might store this info persistently. //! //! @note //! @[DAVLock] objects might be shared between filesystems but not //! between configurations. class DAVLock { string locktoken; //! The lock token given to the client. It may be zero in case there //! only is knowledge that a lock exists but the lock instance has //! been forgotten. This can happen in a filesystem that has some //! way of recording locks but doesn't store the DAV lock tokens. string path; //! Canonical absolute path to the locked resource. Always ends with //! a @expr{"/"@}. int(0..1) recursive; //! @expr{1@} if the lock applies to all resources under @[path], //! @expr{0@} if it applies to @[path] only. string|SimpleNode lockscope; //! The lock scope (RFC 2518 12.7). As a special case, if it only is //! an empty element without attributes then the element name is //! stored as a string. //! //! @note //! RFC 2518 specifies the lock scopes @expr{"DAV:exclusive"@} and //! @expr{"DAV:shared"@}. string|SimpleNode locktype; //! The lock type (RFC 2518 12.8). As a special case, if it only is //! an empty element without attributes then the element name is //! stored as a string. //! //! @note //! RFC 2518 only specifies the lock type @expr{"DAV:write"@}. int(0..) expiry_delta; //! Idle time before this lock expires. //! //! As a special case, if the value is @expr{0@} (zero), the lock //! has infinite duration. array(SimpleNode) owner; //! The owner identification (RFC 2518 12.10), or zero if unknown. //! More precisely, it's the children of the @expr{"DAV:owner"@} //! element. //! //! @[RoxenModule.lock_file] may set this if it's zero, otherwise //! it shouldn't change. int(0..) expiry_time; //! Absolute time when this lock expires. //! //! As a special case, if the value is @expr{0@} (zero), the lock //! has infinite duration. static void create(string locktoken, string path, int(0..1) recursive, string|SimpleNode lockscope, string|SimpleNode locktype, int(0..) expiry_delta, array(SimpleNode) owner) { DAVLock::locktoken = locktoken; DAVLock::path = path; DAVLock::recursive = recursive; DAVLock::lockscope = lockscope; DAVLock::locktype = locktype; DAVLock::expiry_delta = expiry_delta; DAVLock::owner = owner; if (expiry_delta) { if (expiry_delta < 0) error("Negative expiry delta!\n"); expiry_time = time() + expiry_delta; } } //! Returns a DAV:activelock @[Parser.XML.Tree.SimpleNode] structure //! describing the lock. SimpleNode get_xml() { SimpleElementNode res = SimpleElementNode("DAV:activelock", ([]))-> add_child(SimpleElementNode("DAV:locktype", ([]))-> add_child(stringp(locktype)? SimpleElementNode(locktype, ([])):locktype))-> add_child(SimpleElementNode("DAV:lockscope", ([]))-> add_child(stringp(lockscope)? SimpleElementNode(lockscope, ([])):lockscope))-> add_child(SimpleElementNode("DAV:depth", ([]))-> add_child(recursive? SimpleTextNode("Infinity"):SimpleTextNode("0"))); if (owner) { SimpleElementNode node; res->add_child(node = SimpleElementNode("DAV:owner", ([]))); node->replace_children(owner); } if (expiry_delta) { res->add_child(SimpleElementNode("DAV:timeout", ([]))-> add_child(SimpleTextNode(sprintf("Second-%d", expiry_delta)))); } else { res->add_child(SimpleElementNode("DAV:timeout", ([]))-> add_child(SimpleTextNode("Infinite"))); } res->add_child(SimpleElementNode("DAV:locktoken", ([]))-> add_child(SimpleElementNode("DAV:href", ([]))-> add_child(SimpleTextNode(locktoken)))); return res; } static string _sprintf (int flag) { return flag == 'O' && sprintf ("DAVLock(%O on %O, %s, %s%s)", locktoken, path, recursive ? "rec" : "norec", lockscope == "DAV:exclusive" ? "excl" : lockscope == "DAV:shared" ? "shared" : sprintf ("%O", lockscope), locktype == "DAV:write" ? "" : sprintf (", %O", locktype)); } } //! @appears Configuration //! Configuration information for a site. //! @seealso //! @[configuration] class Configuration { inherit BasicDefvar; constant is_configuration = 1; mapping enabled_modules = ([]); mapping(string:array(int)) error_log=([]); #ifdef PROFILE mapping(string:array(int)) profile_map = ([]); #endif class Priority { string _sprintf() { return "Priority()"; } array (RoxenModule) url_modules = ({ }); array (RoxenModule) logger_modules = ({ }); array (RoxenModule) location_modules = ({ }); array (RoxenModule) filter_modules = ({ }); array (RoxenModule) last_modules = ({ }); array (RoxenModule) first_modules = ({ }); mapping (string:array(RoxenModule)) file_extension_modules = ([ ]); mapping (RoxenModule:multiset(string)) provider_modules = ([ ]); } class DataCache { int current_size, max_size, max_file_size; int hits, misses; void flush(); void expire_entry(string url, RequestID id); void set(string url, string data, mapping meta, int expire, RequestID id); array(string|mapping(string:mixed)) get(string url, RequestID id); void init_from_variables( ); }; array(Priority) allocate_pris(); object throttler; RoxenModule types_module; RoxenModule dir_module; function types_fun; string name; int inited; // Protocol specific statistics. int requests, sent, hsent, received; function(string:int) log_function; DataCache datacache; int get_config_id(); string get_doc_for( string region, string variable ); string query_internal_location(RoxenModule|void mod); string query_name(); string comment(); void unregister_urls(); void stop(void|int asynch); string|array(string) type_from_filename( string file, int|void to, string|void myext ); string get_url(); array (RoxenModule) get_providers(string provides); RoxenModule get_provider(string provides); array(mixed) map_providers(string provides, string fun, mixed ... args); mixed call_provider(string provides, string fun, mixed ... args); array(function) file_extension_modules(string ext); array(function) url_modules(); mapping api_functions(void|RequestID id); array(function) logger_modules(); array(function) last_modules(); array(function) first_modules(); array location_modules(); array(function) filter_modules(); void init_log_file(); int|mapping check_security(function|object a, RequestID id, void|int slevel); void invalidate_cache(); void clear_memory_caches(); string examine_return_mapping(mapping m); multiset(DAVLock) find_locks(string path, int(0..1) recursive, int(0..1) exclude_shared, RequestID id); DAVLock|LockFlag check_locks(string path, int(0..1) recursive, RequestID id); mapping(string:mixed) unlock_file(string path, DAVLock lock, RequestID|int(0..0) id); int expire_locks(RequestID id); void refresh_lock(DAVLock lock); mapping(string:mixed)|DAVLock lock_file(string path, int(0..1) recursive, string lockscope, string locktype, int(0..) expiry_delta, array(Parser.XML.Tree.Node) owner, RequestID id); mapping|int(-1..0) low_get_file(RequestID id, int|void no_magic); mapping get_file(RequestID id, int|void no_magic, int|void internal_get); array(string) find_dir(string file, RequestID id, void|int(0..1) verbose); array(int)|object(Stdio.Stat) stat_file(string file, RequestID id); array open_file(string fname, string mode, RequestID id, void|int ig, void|int rc); mapping(string:array(mixed)) find_dir_stat(string file, RequestID id); array access(string file, RequestID id); string real_file(string file, RequestID id); int|string try_get_file(string s, RequestID id, int|void status, int|void nocache, int|void not_internal, mapping|void result_mapping); int(0..1) is_file(string virt_path, RequestID id, int(0..1)|void internal); void start(int num); void save_me(); int save_one( RoxenModule o ); RoxenModule reload_module( string modname ); RoxenModule enable_module( string modname, RoxenModule|void me, ModuleInfo|void moduleinfo, int|void nostart, int|void nosave ); void call_start_callbacks( RoxenModule me, ModuleInfo moduleinfo, ModuleCopies module ); void call_low_start_callbacks( RoxenModule me, ModuleInfo moduleinfo, ModuleCopies module ); int disable_module( string modname, int|void nodest ); int add_modules( array(string) mods, int|void now ); RoxenModule find_module(string name); #if ROXEN_COMPAT < 2.2 Sql.Sql sql_cache_get(string what); Sql.Sql sql_connect(string db, void|string charset); #endif void enable_all_modules(); void low_init(void|int modules_already_enabled); string parse_rxml(string what, RequestID id, void|Stdio.File file, void|mapping defines ); void add_parse_module (RoxenModule mod); void remove_parse_module (RoxenModule mod); string real_file(string a, RequestID b); mapping authenticate_throw( RequestID id, string realm, UserDB|void database, AuthModule|void method); User authenticate( RequestID id, UserDB|void database, AuthModule|void method ); array(AuthModule) auth_modules(); array(UserDB) user_databases(); AuthModule find_auth_module( string name ); UserDB find_user_database( string name ); static string _sprintf( ) { return "Configuration("+name+")"; } } //! @appears Protocol class Protocol { inherit BasicDefvar; constant name = "unknown"; //! Name used for internal identification. constant prot_name = "unknown"; //! Name of the protocol as seen in the protocol part of a url. constant supports_ipless = 0; constant requesthandlerfile = ""; constant default_port = 4711; int bound; int refs; program requesthandler; string path; int port; string ip; array(string) sorted_urls = ({}); mapping(string:mapping) urls = ([]); mapping(Configuration:mapping) conf_data = ([]); void ref(string url, mapping data); void unref(string url); Configuration find_configuration_for_url( string url, RequestID id, int|void no_default ); string get_key(); void save(); void restore(); }; class FakedVariables( mapping real_variables ) { // FIXME: _get_iterator() static array _indices() { return indices( real_variables ); } static array _values() { return map( _indices(), `[] ); } static mixed fix_value( mixed what ) { if( !what ) return what; if( !arrayp(what) ) return what; // huh if( sizeof( what ) == 1 ) return what[0]; return what*"\0"; } static mixed `[]( string ind ) { return fix_value( real_variables[ ind ] ); } static mixed `->(string ind ) { return `[]( ind ); } static mixed `[]=( string ind, mixed what ) { real_variables[ ind ] = ({ what }); return what; } static mixed `->=(string ind, mixed what ) { return `[]=( ind,what ); } static mixed _m_delete( mixed what ) { // report_debug(" _m_delete( %O )\n", what ); return fix_value( m_delete( real_variables, what ) ); } static int _equal( mixed what ) { return `==(what); } static int `==( mixed what ) { if( mappingp( what ) && (real_variables == what) ) return 1; } static string _sprintf( int f ) { switch( f ) { case 'O': return sprintf( "FakedVariables(%O)", real_variables ); default: return sprintf( sprintf("%%%c", f ), real_variables ); } } static this_program `|( mapping what ) { foreach( indices(what), string q )`[]=( q,what[q] ); return this_object(); } static this_program `+=( mapping what ) { foreach( indices(what), string q )`[]=( q,what[q] ); return this_object(); } static this_program `+( mapping what ) { foreach( indices(what), string q )`[]=( q,what[q] ); return this_object(); } static mapping cast(string to) { if (to[..6]=="mapping") { array v=indices(real_variables); return mkmapping(v,map(v,`[])); } error("can't cast to %O\n",to); } } class PrefLanguages //! @appears PrefLanguages //! Support for language preferences. This object is typically //! accessed through @tt{id->misc->pref_languages@}. { int decoded=0; int sorted=0; array(string) subtags=({}); array(string) languages=({}); array(float) qualities=({}); static string _sprintf(int c, mapping|void attrs) { return sprintf("PrefLanguages(%O)", get_languages()); } array(string) get_languages() { sort_lang(); return languages; } string get_language() { if(!languages || !sizeof(languages)) return 0; sort_lang(); return languages[0]; } array(float) get_qualities() { sort_lang(); return qualities; } float get_quality() { if(!qualities || !sizeof(qualities)) return 0.0; sort_lang(); return qualities[0]; } void set_sorted(array(string) lang, void|array(float) q) { languages=lang; if(q && sizeof(q)==sizeof(lang)) qualities=q; else qualities=({1.0})*sizeof(lang); sorted=1; decoded=1; } void sort_lang() { if(sorted && decoded) return; array(float) q; array(string) s=reverse(languages)-({""}), u=({}); if(!decoded) { q=({}); s=Array.map(s, lambda(string x) { float n=1.0; string sub=""; sscanf(lower_case(x), "%s;q=%f", x, n); if(n==0.0) return ""; sscanf(x, "%s-%s", x, sub); if(x == "" ) return ""; q+=({n}); u+=({sub}); return x; }); s-=({""}); decoded=1; } else q=reverse(qualities); sort(q,s,u); languages=reverse(s); qualities=reverse(q); subtags=reverse(u); sorted=1; } } typedef function(CacheKey,mixed...:void) CacheActivationCB; class CacheKey //! @appears CacheKey //! //! Used as @expr{id->misc->cachekey@}. Every request that might be //! cacheable has an instance, and the protocol cache which store the //! result of the request checks that this object still exists before //! using the cache entry. Thus other subsystems that provide data to //! the result can keep track of this object and destruct it whenever //! they change state in a way that invalidates the previous result. //! //! Those data providers should however not store this object //! directly, but instead call @[add_activation_cb]. That avoids //! unnecessary garbage (see below). //! //! A cache implementation must call @[activate] before storing the //! cache key. At that point the functions registered with //! @[add_activation_cb] are called, and the key gets added in the //! internal structures of the data providers. This avoids registering //! cache keys for results that never get cached, which would //! otherwise produce excessive amounts of garbage objects in those //! internal structures. Note that other code might need to call //! @[activate] to process the callbacks, so a key being active //! doesn't necessarily mean it's used in a cache. //! //! @note //! These objects can be destructed asynchronously; all accesses for //! things inside them have to rely on the interpreter lock, and code //! can never assume that @expr{id->misc->cachekey@} exists to begin //! with. The wrapper functions in @[RequestID] handles all this. { #if ID_CACHEKEY_DEBUG RoxenDebug.ObjectMarker __marker = RoxenDebug.ObjectMarker (this); #endif static array(array(CacheActivationCB|array)) activation_cbs; // Functions to call when the cache key is activated, i.e. stored // together with some result in a cache. Zero when the key already // is active. static void create (void|int activate_immediately) { if (!activate_immediately) activation_cbs = ({}); } void add_activation_cb (CacheActivationCB cb, mixed... args) //! Register a callback that will be called if and when this cache //! key is used in a cache, i.e. is activated. The callback gets //! this object followed by @[args] as arguments and should do //! whatever bookkeeping necessary to keep track of the cache key so //! that it can be destructed. //! //! If this cache key already is active then @[cb] is called right //! away. //! //! The registered callbacks will be called in the same order they //! are added. //! //! @note //! Cache keys can be destructed at any time, and @[cb] might get //! called with an already destructed object. //! //! @note //! Take care to avoid cyclic refs when the activation callback is //! registered. This object should e.g. not be among @[args], and //! @[cb] should not be a lambda that contains references to this //! object. { // Relying on the interpreter lock here. if (activation_cbs) // Relying on the interpreter lock here too. activation_cbs += ({({cb, args})}); else cb (this, @args); } int activate() //! Activate the cache key. This must be called when the key is //! stored in a cache. Return nonzero if any callbacks got called. { // Relying on the interpreter lock here. if (array(array(CacheActivationCB|array)) cbs = activation_cbs) { // Relying on the interpreter lock here too. activation_cbs = 0; foreach (cbs, [CacheActivationCB cb, array args]) cb (this, @args); return sizeof (cbs); } return 0; } int activated() //! Returns nonzero iff the key is activated. { // Relying on the interpreter lock here. return !activation_cbs; } int activate_if_necessary() // Activate the key only if any activation cbs are installed. This // is a kludge to play safe in situations early in the request path // where we don't want to activate the key and where there aren't // any outstanding callbacks in the common case with a direct // request but might still be in the recursive case. Ignore if you // can. { // Relying on the interpreter lock here. if (array(array(CacheActivationCB|array)) cbs = activation_cbs) { if (sizeof (cbs)) { if (this) // Relying on the interpreter lock here. activation_cbs = 0; foreach (cbs, [CacheActivationCB cb, array args]) cb (this, @args); return 1; } } return 0; } string _sprintf (int flag) { return flag == 'O' && ("CacheKey()" #ifdef ID_CACHEKEY_DEBUG + (__marker ? "[" + __marker->count + "]" : "") #endif ); } } // Kludge for resolver problems static function _charset_decoder_func; string browser_supports_vary(string ignored, RequestID id) { return (string)!has_value(id->client||"", "MSIE"); } class RequestID //! @appears RequestID //! The request information object contains all request-local information and //! server as the vessel for most forms of intercommunication between modules, //! scripts, RXML and so on. It gets passed round to almost all API callbacks //! worth mentioning. A RequestID object is born when an incoming request is //! encountered, and its life expectancy is short, as it dies again when the //! request has passed through all levels of the <ref>module type calling //! sequence</ref>. { #ifdef ID_OBJ_DEBUG RoxenDebug.ObjectMarker __marker = RoxenDebug.ObjectMarker (this); #endif Configuration conf; Protocol port_obj; //! The port object this request came from. int time; //! Time of the request, standard unix time (seconds since the epoch; 1970). int hrtime; //! Time of the request, high resolution time. string raw_url; //! The nonparsed, nontouched, non-* URL requested by the client. //! Hence, this path is unlike <ref>not_query</ref> and //! <ref>virtfile</ref> not relative to the server URL and must be //! used in conjunction with the former to generate absolute paths //! within the server. Be aware that this string will contain any //! URL variables present in the request as well as the file path. int do_not_disconnect; //! Typically 0, meaning the channel to the client will be disconnected upon //! finishing the request and the RequestID object destroyed with it. mapping (string:array) real_variables; //! Form variables submitted by the client browser, as found in the //! <tt>form</tt> scope in RXML. Both query (as found in the query part of //! the URL) and POST (submitted in the request body) variables share this //! scope, with query variables having priority over POST ones. In other //! words, the query part of the URL overrides whatever variables are sent //! in the request body. //! //! The indices and values of this mapping map to the names and values of //! the variable names. All data (names and values) are decoded from their //! possible transport encoding. //! //! The value is always an array mapping(string:mixed)|FakedVariables variables; //! @decl mapping(string:mixed) variables; //! //! The variables mapping is more or less identical to the //! real_variables maping, but each variable can only have one //! value, if the form variable was sent multiple times from the //! client (this happens, as an example, if you have checkbox //! variables with the same name but different values), the values //! will be separated with \0 (the null character) in this mapping. mapping (string:mixed) misc; //! This mapping contains miscellaneous non-standardized information, and //! is the typical location to store away your own request-local data for //! passing between modules et cetera. Be sure to use a key unique to your //! own application. //! //! If a subrequest (a.k.a. "fake" request) is generated within //! another request then the subrequest receives a copy (created //! with @[copy_value]) of this mapping. I.e. the subrequest sees //! any data put here by the parent request, but changes made in the //! subrequest won't affect the parent. //! //! These are some of the defined entries: //! @mapping //! @member int "cacheable" //! Time in seconds that the request is cacheable. //! Use @[get_max_cache()], @[set_max_cache()] or one of the //! cache macros to access. //! @member array(function) "_cachecallbacks" //! Callbacks to verify that the cache entry is valid. //! @member CacheKey "cachekey" //! @[CacheKey] for the request. //! @member multiset(string) "client_connection" //! Parsed request header "Connection". //! @member array "cookies" //! Empty array. Obsolete entry. //! @member string "connection" //! Protocol connection mode. Typically @tt{"keep-alive"@} or //! @tt{"close"@}. //! @member mapping(string:mixed) "defines" //! RXML macros. //! @member int(100..) "error_code" //! Result error code unless specified elsewhere. //! @member string "etag" //! Entity tag for the request. If the request is cacheable in //! the protocol cache one will be generated if not already present. //! @member array(string) "files" //! Multipart/form-data variables that have an associated filename. //! @member string "host" //! Canonical host header (lower-case, port number present). //! @member string "hostname" //! Hostname from the canonicalized host header. //! @member int "last_modified" //! Time stamp for when the request was last modified. //! @member int "len" //! Length in bytes of the data section of the request. //! @member int "_log_cheat_addition" //! Value to add to @expr{file->len@} to get the length //! to report in the access log. //! @member mapping(string:string|array(string)) "moreheads" //! Response headers. See @[add_response_header()] for details. //! @member int(1..1) "no_proto_cache" //! Flag indicating that the result should not be cached in //! the protocol cache. //! @member RequestID "orig" //! Originating @[RequestID] for recursive requests. //! @member int "port" //! Port number from the canonicalized host header. //! @member PrefLanguages "pref_languages" //! Language preferences for the request. //! @member array "proxyauth" //! Decoded proxy authentication information. //! @member string "range" //! Byte range information. //! @member int(1..1) "request_charset_decoded" //! Flag indicating that @[decode_charset_encoding()] has been run. //! @member string "site_prefix_path" //! Site path prefix. //! @member Stat "stat" //! File status information for the request. //! @member multiset(string) "vary" //! Contains the active set of vary headers. Please use //! @[register_vary_callback()] to alter. //! @member array(string|function(string, RequestID:string)) @ //! "vary_cb_order" //! Contains the cache lookup callback functions relevant to the //! request so far in order. See @[register_vary_callback()] for //! details. //! @member multiset(string|function(string, RequestID:string)) @ //! "vary_cb_set" //! Same content as @tt{"vary_cb_order"@} above, but only used to //! speed up some lookups. //! @endmapping mapping (string:mixed) connection_misc = ([]); //! This mapping contains miscellaneous non-standardized information, and //! is the typical location to store away your own connection-local data //! for passing between requests on the same connection et cetera. Be sure //! to use a key unique to your own application. //! Contains the current set of cookies. //! //! @note //! DON'T touch! //! //! @seealso //! @[cookies] mapping(string:string) real_cookies; //! Wrapper that calls @[register_vary_callback()] as appropriate when //! cookies are accessed. //! //! @note //! Uses the parent pointer to access @[register_vary_callback()] and //! will thus update the original @[RequestID] object even if copied //! to a cloned @[RequestID]. This is a feature. //! //! @seealso //! @[cookies], @[register_vary_callback()], @[Roxen.get_cookie_callback()] static class CookieJar { //! Contains the set of cookies that have been zapped in some way. static mapping(string:string) eaten = ([]); static void create(string|array(string)|void contents) { VARY_WERROR("Initiating cookie jar.\n"); real_cookies = ([]); if(!contents) return; array tmp = arrayp(contents) ? contents : ({ contents}); foreach(tmp, string cookieheader) { foreach(((cookieheader/";") - ({""})), string c) { string name, value; while(sizeof(c) && c[0]==' ') c=c[1..]; if(sscanf(c, "%s=%s", name, value) == 2) { value=_Roxen.http_decode_string(value); name=_Roxen.http_decode_string(name); real_cookies[ name ]=value; #ifdef OLD_RXML_CONFIG // FIXME: Really ought to register this one... if( (name == "RoxenConfig") && strlen(value) ) config = mkmultiset( value/"," ); #endif } } } } static string `->(string cookie) { if (supports && zero_type(eaten[cookie])) { VARY_WERROR("Looking at cookie %O from %s\n", cookie, describe_backtrace(({backtrace()[-2]}))); /* Workaround for MSIE 6's refusal to cache anything with * a Vary:Cookie header. */ register_vary_callback("User-Agent", browser_supports_vary); if (supports->vary) { register_vary_callback("Cookie", Roxen->get_cookie_callback(cookie)); } else { register_vary_callback("User-Agent", Roxen->get_cookie_callback(cookie)); } } return real_cookies[cookie]; } static string `[](mixed cookie) { if (stringp(cookie)) { return `->(cookie); } return UNDEFINED; } static string `->=(string cookie, string value) { if (zero_type(eaten[cookie])) { eaten[cookie] = real_cookies[cookie]; } return real_cookies[cookie] = value; } static string `[]=(mixed cookie, string value) { // FIXME: Warn if not string? return `->=(cookie, value); } static string _m_delete(string cookie) { // FIXME: Warn if not string? if (zero_type(eaten[cookie])) { eaten[cookie] = real_cookies[cookie]; } return m_delete(real_cookies, cookie); } static array(string) _indices() { register_vary_callback("Cookie"); return indices(real_cookies); } static array(string) _values() { register_vary_callback("Cookie"); return values(real_cookies); } static int _sizeof() { register_vary_callback("Cookie"); return sizeof(real_cookies); } static mapping(string:string) `+(mapping(string:string) other) { register_vary_callback("Cookie"); return real_cookies + other; } static mapping(string:string) ``+(mapping(string:string) other) { register_vary_callback("Cookie"); return other + real_cookies; } //! Used to retrieve the original set of cookies at //! protocol cache store time. static mapping(string:string) `~() { VARY_WERROR("Disconnecting cookie jar.\n"); return real_cookies + eaten; } static string _sprintf(int fmt) { return fmt == 'O' && sprintf("CookieJar(%O)", real_cookies); } } CookieJar|mapping(string:string) cookies; //! The indices and values map to the names and values of the cookies sent //! by the client for the requested page. All data (names and values) are //! decoded from their possible transport encoding. //! //! @note //! Used to be a plain mapping in Roxen 4.0 and earlier. It now //! has a wrapper that registers dependencies on the various cookies. //! @note //! The wrapper is removed, and the contents partially restored at //! request send time. //! Call to initialize the cookies. //! //! Typically called from callbacks installed with //! @[register_vary_callback()] if @[cookies] hasn't been initialized. void init_cookies(int|void no_cookie_jar) { if (!cookies) { cookies = CookieJar(request_headers["cookie"]); if (no_cookie_jar) { // Disable the cookie jar -- Called from log()? real_cookies = cookies = ~cookies; } } } mapping (string:array(string)|string) request_headers; //! Indices and values map to the names and values of all HTTP headers sent //! with the request; all data has been transport decoded, and the header //! names are canonized (lowercased) on top of that. Here is where you look //! for the "user-agent" header, the "referer" [sic!] header and similar //! interesting data provided by the client. mapping (string:mixed) throttle; // ? mapping (string:mixed) client_var; //! The client scope; a mapping of various client-related variables, indices //! being the entity names and the values being their values respectively. multiset(string) prestate; //! A multiset of all prestates harvested from the URL. Prestates are boolean //! flags, who are introduced in an extra leading path segment of the URL //! path put within parentheses, as in <a //! href="http://docs.roxen.com/(tables)/">docs://www.roxen.com/(tables)/</a>, //! this rendering a prestate multiset <pi>(< "tables" >)</pi>. //! //! Prestates are mostly useful for debugging purposes, since prestates //! generally lead to multiple URLs for identical documents resulting in //! poor usage of browser/proxy caches and the like. See <ref>config</ref>. multiset(string) config; //! Much like prestates, the id->config multiset is typically used for //! boolean information of state supplied by the client. The config state, //! however, is hidden in a client-side cookie treated specially by roxen, //! namely the <tt>RoxenConfig</tt> cookie. multiset(string) supports; //! All flags set by the supports system. multiset(string) pragma; //! All pragmas (lower-cased for canonization) sent with the request. For //! real-world applications typically only <pi>pragma["no-cache"]</pi> is of //! any particular interest, this being sent when the user does a forced //! reload of the page. array(string) client; array(string) referer; Stdio.File my_fd; // Don't touch; use the returned file descriptor from connection() instead. string prot; //! The protocol used for the request, e g "FTP", "HTTP/1.0", "HTTP/1.1". //! (Se also <ref>clientprot</ref>.) string clientprot; //! The protocol the client wanted to use in the request. This may //! not be the same as <ref>prot</ref>, if the client wanted to talk //! a higher protocol version than the server supports to date. string method; //! The method used by the client in this request, e g "GET", "POST". string realfile; //! When the the requested resource is an actual file in the real //! filesystem, this is its path. string virtfile; //! The mountpoint of the location module that provided the requested file. //! Note that this is not accessable from location modules; you need to keep //! track of your mountpoint on your own using <ref>defvar()</ref> and //! <ref>query()</ref>. This mountpoint is relative to the server URL. string rest_query; //! The scraps and leftovers of the requested URL's query part after //! removing all variables (that is, all key=value pairs) from it. string raw; //! The raw, untouched request in its entirety. string query; //! The entire raw query part (all characters after the first question mark, //! '?') of the requested URL. string not_query; //! The part of the path segment of the requested URL that is below //! the virtual server's mountpoint. For a typical server //! registering a URL with no ending path component, not_query will //! contain all characters from and including the leading '/' to but //! not including the first question mark ('?') of the URL. string extra_extension; string data; //! The raw request body, containing non-decoded post variables et cetera. string leftovers; string rawauth, realauth; // Used by many modules, so let's keep this. string since; string remoteaddr; //! The client's IP address. string host; //! The client's hostname, if resolved. multiset(string) cache_status = (<>); //! Contains the caches that were hit when the request was served. //! See the docstring for @tt{$cache-status@} in the @tt{LogFormat@} //! global variable for known values, but note that the multiset //! never actually contains the value @expr{"nocache"@}; it's only written //! when the multiset is empty. multiset(string) eval_status = (<>); //! Contains the content evaluators that were hit when the request //! was served. See the docstring for @tt{$eval-status@} in the //! @tt{LogFormat@} global variable for known values. object root_id; //! @decl RequestID root_id; //! The root id object directly associated with the request - remains //! the same for all id objects generated by <insert href> tags and //! similar conditions that invoke @[clone_me()]. static void create(Stdio.File fd, Protocol port, Configuration conf){} void send(string|object what, int|void len){} static SimpleNode xml_data; // XML data for the request. SimpleNode get_xml_data() { if (!sizeof(data)) return 0; if (xml_data) return xml_data; // FIXME: Probably ought to check that the content-type for // the request is text/xml. DAV_WERROR("Parsing XML data: %O\n", data); return xml_data = Parser.XML.Tree.simple_parse_input(data, 0, Parser.XML.Tree.PARSE_ENABLE_NAMESPACES); } // Parsed if-header for the request. static mapping(string:array(array(array(string)))) if_data; #ifdef IF_HEADER_DEBUG #define IF_HDR_MSG(X...) werror (X) #else #define IF_HDR_MSG(X...) #endif //! Parse an RFC 2518 9.4 "If Header". //! //! @note //! For speed reasons the parsing is rather forgiving. //! //! @returns //! Returns @expr{0@} (zero) if there was no if header, or //! if parsing of the if header failed. //! Returns a mapping from resource name to condition on success. //! //! A condition is represented as an array of sub-conditions //! (@tt{List@} in RFC 2518), where each sub-condition is an array //! of tokens, and each token is an array of two elements, where //! the first is one of the strings @expr{"not"@}, @expr{"etag"@}, //! or @expr{"key"@}, and the second is the value. //! //! The resource @expr{0@} (zero) represents the default resource. mapping(string:array(array(array(string)))) get_if_data() { if (if_data) { IF_HDR_MSG ("get_if_data(): Returning cached result\n"); return sizeof(if_data) && if_data; } if_data = ([]); // Negative caching. string raw_header; if (!(raw_header = request_headers->if)) { IF_HDR_MSG ("get_if_data(): No if header\n"); return 0; } array(array(string|int|array(array(string)))) decoded_if = MIME.decode_words_tokenized_labled(raw_header); #if 0 IF_HDR_MSG("get_if_data(): decoded_if: %O\n", decoded_if); #endif if (!sizeof(decoded_if)) { IF_HDR_MSG("Got only whitespace.\n"); return 0; } mapping(string:array(array(array(string)))) res = ([ 0: ({}) ]); string tmp_resource; string resource; foreach(decoded_if, array(string|int|array(array(string))) symbol) { switch (symbol[0]) { case "special": switch(symbol[1]) { case '<': tmp_resource = ""; break; case '>': resource = tmp_resource; tmp_resource = 0; // Normalize. // FIXME: Check that the protocol and server parts refer // to this server. // FIXME: Support for servers mounted on subpaths. catch { resource = Standards.URI(resource)->path; }; if (!sizeof(resource) || (resource[-1] != '/')) resource += "/"; if (!res[resource]) res[resource] = ({}); break; default: if (tmp_resource) tmp_resource += sprintf("%c", symbol[1]); break; } break; case "word": case "domain-literal": // Resource if (!tmp_resource) return 0; tmp_resource += symbol[1]; break; case "comment": // Parenthesis expression. if (tmp_resource) { // Inside a resource. tmp_resource += "(" + symbol[1][0][0] + ")"; break; } array(array(string|int|array(array(string)))) sub_expr = MIME.decode_words_tokenized_labled(symbol[1][0][0]); int i; array(array(string)) expr = ({}); string tmp_key; for (i = 0; i < sizeof(sub_expr); i++) { switch(sub_expr[i][0]) { case "special": switch(sub_expr[i][1]) { case '<': tmp_key = ""; break; case '>': if (!tmp_key) { IF_HDR_MSG("No tmp_key.\n"); return 0; } expr += ({ ({ "key", tmp_key }) }); tmp_key = 0; break; default: if (tmp_key) tmp_key += sprintf("%c", sub_expr[i][1]); break; } break; case "domain-literal": if (tmp_key) { tmp_key += sub_expr[i][1]; break; } // entity-tag. string etag = sub_expr[i][1]; // etag is usually something like "[\"some etag\"]" here. sscanf(etag, "[%s]", etag); // Remove brackets expr += ({ ({ "etag", etag }) }); break; case "word": // State-token or Not. if (tmp_key) { tmp_key += sub_expr[i][1]; break; } if (lower_case(sub_expr[i][1]) == "not") { // Not expr += ({ ({ "not", 0 }) }); break; } IF_HDR_MSG("Word outside key: %O\n", sub_expr[i][1]); report_debug("Syntax error in if-header: %O\n", raw_header); return 0; } } if (tmp_key) { IF_HDR_MSG("Active tmp_key: %O\n", tmp_key); report_debug("Syntax error in if-header: %O\n", raw_header); return 0; } res[resource] += ({ expr }); break; default: report_debug("Syntax error in if-header: %O\n", raw_header); return 0; } } if (tmp_resource) { IF_HDR_MSG("Active tmp_resource: %O\n", tmp_resource); report_debug("Syntax error in if-header: %O\n", raw_header); return 0; } IF_HDR_MSG("get_if_data(): Parsed if header: %s:\n" "%O\n", raw_header, res); return if_data = res; } //! Register that the result was dependant on the request header //! specified by @[vary], and/or a callback @[cb] that generates //! a key that can be used as a decision variable. //! //! The headers registred in @[vary] during the requests parsing //! will be used to generate the vary header (RFC 2068 14.43) for //! the result. //! //! @param vary //! Either a (lower-case) string that specifies the name of //! a request header, or @tt{0@} (zero) which specifies that //! it doesn't depend on a header, but something else (eg //! the IP-number of the client (and thus will generate a //! @tt{"*"@} vary header. //! //! @param cb //! This function will be called at request time with the //! path of the request, and the @[RequestID]. It should //! return a key fragment. If @[cb] is not specified, it //! will default to a function that returns the value of //! the request header specified by @[vary]. //! //! @note //! The order of calls to @[register_vary_callback()] is significant //! since it will be used to create a decision tree. //! //! Note also that the function @[cb] should be fast, and avoid //! excessive lengths in the returned key, to keep down on //! perfomance issues. //! //! Please avoid having NULs (@tt{"\0"@}) in the key fragments, //! since they may be used to spoof the cache. //! //! Caveat! The callback function gets called very early in //! the request processing, so not all fields in the @[RequestID] //! object may be valid yet. //! //! @seealso //! @[NOCACHE()] void register_vary_callback(string|void vary, function(string, RequestID: string)|void cb) { // Don't generate a vary header for the Host header. if (vary != "Host") { if (!misc->vary) { misc->vary = (< vary || "*" >); } else { misc->vary[vary || "*"] = 1; } } if (vary) vary = lower_case(vary); if (!misc->vary_cb_set) { misc->vary_cb_set = (< cb || vary >); misc->vary_cb_order = ({ cb || vary }); VARY_WERROR("register_vary_callback(%O, %O)\n", vary, cb); return; } if (misc->vary_cb_set[cb || vary]) { // Already registred. VARY_WERROR("register_vary_callback(%O, %O) Duplicate\n", vary, cb); return; } if (vary && misc->vary_cb_set[vary]) { // The full header has already been registred. VARY_WERROR("register_vary_callback(%O, %O) Full header\n", vary, cb); return; } misc->vary_cb_set[cb || vary] = 1; misc->vary_cb_order += ({ cb || vary }); VARY_WERROR("register_vary_callback(%O, %O)\n", vary, cb); } static string cached_url_base; string url_base() //! Returns the base part of the URL, i.e. what should be added in //! front of a path in the virtual filesystem to get the absolute //! URL to the page. The returned string ends with a "/", or is "" //! if no server base could be found. //! //! This function gets the correct host for protocols that handles //! IP-less hosts. { if (!cached_url_base) { string tmp; // We're looking at the host header... register_vary_callback("Host"); // First look at the host header in the request. if (tmp = misc->host) { int scanres = sscanf(tmp, "%[^:]:%d", string host, int port); if ((scanres < 2) || (port == port_obj->default_port)) { // Some clients don't send the port in the host header // if they've connected to the default port. // NOTE: We want the (probable) port number that the client // used here; NOT the actual port number, since there // may be port remappers in the way. port = port_obj->default_port; // Remove redundant port number. cached_url_base = port_obj->prot_name + "://" + host; } else { cached_url_base = port_obj->prot_name + "://" + tmp; } } // Then use the port object. else if (port_obj) { string host = port_obj->conf_data[conf]->hostname; if (host == "*") if (conf && sizeof (host = conf->get_url()) && sscanf (host, "%*s://%[^:/]", host) == 2) { // Use the hostname in the configuration url. } else // Fall back to the numeric ip. host = port_obj->ip; cached_url_base = port_obj->prot_name + "://" + host; if (port_obj->port != port_obj->default_port) cached_url_base += ":" + port_obj->port; } // Then try the configuration url. else if (conf && sizeof (tmp = conf->get_url())) cached_url_base = tmp[..sizeof (tmp) - 2]; // Remove trailing '/'. // Lastly use a pathetic fallback. With this the produced urls // will still be relative, which has some chance of working. else return cached_url_base = ""; if (string p = misc->site_prefix_path) cached_url_base += p; cached_url_base += "/"; } return cached_url_base; } void add_response_header (string name, string value) //! Adds a header @[name] with the value @[value] to be sent in the //! http response. An existing header with the same name will not be //! overridden, instead another (duplicate) header line will be sent //! in the response. //! //! @note //! If used from within an RXML parse session, this function will //! ensure that the new header is registered properly in the RXML //! p-code cache. That's the primary reason to used it instead of //! adding the header directly to @tt{misc->moreheads@} or //! @tt{misc->defines[" _extra_heads"]@}. { mapping hdrs = misc->defines && misc->defines[" _extra_heads"] || misc->moreheads; if (!hdrs) hdrs = misc->moreheads = ([]); // Essentially Roxen.add_http_header inlined. Can't refer to it // from here due to the recursive resolver problems in Pike. array|string cur_val = hdrs[name]; if(cur_val) { if(arrayp(cur_val)) { if (!has_value(cur_val, value)) cur_val += ({ value }); } else { if (cur_val != value) cur_val = ({ cur_val, value }); } } else cur_val = value; if (hdrs == misc->moreheads) hdrs[name] = cur_val; else if (object/*(RXML.Context)*/ ctx = RXML_CONTEXT) ctx->set_var (name, cur_val, "header"); else hdrs[name] = cur_val; } void set_response_header (string name, string value) //! Sets the header @[name] to the value @[value] to be sent in the //! http response. If an existing header with the same name exists, //! its value(s) will be overridden. This is useful for headers like //! "Expire-Time", otherwise @[add_response_header] is typically a //! better choice. //! //! @note //! If used from within an RXML parse session, this function will //! ensure that the new header is registered properly in the RXML //! p-code cache. That's the primary reason to used it instead of //! adding the header directly to @tt{misc->moreheads@} or //! @tt{misc->defines[" _extra_heads"]@}. { if (misc->defines && misc->defines[" _extra_heads"]) { misc->defines[" _extra_heads"][name] = value; if (object/*(RXML.Context)*/ ctx = RXML_CONTEXT) ctx->signal_var_change (name, "header"); } else { if (!misc->moreheads) misc->moreheads = ([]); misc->moreheads[name] = value; } } static MultiStatus multi_status; MultiStatus get_multi_status() //! Returns a @[MultiStatus] object that will be used to produce a //! 207 Multi-Status response (RFC 2518 10.2). It's only consulted //! if the result returned from @[RoxenModule.find_file] et al is an //! empty mapping. //! //! @note //! It's not necessarily safe to assume that there aren't any //! multi-status responses stored here already on entry to //! @[find_file] et al. C.f. @[multi_status_size]. //! //! @seealso //! @[set_status_for_path] { if (!multi_status) multi_status = MultiStatus(); return multi_status; } int multi_status_size() //! Returns the number responses that have been added to the //! @[MultiStatus] object returned by @[get_multi_status]. Useful to //! see whether a (part of a) recursive operation added any errors //! or other results. { return multi_status && multi_status->num_responses(); } void set_status_for_path (string path, int status_code, string|void message, mixed... args) //! Register a status to be included in the response that applies //! only for the given path. This is used for recursive operations //! that can yield different results for different encountered files //! or directories. //! //! The status is stored in the @[MultiStatus] object returned by //! @[get_multi_status]. //! //! @param path //! Absolute path in the configuration to which the status //! applies. Note that filesystem modules need to prepend their //! location to their internal paths. //! //! @param status_code //! The HTTP status code. //! //! @param message //! If given, it's a message to include in the response. The //! message may contain line feeds ('\n') and ISO-8859-1 //! characters in the ranges 32..126 and 128..255. Line feeds are //! converted to spaces if the response format doesn't allow them. //! //! @param args //! If there are more arguments after @[message] then @[message] //! is taken as an @[sprintf] style format string which is used to //! format @[args]. //! //! @seealso //! @[Roxen.http_status] { if (sizeof (args)) message = sprintf (message, @args); ASSERT_IF_DEBUG (has_prefix (path, "/")); get_multi_status()->add_status (url_base() + path[1..], status_code, message); } void set_status_for_url (string url, int status_code, string|void message, mixed... args) //! Register a status to be included in the response that applies //! only for the given URL. Similar to @[set_status_for_path], but //! takes a complete URL instead of an absolute path within the //! configuration. { if (sizeof (args)) message = sprintf (message, @args); get_multi_status()->add_status (url, status_code, message); } // Charset handling array(string) output_charset = ({}); string input_charset; void set_output_charset( string|function to, int|void mode ) { if (object/*(RXML.Context)*/ ctx = RXML_CONTEXT) ctx->add_p_code_callback ("set_output_charset", to, mode); if( search( output_charset, to ) != -1 ) // Already done. return; switch( mode ) { case 0: // Really set. output_charset = ({ to }); break; case 1: // Only set if not already set. if( !sizeof( output_charset ) ) output_charset = ({ to }); break; case 2: // Join. if (sizeof (output_charset) && (!stringp (to) || !stringp (output_charset[0]))) error ("Can't join charsets with functions (%O with %O).\n", to, output_charset[0]); output_charset |= ({ to }); break; } } string|function(string:string) get_output_charset() { string charset; function(string:string) encoder; foreach( output_charset, string|function f ) [charset,encoder] = join_charset(charset, f, encoder, 0); return charset || encoder; } static string charset_name(function|string what) { switch (what) { case string_to_unicode: return "ISO10646-1"; case string_to_utf8: return "UTF-8"; default: return upper_case((string) what); } } static function charset_function(function|string what, int allow_entities) { switch (what) { case "ISO-10646-1": case "ISO10646-1": case string_to_unicode: return string_to_unicode; case "UTF-8": case string_to_utf8: return string_to_utf8; default: catch { // Use entity fallback if content type allows it function fallback_func = allow_entities && lambda(string char) { return sprintf("&#x%x;", char[0]); }; _charset_decoder_func = _charset_decoder_func || Roxen->_charset_decoder; return _charset_decoder_func(Locale.Charset.encoder((string) what, "", fallback_func)) ->decode; }; } return lambda(string what) { return what; }; } static array(string) join_charset(string old, function|string add, function oldcodec, int allow_entities) { switch (old && upper_case(old)) { case 0: return ({ charset_name(add), charset_function(add, allow_entities) }); case "ISO10646-1": case "UTF-8": return ({ old, oldcodec }); // Everything goes here. :-) case "ISO-2022": return ({ old, oldcodec }); // Not really true, but how to know this? default: // Not true, but there is no easy way to add charsets yet... #if 1 // The safe choice. return ({"UTF-8", string_to_utf8}); #else return ({ charset_name(add), charset_function(add, allow_entities) }); #endif } } array replace_charset_placeholder(string charset, string what, int allow_entities) { // If we allow entities we also replace the automatic charset placeholder with the charset in use if(allow_entities && charset) what = replace(what, Roxen->magic_charset_variable_placeholder, charset); return ({ charset, what }); } array(string) output_encode(string what, int|void allow_entities, string|void force_charset) { // Performance optimization for unneeded ISO-8859-1 recoding of // strings which already are narrow. if (String.width(what) == 8) { if (force_charset) { if (upper_case(force_charset) == "ISO-8859-1") return replace_charset_placeholder("ISO-8859-1", what, allow_entities); } else { if (sizeof(output_charset) == 1 && upper_case(output_charset[0]) == "ISO-8859-1") return replace_charset_placeholder("ISO-8859-1", what, allow_entities); } } if (!force_charset) { string charset; function encoder; foreach( output_charset, string|function f ) [charset,encoder] = join_charset(charset, f, encoder, allow_entities); if (!encoder) if (String.width(what) > 8) { charset = "UTF-8"; encoder = string_to_utf8; } if (encoder) what = encoder(what); return replace_charset_placeholder( charset, what, allow_entities ); } else return ({ 0, Locale.Charset.encoder((force_charset / "=")[-1])->feed(what)->drain() }); } string scan_for_query( string f ) { if(sscanf(f,"%s?%s", f, query) == 2) { string v, a, b; foreach(query / "&", v) if(sscanf(v, "%s=%s", a, b) == 2) { a = _Roxen.http_decode_string(replace(a, "+", " ")); b = _Roxen.http_decode_string(replace(b, "+", " ")); real_variables[ a ] += ({ b }); } else if(strlen( rest_query )) rest_query += "&" + _Roxen.http_decode_string( v ); else rest_query = _Roxen.http_decode_string( v ); rest_query=replace(rest_query, "+", "\000"); } return f; } mapping(string:string) make_response_headers (mapping(string:mixed) file) //! Make the response headers from a response mapping for this //! request. The headers associated with transfer modifications of //! the response, e.g. 206 Partial Content and 304 Not Modified, are //! not calculated here. //! //! @note //! Is destructive on @[file] and on various data in the request; //! should only be called once for a @[RequestID] instance. { if (!file->stat) file->stat = misc->stat; if(objectp(file->file)) { if(!file->stat && file->file->stat) file->stat = file->file->stat(); if (zero_type(misc->cacheable) && file->file->is_file) { // Assume a cacheablity on the order of the age of the file. misc->cacheable = (predef::time(1) - file->stat[ST_MTIME])/4; } } if( Stat fstat = file->stat ) { if( !file->len && (fstat[1] >= 0) && file->file ) file->len = fstat[1]; if ( fstat[ST_MTIME] > misc->last_modified ) misc->last_modified = fstat[ST_MTIME]; } if (!file->error) file->error = Protocols.HTTP.HTTP_OK; if(!file->type) file->type="text/plain"; mapping(string:string) heads = ([]); if( !zero_type(misc->cacheable) && (misc->cacheable != INITIAL_CACHEABLE) ) { if (!misc->cacheable) { // It expired a year ago. heads["Expires"] = Roxen->http_date( predef::time(1)-31557600 ); // Force the vary header generated below to be "*". misc->vary = (< 0 >); VARY_WERROR("Not cacheable. Force vary *.\n"); } else heads["Expires"] = Roxen->http_date( predef::time(1)+misc->cacheable ); if (misc->cacheable < INITIAL_CACHEABLE) { // Data with expiry is assumed to have been generated at the // same instant. misc->last_modified = predef::time(1); } } if (misc->last_modified) heads["Last-Modified"] = Roxen->http_date(misc->last_modified); string charset=""; if( stringp(file->data) ) { if (file->charset) // Join to be on the safe side. set_output_charset (file->charset, 2); if (sizeof (output_charset) || has_prefix (file->type, "text/") || (String.width(file->data) > 8)) { int allow_entities = has_prefix(file->type, "text/xml") || has_prefix(file->type, "text/html"); [charset,file->data] = output_encode( file->data, allow_entities ); if( charset && (search(file["type"], "; charset=") == -1)) charset = "; charset="+charset; else charset = ""; } file->len = strlen(file->data); } heads["Content-Type"] = file->type + charset; heads["Accept-Ranges"] = "bytes"; heads["Server"] = replace(roxenp()->version(), " ", "_"); if (file->error == 500) { // Internal server error. // Make sure the connection is closed to resync. heads["Connection"] = "close"; misc->connection = "close"; } else if( misc->connection ) heads["Connection"] = misc->connection; if(file->encoding) heads["Content-Encoding"] = file->encoding; heads->Date = Roxen->http_date(predef::time(1)); if(file->expires) heads->Expires = Roxen->http_date(file->expires); //if( file->len > 0 || (file->error != 200) ) heads["Content-Length"] = (string)file->len; if (misc->etag) heads->ETag = misc->etag; #ifdef RAM_CACHE if (!misc->etag && file->len && (file->data || file->file) && file->error == 200 && (<"HEAD", "GET">)[method] && (file->len < conf->datacache->max_file_size)) { string data = ""; if (file->file) { data = file->file->read(file->len); if (file->data && (sizeof(data) < file->len)) { data += file->data[..file->len - (sizeof(data)+1)]; } m_delete(file, "file"); } else if (file->data) { data = file->data[..file->len - 1]; } file->data = data; heads->ETag = misc->etag = sprintf("\"%s\"", Crypto.string_to_hex(Crypto.md5()->update(data)->digest())); } #endif /* RAM_CACHE */ if (misc->vary && sizeof(misc->vary)) { // Generate a vary header. VARY_WERROR("Full set: %s\n", ((array)misc->vary) * ", "); if (!supports->vary) { // Broken support for vary. heads->Vary = "User-Agent"; // It expired a year ago. heads->Expires = Roxen->http_date(predef::time(1)-31557600); VARY_WERROR("Vary not supported by the browser.\n"); } else if (misc->vary[0]) { // Depends on non-headers. heads->Vary = "*"; } else { heads->Vary = ((array)misc->vary) * ", "; } } if(mappingp(file->extra_heads)) heads |= file->extra_heads; if(mappingp(misc->moreheads)) heads |= misc->moreheads; return heads; } void adjust_for_config_path( string p ) { if( not_query ) not_query = not_query[ strlen(p).. ]; raw_url = raw_url[ strlen(p).. ]; misc->site_prefix_path = p; } void end(string|void s, int|void keepit){} void ready_to_receive(){} void send_result(mapping|void result) { #ifdef DEBUG error ("send_result not overridden.\n"); #endif } RequestID clone_me() { object c,t; c=object_program(t=this_object())(0, port_obj, conf); c->port_obj = port_obj; c->conf = conf; c->root_id = root_id; c->time = time; c->raw_url = raw_url; c->real_variables = copy_value( real_variables ); c->variables = FakedVariables( c->real_variables ); c->misc = copy_value( misc ); c->misc->orig = t; c->connection_misc = connection_misc; c->prestate = prestate; c->supports = supports; c->config = config; c->client_var = client_var; c->remoteaddr = remoteaddr; c->host = host; c->client = client; c->referer = referer; c->pragma = pragma; c->cookies = cookies; c->request_headers = request_headers + ([]); c->my_fd = 0; c->prot = prot; c->clientprot = clientprot; c->method = method; c->rest_query = rest_query; c->raw = raw; c->query = query; c->not_query = not_query; c->data = data; c->extra_extension = extra_extension; c->realauth = realauth; c->rawauth = rawauth; c->since = since; return c; } Stdio.File connection( ) //! Returns the file descriptor used for the connection to the client. { return my_fd; } Configuration configuration() //! Returns the <ref>Configuration</ref> object of the virtual server that //! is handling the request. { return conf; } string _sprintf (int flag) { return flag == 'O' && ("RequestID(" + (raw_url||"") + ")" #ifdef ID_OBJ_DEBUG + (__marker ? "[" + __marker->count + "]" : "") #endif ); } } //! @appears MultiStatusStatus class MultiStatusStatus (int http_code, void|string message) { constant is_status = 1; void build_response (SimpleElementNode response_node) { SimpleElementNode node = SimpleElementNode("DAV:status", ([])); response_node->add_child (node); // No use wasting space on a good message in the status node since // we have it in the responsedescription instead. node->add_child(SimpleTextNode(sprintf("HTTP/1.1 %d ", http_code))); if (message) { node = SimpleElementNode ("DAV:responsedescription", ([])); response_node->add_child (node); node->add_child (SimpleTextNode (message)); } } int `== (mixed other) { return objectp (other) && object_program (other) == this_program && other->http_code == http_code && other->message == message; } int __hash() { return http_code + (message && hash (message)); } string _sprintf (int flag) { return flag == 'O' && sprintf ("MultiStatusStatus(%d,%O)", http_code, message); } } private SimpleElementNode ok_status_node = SimpleElementNode("DAV:status", ([]))->add_child(SimpleTextNode("HTTP/1.1 200 OK")); //! @appears MultiStatusPropStat class MultiStatusPropStat { constant is_prop_stat = 1; mapping(string:string|SimpleNode|array(SimpleNode)|MultiStatusStatus) properties = ([]); //! The property settings. Indexed on property name (with complete //! XML namespace). Values are: //! //! @mixed //! @type array(SimpleNode) //! The property value as a sequence of XML nodes. These nodes //! are used as children to the property nodes in the DAV //! protocol. //! @type SimpleNode //! Same as an array containing only this node. //! @type string //! Same as a single @[Parser.XML.Tree.SimpleTextNode] with this value. //! @type int(0..0) //! The property exists but has no value. //! @type MultiStatusStatus //! There was an error querying the property and this is the //! status it generated instead of a value. //! @endmixed void build_response (SimpleElementNode response_node) { SimpleElementNode ok_prop_node = SimpleElementNode("DAV:prop", ([])); mapping(MultiStatusStatus:SimpleNode) prop_nodes = ([]); foreach (properties; string prop_name; string|SimpleNode|array(SimpleNode)|MultiStatusStatus value) { if (objectp (value) && value->is_status) { // Group together failed properties according to status codes. SimpleNode prop_node = prop_nodes[value]; if (!prop_node) prop_nodes[value] = prop_node = SimpleElementNode("DAV:prop", ([])); prop_node->add_child(SimpleElementNode(prop_name, ([]))); } else { // The property is ok and has a value. string ms_type; // The DAV client in Windows XP Pro (at least) requires types // on the date fields to parse them correctly. The type system // is of course some MS goo. switch (prop_name) { case "DAV:creationdate": ms_type = "dateTime.tz"; break; case "DAV:getlastmodified": ms_type = "dateTime.rfc1123"; break; // MS header - format unknown. //case "DAV:lastaccessed": ms_type = "dateTime.tz"; break; } SimpleElementNode node = SimpleElementNode(prop_name, ms_type ? ([ "urn:schemas-microsoft-com:datatypesdt": ms_type ]) : ([])); ok_prop_node->add_child (node); if (arrayp (value)) node->replace_children (value); else if (stringp (value)) node->add_child(SimpleTextNode(value)); else if (objectp (value)) node->add_child (value); } } if (ok_prop_node->count_children()) { SimpleElementNode propstat_node = SimpleElementNode("DAV:propstat", ([])); response_node->add_child (propstat_node); propstat_node->add_child (ok_prop_node); propstat_node->add_child (ok_status_node); } foreach (prop_nodes; MultiStatusStatus status; SimpleNode prop_node) { SimpleElementNode propstat_node = SimpleElementNode("DAV:propstat", ([])); response_node->add_child (propstat_node); propstat_node->add_child (prop_node); status->build_response (propstat_node); } } string _sprintf (int flag) { return flag == 'O' && sprintf ("MultiStatusPropStat(%O)", properties); } } //! @appears MultiStatusNode typedef MultiStatusStatus|MultiStatusPropStat MultiStatusNode; //! @appears MultiStatus class MultiStatus { static mapping(string:MultiStatusNode) status_set = ([]); static mapping(string:string) args = ([ "xmlns:DAV": "DAV:", // MS namespace for data types; see comment in // XMLPropStatNode.add_property. Note: The XML parser in the // MS DAV client is broken and requires the break of the last // word "datatypesdt" to be exactly at this point. "xmlns:MS": "urn:schemas-microsoft-com:datatypes", ]); int num_responses() //! Returns the number of responses that have been added to this //! object. { return sizeof (status_set); } MultiStatusNode get_response (string href) //! Returns the response stored for @[href] if there is any. //! //! @returns //! @mixed //! @type MultiStatusStatus //! There was some kind of error on @[href] and this is the //! stored status. This type is preferably checked by testing //! for a nonzero @expr{is_status@} member. //! @type MultiStatusPropStat //! A property query was successful on @[href] and the //! returned object contains the results for some or all //! properties. This type is preferably checked by testing for //! a nonzero @expr{is_prop_stat@} member. //! @endmixed { return status_set[href]; } mapping(string:MultiStatusNode) get_responses_by_prefix (string href_prefix) //! Returns the stored responses for all URI:s that got //! @[href_prefix] as prefix. See @[get_response] for details about //! the response value. //! //! Prefixes are only matched at @expr{"/"@} boundaries, so //! @expr{"http://x.se/foo"@} is considered a prefix of //! @expr{"http://x.se/foo/bar"@} but not //! @expr{"http://x.se/foobar"@}. As a special case, the empty //! string as @[href_prefix] returns all stored responses. { if (href_prefix == "") return status_set + ([]); mapping(string:MultiStatusNode) result = ([]); if (!has_suffix (href_prefix, "/")) { if (MultiStatusNode stat = status_set[href_prefix]) result[href_prefix] = stat; href_prefix += "/"; } foreach (status_set; string href; MultiStatusNode stat) if (has_prefix (href, href_prefix)) result[href] = stat; return result; } //! Add DAV:propstat information about the property @[prop_name] for //! the resource @[href]. //! //! @param prop_value //! Optional property value. It can be one of the following: //! @mixed prop_value //! @type void|int(0..0) //! Operation performed ok, no value. //! @type string|SimpleNode|array(SimpleNode) //! Property has value @[prop_value]. //! @type MultiStatusStatus //! @type mapping(string:mixed) //! Operation failed as described by the mapping. //! @endmixed void add_property(string href, string prop_name, void|int(0..0)|string|array(SimpleNode)|SimpleNode| MultiStatusStatus|mapping(string:mixed) prop_value) { MultiStatusPropStat prop_stat; if (MultiStatusNode stat = status_set[href]) if (stat->is_prop_stat) // This will cause override of an existing MultiStatusStatus. // Presumably it came from another file system that is now // being hidden. Or is it better to keep the status node and // do nothing here instead? prop_stat = stat; if (!prop_stat) prop_stat = status_set[href] = MultiStatusPropStat(); if (mappingp (prop_value)) prop_value = MultiStatusStatus (prop_value->error, prop_value->rettext); prop_stat->properties[prop_name] = prop_value; } void add_status (string href, int status_code, void|string message, mixed... args) //! Add a status for the specified url. The remaining arguments are //! the same as for @[Roxen.http_status]. { if (sizeof (args)) message = sprintf (message, @args); if (!status_code) error("Bad status code!\n"); status_set[href] = MultiStatusStatus (status_code, message); } void add_namespace (string namespace) //! Add a namespace to the generated @tt{<multistatus>@} element. //! Useful if several properties share a namespace. { int ns_count = 0; string ns_name; while (args[ns_name = "xmlns:NS" + ns_count]) { if (args[ns_name] == namespace) return; ns_count++; } args[ns_name] = namespace; } SimpleNode get_xml_node() { SimpleElementNode node; SimpleRootNode root = SimpleRootNode()-> add_child(SimpleHeaderNode((["version": "1.0", "encoding": "utf-8"])))-> add_child(node = SimpleElementNode("DAV:multistatus", args)); array(SimpleNode) response_xml = allocate(sizeof(status_set)); int i; DAV_WERROR("Generating XML Nodes for status_set:%O\n", status_set); // Sort this because some client (which one?) requires collections // to come before the entries they contain. foreach(sort(indices(status_set)), string href) { SimpleElementNode response_node = SimpleElementNode("DAV:response", ([]))-> add_child(SimpleElementNode("DAV:href", ([]))-> add_child(SimpleTextNode(href))); response_xml[i++] = response_node; status_set[href]->build_response (response_node); } node->replace_children(response_xml); return root; } mapping(string:mixed) http_answer() { string xml = get_xml_node()->render_xml(); return ([ "error": 207, "data": xml, "len": sizeof(xml), "type": "text/xml; charset=\"utf-8\"", ]); } class Prefixed (static string href_prefix) { MultiStatus get_multi_status() {return MultiStatus::this;} void add_property(string path, string prop_name, void|int(0..0)|string|array(SimpleNode)|SimpleNode| MultiStatusStatus|mapping(string:mixed) prop_value) { MultiStatus::add_property(href_prefix + path, prop_name, prop_value); } void add_status (string path, int status_code, void|string message, mixed... args) { MultiStatus::add_status (href_prefix + path, status_code, message, @args); } void add_namespace (string namespace) { MultiStatus::add_namespace (namespace); } MultiStatus.Prefixed prefix(string href_prefix) { return this_program (this_program::href_prefix + href_prefix); } } MultiStatus.Prefixed prefix (string href_prefix) //! Returns an object with the same @expr{add_*@} methods as this //! one except that @[href_prefix] is implicitly prepended to every //! path. { return Prefixed (href_prefix); } } // Only for protyping and breaking of circularities. static class PropertySet { string path; RequestID id; Stat get_stat(); mapping(string:string) get_response_headers(); multiset(string) query_all_properties(); string|array(SimpleNode)|mapping(string:mixed) query_property(string prop_name); mapping(string:mixed) start(); void unroll(); void commit(); mapping(string:mixed) set_property(string prop_name, string|array(SimpleNode) value); mapping(string:mixed) set_dead_property(string prop_name, array(SimpleNode) value); mapping(string:mixed) remove_property(string prop_name); mapping(string:mixed) find_properties(string mode, MultiStatus.Prefixed result, multiset(string)|void filt); } //! See @[RoxenModule.check_locks]. enum LockFlag { LOCK_NONE = 0, LOCK_SHARED_BELOW = 2, LOCK_SHARED_AT = 3, LOCK_OWN_BELOW = 4, LOCK_EXCL_BELOW = 6, LOCK_EXCL_AT = 7 }; //! How to handle an existing destination when files or directories //! are moved or copied in a filesystem. enum Overwrite { //! Fail if the destination exists. Corresponds to an Overwrite //! header with the value "F" (RFC 2518 9.6). NEVER_OVERWRITE = -1, //! If the source and destination are directories, overwrite the //! properties only. If the source and destination are files, //! overwrite the file along with the properties. Otherwise fail if //! the destination exists. MAYBE_OVERWRITE = 0, //! If the destination exists then delete it recursively before //! writing the new content. Corresponds to an Overwrite header with //! the value "T" (RFC 2518 9.6). DO_OVERWRITE = 1, }; //! State of the DAV:propertybehavior. //! //! @mixed //! @type int(0..0) //! DAV:omit. //! Failure to copy a property does not cause the entire copy //! to fail. //! @type int(1..1) //! DAV:keepalive "*". //! All live properties must be kept alive. //! @type multiset(string) //! Set of properties to keep alive. Properties not in the set //! should be copied according to best effort. The properties are //! listed with complete namespaces. //! @endmixed typedef int(0..1)|multiset(string) PropertyBehavior; class RoxenModule { inherit BasicDefvar; constant is_module = 1; constant module_type = 0; constant module_unique = 1; LocaleString module_name; LocaleString module_doc; string module_identifier(); string module_local_id(); array(int|string|mapping) register_module(); string file_name_and_stuff(); void start (void|int variable_save, void|Configuration conf, void|int newly_added); //! This function is called both when a module is loaded //! (@[variable_save] is 0) and when its variables are saved after a //! change (@[variable_save] is 2). //! //! @[newly_added] is 1 if the module is being added by the //! administrator through the admin interface (implies that //! @[variable_save] is 0). It's zero if the module is loaded //! normally, i.e. as a result of an entry in the server //! configuration file. //! //! @[conf] is the configuration that the module instance belongs //! to, i.e. the same as the return value from @[my_configuration]. //! //! @note //! A module can't assume that it has been loaded before in this //! server configuration just because @[newly_added] is zero. The //! administrator might for instance have edited the configuration //! file directly. string query_internal_location(); string query_location(); string|multiset(string) query_provides(); function(RequestID:int|mapping) query_seclevels(); void set_status_for_path (string path, RequestID id, int status_code, string|void message, mixed... args); array(int)|object(Stdio.Stat) stat_file(string f, RequestID id); array(string) find_dir(string f, RequestID id); mapping(string:array(mixed)) find_dir_stat(string f, RequestID id); string real_file(string f, RequestID id); void save(); mapping api_functions(); mapping query_tag_callers(); mapping query_container_callers(); string info(object conf); string comment(); PropertySet|mapping(string:mixed) query_property_set(string path, RequestID id); string|array(SimpleNode)|mapping(string:mixed) query_property(string path, string prop_name, RequestID id); mapping(string:mixed) recurse_find_properties(string path, string mode, int depth, RequestID id, multiset(string)|void filt); mapping(string:mixed) patch_properties(string path, array(PatchPropertyCommand) instructions, RequestID id); mapping(string:mixed) set_property (string path, string prop_name, string|array(SimpleNode) value, RequestID id); mapping(string:mixed) remove_property (string path, string prop_name, RequestID id); string resource_id (string path, RequestID id); string|int authenticated_user_id (string path, RequestID id); multiset(DAVLock) find_locks(string path, int(0..1) recursive, int(0..1) exclude_shared, RequestID id); DAVLock|LockFlag check_locks(string path, int(0..1) recursive, RequestID id); mapping(string:mixed) lock_file(string path, DAVLock lock, RequestID id); mapping(string:mixed) unlock_file (string path, DAVLock lock, RequestID id); mapping(string:mixed)|int(0..1) check_if_header(string relative_path, int(0..1) recursive, RequestID id); mapping(string:mixed)|int(-1..0)|Stdio.File find_file(string path, RequestID id); mapping(string:mixed) recurse_delete_files(string path, RequestID id); mapping(string:mixed) make_collection(string path, RequestID id); mapping(string:mixed) recurse_copy_files(string source, string destination, PropertyBehavior behavior, Overwrite overwrite, RequestID id); mapping(string:mixed) recurse_move_files(string source, string destination, PropertyBehavior behavior, Overwrite overwrite, RequestID id); } class PatchPropertyCommand { constant command = ""; string property_name; mapping(string:mixed) execute(PropertySet context); } class _roxen { mapping(string:object) variables; constant real_version = ""; object locale; int start_time; array(Configuration) configurations; mixed query(string a); void store(string a, mapping b, int c, object d); mapping(string:mixed) retrieve(string a, object b); void remove(string a, object b); string version(); void dump(string a); void nwrite(string a, int|void b, int|void c, void|mixed ... d); int main(int a, array(string) b); } class AuthModule //! @appears AuthModule //! The interface an authentication module must implement { inherit RoxenModule; constant module_type = MODULE_AUTH; constant thread_safe=1; constant name = "method name"; User authenticate( RequestID id, UserDB db ); //! Try to authenticate the request with users from the specified user //! database. If no @[db] is specified, all datbases in the current //! configuration are searched in order, then the configuration user //! database. mapping authenticate_throw( RequestID id, string realm, UserDB db ); //! Returns a reply mapping, similar to @[Roxen.http_rxml_reply] with //! friends. If no @[db] is specified, all datbases in the current //! configuration are searched in order, then the configuration user //! database. } static mapping(string:function(void:void)) user_sql_inited = ([]); static Sql.Sql user_mysql; static void init_user_sql(string table) { string db = all_constants()->REPLICATE?"replicate":"local"; if( !user_mysql ) user_mysql = master()->resolv("DBManager.get")( db ); if(catch(user_mysql->query( "SELECT module FROM "+ table+" WHERE module=''"))) { user_mysql->query( "CREATE TABLE "+table+" " " (module varchar(30) NOT NULL, " " name varchar(30) NOT NULL, " " user varchar(30) NOT NULL, " " value blob, " " raw int not null, " " INDEX foo (module,name,user))" ); master()->resolv("DBManager.is_module_table")( 0, db, table, "Contains metadata about users. " "Userdatabases can store information here " "at the request of other modules, or they " "can keep their own state in this table" ); } user_sql_inited[ table ]= lambda(){user_mysql = master()->resolv("DBManager.get")( db );}; } //! @appears Group class Group( UserDB database ) { string name(); //! The group name array(string) members() //! All users that are members of this group. The default //! implementation loops over all users handled by the user database //! and looks for users with the same gid as this group, or who is a //! member of it when the groups() method are called. { array res = ({}); User uid; int id = gid(); foreach( database->list_users(), string u ) if( (uid = database->find_user( u )) && ((uid->gid() == id) || has_value(uid->groups(), name()))) res += ({ u }); return res; } int gid(); //! A numerical GID, or -1 if not applicable int set_name( string new_name ) { return 0; } int set_gid( int new_gid ) { return 0; } int set_members( array(string) members ) { return 0; } //! Returns 1 if it was possible to set the variable. } #ifdef THREADS static Thread.Mutex mutex = Thread.Mutex(); #endif //! @appears User class User( UserDB database ) { static string table; string name(); //! The user (short) name string real_name(); //! The real name of the user int password_authenticate(string password) //! Return 1 if the password is correct, 0 otherwise. The default //! implementation uses the crypted_password() method. { string c = crypted_password(); return !sizeof(c) || crypt(password, c); } int uid(); //! A numerical UID, or -1 if not applicable int gid(); //! A numerical GID, or -1 if not applicable string shell(); //! The shell, or 0 if not applicable string gecos() //! The gecos field, defaults to return the real name { return real_name(); } string homedir(); string crypted_password() { return "x"; } //! Used by compat_userinfo(). The default implementation returns "x" array(string) groups() //! Return all groups this user is a member in. The default //! implementation returns ({}) { return ({}); } int set_name(string name) {} int set_real_name(string rname) {} int set_uid(int uid) {} int set_gid(int gid) {} int set_shell(string shell) {} int set_gecos(string gecos) {} int set_homedir(string hodir) {} int set_crypted_password(string passwd) {} int set_password(string passwd) {} //! Returns 1 if it was possible to set the variable. array compat_userinfo( ) //! Return a unix passwd compatible array with user information. The //! defualt implementation uses the other methods to assemble this //! information. //! //! Basically: //! return ({ name(), crypted_password(), //! uid(), gid(), gecos(), homedir(), //! shell() }); { return ({name(),crypted_password(),uid(),gid(),gecos(),homedir(),shell()}); } #define INIT_SQL() do{ \ if(!table) table = replace(database->my_configuration()->name," ","_")+"_user_variables"; \ if(!user_sql_inited[ table ] )init_user_sql( table );else user_sql_inited[ table ](); \ } while( 0 ) #ifdef THREADS #define LOCK() mixed ___key = mutex->lock() #else #define LOCK() #endif static string module_name( RoxenModule module ) { if( !module ) // NULL does not work together with indexes, but this is // not a valid modulename, so it's not a problem. return "'0'"; else return replace("'"+user_mysql->quote(module->sname())+"'","%","%%"); } mixed set_var( RoxenModule module, string index, mixed value ) //! Set a specified variable in the user. If @[value] is a string, //! it's stored as is in the database, otherwise it's encoded using //! encode_value before it's stored. Returns the value. //! //! You can use 0 for the @[module] argument. //! //! The default implementation stores the value in a mysql table //! '*_user_data' in the 'shared' database. //! //! Use @[get_var] to retrieve the value, and @[delete_var] to //! delete it. { delete_var( module, index ); mixed oval = value; LOCK(); INIT_SQL(); int encoded; if( stringp( value ) ) value = string_to_utf8( value ); else { value = encode_value( value ); encoded = 1; } user_mysql->query( "INSERT INTO "+table+" (module,name,user,value,raw) " "VALUES ("+module_name( module )+", %s, %s, %s, %d)", index, name(), value, encoded ); return oval; } mixed get_var( RoxenModule module, string index ) //! Return the value of a variable previously set with @[set_var] { array rows; LOCK(); INIT_SQL(); rows = user_mysql->query( "SELECT * FROM "+table+ " WHERE module="+module_name( module ) +" AND name=%s AND user=%s", index, name() ); if( !sizeof( rows ) ) return 0; mapping m = rows[0]; if( (int)m->raw ) return decode_value( m->value ); return utf8_to_string( m->value ); } void delete_var( RoxenModule module, string index ) //! Delete a variable previously created with @[set_var] { LOCK(); INIT_SQL(); user_mysql->query( "DELETE FROM "+table+" WHERE (module="+ module_name( module )+ " AND name=%s AND user=%s)", index, name() ); } #undef INIT_SQL #undef LOCK } class UserDB //! @appears UserDB //! The interface a UserDB module must implement. { inherit RoxenModule; constant module_type = MODULE_USERDB; constant thread_safe=1; constant name = "db name"; User find_user( string s, RequestID|void id ); //! Find a user User find_user_from_uid( int uid, RequestID|void id ) //! Find a user given a UID. The default implementation loops over //! list_users() and checks the uid() of each one. { User user; foreach( list_users(), string u ) if( (user = find_user( u )) && (user->uid() == uid) ) return user; } Group find_group( string group, RequestID|void id ) //! Find a group object given a group name. //! The default implementation returns 0. { } Group find_group_from_gid( int gid, RequestID|void id ) //! Find a group given a GID. The default implementation loops over //! list_groups() and checks the gid() of each one. { Group group; foreach( list_groups(), string u ) if( (group = find_group( u )) && (group->gid() == gid) ) return group; } array(string) list_groups( RequestID|void id ) //! Return a list of all groups handled by this database module. //! The default implementation returns the empty array. { return ({}); } array(string) list_users( RequestID|void id ); //! Return a list of all users handled by this database module. User create_user( string s ) //! Not necessarily implemented, as an example, it's not possible to //! create users in the system user database from Roxen WebServer. //! The default implementation returns 0. { return 0; } Group create_group( string s ) //! Not necessarily implemented, as an example, it's not possible to //! create groups in the system user database from Roxen WebServer. //! The default implementation returns 0. { return 0; } }

Roxen.git/ server/ base_server/ prototypes.pike > 4d0c6687a0b40fbfd57cedab9acec2a1ef95a943 [Annotate]