Roxen.git/server/etc/modules/Variable.pmod/module.pmod:04e337f37d59a196b58fe6df7420427fd919a29f

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 // $Id$ #include <module.h> #include <roxen.h> // Locale macros //<locale-token project="roxen_config"> LOCALE </locale-token> #define LOCALE(X,Y) \ ([string](mixed)Locale.translate("roxen_config",roxenp()->locale->get(),X,Y)) // Increased for each variable, used to index the mappings below. The unique // prefix is needed to avoid clobbering variables after server restart. protected int unique_vid; protected string unique_prefix = (string) getpid(); // The theory is that most variables (or at least a sizable percentage // of all variables) do not have these members. Thus this saves // quite a respectable amount of memory, the cost is speed. But // hopefully not all that great a percentage of speed. protected mapping(string:mixed) changed_values = ([]); protected mapping(string:function(object:void)) changed_callbacks = ([]); protected mapping(string:int) all_flags = ([]); protected mapping(string:string) all_warnings = ([]); protected mapping(string:function(RequestID,object:int)) invisibility_callbacks = set_weak_flag( ([]), 1 ); mapping(string:Variable) all_variables = set_weak_flag( ([]), 1 ); mapping get_all_variables() { return all_variables; } Variable get_variables( string v ) { return all_variables[v]; } string get_diff_def_html( Variable v, string button_tag, string def_url, string diff_url, int page ) { if( page ) return v->diff( 2 ); if( v->is_defaulted() || (v->get_flags() & VAR_NO_DEFAULT) ) return ""; string oneliner = v->diff( 0 ), diff_button=""; mapping m; if( !oneliner ) { if( v->diff( 1 ) ) { m = ([ "href":diff_url,"target":"_new", ]); diff_button = Roxen.make_container( "a",m, Roxen.make_container( button_tag, ([]), LOCALE(474,"Show changes") ) ); } } m = ([ "href" : def_url, "onclick" : "return confirm('" + LOCALE(1041, "Are you sure you want " "to restore the default " "value?") + "');" ]); return diff_button + " " + Roxen.make_container( "a",m, Roxen.make_container( button_tag, ([]), LOCALE(475, "Restore default value" )+ (oneliner||"") ) ); } class Diff { private array(string) diff; private array(string) print_row(array(string) diff_old, array(string) diff_new, int line, int|void start, int|void end) { if(!sizeof(diff_old) && sizeof(diff_new)) // New row. return Array.map(diff_new, lambda(string s) {return "+ " + s;} ); if(sizeof(diff_old) && !sizeof(diff_new)) // Deleted row. return Array.map(diff_old, lambda(string s) {return "- " + s;} ); if(diff_old != diff_new) // Modified row. return Array.map(diff_old, lambda(string s) {return "- " + s;} ) + Array.map(diff_new, lambda(string s) {return "+ " + s;} ); if(start + end < sizeof(diff_old) && (start || end)) { if(start && !end) diff_old = diff_old[.. start - 1]; else { diff_old = diff_old[.. start - 1] + ({ line + sizeof(diff_old) - end }) + diff_old[sizeof(diff_old) - end ..]; } } return Array.map(diff_old, lambda(string|int s) { if(intp(s)) return "Line "+s+":"; return " " + s; } ); } string html(void|int hide_header) { string r = ""; int added, deleted; if(sizeof(diff) && diff[-1] == " ") diff = diff[..sizeof(diff)-2]; foreach(diff, string row) { row = Roxen.html_encode_string(row); row = replace(row, "\t", " "); row = replace(row, " ", " "); switch(row[0]) { case '&': r += "<tt>"+row+"</tt><br>\n"; break; case '+': r += "<font color='darkgreen'><tt>"+row+"</tt></font><br>\n"; added++; break; case '-': r += "<font color='darkred'><tt>"+row+"</tt></font><br>\n"; deleted++; break; case 'L': r += "<i>"+row+"</i><br>\n"; break; } } if (!hide_header) r = "<b>" + LOCALE(476, "Change in content") + "</b><br />\n"+ "<i>"+(added==1? LOCALE(477, "1 line added."): sprintf(LOCALE(478, "%d lines added."), added)) + " " + (deleted==1? LOCALE(479, "1 line deleted."): sprintf(LOCALE(480, "%d lines deleted."), deleted)) + "</i><p>\n"+ r; return r; } array get() { return diff; } void create(array(string) new, array(string) old, int context) { array(array(string)) diff_old, diff_new; [diff_old, diff_new] = Array.diff(old, new); int line = 1; int diffp = 0; diff = ({ }); for(int i = 0; i < sizeof(diff_old); i++) { if(diff_old[i] != diff_new[i]) { diff += print_row(diff_old[i], diff_new[i], line); diffp = 1; } else if(sizeof(diff_old) > 1) { diff += print_row(diff_old[i], diff_new[i], line, diffp?context:0, sizeof(diff_old) - 1 > i?context:0 ); diffp = 0; } line += sizeof(diff_old[i] - ({ })); } } } class Variable //! The basic variable type in Roxen. All other variable types should //! inherit this class. { constant is_variable = 1; constant type = "Basic"; //! Mostly used for debug (sprintf( "%O", variable_obj ) uses it) string _id = unique_prefix + "_" + (string) unique_vid++; // used for indexing the mappings. protected mixed _initial; // default value protected string _path = sprintf("v%s",_id); // used for forms protected LocaleString __name, __doc; string diff( int render ) //! Generate a html diff of the difference between the current //! value and the default value. //! //! This method is used by the configuration interface. //! //! The argument @[render] is used to select the operation mode. //! //! render=0 means that you should generate an inline diff. This //! should be at most 1 line of text with no more than 30 or so //! characters. This is mostly useful for simple variable types such //! as integers or choice-lists. //! //! If you return 0 when render=0, this function will be called with //! render=1 instead. If you return a non-zero value, you indicate //! that there is a diff available. In this case the function can be //! called again with render=2, in this case you have a full page of //! HTML code to render on. //! //! If you return 0 for render=1 as well, no difference will be //! shown. This is the default. { return 0; } void destroy() { if (global::this) { // clean up... m_delete( all_flags, _id ); m_delete( all_warnings, _id ); m_delete( invisibility_callbacks, _id ); m_delete( changed_values, _id ); } } string get_warnings() //! Returns the current warnings, if any. { return all_warnings[ _id ]; } int get_flags() //! Returns the 'flags' field for this variable. //! Flags is a bitwise or of one or more of //! //! @int //! @value VAR_EXPERT //! Only for experts. //! @value VAR_MORE //! Only visible when more-mode is on (default on). //! @value VAR_DEVELOPER //! Only visible when devel-mode is on (default on). //! @value VAR_INITIAL //! Should be configured initially. //! @value VAR_INVISIBLE //! The variable is permanently hidden from view. //! @endint { return all_flags[_id]; } void set_flags( int flags ) //! Set the flags for this variable. //! Flags is a bitwise or of one or more of //! //! @int //! @value VAR_EXPERT //! Only for experts. //! @value VAR_MORE //! Only visible when more-mode is on (default on). //! @value VAR_DEVELOPER //! Only visible when devel-mode is on (default on). //! @value VAR_INITIAL //! Should be configured initially. //! @value VAR_INVISIBLE //! The variable is permanently hidden from view. //! @endint { if(!flags ) m_delete( all_flags, _id ); else all_flags[_id] = flags; } int check_visibility( RequestID id, int more_mode, int expert_mode, int devel_mode, int initial, int|void variable_in_cfif ) //! Check if the variable should be visible to the //! configuration interface user. //! //! @param variable_in_cfif //! If variable_in_cfif is true, the variable is in a module //! that is added to the configuration interface itself. //! //! @returns //! Return 1 if this variable should be visible in the //! configuration interface. The default implementation check the //! 'flags' field, and the invisibility callback, if any. See //! get_flags, set_flags and set_invisibibility_check_callback //! { int flags = get_flags(); function cb; if( flags & VAR_INVISIBLE ) return 0; if( initial && !(flags & VAR_INITIAL) ) return 0; if( (flags & VAR_EXPERT) && !expert_mode ) return 0; if( (flags & VAR_MORE) && !more_mode ) return 0; if( (flags & VAR_DEVELOPER) && !devel_mode ) return 0; if( (flags & VAR_NOT_CFIF) && variable_in_cfif ) return 0; if( (cb = get_invisibility_check_callback() ) && cb( id, this_object() ) ) return 0; return 1; } void set_invisibility_check_callback( function(RequestID,Variable:int) cb ) //! If the function passed as argument returns 1, the variable //! will not be visible in the configuration interface. //! //! Pass 0 to remove the invisibility callback. { if( functionp( cb ) ) invisibility_callbacks[ _id ] = cb; else m_delete( invisibility_callbacks, _id ); } function(Variable:void) get_changed_callback( ) //! Return the callback set with set_changed_callback { return changed_callbacks[ _id ]; } void set_changed_callback( function(Variable:void) cb ) //! The function passed as an argument will be called //! when the variable value is changed. //! //! Pass 0 to remove the callback. { if( functionp( cb ) ) changed_callbacks[ _id ] = cb; else m_delete( changed_callbacks, _id ); } void add_changed_callback( function(Variable:void) cb ) //! Add a new callback to be called when the variable is changed. //! If set_changed_callback is called, callbacks added with this function //! are overridden. { mixed oc = get_changed_callback( ); if( arrayp( oc ) ) oc += ({ cb }); else oc = ({ oc, cb }) - ({ 0 }); changed_callbacks[ _id ] = oc; } function(RequestID,Variable:int) get_invisibility_check_callback() //! Return the current invisibility check callback { return invisibility_callbacks[_id]; } LocaleString doc( ) //! Return the documentation for this variable (locale dependant). //! //! The default implementation queries the locale object in roxen //! to get the documentation. { return __doc || ""; } void set_doc (LocaleString doc) //! Set the (locale dependent) documentation for this variable. { __doc = doc; } LocaleString name( ) //! Return the name of this variable (locale dependant). //! //! The default implementation queries the locale object in roxen //! to get the documentation. { return __name || LOCALE(326,"unnamed")+" "+_id; } void set_name (LocaleString name) //! Set the (locale dependent) name for this variable. { __name = name; } LocaleString type_hint( ) //! Return the type hint for this variable. //! Type hints are generic documentation for this variable type, //! and is the same for all instances of the type. { } mixed default_value() //! The default (initial) value for this variable. { return _initial; } void set_default_value (mixed to) //! Change the default value. If the variable was previously set to //! the old default value, this will also change its actual value. { _initial = to; } void set_warning( string to ) //! Set the warning shown in the configuration interface { if( to && strlen(to) ) all_warnings[ _id ] = to; else m_delete( all_warnings, _id ); } void add_warning( string to ) //! Like set_warning, but adds to the current warning, if any. { if(to) set_warning( (get_warnings()||"") + to ); } int set( mixed to ) //! Set the variable to a new value. //! If this function returns true, the set was successful. //! Otherwise 0 is returned. 0 is also returned if the variable was //! not changed by the set. 1 is returned if the variable was //! changed, and -1 is returned if the variable was changed back to //! its default value. //! //! If verify_set() threw a string, ([])[0] is returned, that is, //! 0 with zero_type set. //! //! If verify_set() threw an exception, the exception is thrown. { string err; mixed e2; if( e2 = catch( [err,to] = verify_set( to )) ) { if( stringp( e2 ) ) { add_warning( e2 ); return ([])[0]; } throw( e2 ); } add_warning( err ); return low_set( to ); } int low_set( mixed to ) //! Forced set. No checking is done whatsoever. //! 1 is returned if the variable was changed, -1 is returned if //! the variable was changed back to it's default value and 0 //! otherwise. { if( equal( to, query() ) ) return 0; if( !equal(to, default_value() ) ) { changed_values[ _id ] = to; if( get_changed_callback() ) get_changed_callback()( this_object() ); return 1; } else { m_delete( changed_values, _id ); if( get_changed_callback() ) get_changed_callback()( this_object() ); return -1; } } mixed query() //! Returns the current value for this variable. { mixed v; if( !zero_type( v = changed_values[ _id ] ) ) return v; return default_value(); } mixed encode() //! Returns the current value for this variable encoded for storage. //! //! The default implementation just returns the value from @[query()]. //! //! @seealso //! @[query()], @[decode()] { return query(); } int decode(mixed encoded) //! Set the variable from the encoded representation //! returned by @[encode()]. //! //! The default implementation just calls @[set()] with the argument. //! //! @seealso //! @[set()], @[decode()] { return set(encoded); } int is_defaulted() //! Return true if this variable is set to it's default value. { return zero_type( changed_values[ _id ] ) || equal(changed_values[ _id ], default_value()); } array(string|mixed) verify_set_from_form( mixed new_value ) //! Like verify_set, but only called when the variables are set //! from a form. { return ({ 0, new_value }); } array(string|mixed) verify_set( mixed new_value ) //! Return ({ error, new_value }) for the variable, or throw a string. //! //! If error != 0, it should contain a warning or error message. //! If new_value is modified, it will be used instead of the //! supplied value. //! //! If a string is thrown, it will be used as a error message from //! set, and the variable will not be changed. { return ({ 0, new_value }); } mapping(string:string) get_form_vars( RequestID id ) //! Return all form variables preficed with path(). { string p = path(); array names = glob( p+"*", indices(id->real_variables) ); mapping res = ([ ]); foreach( sort(names), string n ) res[ n[strlen(p).. ] ] = id->real_variables[ n ][0]; return res; } mixed transform_from_form( string what, mapping|void v ) //! Given a form value, return what should be set. //! Used by the default set_from_form implementation. { return what; } int(0..1) set_from_form( RequestID id, void|int(0..1) force ) //! Set this variable from the form variable in id->variables, //! if any are available. The default implementation simply sets //! the variable to the string in the form variables. @[force] //! forces the variable to be set even if the variable already //! has the new value, forcing possible warnings to be added. //! Returns 1 if the variable was changed, otherwise 0. //! //! Other side effects: Might create warnings to be shown to the //! user (see get_warnings) //! //! Calls verify_set_from_form and verify_set { mixed val; if( sizeof( val = get_form_vars(id)) && val[""]) { set_warning(0); val = transform_from_form( val[""], val ); if( !force && val == query() ) return 0; array b; mixed q = catch( b = verify_set_from_form( val ) ); if( q || sizeof( b ) != 2 ) { if( q ) add_warning( q ); else add_warning( "Internal error: Illegal sized array " "from verify_set_from_form\n" ); return 0; } if( b ) { add_warning( b[0] ); set( b[1] ); return 1; } } } string path() //! A unique identifier for this variable. //! Should be used to prefix form variable names. //! //! Unless this variable was created by defvar(), the path is set //! by the configuration interface the first time the variable is //! to be shown in a form. This function can thus return 0. If it //! does, and you still have to show the form, call set_path( ) //! with a unique string. { return _path; } void set_path( string to ) //! Set the path. Not normally called from user-level code. //! //! This function must be called at least once before render_form //! can be called (at least if more than one variable is to be //! shown on the same page). This is normally done by the //! configuration interface. { m_delete( all_variables, _path ); _path = to; all_variables[ to ] = this_object(); } string render_form( RequestID id, void|mapping additional_args ); //! Return a (HTML) form to change this variable. The name of all <input> //! or similar variables should be prefixed with the value returned //! from the path() function. string render_view( RequestID id ) //! Return a 'view only' version of this variable. { mixed v = query(); if( arrayp(v) ) v = map(v,lambda(mixed v){return(string)v;})*", " ; return Roxen.html_encode_string( (string)v ); } protected string _sprintf( int i ) { if( i == 'O' ) return sprintf( "Variable.%s(%s)",type,(string)name()); } protected void create(mixed default_value, void|int flags, void|LocaleString std_name, void|LocaleString std_doc) //! Constructor. //! Flags is a bitwise or of one or more of //! //! VAR_EXPERT Only for experts //! VAR_MORE Only visible when more-mode is on (default on) //! VAR_DEVELOPER Only visible when devel-mode is on (default on) //! VAR_INITIAL Should be configured initially. //! //! The std_name and std_doc is the name and documentation string //! for the default locale (always english) { set_flags( flags ); _initial = default_value; __name = std_name; __doc = std_doc; all_variables[ path() ] = this_object(); } } class NoLimit { string _sprintf (int flag) { switch (flag) { case 's': return "n/a"; case 'O': return this == no_limit ? "no_limit" : "<bogus no_limit clone>"; default: return 0; } } } NoLimit no_limit = NoLimit(); //! @[no_limit] is used as value in a limit setting to signify that it //! isn't applicable, to allow open ended intervals in e.g. @[Float] //! and @[Int]. //! //! @note //! Always use the @[no_limit] object, never instance another one from //! the @[NoLimit] class. // ===================================================================== // Float // ===================================================================== class Float //! Float variable, with optional range checks, and adjustable precision. { inherit Variable; constant type = "Float"; protected float|NoLimit _max = no_limit, _min = no_limit; protected int _prec = 2; protected int _may_be_empty = 0; protected int(0..1) _is_empty = 0; protected string _format( float|NoLimit m ) { if (m == no_limit) return "n/a"; if( !_prec ) return sprintf( "%d", (int)m ); return sprintf( "%1."+_prec+"f", m ); } string diff( int render ) { if(!render) return "("+_format(default_value())+")"; } void set_range(float|NoLimit minimum, float|NoLimit maximum ) //! Set the range of the variable. //! //! As a compatibility measure, the range check is removed if //! maximum < minimum. { if (maximum != no_limit && minimum != no_limit && maximum < minimum) _max = _min = no_limit; else { _max = maximum; _min = minimum; } } void set_precision( int prec ) //! Set the number of _decimals_ shown to the user. //! If prec is 3, and the float is 1, 1.000 will be shown. //! Default is 2. { _prec = prec; } array(string|float) verify_set( float new_value ) { if (new_value == (float)0 && _is_empty) return ({ 0, new_value }); string warn; if(_max != no_limit && new_value > _max) { warn = sprintf(LOCALE(328,"Value is bigger than %s, adjusted"), _format(_max) ); new_value = _max; } else if(_min != no_limit && new_value < _min) { warn = sprintf(LOCALE(329,"Value is less than %s, adjusted"), _format(_min) ); new_value = _min; } return ({ warn, new_value }); } float transform_from_form( mixed what ) { if (!sizeof(what) && _may_be_empty) { _is_empty = 1; return (float)0; } string junk; if(!sizeof(what)) { add_warning(LOCALE(80, "No data entered.\n")); return _min; } sscanf(what, "%f%s", what, junk); if(!junk) { add_warning(LOCALE(81, "Data is not a float.\n")); return _min; } if(sizeof(junk)) add_warning(sprintf(LOCALE(82, "Found the string %O trailing after the float.\n"), junk)); return (float)what; } string render_view( RequestID id ) { return Roxen.html_encode_string( _format(query()) ); } string render_form( RequestID id, void|mapping additional_args ) { int size = 15; if( _max != no_limit && _min != no_limit ) size = max( strlen(_format(_max)), strlen(_format(_min)) )+2; string value; catch { if (_may_be_empty && (float)query() == (float)0) value = ""; else value = query()==""? "" : _format( (float)query() ); }; additional_args = additional_args || ([]); if (!additional_args->type) additional_args->type="text"; return input(path(), value, size, additional_args); } void may_be_empty(int(0..1) state) //! Decides if an empty variable also is valid. { _may_be_empty = state; } } // ===================================================================== // Int // ===================================================================== class Int //! Integer variable, with optional range checks { inherit Variable; constant type = "Int"; protected int|NoLimit _max = no_limit, _min = no_limit; protected int(0..1) _may_be_empty = 0; protected int(0..1) _is_empty = 0; void set_range(int|NoLimit minimum, int|NoLimit maximum ) //! Set the range of the variable. //! //! As a compatibility measure, the range check is removed if //! maximum < minimum. { if (maximum != no_limit && minimum != no_limit && maximum < minimum) _max = _min = no_limit; else { _max = maximum; _min = minimum; } } string diff( int render ) { if(!render) return "("+default_value()+")"; } array(string|int) verify_set( mixed new_value ) { if (new_value == 0 && _is_empty) return ({ 0, new_value }); string warn; if(!intp( new_value ) ) return ({ sprintf(LOCALE(152,"%O is not an integer"),new_value), query() }); if( _max != no_limit && new_value > _max) { warn = sprintf(LOCALE(328,"Value is bigger than %s, adjusted"), (string)_max ); new_value = _max; } else if( _min != no_limit && new_value < _min) { warn = sprintf(LOCALE(329,"Value is less than %s, adjusted"), (string)_min ); new_value = _min; } return ({ warn, new_value }); } int transform_from_form( mixed what ) { if (!sizeof(what) && _may_be_empty) { _is_empty = 1; return 0; } string junk; if(!sizeof(what)) { add_warning(LOCALE(80, "No data entered.\n")); return _min; } sscanf( what, "%d%s", what, junk ); if(!junk) { add_warning(LOCALE(83, "Data is not an integer\n")); return _min; } if(sizeof(junk)) add_warning(sprintf(LOCALE(84, "Found the string %O trailing after the integer.\n"), junk)); return what; } string render_form( RequestID id, void|mapping additional_args ) { int size = 10; if( _min != no_limit && _max != no_limit ) size = max( strlen((string)_max), strlen((string)_min) )+2; string value = (query() == 0 && _is_empty)? "" : (string)query(); additional_args = additional_args || ([]); if (!additional_args->type) additional_args->type="text"; return input(path(), value, size, additional_args); } void may_be_empty(int(0..1) state) //! Decides if an empty variable also is valid. { _may_be_empty = state; } } class TmpInt //! @[Int] that doesn't get saved. { inherit Int; void save() {} } class Priority //! @[Int] that gets adjusted to the configured range. { inherit Int; constant type = "Priority"; protected int|NoLimit _max = 9, _min = 0; void set_range(int|NoLimit minimum, int|NoLimit maximum ) //! Set the range of the variable. //! //! @note //! Also scales the value of the variable accordingly. { if (_max != maximum) { if (!maximum || !_max) { set_default_value(0); low_set(0); } else { // Scale the old value. int new_val = (query() * maximum)/_max; if (new_val < minimum) new_val = minimum; int new_default = (default_value() * maximum)/_max; set_default_value(new_default); low_set(new_val); } } _max = maximum; _min = minimum; } string render_form( RequestID id, void|mapping additional_args ) { if ((_max != 9) || _min) return ::render_form(id, additional_args); // Display the traditional 0-9 selector by default. string res = "<select name='"+path()+"'>\n"; string current = (string)query(); int selected = 0; foreach( ({ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 }), int elem ) { mapping m = ([]); m->value = (string)elem; if( equal( m->value, current ) ) { m->selected="selected"; selected = 1; } res += " "+Roxen.make_container( "option", m, (string)elem )+"\n"; } if (!selected) // Make an entry for the current value if it's not in the list, // so no other value appears to be selected, and to ensure that // the value doesn't change as a side-effect by another change. res += " " + Roxen.make_container ( "option", (["value":current, "selected": "selected"]), sprintf(LOCALE(332,"(keep stale value %s)"),current)); return res + "</select>"; } string|int encode() { if (!_max) return 0; int ones = _max/9; int val = query(); if (val % ones) { // New-style. int digits = sizeof(sprintf("%d", ones)); // NB: We pad with zeroes to the field size to encode the // field size that was used at encode time. return sprintf("%*0d", digits, val); } // Compat. return val / ones; } int decode(string|int encoded) { if (!_max) { return set(0); } int ones = _max/9; if (intp(encoded)) { return set(encoded * ones); } if (encoded == "") { // Paranoia check in case someone has modified the config file. return set(5 * ones); // Default value. } // Expand the encoded value to the current field size. int digits = sizeof(sprintf("%d", ones)); while (sizeof(encoded) < digits) { encoded += encoded; } if (sizeof(encoded) > digits) { encoded = encoded[..digits-1]; } return set(array_sscanf(encoded, "%d")[0]); } LocaleString|string doc() { return ::doc() + sprintf((string)LOCALE(1120, "<p>%d is the highest priority and " "0 the lowest.</p>"), _max); } } // ===================================================================== // String // ===================================================================== class String //! String variable { inherit Variable; constant type = "String"; int width = 60; //! The width of the input field. Used by overriding classes. string diff( int render ) { if(!render) return "("+Roxen.html_encode_string( default_value() )+")"; } array(string) verify_set_from_form( mixed new ) { return ({ 0, [string]new-"\r" }); } string render_form( RequestID id, void|mapping additional_args ) { additional_args = additional_args || ([]); if (!additional_args->type) additional_args->type="text"; return input(path(), (string)query(), width, additional_args); } } // ===================================================================== // Text // ===================================================================== class Text //! Text (multi-line string) variable { inherit String; constant type = "Text"; int cols = 56; //! The width of the textarea int rows = 10; //! The height of the textarea string diff( int render ) { switch( render ) { case 0: return 0; case 1: return ""; case 2: array lines_orig = default_value()/"\n"; array lines_new = query()/"\n"; Diff diff = Diff( lines_new, lines_orig, 2 ); if( sizeof(diff->get()) ) return diff->html(); else return "<i>"+LOCALE(481,"No difference\n" )+"</i>"; } } array(string) verify_set_from_form( mixed new ) { return ({ 0, [string]new-"\r" }); } string render_form( RequestID id, void|mapping additional_args ) { return "<textarea cols='"+cols+"' rows='"+rows+"' name='"+path()+"' wrap='off'>" + Roxen.html_encode_string( query() || "" ) + "</textarea>"; } protected void create(mixed default_value, void|int flags, void|LocaleString std_name, void|LocaleString std_doc) //! Constructor. //! Flags is a bitwise or of one or more of //! //! VAR_EXPERT Only for experts //! VAR_MORE Only visible when more-mode is on (default on) //! VAR_DEVELOPER Only visible when devel-mode is on (default on) //! VAR_INITIAL Should be configured initially. //! //! The std_name and std_doc is the name and documentation string //! for the default locale (always english) { if( strlen( default_value ) && default_value[0] == '\n' ) // This is enforced by both netscape and IE... So let's just conform. default_value = default_value[1..]; ::create( default_value, flags, std_name, std_doc ); } } // ===================================================================== // Password // ===================================================================== class Password //! Password variable (uses crypt_password) { inherit String; int width = 40; constant type = "Password"; int(0..1) set_from_form( RequestID id ) { mapping val; if( sizeof( val = get_form_vars(id)) && val[""] && strlen(val[""]) ) { set( crypt_password( val[""] ) ); return 1; } return 0; } string render_view( RequestID id ) { return "******"; } string render_form( RequestID id, void|mapping additional_args ) { additional_args = additional_args || ([]); additional_args->type="password"; return input(path(), "", 30, additional_args); } } class File //! A filename { inherit String; constant type = "File"; int width = 60; string read( ) //! Read the file as a string. { return Stdio.read_bytes( query() ); } Stat stat() //! Stat the file { return file_stat( query() ); } #ifdef __NT__ array verify_set( string value ) { return ::verify_set( replace( value, "\\", "/" ) ); } #endif } class Location //! A location in the virtual filesystem { inherit String; constant type = "Location"; int width = 60; array verify_set( string value ) { if( !strlen( value ) || !((<'~','/'>)[value[-1]]) ) return ({ LOCALE(330,"You most likely want an ending '/' on this variable"), value }); return ::verify_set( value ); } } class URL //! A URL. { inherit String; constant type = "URL"; int width = 60; array verify_set_from_form( string new_value ) { return verify_port( new_value ); } } class Directory //! A Directory. { inherit String; constant type = "Directory"; int width = 60; array verify_set( string value ) { #ifdef __NT__ value = replace( value, "\\", "/" ); #endif if( strlen(value) && value[-1] != '/' ) value += "/"; if( !strlen( value ) ) return ::verify_set( value ); if( !(r_file_stat( value ) && (r_file_stat( value )[ ST_SIZE ] == -2 ))) return ({sprintf(LOCALE(331,"%s is not a directory"),value)+"\n",value}); return ::verify_set( value ); } Stat stat() //! Stat the directory { return file_stat( query() ); } array get( ) //! Return a listing of all files in the directory { return get_dir( query() ); } } // ===================================================================== // MultipleChoice (one of many) baseclass // ===================================================================== class MultipleChoice //! Base class for multiple-choice (one or many of many) variables. { inherit Variable; protected array _list = ({}); protected mapping _table = ([]); protected int(0..1) multiselect; //! Identifier to use to detect presence of //! support for multiselect mode. constant multiselect_supported = 1; array(string|array(string)) verify_set(mixed to) { if (multiselect && stringp(to)) { return ({ "Compatibility: " "Converted to multi-select.\n", ({ to }), }); } else if (!multiselect && arrayp(to)) { return ({ "Compatibility: " "Converted to single-select.\n", sizeof (to) ? to[0] : default_value(), }); } return ::verify_set(to); } string diff( int render ) { if(!render) { if (multiselect) return "(" + map(default_value(), _title) * ", " + ")"; return "("+_title( default_value() )+")"; } } void set_choice_list( array to ) //! Set the list of choices. { _list = to; } array get_choice_list( ) //! Get the list of choices. Used by this class as well. //! You can overload this function if you want a dynamic list. { return _list; } void set_translation_table( mapping to ) //! Set the lookup table. { _table = to; } mapping get_translation_table( ) //! Get the lookup table. Used by this class as well. //! You can overload this function if you want a dynamic table. { return _table; } int(0..1) set_from_form(RequestID id, void|int(0..1) force) { if (!multiselect) return ::set_from_form(id); if (!id->real_variables[path()]) return 0; set_warning(0); mapping(string:string) m = get_form_vars(id); array(mixed) values = ({}); foreach(id->real_variables[path()] || ({}), string form_val) { mixed val = transform_from_form(form_val, m); array b = ({ 0, val }); mixed err = catch { b = verify_set_from_form(val); }; if (err) { add_warning(err); return 0; } else if (sizeof(b) != 2) { add_warning("Internal error: Illegal sized array " "from verify_set_from_form\n"); return 0; } if (b[0]) { add_warning(b[0]); } values += ({ b[1] }); } set(values); return 1; } protected string _name( mixed what ) //! Get the name used as value for an element gotten from the //! get_choice_list() function. { return (string)what; } protected string _title( mixed what ) //! Get the title used as description (shown to the user) for an //! element gotten from the get_choice_list() function. { if( mapping tt = get_translation_table() ) return tt[ what ] || (string)what; return (string)what; } string render_form( RequestID id, void|mapping additional_args ) { string autosubmit = ""; if(additional_args && additional_args->autosubmit) autosubmit = " autosubmit='autosubmit' onChange='javascript:submit();'"; if (multiselect) { array(string) current = map(query(), _name); string res = "<table>\n"; foreach( get_choice_list(), mixed elem ) { mapping m = ([ "type": "checkbox", "name": path(), "value": _name(elem), ]); if(has_value(current, m->value)) { m->checked="checked"; current -= ({ m->value }); } res += sprintf("<tr><td>%s</td><td>%s</td></tr>\n", Roxen.make_tag( "input", m), Roxen.html_encode_string(_title(elem))); } // Make an entry for the current values if they're not in the list, // to ensure that the value doesn't change as a side-effect by // another change. foreach(current, string value) { mapping m = ([ "type": "checkbox", "name": path(), "value": value, "checked": "checked", ]); string title = sprintf(LOCALE(1121,"(stale value %s)"), value); res += sprintf("<tr><td>%s</td><td>%s</td></tr>\n", Roxen.make_tag( "input", m), Roxen.html_encode_string(title)); } return res + "</table>"; } else { string current = _name (query()); int selected = 0; string res = "<select name='"+path()+"'"+autosubmit+">\n"; foreach( get_choice_list(), mixed elem ) { mapping m = ([]); m->value = _name( elem ); if( equal( m->value, current ) ) { m->selected="selected"; selected = 1; } res += " "+Roxen.make_container( "option", m, _title( elem ) )+"\n"; } if (!selected) // Make an entry for the current value if it's not in the list, // so no other value appears to be selected, and to ensure that // the value doesn't change as a side-effect by another change. res += " " + Roxen.make_container ( "option", (["value":current, "selected": "selected"]), sprintf(LOCALE(332,"(keep stale value %s)"),current)); return res + "</select>"; } } protected void create( mixed default_value, array|mapping choices, void|int _flags, void|LocaleString std_name, void|LocaleString std_doc ) //! Constructor. //! //! Choices is the list of possible choices, can be set with //! set_choice_list at any time. //! //! Flags is a bitwise or of one or more of //! //! VAR_EXPERT Only for experts //! VAR_MORE Only visible when more-mode is on (default on) //! VAR_DEVELOPER Only visible when devel-mode is on (default on) //! VAR_INITIAL Should be configured initially. //! //! The std_name and std_doc is the name and documentation string //! for the default locale (always english) { ::create( default_value, _flags, std_name, std_doc ); multiselect = arrayp(default_value); if( mappingp( choices ) ) { set_translation_table( choices ); set_choice_list( sort(indices(choices)) ); } else set_choice_list( choices ); } } // ===================================================================== // MultipleChoice subclasses // ===================================================================== class StringChoice //! Select one of many strings. { inherit MultipleChoice; constant type = "StringChoice"; } class IntChoice //! Select one of many integers. { inherit MultipleChoice; constant type = "IntChoice"; int transform_from_form( string what ) { return (int)what; } } class FloatChoice //! Select one of many floating point (real) numbers. { inherit MultipleChoice; constant type = "FloatChoice"; protected int _prec = 3; void set_precision( int prec ) //! Set the number of _decimals_ shown to the user. //! If prec is 3, and the float is 1, 1.000 will be shown. //! Default is 2. { _prec = prec; } protected string _title( mixed what ) { if( !_prec ) return sprintf( "%d", (int)what ); return sprintf( "%1."+_prec+"f", what ); } int transform_from_form( string what ) { array q = get_choice_list(); mapping a = mkmapping( map( q, _name ), q ); return a[what] || (float)what; // Do we want this fallback? } } class FontChoice //! Select a font from the list of available fonts { inherit StringChoice; constant type = "FontChoice"; void set_choice_list() { } array get_choice_list() { return roxenp()->fonts->available_fonts(); } protected void create(mixed default_value, void|int flags, void|LocaleString std_name, void|LocaleString std_doc) //! Constructor. //! Flags is a bitwise or of one or more of //! //! VAR_EXPERT Only for experts //! VAR_MORE Only visible when more-mode is on (default on) //! VAR_DEVELOPER Only visible when devel-mode is on (default on) //! VAR_INITIAL Should be configured initially. //! //! The std_name and std_doc is the name and documentation string //! for the default locale (always english) { ::create( default_value, 0, flags,std_name, std_doc ); } } class TableChoice { inherit StringChoice; constant type = "TableChoice"; Variable db; array(string) get_choice_list( ) { return sort(DBManager.db_tables( db->query() )); } void create( string default_value, void|int flags, void|LocaleString std_name, void|LocaleString std_doc, Variable _dbchoice ) { ::create( default_value, ({}), flags, std_name, std_doc ); db = _dbchoice; } } class DatabaseChoice //! Select a database from all available databases. { inherit StringChoice; constant type = "DatabaseChoice"; function(void:void|object) config = lambda() { return 0; }; DatabaseChoice set_configuration_pointer( function(void:object) configuration ) //! Provide a function that returns a configuration object, //! that will be used for authentication against the database //! manager. Typically called as //! @expr{set_configuration_pointer(my_configuration)@}. { config = configuration; return this_object(); } array get_choice_list( ) { if (!functionp(config)) { // Some modules apparently send in a configration reference instead of // a function pointer when calling set_configuration_pointer(). report_warning("Incorrect usage of Variable.DatabaseChoice:\n\n%s", describe_backtrace(backtrace())); return ({ " none" }); } return ({ " none" }) + sort(DBManager.list( config() )); } protected void create(string default_value, void|int flags, void|LocaleString std_name, void|LocaleString std_doc) { ::create( default_value, ({}), flags, std_name, std_doc ); } } class AuthMethodChoice { inherit StringChoice; constant type = "AuthMethodChoice"; protected Configuration config; array get_choice_list( ) { return ({ " all" }) + sort( config->auth_modules()->name ); } protected void create( string default_value, int flags, string std_name, string std_doc, Configuration c ) { config = c; ::create( default_value, ({}), flags, std_name, std_doc ); } } class UserDBChoice { inherit StringChoice; constant type = "UserDBChoice"; protected Configuration config; array get_choice_list( ) { return ({ " all" }) + sort( config->user_databases()->name ); } protected void create( string default_value, int flags, string std_name, string std_doc, Configuration c ) { config = c; ::create( default_value, ({}), flags, std_name, std_doc ); } } //! Select a module in the current configuration. class ModuleChoice { inherit StringChoice; constant type = "ModuleChoice"; protected Configuration conf; protected string|array(string) module_id; protected string|array(string) default_id; protected int automatic_dependency; int low_set(array(RoxenModule)|RoxenModule to) { array(RoxenModule)|RoxenModule old = changed_values[_id]; if (!old) { if (module_id) { if (multiselect) { old = map(module_id, transform_from_form); } else { old = transform_from_form(module_id); } } else { old = default_value(); if (old) { module_id = _name(old); } } if (old) { changed_values[_id] = old; } } if (equal (to, old)) return 0; changed_values[_id] = to; if (multiselect) { array(string) names = map (to, _name); if (equal (module_id, names)) return 0; // Reloaded module or similar. module_id = names; } else { if (module_id == _name(to)) return 0; // Reloaded module or similar. module_id = _name(to); } if( get_changed_callback() ) get_changed_callback()( this_object() ); return 1; } // NOTE: Will be called with a string at module init! int set(string|array(string)|RoxenModule|array(RoxenModule) to) { if (multiselect && arrayp(to) && sizeof(to) && stringp(to[0])) { module_id = to; array(RoxenModule) mods = map(to, transform_from_form); if (automatic_dependency) { foreach(mods; int i; RoxenModule mod) { if (!mod && conf->enabled_modules[to[i]]) { conf->add_modules(({to[i]}), 1); mod = transform_from_form(to[i]); } if (!mod && conf->enabled_modules[to[i]]) // The module exists but isn't started yet. Don't call set() // in this case since that will cause a bogus warning. return 0; mods[i] = mod; } } // FIXME: Modules that have disappeared from the configuration // will be silently removed here. To fix that, "to" must be able // to hold a mix of RoxenModule and string, and low_set must be // updated accordingly. Also, see query(). to = mods - ({ 0 }); } else if (stringp(to)) { module_id = to; RoxenModule mod = transform_from_form (to); if (!mod && automatic_dependency && conf->enabled_modules[to]) { conf->add_modules (({to}), 1); mod = transform_from_form (to); } if (!mod && conf->enabled_modules[to]) // The module exists but isn't started yet. Don't call set() // in this case since that will cause a bogus warning. return 0; to = mod; } return ::set(to); } RoxenModule|array(RoxenModule) query() { array(RoxenModule)|RoxenModule res = changed_values[_id]; if (!res || (multiselect && has_value(res, 0))) { if (module_id) { // The module might have been reloaded. // Try locating it again. if (multiselect) { res = map(module_id, transform_from_form) - ({ 0 }); } else { res = transform_from_form(module_id); } } else { res = default_value(); } if (res) low_set(res); } return res; } //! Fetch the unsorted list of choices. protected array low_get_choice_list() { return indices(conf->otomod); } array get_choice_list() { array res = low_get_choice_list(); // Sort order: // priority: descending, // title: ascending, // module_id: ascending. sort(res->module_local_id(), res); sort(map(res, _title), res); res = reverse(res); sort(res->query("_priority"), res); res = reverse(res); return res; } protected string _name(RoxenModule val) { return val?val->module_local_id():""; } protected string _title(RoxenModule val) { return val?Roxen.get_modfullname(val):""; } RoxenModule transform_from_form(string module_id, mapping|void v) { return conf->find_module(module_id); } RoxenModule|array(RoxenModule) default_value() { if (default_id) { if (multiselect) return map(default_id, transform_from_form); return transform_from_form(default_id); } array(RoxenModule) modules = get_choice_list(); if (sizeof(modules)) { return modules[0]; } return UNDEFINED; } array(string|mixed) verify_set( mixed new_value ) { if (!new_value) { return ({ "Not configured", 0 }); } return ({ 0, new_value }); } //! @param default_id //! The @[RoxenModule.module_local_id] of the default value. //! @param conf //! The current configuration. //! @param no_automatic_dependency //! Do not automatically depend on the chosen module. Normally, if //! it already exists in the configuration then it will be loaded //! before @expr{start@} in this module is called. Setting this //! flag disables that. protected void create(string|array(string) default_id, int flags, string std_name, string std_doc, Configuration conf, void|int no_automatic_dependency) { this_program::default_id = default_id; this_program::conf = conf; automatic_dependency = !no_automatic_dependency; ::create(0, ({}), flags, std_name, std_doc); multiselect = arrayp(default_id); } } //! Select a module that provides the specified interface. class ProviderChoice { inherit ModuleChoice; constant type = "ProviderChoice"; protected string provides; protected array low_get_choice_list() { return conf->get_providers(provides); } //! @param default_id //! The @[RoxenModule.module_local_id] of the default value. //! @param provides //! The provider string to match modules against. //! @param conf //! The current configuration. protected void create(string default_id, int flags, string std_name, string std_doc, string provides, Configuration conf) { this_program::provides = provides; ::create(default_id, flags, std_name, std_doc, conf); } } // ===================================================================== // List baseclass // ===================================================================== class List //! Many of one type types { inherit Variable; constant type="List"; int width = 60; array(string|array(string)) verify_set(mixed to) { if (stringp(to)) { // Backward compatibility junk... return ({ "Compatibility: " "Converted from TYPE_STRING to TYPE_STRING_LIST.\n", map(to/",", global.String.trim_all_whites), }); } return ::verify_set(to); } string transform_to_form( mixed what ) //! Override this function to do the value->form mapping for //! individual elements in the array. { return (string)what; } mixed transform_from_form( string what,mapping v ) { return what; } protected int _current_count = time()*100+(gethrtime()/10000); int(0..1) set_from_form(RequestID id) { int rn, do_goto; array l = copy_value(query()); mapping vl = get_form_vars(id); // first do the assign... if( (int)vl[".count"] != _current_count ) return 0; _current_count++; set_warning(0); foreach( indices( vl ), string vv ) if( sscanf( vv, ".set.%d", rn ) && (vv == ".set."+rn) ) { if ((rn >= 0) && (rn < sizeof(l))) { m_delete( id->real_variables, path()+vv ); l[rn] = transform_from_form( vl[vv], vl ); m_delete( vl, vv ); } else { report_debug("set_from_form(%O): vv:%O sizeof(l):%d\n", id, vv, sizeof(l)); } } // then the move... foreach( indices(vl), string vv ) if( sscanf( vv, ".up.%d.x%*s", rn ) == 2 ) { do_goto = 1; m_delete( id->real_variables, path()+vv ); m_delete( vl, vv ); l = l[..rn-2] + l[rn..rn] + l[rn-1..rn-1] + l[rn+1..]; } else if( sscanf( vv, ".down.%d.x%*s", rn )==2 ) { do_goto = 1; m_delete( id->real_variables, path()+vv ); l = l[..rn-1] + l[rn+1..rn+1] + l[rn..rn] + l[rn+2..]; } // then the possible add. if( vl[".new.x"] ) { do_goto = 1; m_delete( id->real_variables, path()+".new.x" ); l += ({ transform_from_form( "",vl ) }); } // .. and delete .. foreach( indices(vl), string vv ) if( sscanf( vv, ".delete.%d.x%*s", rn )==2 ) { do_goto = 1; m_delete( id->real_variables, path()+vv ); l = l[..rn-1] + l[rn+1..]; } array b; mixed q = catch( b = verify_set_from_form( l ) ); if( q || sizeof( b ) != 2 ) { if( q ) add_warning( q ); else add_warning( "Internal error: Illegal sized array " "from verify_set_from_form\n" ); return 0; } int ret; if( b ) { add_warning( b[0] ); set( b[1] ); ret = 1; } if( do_goto && !id->misc->do_not_goto ) { RequestID nid = id; while( nid->misc->orig ) nid = id->misc->orig; string section = RXML.get_var("section", "var"); string query = nid->query; if( !query ) query = ""; else query += "&"; // The URL will get a fragment identifier below and since some // broken browsers (MSIE) incorrectly includes the fragment in // the last variable value we'll place section before random. query += (section ? ("section=" + section + "&") : "") + "random=" + random(4949494); query += "&_roxen_wizard_id=" + id->cookies["RoxenWizardId"]; string url = Roxen.http_encode_invalids (nid->not_query + (nid->misc->path_info || "") + "?" + query + "#" + path()); nid->set_response_header ("Location", url); if( nid->misc->defines ) nid->misc->defines[ " _error" ] = 302; else if( id->misc->defines ) id->misc->defines[ " _error" ] = 302; } return ret; } string render_row(string prefix, mixed val, int width) { return input( prefix, val, width ); } string render_form( RequestID id, void|mapping additional_args ) { string prefix = path()+"."; int i; string res = "<a name='"+path()+"'>\n</a><table class='auto rxn-var-list'>\n" "<input type='hidden' name='"+prefix+"count' value='"+_current_count+"' />\n"; foreach( map(query(), transform_to_form), mixed val ) { res += "<tr>\n<td><span class='small'>"+ render_row(prefix+"set."+i, val, width) + "</span></td>\n"; #define BUTTON(X,Y) ("<submit-gbutton2 name='"+X+"'>"+Y+"</submit-gbutton2>") #define REORDER(X,Y) ("<submit-gbutton2 name='"+X+"' icon-src='"+Y+"'></submit-gbutton2>") #define DIMBUTTON(X) ("<disabled-gbutton icon-src='"+X+"'></disabled-gbutton>") if( i ) res += "\n<td class='rxn-btn-td'>"+ REORDER(prefix+"up."+i, "/internal-roxen-up")+ "</td>"; else res += "\n<td class='rxn-btn-td'>"+DIMBUTTON("/internal-roxen-up")+"</td>"; if( i != sizeof( query())- 1 ) res += "\n<td class='rxn-btn-td'>"+ REORDER(prefix+"down."+i, "/internal-roxen-down") +"</td>"; else res += "\n<td class='rxn-btn-td'>"+DIMBUTTON("/internal-roxen-down")+"</td>"; res += "\n<td class='rxn-btn-td'>"+ BUTTON(prefix+"delete."+i, LOCALE(227, "Delete") ) +"</td>"; "</tr>"; i++; } res += "\n<tr><td colspan='4' class='rxn-new-row'>"+ BUTTON(prefix+"new", LOCALE(297, "New row") )+ "</td></tr></table>\n\n"; return res; } } // ===================================================================== // List subclasses // ===================================================================== class DirectoryList //! A list of directories { inherit List; constant type="DirectoryList"; array verify_set( array(string) value ) { string warn = ""; foreach( value, string vi ) { if(!strlen(vi)) // empty continue; if( !(r_file_stat( vi ) && (r_file_stat( vi )[ ST_SIZE ] == -2 ))) warn += sprintf(LOCALE(331,"%s is not a directory"),vi)+"\n"; if( strlen(vi) && vi[-1] != '/' ) value = replace( value, vi, vi+"/" ); } #ifdef __NT__ value = map( value, replace, "\\", "/" ); #endif if( strlen( warn ) ) return ({ warn, value }); return ::verify_set( value ); } } class StringList //! A list of strings { inherit List; constant type="StringList"; } class IntList //! A list of integers { inherit List; constant type="IntList"; int width=20; string transform_to_form(int what) { return (string)what; } int transform_from_form(string what,mapping v) { return (int)what; } } class FloatList //! A list of floating point numbers { inherit List; constant type="FloatList"; int width=20; protected int _prec = 3; void set_precision( int prec ) //! Set the number of _decimals_ shown to the user. //! If prec is 3, and the float is 1, 1.000 will be shown. //! Default is 2. { _prec = prec; } string transform_to_form(int what) { return sprintf("%1."+_prec+"f", what); } float transform_from_form(string what,mapping v) { return (float)what; } } class URLList //! A list of URLs { inherit List; constant type="URLList"; array verify_set_from_form( array(string) new_value ) { string warn = ""; array res = ({}); foreach( new_value, string vv ) { string tmp1, tmp2; [tmp1,tmp2] = verify_port( vv ); if( tmp1 ) warn += tmp1; res += ({ tmp2 }); } if( !strlen( warn ) ) warn = 0; return ({ warn, res }); } } class PortList //! A list of Port URLs { inherit List; constant type="PortList"; string render_row( string prefix, mixed val, int width ) { string res = "<input type=hidden name='"+prefix+"' value='"+prefix+"' />"; Standards.URI split = Standards.URI( val ); res += "<div class='rxn-port'><div class='port-url'><select name='"+prefix+"prot'>"; int default_port; foreach( sort(indices( roxenp()->protocols )), string p ) { if( p == split->scheme ) { res += "<option selected='t'>"+p+"</option>"; default_port = roxenp()->protocols[p]->default_port; } else res += "<option>"+p+"</option>"; } res += "</select>"; res += "://<input type=text name='"+prefix+"host' value='"+ Roxen.html_encode_string(split->host)+"' />"; res += ":<input type=text size=5 name='"+prefix+"port' value='"+ (split->port == default_port ? "" : split->port) +"' />"; res += "/<input type=text name='"+prefix+"path' value='"+ Roxen.html_encode_string(split->path[1..])+"' /></div>"; mapping opts = ([]); string a,b; foreach( (split->fragment||"")/";", string x ) { sscanf( x, "%s=%s", a, b ); opts[a]=b; } res += "<div class='port-ip'>IP#: <input size=15 type=text name='"+prefix+"ip' value='"+ Roxen.html_encode_string(opts->ip||"")+"' /> "; res += LOCALE(510,"Bind this port: "); res += "<select name='"+prefix+"nobind'>"; if( (int)opts->nobind ) { res += ("<option value='0'>"+LOCALE("yes","Yes")+"</option>" "<option selected='t' value='1'>"+LOCALE("no","No")+"</option>"); } else { res += ("<option selected='t' value='0'>"+LOCALE("yes","Yes")+"</option>" "<option value='1'>"+LOCALE("no","No")+"</option>"); } res += "</select></div></div>"; return res; } string transform_from_form( string v, mapping va ) { if( v == "" ) return "http://*/"; v = v[strlen(path())..]; if( strlen( va[v+"path"] ) && va[v+"path"][-1] != '/' ) va[v+"path"]+="/"; // Handle IPv6 addresses string host = va[v + "host"]; if (has_value(host, ":") && !has_prefix(host, "[")) host = "[" + host + "]"; return (string)Standards.URI(va[v+"prot"]+"://"+ host + (va[v+"port"] && sizeof (va[v+"port"]) ? ":"+ va[v+"port"] : "") +"/"+va[v+"path"]+"#" // all options below this point "ip="+va[v+"ip"]+";" "nobind="+va[v+"nobind"]+";" ); } array verify_set_from_form( array(string) new_value ) { string warn = ""; array res = ({}); foreach( new_value, string vv ) { string tmp1, tmp2; [tmp1,tmp2] = verify_port( vv ); if( tmp1 ) warn += tmp1; res += ({ tmp2 }); } if( !strlen( warn ) ) warn = ""; return ({ warn, res }); } } class FileList //! A list of filenames. { inherit List; constant type="FileList"; #ifdef __NT__ array(string|array(string)) verify_set(mixed value ) { // Backward compatibility junk... if (stringp(value)) return ::verify_set( replace(value, "\\", "/") ); return ::verify_set( map( value, replace, "\\", "/" ) ); } #endif } // ===================================================================== // Flag // ===================================================================== class Flag //! A on/off toggle. { inherit Variable; constant type = "Flag"; int transform_from_form( string what ) { return (int)what; } string render_form( RequestID id, void|mapping additional_args ) { string res = "<select name=\""+path()+"\"> "; if(query()) res += "<option value=\"1\" selected=\"selected\">" + LOCALE("yes", "Yes")+ "</option>\n" "<option value=\"0\">" +LOCALE("no", "No")+ "</option>\n"; else res += "<option value=\"1\">" +LOCALE("yes", "Yes")+ "</option>\n" "<option value=\"0\" selected>" +LOCALE("no", "No")+ "</option>\n"; return res+"</select>"; } } // ================================================================= // Utility functions used in multiple variable classes above // ================================================================= protected array(string) verify_port( string port ) { if(!strlen(port)) return ({ 0, port }); string warning=""; if( (int)port ) { warning += sprintf(LOCALE(333,"Assuming http://*:%[0]d/ for %[0]d")+"\n", (int)port); port = "http://*:"+port+"/"; } string protocol, host, path; if(!strlen( port ) ) return ({ LOCALE(334,"Empty URL field")+"\n", port }); if(sscanf( port, "%[^:]://%[^/]%s", protocol, host, path ) != 3) return ({ sprintf(LOCALE(335,"%s does not conform to URL syntax")+"\n",port), port }); // if( path == "" || path[-1] != '/' ) // { // warning += sprintf(LOCALE(336,"Added / to the end of %s")+"\n",port); // path += "/"; // } if( protocol != lower_case( protocol ) ) { warning += sprintf(LOCALE(338,"Changed %s to %s"), protocol, lower_case( protocol ))+"\n"; protocol = lower_case( protocol ); } #if constant(SSL.File) // All is A-OK #else if( (protocol == "https" || protocol == "ftps") ) warning += LOCALE(339,"SSL support not available in this Pike version.")+"\n"+ sprintf(LOCALE(340,"Please use %s instead."), protocol[..strlen(protocol)-2])+"\n"; #endif int pno; int default_pno = (roxenp()->protocols[lower_case(protocol)] || ([ ]) )->default_port; if (has_value(host, "[")) { // IPv6 address Standards.URI uri = Standards.URI(port); pno = uri->port; port = (string) uri; } else { if (sscanf(host, "%s:%d", host, pno) == 2) if (pno != default_pno) host = host + ":" + pno; port = protocol+"://"+host+path; } if (default_pno && (pno == default_pno)) warning += sprintf(LOCALE(341, "Removed the default port number " "(%d) from %s"), pno, port) + "\n"; if( !roxenp()->protocols[ protocol ] ) warning += sprintf(LOCALE(342,"Warning: The protocol %s is not known " "by roxen"),protocol)+"\n"; return ({ (strlen(warning)?warning:0), port }); } string input(string name, string value, int size, void|mapping(string:string) args, void|int noxml) { if(!args) args=([]); else args+=([]); args->name=name; if(value) args->value = Roxen.html_encode_string(value); if(!args->size && size) args->size=(string)size; string render="<input"; foreach(indices(args), string attr) { render+=" "+attr+"="; if(!has_value(args[attr], "\"")) render+="\""+args[attr]+"\""; else if(!has_value(args[attr], "'")) render+="'"+args[attr]+"'"; else render+="'"+replace(args[attr], "'", "'")+"'"; } // render = "<tt>" + Roxen.html_encode_string(name) + "</tt><br />\n" + render; if(noxml) return render+">"; return render+" />"; }

Roxen.git/ server/ etc/ modules/ Variable.pmod/ module.pmod > 04e337f37d59a196b58fe6df7420427fd919a29f [Annotate]