1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 <?php
// error_reporting(E_ALL); ini_set('display_errors', 1); // uncomment this line for debugging
/**
* Project: Securimage: A PHP class dealing with CAPTCHA images, audio, and validation
* File: securimage.php
*
* Copyright (c) 2016, Drew Phillips
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* Any modifications to the library should be indicated clearly in the source code
* to inform users that the changes are not a part of the original software.
*
* If you found this script useful, please take a quick moment to rate it.
* http://www.hotscripts.com/rate/49400.html Thanks.
*
* @link http://www.phpcaptcha.org Securimage PHP CAPTCHA
* @link http://www.phpcaptcha.org/latest.zip Download Latest Version
* @link http://www.phpcaptcha.org/Securimage_Docs/ Online Documentation
* @copyright 2016 Drew Phillips
* @author Drew Phillips <drew@drew-phillips.com>
* @version 3.6.4 (Mar 3, 2016)
* @package Securimage
*
*/
/**
ChangeLog
3.6.4
- Fix XSS vulnerability in example_form.ajax.php (Discovered by RedTeam. advisory rt-sa-2016-002)
- Update example_form.ajax.php to use Securimage::getCaptchaHtml()
3.6.3
- Add support for multibyte wordlist files
- Fix code generation issues with UTF-8 charsets
- Add parameter to getCaptchaHtml() method to control display components of captcha HTML
- Fix database audio storage issue with multiple namespaces
3.6.2
- Support HTTP range requests with audio playback (iOS requirement)
- Add optional config.inc.php for storing global configuration settings
3.6.1
- Fix copyElement bug in securimage.js for IE Flash fallback
3.6
- Implement CAPTCHA audio using HTML5 <audio> with optional Flash fallback
- Support MP3 audio using LAME MP3 Encoder (Internet Explorer 9+ does not support WAV format in <audio> tags)
- Add getCaptchaHtml() options to support full framework integration (ruifil)
3.5.4
- Fix email validation code in example form files
- Fix backslashes in getCaptchaHtml for img attribute on Windows systems
3.5.3
- Add options for audio button to getCaptchaHtml(), fix urlencoding of flash parameters that was breaking button
3.5.2
- Add Securimage::getCaptchaHtml() for getting automatically generated captcha html code
- Option for using SoX to add effects to captcha audio to make identification by neural networks more difficult
- Add setNamespace() method
- Add getTimeToSolve() method
- Add session_status() check so session still starts if one had previously been opened and closed
- Add .htaccess file to audio directory to deny access; update audio files
- Option to skip checking of database tables during connection
- Add composer.json to package, submit to packagist
- Add font_ratio variable to determine size of font (github.com/wilkor)
- Add hint if sqlite3 database is not writeable. Improve database error handling, add example database options to securimage_play.php
- Fixed issue regarding database storage and math captcha breaking audio output (github.com/SoftwareAndOutsourcing)
3.5.1
- Fix XSS vulnerability in example_form.php (discovered by Gjoko Krstic - <gjoko@zeroscience.mk>)
3.5
- Release new version
- MB string support for charlist
- Modify audio file path to use language directories
- Changed default captcha appearance
3.2RC4
- Add MySQL, PostgreSQL, and SQLite3 support for database storage
- Deprecate "use_sqlite_db" option and remove SQLite2/sqlite_* functions
- Add new captcha type that displays 2 dictionary words on one image
- Update examples
3.2RC3
- Fix canSendHeaders() check which was breaking if a PHP startup error was issued
3.2RC2
- Add error handler (https://github.com/dapphp/securimage/issues/15)
- Fix flash examples to use the correct value name for audio parameter
3.2RC1
- New audio captcha code. Faster, fully dynamic audio, full WAV support
(Paul Voegler, Drew Phillips) <http://voegler.eu/pub/audio>
- New Flash audio streaming button. User defined image and size supported
- Additional options for customizing captcha (noise_level, send_headers,
no_exit, no_session, display_value
- Add captcha ID support. Uses sqlite and unique captcha IDs to track captchas,
no session used
- Add static methods for creating and validating captcha by ID
- Automatic clearing of old codes from SQLite database
3.0.3Beta
- Add improved mixing function to WavFile class (Paul Voegler)
- Improve performance and security of captcha audio (Paul Voegler, Drew Phillips)
- Add option to use random file as background noise in captcha audio
- Add new securimage options for audio files
3.0.2Beta
- Fix issue with session variables when upgrading from 2.0 - 3.0
- Improve audio captcha, switch to use WavFile class, make mathematical captcha audio work
3.0.1
- Bugfix: removed use of deprecated variable in addSignature method that would cause errors with display_errors on
3.0
- Rewrite class using PHP5 OOP
- Remove support for GD fonts, require FreeType
- Remove support for multi-color codes
- Add option to make codes case-sensitive
- Add namespaces to support multiple captchas on a single page or page specific captchas
- Add option to show simple math problems instead of codes
- Remove support for mp3 files due to vulnerability in decoding mp3 audio files
- Create new flash file to stream wav files instead of mp3
- Changed to BSD license
2.0.2
- Fix pathing to make integration into libraries easier (Nathan Phillip Brink ohnobinki@ohnopublishing.net)
2.0.1
- Add support for browsers with cookies disabled (requires php5, sqlite) maps users to md5 hashed ip addresses and md5 hashed codes for security
- Add fallback to gd fonts if ttf support is not enabled or font file not found (Mike Challis http://www.642weather.com/weather/scripts.php)
- Check for previous definition of image type constants (Mike Challis)
- Fix mime type settings for audio output
- Fixed color allocation issues with multiple colors and background images, consolidate allocation to one function
- Ability to let codes expire after a given length of time
- Allow HTML color codes to be passed to Securimage_Color (suggested by Mike Challis)
2.0.0
- Add mathematical distortion to characters (using code from HKCaptcha)
- Improved session support
- Added Securimage_Color class for easier color definitions
- Add distortion to audio output to prevent binary comparison attack (proposed by Sven "SavageTiger" Hagemann [insecurity.nl])
- Flash button to stream mp3 audio (Douglas Walsh www.douglaswalsh.net)
- Audio output is mp3 format by default
- Change font to AlteHaasGrotesk by yann le coroller
- Some code cleanup
1.0.4 (unreleased)
- Ability to output audible codes in mp3 format to stream from flash
1.0.3.1
- Error reading from wordlist in some cases caused words to be cut off 1 letter short
1.0.3
- Removed shadow_text from code which could cause an undefined property error due to removal from previous version
1.0.2
- Audible CAPTCHA Code wav files
- Create codes from a word list instead of random strings
1.0
- Added the ability to use a selected character set, rather than a-z0-9 only.
- Added the multi-color text option to use different colors for each letter.
- Switched to automatic session handling instead of using files for code storage
- Added GD Font support if ttf support is not available. Can use internal GD fonts or load new ones.
- Added the ability to set line thickness
- Added option for drawing arced lines over letters
- Added ability to choose image type for output
*/
/**
* Securimage CAPTCHA Class.
*
* A class for creating and validating secure CAPTCHA images and audio.
*
* The class contains many options regarding appearance, security, storage of
* captcha data and image/audio generation options.
*
* @version 3.5.2
* @package Securimage
* @subpackage classes
* @author Drew Phillips <drew@drew-phillips.com>
*
*/
class Securimage
{
// All of the public variables below are securimage options
// They can be passed as an array to the Securimage constructor, set below,
// or set from securimage_show.php and securimage_play.php
/**
* Constant for rendering captcha as a JPEG image
* @var int
*/
const SI_IMAGE_JPEG = 1;
/**
* Constant for rendering captcha as a PNG image (default)
* @var int
*/
const SI_IMAGE_PNG = 2;
/**
* Constant for rendering captcha as a GIF image
* @var int
*/
const SI_IMAGE_GIF = 3;
/**
* Constant for generating a normal alphanumeric captcha based on the
* character set
*
* @see Securimage::$charset charset property
* @var int
*/
const SI_CAPTCHA_STRING = 0;
/**
* Constant for generating a captcha consisting of a simple math problem
*
* @var int
*/
const SI_CAPTCHA_MATHEMATIC = 1;
/**
* Constant for generating a word based captcha using 2 words from a list
*
* @var int
*/
const SI_CAPTCHA_WORDS = 2;
/**
* MySQL option identifier for database storage option
*
* @var string
*/
const SI_DRIVER_MYSQL = 'mysql';
/**
* PostgreSQL option identifier for database storage option
*
* @var string
*/
const SI_DRIVER_PGSQL = 'pgsql';
/**
* SQLite option identifier for database storage option
*
* @var string
*/
const SI_DRIVER_SQLITE3 = 'sqlite';
/**
* getCaptchaHtml() display constant for HTML Captcha Image
*
* @var integer
*/
const HTML_IMG = 1;
/**
* getCaptchaHtml() display constant for HTML5 Audio code
*
* @var integer
*/
const HTML_AUDIO = 2;
/**
* getCaptchaHtml() display constant for Captcha Input text box
*
* @var integer
*/
const HTML_INPUT = 4;
/**
* getCaptchaHtml() display constant for Captcha Text HTML label
*
* @var integer
*/
const HTML_INPUT_LABEL = 8;
/**
* getCaptchaHtml() display constant for HTML Refresh button
*
* @var integer
*/
const HTML_ICON_REFRESH = 16;
/**
* getCaptchaHtml() display constant for all HTML elements (default)
*
* @var integer
*/
const HTML_ALL = 0xffffffff;
/*%*********************************************************************%*/
// Properties
/**
* The width of the captcha image
* @var int
*/
public $image_width = 215;
/**
* The height of the captcha image
* @var int
*/
public $image_height = 80;
/**
* Font size is calculated by image height and this ratio. Leave blank for
* default ratio of 0.4.
*
* Valid range: 0.1 - 0.99.
*
* Depending on image_width, values > 0.6 are probably too large and
* values < 0.3 are too small.
*
* @var float
*/
public $font_ratio;
/**
* The type of the image, default = png
*
* @see Securimage::SI_IMAGE_PNG SI_IMAGE_PNG
* @see Securimage::SI_IMAGE_JPEG SI_IMAGE_JPEG
* @see Securimage::SI_IMAGE_GIF SI_IMAGE_GIF
* @var int
*/
public $image_type = self::SI_IMAGE_PNG;
/**
* The background color of the captcha
* @var Securimage_Color|string
*/
public $image_bg_color = '#ffffff';
/**
* The color of the captcha text
* @var Securimage_Color|string
*/
public $text_color = '#707070';
/**
* The color of the lines over the captcha
* @var Securimage_Color|string
*/
public $line_color = '#707070';
/**
* The color of the noise that is drawn
* @var Securimage_Color|string
*/
public $noise_color = '#707070';
/**
* How transparent to make the text.
*
* 0 = completely opaque, 100 = invisible
*
* @var int
*/
public $text_transparency_percentage = 20;
/**
* Whether or not to draw the text transparently.
*
* true = use transparency, false = no transparency
*
* @var bool
*/
public $use_transparent_text = true;
/**
* The length of the captcha code
* @var int
*/
public $code_length = 6;
/**
* Whether the captcha should be case sensitive or not.
*
* Not recommended, use only for maximum protection.
*
* @var bool
*/
public $case_sensitive = false;
/**
* The character set to use for generating the captcha code
* @var string
*/
public $charset = 'ABCDEFGHKLMNPRSTUVWYZabcdefghklmnprstuvwyz23456789';
/**
* How long in seconds a captcha remains valid, after this time it will be
* considered incorrect.
*
* @var int
*/
public $expiry_time = 900;
/**
* The session name securimage should use.
*
* Only use if your application uses a custom session name (e.g. Joomla).
* It is recommended to set this value here so it is used by all securimage
* scripts (i.e. securimage_show.php)
*
* @var string
*/
public $session_name = null;
/**
* true to use the wordlist file, false to generate random captcha codes
* @var bool
*/
public $use_wordlist = false;
/**
* The level of distortion.
*
* 0.75 = normal, 1.0 = very high distortion
*
* @var double
*/
public $perturbation = 0.85;
/**
* How many lines to draw over the captcha code to increase security
* @var int
*/
public $num_lines = 5;
/**
* The level of noise (random dots) to place on the image, 0-10
* @var int
*/
public $noise_level = 2;
/**
* The signature text to draw on the bottom corner of the image
* @var string
*/
public $image_signature = '';
/**
* The color of the signature text
* @var Securimage_Color|string
*/
public $signature_color = '#707070';
/**
* The path to the ttf font file to use for the signature text.
* Defaults to $ttf_file (AHGBold.ttf)
*
* @see Securimage::$ttf_file
* @var string
*/
public $signature_font;
/**
* No longer used.
*
* Use an SQLite database to store data (for users that do not support cookies)
*
* @var bool
* @see Securimage::$database_driver database_driver property
* @deprecated 3.2RC4
*/
public $use_sqlite_db = false;
/**
* Use a database backend for code storage.
* Provides a fallback to users with cookies disabled.
* Required when using captcha IDs.
*
* @see Securimage::$database_driver
* @var bool
*/
public $use_database = false;
/**
* Whether or not to skip checking if Securimage tables exist when using a
* database.
*
* Turn this to true once database functionality is working to improve
* performance.
*
* @var bool true to not check if captcha_codes tables are set up, false
* to check (and create if necessary)
*/
public $skip_table_check = false;
/**
* Database driver to use for database support.
* Allowable values: *mysql*, *pgsql*, *sqlite*.
* Default: sqlite
*
* @var string
*/
public $database_driver = self::SI_DRIVER_SQLITE3;
/**
* Database host to connect to when using mysql or postgres
*
* On Linux use "localhost" for Unix domain socket, otherwise uses TCP/IP
*
* Does not apply to SQLite
*
* @var string
*/
public $database_host = 'localhost';
/**
* Database username for connection (mysql, postgres only)
* Default is an empty string
*
* @var string
*/
public $database_user = '';
/**
* Database password for connection (mysql, postgres only)
* Default is empty string
*
* @var string
*/
public $database_pass = '';
/**
* Name of the database to select (mysql, postgres only)
*
* @see Securimage::$database_file for SQLite
* @var string
*/
public $database_name = '';
/**
* Database table where captcha codes are stored
*
* Note: Securimage will attempt to create this table for you if it does
* not exist. If the table cannot be created, an E_USER_WARNING is emitted
*
* @var string
*/
public $database_table = 'captcha_codes';
/**
* Fully qualified path to the database file when using SQLite3.
*
* This value is only used when $database_driver == sqlite and does
* not apply when no database is used, or when using MySQL or PostgreSQL.
*
* On *nix, file must have permissions of 0666.
*
* **Make sure the directory containing this file is NOT web accessible**
*
* @var string
*/
public $database_file;
/**
* The type of captcha to create.
*
* Either alphanumeric based on *charset*, a simple math problem, or an
* image consisting of 2 words from the word list.
*
* @see Securimage::SI_CAPTCHA_STRING SI_CAPTCHA_STRING
* @see Securimage::SI_CAPTCHA_MATHEMATIC SI_CAPTCHA_MATHEMATIC
* @see Securimage::SI_CAPTCHA_WORDS SI_CAPTCHA_WORDS
* @see Securimage::$charset charset property
* @see Securimage::$wordlist_file wordlist_file property
* @var int
*/
public $captcha_type = self::SI_CAPTCHA_STRING; // or self::SI_CAPTCHA_MATHEMATIC, or self::SI_CAPTCHA_WORDS;
/**
* The captcha namespace used for having multiple captchas on a page or
* to separate captchas from differen forms on your site.
* Example:
*
* <?php
* // use <img src="securimage_show.php?namespace=contact_form">
* // or manually in securimage_show.php
* $img->setNamespace('contact_form');
*
* // in form validator
* $img->setNamespace('contact_form');
* if ($img->check($code) == true) {
* echo "Valid!";
* }
*
* @var string
*/
public $namespace;
/**
* The TTF font file to use to draw the captcha code.
*
* Leave blank for default font AHGBold.ttf
*
* @var string
*/
public $ttf_file;
/**
* The path to the wordlist file to use.
*
* Leave blank for default words/words.txt
*
* @var string
*/
public $wordlist_file;
/**
* Character encoding of the wordlist file.
* Requires PHP Multibyte String (mbstring) support.
* Allows word list to contain characters other than US-ASCII (requires compatible TTF font).
*
* @var string The character encoding (e.g. UTF-8, UTF-7, EUC-JP, GB2312)
* @see http://php.net/manual/en/mbstring.supported-encodings.php
* @since 3.6.3
*/
public $wordlist_file_encoding = null;
/**
* The directory to scan for background images, if set a random background
* will be chosen from this folder
*
* @var string
*/
public $background_directory;
/**
* No longer used
*
* The path to the SQLite database file to use
*
* @deprecated 3.2RC4
* @see Securimage::$database_file database_file property
* @var string
*/
public $sqlite_database;
/**
* The path to the audio files to be used for audio captchas.
*
* Can also be set in securimage_play.php
*
* Example:
*
* $img->audio_path = '/home/yoursite/public_html/securimage/audio/en/';
*
* @var string
*/
public $audio_path;
/**
* Use SoX (The Swiss Army knife of audio manipulation) for audio effects
* and processing.
*
* Using SoX should make it more difficult for bots to solve audio captchas
*
* @see Securimage::$sox_binary_path sox_binary_path property
* @var bool true to use SoX, false to use PHP
*/
public $audio_use_sox = false;
/**
* The path to the SoX binary on your system
*
* @var string
*/
public $sox_binary_path = '/usr/bin/sox';
/**
* The path to the lame (mp3 encoder) binary on your system
* Static so that Securimage::getCaptchaHtml() has access to this value.
*
* @since 3.6
* @var string
*/
public static $lame_binary_path = '/usr/bin/lame';
/**
* The path to the directory containing audio files that will be selected
* randomly and mixed with the captcha audio.
*
* @var string
*/
public $audio_noise_path;
/**
* Whether or not to mix background noise files into captcha audio
*
* Mixing random background audio with noise can help improve security of
* audio captcha.
*
* Default: securimage/audio/noise
*
* @since 3.0.3
* @see Securimage::$audio_noise_path audio_noise_path property
* @var bool true = mix, false = no
*/
public $audio_use_noise;
/**
* The method and threshold (or gain factor) used to normalize the mixing
* with background noise.
*
* See http://www.voegler.eu/pub/audio/ for more information.
*
* Default: 0.6
*
* Valid:
* >= 1
* Normalize by multiplying by the threshold (boost - positive gain).
* A value of 1 in effect means no normalization (and results in clipping).
*
* <= -1
* Normalize by dividing by the the absolute value of threshold (attenuate - negative gain).
* A factor of 2 (-2) is about 6dB reduction in volume.
*
* [0, 1) (open inverval - not including 1)
* The threshold above which amplitudes are comressed logarithmically.
* e.g. 0.6 to leave amplitudes up to 60% "as is" and compressabove.
*
* (-1, 0) (open inverval - not including -1 and 0)
* The threshold above which amplitudes are comressed linearly.
* e.g. -0.6 to leave amplitudes up to 60% "as is" and compress above.
*
* @since 3.0.4
* @var float
*/
public $audio_mix_normalization = 0.8;
/**
* Whether or not to degrade audio by introducing random noise.
*
* Current research shows this may not increase the security of audible
* captchas.
*
* Default: true
*
* @since 3.0.3
* @var bool
*/
public $degrade_audio;
/**
* Minimum delay to insert between captcha audio letters in milliseconds
*
* @since 3.0.3
* @var float
*/
public $audio_gap_min = 0;
/**
* Maximum delay to insert between captcha audio letters in milliseconds
*
* @since 3.0.3
* @var float
*/
public $audio_gap_max = 3000;
/**
* Captcha ID if using static captcha
* @var string Unique captcha id
*/
protected static $_captchaId = null;
/**
* The GD image resource of the captcha image
*
* @var resource
*/
protected $im;
/**
* A temporary GD image resource of the captcha image for distortion
*
* @var resource
*/
protected $tmpimg;
/**
* The background image GD resource
* @var string
*/
protected $bgimg;
/**
* Scale factor for magnification of distorted captcha image
*
* @var int
*/
protected $iscale = 5;
/**
* Absolute path to securimage directory.
*
* This is calculated at runtime
*
* @var string
*/
public $securimage_path = null;
/**
* The captcha challenge value.
*
* Either the case-sensitive/insensitive word captcha, or the solution to
* the math captcha.
*
* @var string|bool Captcha challenge value
*/
protected $code;
/**
* The display value of the captcha to draw on the image
*
* Either the word captcha or the math equation to present to the user
*
* @var string Captcha display value to draw on the image
*/
protected $code_display;
/**
* Alternate text to draw as the captcha image text
*
* A value that can be passed to the constructor that can be used to
* generate a captcha image with a given value.
*
* This value does not get stored in the session or database and is only
* used when calling Securimage::show().
*
* If a display_value was passed to the constructor and the captcha image
* is generated, the display_value will be used as the string to draw on
* the captcha image.
*
* Used only if captcha codes are generated and managed by a 3rd party
* app/library
*
* @var string Captcha code value to display on the image
*/
public $display_value;
/**
* Captcha code supplied by user [set from Securimage::check()]
*
* @var string
*/
protected $captcha_code;
/**
* Time (in seconds) that the captcha was solved in (correctly or incorrectly).
*
* This is from the time of code creation, to when validation was attempted.
*
* @var int
*/
protected $_timeToSolve = 0;
/**
* Flag that can be specified telling securimage not to call exit after
* generating a captcha image or audio file
*
* @var bool If true, script will not terminate; if false script will terminate (default)
*/
protected $no_exit;
/**
* Flag indicating whether or not a PHP session should be started and used
*
* @var bool If true, no session will be started; if false, session will be started and used to store data (default)
*/
protected $no_session;
/**
* Flag indicating whether or not HTTP headers will be sent when outputting
* captcha image/audio
*
* @var bool If true (default) headers will be sent, if false, no headers are sent
*/
protected $send_headers;
/**
* PDO connection when a database is used
*
* @var PDO|bool
*/
protected $pdo_conn;
/**
* The GD color for the background color
*
* @var int
*/
protected $gdbgcolor;
/**
* The GD color for the text color
*
* @var int
*/
protected $gdtextcolor;
/**
* The GD color for the line color
*
* @var int
*/
protected $gdlinecolor;
/**
* The GD color for the signature text color
*
* @var int
*/
protected $gdsignaturecolor;
/**
* Create a new securimage object, pass options to set in the constructor.
*
* The object can then be used to display a captcha, play an audible captcha, or validate a submission.
*
* @param array $options Options to initialize the class. May be any class property.
*
* $options = array(
* 'text_color' => new Securimage_Color('#013020'),
* 'code_length' => 5,
* 'num_lines' => 5,
* 'noise_level' => 3,
* 'font_file' => Securimage::getPath() . '/custom.ttf'
* );
*
* $img = new Securimage($options);
*
*/
public function __construct($options = array())
{
$this->securimage_path = dirname(__FILE__);
if (!is_array($options)) {
trigger_error(
'$options passed to Securimage::__construct() must be an array. ' .
gettype($options) . ' given',
E_USER_WARNING
);
$options = array();
}
// check for and load settings from custom config file
if (file_exists(dirname(__FILE__) . '/config.inc.php')) {
$settings = include dirname(__FILE__) . '/config.inc.php';
if (is_array($settings)) {
$options = array_merge($settings, $options);
}
}
if (is_array($options) && sizeof($options) > 0) {
foreach($options as $prop => $val) {
if ($prop == 'captchaId') {
Securimage::$_captchaId = $val;
$this->use_database = true;
} else if ($prop == 'use_sqlite_db') {
trigger_error("The use_sqlite_db option is deprecated, use 'use_database' instead", E_USER_NOTICE);
} else {
$this->$prop = $val;
}
}
}
$this->image_bg_color = $this->initColor($this->image_bg_color, '#ffffff');
$this->text_color = $this->initColor($this->text_color, '#616161');
$this->line_color = $this->initColor($this->line_color, '#616161');
$this->noise_color = $this->initColor($this->noise_color, '#616161');
$this->signature_color = $this->initColor($this->signature_color, '#616161');
if (is_null($this->ttf_file)) {
$this->ttf_file = $this->securimage_path . '/AHGBold.ttf';
}
$this->signature_font = $this->ttf_file;
if (is_null($this->wordlist_file)) {
$this->wordlist_file = $this->securimage_path . '/words/words.txt';
}
if (is_null($this->database_file)) {
$this->database_file = $this->securimage_path . '/database/securimage.sq3';
}
if (is_null($this->audio_path)) {
$this->audio_path = $this->securimage_path . '/audio/en/';
}
if (is_null($this->audio_noise_path)) {
$this->audio_noise_path = $this->securimage_path . '/audio/noise/';
}
if (is_null($this->audio_use_noise)) {
$this->audio_use_noise = true;
}
if (is_null($this->degrade_audio)) {
$this->degrade_audio = true;
}
if (is_null($this->code_length) || (int)$this->code_length < 1) {
$this->code_length = 6;
}
if (is_null($this->perturbation) || !is_numeric($this->perturbation)) {
$this->perturbation = 0.75;
}
if (is_null($this->namespace) || !is_string($this->namespace)) {
$this->namespace = 'default';
}
if (is_null($this->no_exit)) {
$this->no_exit = false;
}
if (is_null($this->no_session)) {
$this->no_session = false;
}
if (is_null($this->send_headers)) {
$this->send_headers = true;
}
if ($this->no_session != true) {
// Initialize session or attach to existing
if ( session_id() == '' || (function_exists('session_status') && PHP_SESSION_NONE == session_status()) ) { // no session has been started yet (or it was previousy closed), which is needed for validation
if (!is_null($this->session_name) && trim($this->session_name) != '') {
session_name(trim($this->session_name)); // set session name if provided
}
session_start();
}
}
}
/**
* Return the absolute path to the Securimage directory.
*
* @return string The path to the securimage base directory
*/
public static function getPath()
{
return dirname(__FILE__);
}
/**
* Generate a new captcha ID or retrieve the current ID (if exists).
*
* @param bool $new If true, generates a new challenge and returns and ID. If false, the existing captcha ID is returned, or null if none exists.
* @param array $options Additional options to be passed to Securimage.
* $options must include database settings if they are not set directly in securimage.php
*
* @return null|string Returns null if no captcha id set and new was false, or the captcha ID
*/
public static function getCaptchaId($new = true, array $options = array())
{
if (is_null($new) || (bool)$new == true) {
$id = sha1(uniqid($_SERVER['REMOTE_ADDR'], true));
$opts = array('no_session' => true,
'use_database' => true);
if (sizeof($options) > 0) $opts = array_merge($options, $opts);
$si = new self($opts);
Securimage::$_captchaId = $id;
$si->createCode();
return $id;
} else {
return Securimage::$_captchaId;
}
}
/**
* Validate a captcha code input against a captcha ID
*
* @param string $id The captcha ID to check
* @param string $value The captcha value supplied by the user
* @param array $options Array of options to construct Securimage with.
* Options must include database options if they are not set in securimage.php
*
* @see Securimage::$database_driver
* @return bool true if the code was valid for the given captcha ID, false if not or if database failed to open
*/
public static function checkByCaptchaId($id, $value, array $options = array())
{
$opts = array('captchaId' => $id,
'no_session' => true,
'use_database' => true);
if (sizeof($options) > 0) $opts = array_merge($options, $opts);
$si = new self($opts);
if ($si->openDatabase()) {
$code = $si->getCodeFromDatabase();
if (is_array($code)) {
$si->code = $code['code'];
$si->code_display = $code['code_disp'];
}
if ($si->check($value)) {
$si->clearCodeFromDatabase();
return true;
} else {
return false;
}
} else {
return false;
}
}
/**
* Generates a new challenge and serves a captcha image.
*
* Appropriate headers will be sent to the browser unless the *send_headers* option is false.
*
* @param string $background_image The absolute or relative path to the background image to use as the background of the captcha image.
*
* $img = new Securimage();
* $img->code_length = 6;
* $img->num_lines = 5;
* $img->noise_level = 5;
*
* $img->show(); // sends the image and appropriate headers to browser
* exit;
*/
public function show($background_image = '')
{
set_error_handler(array(&$this, 'errorHandler'));
if($background_image != '' && is_readable($background_image)) {
$this->bgimg = $background_image;
}
$this->doImage();
}
/**
* Checks a given code against the correct value from the session and/or database.
*
* @param string $code The captcha code to check
*
* $code = $_POST['code'];
* $img = new Securimage();
* if ($img->check($code) == true) {
* $captcha_valid = true;
* } else {
* $captcha_valid = false;
* }
*
* @return bool true if the given code was correct, false if not.
*/
public function check($code)
{
$this->code_entered = $code;
$this->validate();
return $this->correct_code;
}
/**
* Returns HTML code for displaying the captcha image, audio button, and form text input.
*
* Options can be specified to modify the output of the HTML. Accepted options:
*
* 'securimage_path':
* Optional: The URI to where securimage is installed (e.g. /securimage)
* 'show_image_url':
* Path to the securimage_show.php script (useful when integrating with a framework or moving outside the securimage directory)
* This will be passed as a urlencoded string to the <img> tag for outputting the captcha image
* 'audio_play_url':
* Same as show_image_url, except this indicates the URL of the audio playback script
* 'image_id':
* A string that sets the "id" attribute of the captcha image (default: captcha_image)
* 'image_alt_text':
* The alt text of the captcha image (default: CAPTCHA Image)
* 'show_audio_button':
* true/false Whether or not to show the audio button (default: true)
* 'disable_flash_fallback':)
* Allow only HTML5 audio and disable Flash fallback
* 'show_refresh_button':
* true/false Whether or not to show a button to refresh the image (default: true)
* 'audio_icon_url':
* URL to the image used for showing the HTML5 audio icon
* 'icon_size':
* Size (for both height & width) in pixels of the audio and refresh buttons
* 'show_text_input':
* true/false Whether or not to show the text input for the captcha (default: true)
* 'refresh_alt_text':
* Alt text for the refresh image (default: Refresh Image)
* 'refresh_title_text':
* Title text for the refresh image link (default: Refresh Image)
* 'input_id':
* A string that sets the "id" attribute of the captcha text input (default: captcha_code)
* 'input_name':
* A string that sets the "name" attribute of the captcha text input (default: same as input_id)
* 'input_text':
* A string that sets the text of the label for the captcha text input (default: Type the text:)
* 'input_attributes':
* An array of additional HTML tag attributes to pass to the text input tag (default: empty)
* 'image_attributes':
* An array of additional HTML tag attributes to pass to the captcha image tag (default: empty)
* 'error_html':
* Optional HTML markup to be shown above the text input field
* 'namespace':
* The optional captcha namespace to use for showing the image and playing back the audio. Namespaces are for using multiple captchas on the same page.
*
* @param array $options Array of options for modifying the HTML code.
* @param int $parts Securiage::HTML_* constant controlling what component of the captcha HTML to display
*
* @return string The generated HTML code for displaying the captcha
*/
public static function getCaptchaHtml($options = array(), $parts = Securimage::HTML_ALL)
{
static $javascript_init = false;
if (!isset($options['securimage_path'])) {
$docroot = (isset($_SERVER['DOCUMENT_ROOT'])) ? $_SERVER['DOCUMENT_ROOT'] : substr($_SERVER['SCRIPT_FILENAME'], 0, -strlen($_SERVER['SCRIPT_NAME']));
$docroot = realpath($docroot);
$sipath = dirname(__FILE__);
$securimage_path = str_replace($docroot, '', $sipath);
} else {
$securimage_path = $options['securimage_path'];
}
$show_image_url = (isset($options['show_image_url'])) ? $options['show_image_url'] : null;
$image_id = (isset($options['image_id'])) ? $options['image_id'] : 'captcha_image';
$image_alt = (isset($options['image_alt_text'])) ? $options['image_alt_text'] : 'CAPTCHA Image';
$show_audio_btn = (isset($options['show_audio_button'])) ? (bool)$options['show_audio_button'] : true;
$disable_flash_fbk = (isset($options['disable_flash_fallback'])) ? (bool)$options['disable_flash_fallback'] : false;
$show_refresh_btn = (isset($options['show_refresh_button'])) ? (bool)$options['show_refresh_button'] : true;
$refresh_icon_url = (isset($options['refresh_icon_url'])) ? $options['refresh_icon_url'] : null;
$audio_but_bg_col = (isset($options['audio_button_bgcol'])) ? $options['audio_button_bgcol'] : '#ffffff';
$audio_icon_url = (isset($options['audio_icon_url'])) ? $options['audio_icon_url'] : null;
$loading_icon_url = (isset($options['loading_icon_url'])) ? $options['loading_icon_url'] : null;
$icon_size = (isset($options['icon_size'])) ? $options['icon_size'] : 32;
$audio_play_url = (isset($options['audio_play_url'])) ? $options['audio_play_url'] : null;
$audio_swf_url = (isset($options['audio_swf_url'])) ? $options['audio_swf_url'] : null;
$show_input = (isset($options['show_text_input'])) ? (bool)$options['show_text_input'] : true;
$refresh_alt = (isset($options['refresh_alt_text'])) ? $options['refresh_alt_text'] : 'Refresh Image';
$refresh_title = (isset($options['refresh_title_text'])) ? $options['refresh_title_text'] : 'Refresh Image';
$input_text = (isset($options['input_text'])) ? $options['input_text'] : 'Type the text:';
$input_id = (isset($options['input_id'])) ? $options['input_id'] : 'captcha_code';
$input_name = (isset($options['input_name'])) ? $options['input_name'] : $input_id;
$input_attrs = (isset($options['input_attributes'])) ? $options['input_attributes'] : array();
$image_attrs = (isset($options['image_attributes'])) ? $options['image_attributes'] : array();
$error_html = (isset($options['error_html'])) ? $options['error_html'] : null;
$namespace = (isset($options['namespace'])) ? $options['namespace'] : '';
$rand = md5(uniqid($_SERVER['REMOTE_PORT'], true));
$securimage_path = rtrim($securimage_path, '/\\');
$securimage_path = str_replace('\\', '/', $securimage_path);
$image_attr = '';
if (!is_array($image_attrs)) $image_attrs = array();
if (!isset($image_attrs['style'])) $image_attrs['style'] = 'float: left; padding-right: 5px';
$image_attrs['id'] = $image_id;
$show_path = $securimage_path . '/securimage_show.php?';
if ($show_image_url) {
if (parse_url($show_image_url, PHP_URL_QUERY)) {
$show_path = "{$show_image_url}&";
} else {
$show_path = "{$show_image_url}?";
}
}
if (!empty($namespace)) {
$show_path .= sprintf('namespace=%s&', $namespace);
}
$image_attrs['src'] = $show_path . $rand;
$image_attrs['alt'] = $image_alt;
foreach($image_attrs as $name => $val) {
$image_attr .= sprintf('%s="%s" ', $name, htmlspecialchars($val));
}
$swf_path = $securimage_path . '/securimage_play.swf';
$play_path = $securimage_path . '/securimage_play.php?';
$icon_path = $securimage_path . '/images/audio_icon.png';
$load_path = $securimage_path . '/images/loading.png';
$js_path = $securimage_path . '/securimage.js';
if (!empty($audio_icon_url)) {
$icon_path = $audio_icon_url;
}
if (!empty($loading_icon_url)) {
$load_path = $loading_icon_url;
}
if (!empty($audio_play_url)) {
if (parse_url($audio_play_url, PHP_URL_QUERY)) {
$play_path = "{$audio_play_url}&";
} else {
$play_path = "{$audio_play_url}?";
}
}
if (!empty($namespace)) {
$play_path .= sprintf('namespace=%s&', $namespace);
}
if (!empty($audio_swf_url)) {
$swf_path = $audio_swf_url;
}
$audio_obj = $image_id . '_audioObj';
$html = '';
if ( ($parts & Securimage::HTML_IMG) > 0) {
$html .= sprintf('<img %s/>', $image_attr);
}
if ( ($parts & Securimage::HTML_AUDIO) > 0 && $show_audio_btn) {
// html5 audio
$html .= sprintf('<div id="%s_audio_div">', $image_id) . "\n" .
sprintf('<audio id="%s_audio" preload="none" style="display: none">', $image_id) . "\n";
// check for existence and executability of LAME binary
// prefer mp3 over wav by sourcing it first, if available
if (is_executable(Securimage::$lame_binary_path)) {
$html .= sprintf('<source id="%s_source_mp3" src="%sid=%s&format=mp3" type="audio/mpeg">', $image_id, $play_path, uniqid()) . "\n";
}
// output wav source
$html .= sprintf('<source id="%s_source_wav" src="%sid=%s" type="audio/wav">', $image_id, $play_path, uniqid()) . "\n";
// flash audio button
if (!$disable_flash_fbk) {
$html .= sprintf('<object type="application/x-shockwave-flash" data="%s?bgcol=%s&icon_file=%s&audio_file=%s" height="%d" width="%d">',
htmlspecialchars($swf_path),
urlencode($audio_but_bg_col),
urlencode($icon_path),
urlencode(html_entity_decode($play_path)),
$icon_size, $icon_size
);
$html .= sprintf('<param name="movie" value="%s?bgcol=%s&icon_file=%s&audio_file=%s" />',
htmlspecialchars($swf_path),
urlencode($audio_but_bg_col),
urlencode($icon_path),
urlencode(html_entity_decode($play_path))
);
$html .= '</object><br />';
}
// html5 audio close
$html .= "</audio>\n</div>\n";
// html5 audio controls
$html .= sprintf('<div id="%s_audio_controls">', $image_id) . "\n" .
sprintf('<a tabindex="-1" class="captcha_play_button" href="%sid=%s" onclick="return false">',
$play_path, uniqid()
) . "\n" .
sprintf('<img class="captcha_play_image" height="%d" width="%d" src="%s" alt="Play CAPTCHA Audio" style="border: 0px">', $icon_size, $icon_size, htmlspecialchars($icon_path)) . "\n" .
sprintf('<img class="captcha_loading_image rotating" height="%d" width="%d" src="%s" alt="Loading audio" style="display: none">', $icon_size, $icon_size, htmlspecialchars($load_path)) . "\n" .
"</a>\n<noscript>Enable Javascript for audio controls</noscript>\n" .
"</div>\n";
// html5 javascript
if (!$javascript_init) {
$html .= sprintf('<script type="text/javascript" src="%s"></script>', $js_path) . "\n";
$javascript_init = true;
}
$html .= '<script type="text/javascript">' .
"$audio_obj = new SecurimageAudio({ audioElement: '{$image_id}_audio', controlsElement: '{$image_id}_audio_controls' });" .
"</script>\n";
}
if ( ($parts & Securimage::HTML_ICON_REFRESH) > 0 && $show_refresh_btn) {
$icon_path = $securimage_path . '/images/refresh.png';
if ($refresh_icon_url) {
$icon_path = $refresh_icon_url;
}
$img_tag = sprintf('<img height="%d" width="%d" src="%s" alt="%s" onclick="this.blur()" style="border: 0px; vertical-align: bottom" />',
$icon_size, $icon_size, htmlspecialchars($icon_path), htmlspecialchars($refresh_alt));
$html .= sprintf('<a tabindex="-1" style="border: 0" href="#" title="%s" onclick="%sdocument.getElementById(\'%s\').src = \'%s\' + Math.random(); this.blur(); return false">%s</a><br />',
htmlspecialchars($refresh_title),
($audio_obj) ? "if (typeof window.{$audio_obj} !== 'undefined') {$audio_obj}.refresh(); " : '',
$image_id,
$show_path,
$img_tag
);
}
if ($parts == Securimage::HTML_ALL) {
$html .= '<div style="clear: both"></div>';
}
if ( ($parts & Securimage::HTML_INPUT_LABEL) > 0 && $show_input) {
$html .= sprintf('<label for="%s">%s</label> ',
htmlspecialchars($input_id),
htmlspecialchars($input_text));
if (!empty($error_html)) {
$html .= $error_html;
}
}
if ( ($parts & Securimage::HTML_INPUT) > 0 && $show_input) {
$input_attr = '';
if (!is_array($input_attrs)) $input_attrs = array();
$input_attrs['type'] = 'text';
$input_attrs['name'] = $input_name;
$input_attrs['id'] = $input_id;
foreach($input_attrs as $name => $val) {
$input_attr .= sprintf('%s="%s" ', $name, htmlspecialchars($val));
}
$html .= sprintf('<input %s/>', $input_attr);
}
return $html;
}
/**
* Get the time in seconds that it took to solve the captcha.
*
* @return int The time in seconds from when the code was created, to when it was solved
*/
public function getTimeToSolve()
{
return $this->_timeToSolve;
}
/**
* Set the namespace for the captcha being stored in the session or database.
*
* Namespaces are useful when multiple captchas need to be displayed on a single page.
*
* @param string $namespace Namespace value, String consisting of characters "a-zA-Z0-9_-"
*/
public function setNamespace($namespace)
{
$namespace = preg_replace('/[^a-z0-9-_]/i', '', $namespace);
$namespace = substr($namespace, 0, 64);
if (!empty($namespace)) {
$this->namespace = $namespace;
} else {
$this->namespace = 'default';
}
}
/**
* Generate an audible captcha in WAV format and send it to the browser with appropriate headers.
* Example:
*
* $img = new Securimage();
* $img->outputAudioFile(); // outputs a wav file to the browser
* exit;
*
* @param string $format
*/
public function outputAudioFile($format = null)
{
set_error_handler(array(&$this, 'errorHandler'));
if (isset($_SERVER['HTTP_RANGE'])) {
$range = true;
$rangeId = (isset($_SERVER['HTTP_X_PLAYBACK_SESSION_ID'])) ?
'ID' . $_SERVER['HTTP_X_PLAYBACK_SESSION_ID'] :
'ID' . md5($_SERVER['REQUEST_URI']);
$uniq = $rangeId;
} else {
$uniq = md5(uniqid(microtime()));
}
try {
if (!($audio = $this->getAudioData())) {
// if previously generated audio not found for current captcha
require_once dirname(__FILE__) . '/WavFile.php';
$audio = $this->getAudibleCode();
if (strtolower($format) == 'mp3') {
$audio = $this->wavToMp3($audio);
}
$this->saveAudioData($audio);
}
} catch (Exception $ex) {
if (($fp = @fopen(dirname(__FILE__) . '/si.error_log', 'a+')) !== false) {
fwrite($fp, date('Y-m-d H:i:s') . ': Securimage audio error "' . $ex->getMessage() . '"' . "\n");
fclose($fp);
}
$audio = $this->audioError();
}
if ($this->no_session != true) {
// close session to make it available to other requests in the event
// streaming the audio takes sevaral seconds or more
session_write_close();
}
if ($this->canSendHeaders() || $this->send_headers == false) {
if ($this->send_headers) {
if ($format == 'mp3') {
$ext = 'mp3';
$type = 'audio/mpeg';
} else {
$ext = 'wav';
$type = 'audio/wav';
}
header('Accept-Ranges: bytes');
header("Content-Disposition: attachment; filename=\"securimage_audio-{$uniq}.{$ext}\"");
header('Cache-Control: no-store, no-cache, must-revalidate');
header('Expires: Sun, 1 Jan 2000 12:00:00 GMT');
header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . 'GMT');
header('Content-type: ' . $type);
}
$this->rangeDownload($audio);
} else {
echo '<hr /><strong>'
.'Failed to generate audio file, content has already been '
.'output.<br />This is most likely due to misconfiguration or '
.'a PHP error was sent to the browser.</strong>';
}
restore_error_handler();
if (!$this->no_exit) exit;
}
/**
* Output audio data with http range support. Typically this shouldn't be
* called directly unless being used with a custom implentation. Use
* Securimage::outputAudioFile instead.
*
* @param string $audio Raw wav or mp3 audio file content
*/
public function rangeDownload($audio)
{
/* Congratulations Firefox Android/Linux/Windows for being the most
* sensible browser of all when streaming HTML5 audio!
*
* Chrome on Android and iOS on iPad/iPhone both make extra HTTP requests
* for the audio whether on WiFi or the mobile network resulting in
* multiple downloads of the audio file and wasted bandwidth.
*
* If I'm doing something wrong in this code or anyone knows why, I'd
* love to hear from you.
*/
$audioLength = $size = strlen($audio);
if (isset($_SERVER['HTTP_RANGE'])) {
list( , $range) = explode('=', $_SERVER['HTTP_RANGE']); // bytes=byte-range-set
$range = trim($range);
if (strpos($range, ',') !== false) {
// eventually, we should handle requests with multiple ranges
// most likely these types of requests will never be sent
header('HTTP/1.1 416 Range Not Satisfiable');
echo "<h1>Range Not Satisfiable</h1>";
exit;
} else if (preg_match('/(\d+)-(\d+)/', $range, $match)) {
// bytes n - m
$range = array(intval($match[1]), intval($match[2]));
} else if (preg_match('/(\d+)-$/', $range, $match)) {
// bytes n - last byte of file
$range = array(intval($match[1]), null);
} else if (preg_match('/-(\d+)/', $range, $match)) {
// final n bytes of file
$range = array($size - intval($match[1]), $size - 1);
}
if ($range[1] === null) $range[1] = $size - 1;
$length = $range[1] - $range[0] + 1;
$audio = substr($audio, $range[0], $length);
$audioLength = strlen($audio);
header('HTTP/1.1 206 Partial Content');
header("Content-Range: bytes {$range[0]}-{$range[1]}/{$size}");
if ($range[0] < 0 ||$range[1] >= $size || $range[0] >= $size || $range[0] > $range[1]) {
header('HTTP/1.1 416 Range Not Satisfiable');
echo "<h1>Range Not Satisfiable</h1>";
exit;
}
}
header('Content-Length: ' . $audioLength);
echo $audio;
}
/**
* Return the code from the session or database (if configured). If none exists or was found, an empty string is returned.
*
* @param bool $array true to receive an array containing the code and properties, false to receive just the code.
* @param bool $returnExisting If true, and the class property *code* is set, it will be returned instead of getting the code from the session or database.
* @return array|string Return is an array if $array = true, otherwise a string containing the code
*/
public function getCode($array = false, $returnExisting = false)
{
$code = array();
$time = 0;
$disp = 'error';
if ($returnExisting && strlen($this->code) > 0) {
if ($array) {
return array(
'code' => $this->code,
'display' => $this->code_display,
'code_display' => $this->code_display,
'time' => 0);
} else {
return $this->code;
}
}
if ($this->no_session != true) {
if (isset($_SESSION['securimage_code_value'][$this->namespace]) &&
trim($_SESSION['securimage_code_value'][$this->namespace]) != '') {
if ($this->isCodeExpired(
$_SESSION['securimage_code_ctime'][$this->namespace]) == false) {
$code['code'] = $_SESSION['securimage_code_value'][$this->namespace];
$code['time'] = $_SESSION['securimage_code_ctime'][$this->namespace];
$code['display'] = $_SESSION['securimage_code_disp'] [$this->namespace];
}
}
}
if (empty($code) && $this->use_database) {
// no code in session - may mean user has cookies turned off
$this->openDatabase();
$code = $this->getCodeFromDatabase();
if (!empty($code)) {
$code['display'] = $code['code_disp'];
unset($code['code_disp']);
}
} else { /* no code stored in session or sqlite database, validation will fail */ }
if ($array == true) {
return $code;
} else {
return $code['code'];
}
}
/**
* The main image drawing routing, responsible for constructing the entire image and serving it
*/
protected function doImage()
{
if( ($this->use_transparent_text == true || $this->bgimg != '') && function_exists('imagecreatetruecolor')) {
$imagecreate = 'imagecreatetruecolor';
} else {
$imagecreate = 'imagecreate';
}
$this->im = $imagecreate($this->image_width, $this->image_height);
$this->tmpimg = $imagecreate($this->image_width * $this->iscale, $this->image_height * $this->iscale);
$this->allocateColors();
imagepalettecopy($this->tmpimg, $this->im);
$this->setBackground();
$code = '';
if ($this->getCaptchaId(false) !== null) {
// a captcha Id was supplied
// check to see if a display_value for the captcha image was set
if (is_string($this->display_value) && strlen($this->display_value) > 0) {
$this->code_display = $this->display_value;
$this->code = ($this->case_sensitive) ?
$this->display_value :
strtolower($this->display_value);
$code = $this->code;
} else if ($this->openDatabase()) {
// no display_value, check the database for existing captchaId
$code = $this->getCodeFromDatabase();
// got back a result from the database with a valid code for captchaId
if (is_array($code)) {
$this->code = $code['code'];
$this->code_display = $code['code_disp'];
$code = $code['code'];
}
}
}
if ($code == '') {
// if the code was not set using display_value or was not found in
// the database, create a new code
$this->createCode();
}
if ($this->noise_level > 0) {
$this->drawNoise();
}
$this->drawWord();
if ($this->perturbation > 0 && is_readable($this->ttf_file)) {
$this->distortedCopy();
}
if ($this->num_lines > 0) {
$this->drawLines();
}
if (trim($this->image_signature) != '') {
$this->addSignature();
}
$this->output();
}
/**
* Allocate the colors to be used for the image
*/
protected function allocateColors()
{
// allocate bg color first for imagecreate
$this->gdbgcolor = imagecolorallocate($this->im,
$this->image_bg_color->r,
$this->image_bg_color->g,
$this->image_bg_color->b);
$alpha = intval($this->text_transparency_percentage / 100 * 127);
if ($this->use_transparent_text == true) {
$this->gdtextcolor = imagecolorallocatealpha($this->im,
$this->text_color->r,
$this->text_color->g,
$this->text_color->b,
$alpha);
$this->gdlinecolor = imagecolorallocatealpha($this->im,
$this->line_color->r,
$this->line_color->g,
$this->line_color->b,
$alpha);
$this->gdnoisecolor = imagecolorallocatealpha($this->im,
$this->noise_color->r,
$this->noise_color->g,
$this->noise_color->b,
$alpha);
} else {
$this->gdtextcolor = imagecolorallocate($this->im,
$this->text_color->r,
$this->text_color->g,
$this->text_color->b);
$this->gdlinecolor = imagecolorallocate($this->im,
$this->line_color->r,
$this->line_color->g,
$this->line_color->b);
$this->gdnoisecolor = imagecolorallocate($this->im,
$this->noise_color->r,
$this->noise_color->g,
$this->noise_color->b);
}
$this->gdsignaturecolor = imagecolorallocate($this->im,
$this->signature_color->r,
$this->signature_color->g,
$this->signature_color->b);
}
/**
* The the background color, or background image to be used
*/
protected function setBackground()
{
// set background color of image by drawing a rectangle since imagecreatetruecolor doesn't set a bg color
imagefilledrectangle($this->im, 0, 0,
$this->image_width, $this->image_height,
$this->gdbgcolor);
imagefilledrectangle($this->tmpimg, 0, 0,
$this->image_width * $this->iscale, $this->image_height * $this->iscale,
$this->gdbgcolor);
if ($this->bgimg == '') {
if ($this->background_directory != null &&
is_dir($this->background_directory) &&
is_readable($this->background_directory))
{
$img = $this->getBackgroundFromDirectory();
if ($img != false) {
$this->bgimg = $img;
}
}
}
if ($this->bgimg == '') {
return;
}
$dat = @getimagesize($this->bgimg);
if($dat == false) {
return;
}
switch($dat[2]) {
case 1: $newim = @imagecreatefromgif($this->bgimg); break;
case 2: $newim = @imagecreatefromjpeg($this->bgimg); break;
case 3: $newim = @imagecreatefrompng($this->bgimg); break;
default: return;
}
if(!$newim) return;
imagecopyresized($this->im, $newim, 0, 0, 0, 0,
$this->image_width, $this->image_height,
imagesx($newim), imagesy($newim));
}
/**
* Scan the directory for a background image to use
* @return string|bool
*/
protected function getBackgroundFromDirectory()
{
$images = array();
if ( ($dh = opendir($this->background_directory)) !== false) {
while (($file = readdir($dh)) !== false) {
if (preg_match('/(jpg|gif|png)$/i', $file)) $images[] = $file;
}
closedir($dh);
if (sizeof($images) > 0) {
return rtrim($this->background_directory, '/') . '/' . $images[mt_rand(0, sizeof($images)-1)];
}
}
return false;
}
/**
* This method generates a new captcha code.
*
* Generates a random captcha code based on *charset*, math problem, or captcha from the wordlist and saves the value to the session and/or database.
*/
public function createCode()
{
$this->code = false;
switch($this->captcha_type) {
case self::SI_CAPTCHA_MATHEMATIC:
{
do {
$signs = array('+', '-', 'x');
$left = mt_rand(1, 10);
$right = mt_rand(1, 5);
$sign = $signs[mt_rand(0, 2)];
switch($sign) {
case 'x': $c = $left * $right; break;
case '-': $c = $left - $right; break;
default: $c = $left + $right; break;
}
} while ($c <= 0); // no negative #'s or 0
$this->code = "$c";
$this->code_display = "$left $sign $right";
break;
}
case self::SI_CAPTCHA_WORDS:
$words = $this->readCodeFromFile(2);
$this->code = implode(' ', $words);
$this->code_display = $this->code;
break;
default:
{
if ($this->use_wordlist && is_readable($this->wordlist_file)) {
$this->code = $this->readCodeFromFile();
}
if ($this->code == false) {
$this->code = $this->generateCode($this->code_length);
}
$this->code_display = $this->code;
$this->code = ($this->case_sensitive) ? $this->code : strtolower($this->code);
} // default
}
$this->saveData();
}
/**
* Draws the captcha code on the image
*/
protected function drawWord()
{
$width2 = $this->image_width * $this->iscale;
$height2 = $this->image_height * $this->iscale;
$ratio = ($this->font_ratio) ? $this->font_ratio : 0.4;
if ((float)$ratio < 0.1 || (float)$ratio >= 1) {
$ratio = 0.4;
}
if (!is_readable($this->ttf_file)) {
imagestring($this->im, 4, 10, ($this->image_height / 2) - 5, 'Failed to load TTF font file!', $this->gdtextcolor);
} else {
if ($this->perturbation > 0) {
$font_size = $height2 * $ratio;
$bb = imageftbbox($font_size, 0, $this->ttf_file, $this->code_display);
$tx = $bb[4] - $bb[0];
$ty = $bb[5] - $bb[1];
$x = floor($width2 / 2 - $tx / 2 - $bb[0]);
$y = round($height2 / 2 - $ty / 2 - $bb[1]);
imagettftext($this->tmpimg, $font_size, 0, (int)$x, (int)$y, $this->gdtextcolor, $this->ttf_file, $this->code_display);
} else {
$font_size = $this->image_height * $ratio;
$bb = imageftbbox($font_size, 0, $this->ttf_file, $this->code_display);
$tx = $bb[4] - $bb[0];
$ty = $bb[5] - $bb[1];
$x = floor($this->image_width / 2 - $tx / 2 - $bb[0]);
$y = round($this->image_height / 2 - $ty / 2 - $bb[1]);
imagettftext($this->im, $font_size, 0, (int)$x, (int)$y, $this->gdtextcolor, $this->ttf_file, $this->code_display);
}
}
// DEBUG
//$this->im = $this->tmpimg;
//$this->output();
}
/**
* Copies the captcha image to the final image with distortion applied
*/
protected function distortedCopy()
{
$numpoles = 3; // distortion factor
// make array of poles AKA attractor points
for ($i = 0; $i < $numpoles; ++ $i) {
$px[$i] = mt_rand($this->image_width * 0.2, $this->image_width * 0.8);
$py[$i] = mt_rand($this->image_height * 0.2, $this->image_height * 0.8);
$rad[$i] = mt_rand($this->image_height * 0.2, $this->image_height * 0.8);
$tmp = ((- $this->frand()) * 0.15) - .15;
$amp[$i] = $this->perturbation * $tmp;
}
$bgCol = imagecolorat($this->tmpimg, 0, 0);
$width2 = $this->iscale * $this->image_width;
$height2 = $this->iscale * $this->image_height;
imagepalettecopy($this->im, $this->tmpimg); // copy palette to final image so text colors come across
// loop over $img pixels, take pixels from $tmpimg with distortion field
for ($ix = 0; $ix < $this->image_width; ++ $ix) {
for ($iy = 0; $iy < $this->image_height; ++ $iy) {
$x = $ix;
$y = $iy;
for ($i = 0; $i < $numpoles; ++ $i) {
$dx = $ix - $px[$i];
$dy = $iy - $py[$i];
if ($dx == 0 && $dy == 0) {
continue;
}
$r = sqrt($dx * $dx + $dy * $dy);
if ($r > $rad[$i]) {
continue;
}
$rscale = $amp[$i] * sin(3.14 * $r / $rad[$i]);
$x += $dx * $rscale;
$y += $dy * $rscale;
}
$c = $bgCol;
$x *= $this->iscale;
$y *= $this->iscale;
if ($x >= 0 && $x < $width2 && $y >= 0 && $y < $height2) {
$c = imagecolorat($this->tmpimg, $x, $y);
}
if ($c != $bgCol) { // only copy pixels of letters to preserve any background image
imagesetpixel($this->im, $ix, $iy, $c);
}
}
}
}
/**
* Draws distorted lines on the image
*/
protected function drawLines()
{
for ($line = 0; $line < $this->num_lines; ++ $line) {
$x = $this->image_width * (1 + $line) / ($this->num_lines + 1);
$x += (0.5 - $this->frand()) * $this->image_width / $this->num_lines;
$y = mt_rand($this->image_height * 0.1, $this->image_height * 0.9);
$theta = ($this->frand() - 0.5) * M_PI * 0.7;
$w = $this->image_width;
$len = mt_rand($w * 0.4, $w * 0.7);
$lwid = mt_rand(0, 2);
$k = $this->frand() * 0.6 + 0.2;
$k = $k * $k * 0.5;
$phi = $this->frand() * 6.28;
$step = 0.5;
$dx = $step * cos($theta);
$dy = $step * sin($theta);
$n = $len / $step;
$amp = 1.5 * $this->frand() / ($k + 5.0 / $len);
$x0 = $x - 0.5 * $len * cos($theta);
$y0 = $y - 0.5 * $len * sin($theta);
$ldx = round(- $dy * $lwid);
$ldy = round($dx * $lwid);
for ($i = 0; $i < $n; ++ $i) {
$x = $x0 + $i * $dx + $amp * $dy * sin($k * $i * $step + $phi);
$y = $y0 + $i * $dy - $amp * $dx * sin($k * $i * $step + $phi);
imagefilledrectangle($this->im, $x, $y, $x + $lwid, $y + $lwid, $this->gdlinecolor);
}
}
}
/**
* Draws random noise on the image
*/
protected function drawNoise()
{
if ($this->noise_level > 10) {
$noise_level = 10;
} else {
$noise_level = $this->noise_level;
}
$t0 = microtime(true);
$noise_level *= 125; // an arbitrary number that works well on a 1-10 scale
$points = $this->image_width * $this->image_height * $this->iscale;
$height = $this->image_height * $this->iscale;
$width = $this->image_width * $this->iscale;
for ($i = 0; $i < $noise_level; ++$i) {
$x = mt_rand(10, $width);
$y = mt_rand(10, $height);
$size = mt_rand(7, 10);
if ($x - $size <= 0 && $y - $size <= 0) continue; // dont cover 0,0 since it is used by imagedistortedcopy
imagefilledarc($this->tmpimg, $x, $y, $size, $size, 0, 360, $this->gdnoisecolor, IMG_ARC_PIE);
}
$t1 = microtime(true);
$t = $t1 - $t0;
/*
// DEBUG
imagestring($this->tmpimg, 5, 25, 30, "$t", $this->gdnoisecolor);
header('content-type: image/png');
imagepng($this->tmpimg);
exit;
*/
}
/**
* Print signature text on image
*/
protected function addSignature()
{
$bbox = imagettfbbox(10, 0, $this->signature_font, $this->image_signature);
$textlen = $bbox[2] - $bbox[0];
$x = $this->image_width - $textlen - 5;
$y = $this->image_height - 3;
imagettftext($this->im, 10, 0, $x, $y, $this->gdsignaturecolor, $this->signature_font, $this->image_signature);
}
/**
* Sends the appropriate image and cache headers and outputs image to the browser
*/
protected function output()
{
if ($this->canSendHeaders() || $this->send_headers == false) {
if ($this->send_headers) {
// only send the content-type headers if no headers have been output
// this will ease debugging on misconfigured servers where warnings
// may have been output which break the image and prevent easily viewing
// source to see the error.
header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
header("Last-Modified: " . gmdate("D, d M Y H:i:s") . "GMT");
header("Cache-Control: no-store, no-cache, must-revalidate");
header("Cache-Control: post-check=0, pre-check=0", false);
header("Pragma: no-cache");
}
switch ($this->image_type) {
case self::SI_IMAGE_JPEG:
if ($this->send_headers) header("Content-Type: image/jpeg");
imagejpeg($this->im, null, 90);
break;
case self::SI_IMAGE_GIF:
if ($this->send_headers) header("Content-Type: image/gif");
imagegif($this->im);
break;
default:
if ($this->send_headers) header("Content-Type: image/png");
imagepng($this->im);
break;
}
} else {
echo '<hr /><strong>'
.'Failed to generate captcha image, content has already been '
.'output.<br />This is most likely due to misconfiguration or '
.'a PHP error was sent to the browser.</strong>';
}
imagedestroy($this->im);
restore_error_handler();
if (!$this->no_exit) exit;
}
/**
* Generates an audio captcha in WAV format
*
* @return string The audio representation of the captcha in Wav format
*/
protected function getAudibleCode()
{
$letters = array();
$code = $this->getCode(true, true);
if (empty($code) || $code['code'] == '') {
if (strlen($this->display_value) > 0) {
$code = array('code' => $this->display_value, 'display' => $this->display_value);
} else {
$this->createCode();
$code = $this->getCode(true);
}
}
if (empty($code)) {
$error = 'Failed to get audible code (are database settings correct?). Check the error log for details';
trigger_error($error, E_USER_WARNING);
throw new Exception($error);
}
if (preg_match('/(\d+) (\+|-|x) (\d+)/i', $code['display'], $eq)) {
$math = true;
$left = $eq[1];
$sign = str_replace(array('+', '-', 'x'), array('plus', 'minus', 'times'), $eq[2]);
$right = $eq[3];
$letters = array($left, $sign, $right);
} else {
$math = false;
$length = strlen($code['display']);
for($i = 0; $i < $length; ++$i) {
$letter = $code['display']{$i};
$letters[] = $letter;
}
}
try {
return $this->generateWAV($letters);
} catch(Exception $ex) {
throw $ex;
}
}
/**
* Gets a captcha code from a file containing a list of words.
*
* Seek to a random offset in the file and reads a block of data and returns a line from the file.
*
* @param int $numWords Number of words (lines) to read from the file
* @return string|array|bool Returns a string if only one word is to be read, or an array of words
*/
protected function readCodeFromFile($numWords = 1)
{
$strpos_func = 'strpos';
$strlen_func = 'strlen';
$substr_func = 'substr';
$strtolower_func = 'strtolower';
$mb_support = false;
if (!empty($this->wordlist_file_encoding)) {
if (!extension_loaded('mbstring')) {
trigger_error("wordlist_file_encoding option set, but PHP does not have mbstring support", E_USER_WARNING);
return false;
}
// emits PHP warning if not supported
$mb_support = mb_internal_encoding($this->wordlist_file_encoding);
if (!$mb_support) {
return false;
}
$strpos_func = 'mb_strpos';
$strlen_func = 'mb_strlen';
$substr_func = 'mb_substr';
$strtolower_func = 'mb_strtolower';
}
$fp = fopen($this->wordlist_file, 'rb');
if (!$fp) return false;
$fsize = filesize($this->wordlist_file);
if ($fsize < 128) return false; // too small of a list to be effective
if ((int)$numWords < 1 || (int)$numWords > 5) $numWords = 1;
$words = array();
$i = 0;
do {
fseek($fp, mt_rand(0, $fsize - 128), SEEK_SET); // seek to a random position of file from 0 to filesize-128
$data = fread($fp, 128); // read a chunk from our random position
if ($mb_support !== false) {
$data = mb_ereg_replace("\r?\n", "\n", $data);
} else {
$data = preg_replace("/\r?\n/", "\n", $data);
}
$start = @$strpos_func($data, "\n", mt_rand(0, 56)) + 1; // random start position
$end = @$strpos_func($data, "\n", $start); // find end of word
if ($start === false) {
// picked start position at end of file
continue;
} else if ($end === false) {
$end = $strlen_func($data);
}
$word = $strtolower_func($substr_func($data, $start, $end - $start)); // return a line of the file
if ($mb_support) {
// convert to UTF-8 for imagettftext
$word = mb_convert_encoding($word, 'UTF-8', $this->wordlist_file_encoding);
}
$words[] = $word;
} while (++$i < $numWords);
fclose($fp);
if ($numWords < 2) {
return $words[0];
} else {
return $words;
}
}
/**
* Generates a random captcha code from the set character set
*
* @see Securimage::$charset Charset option
* @return string A randomly generated CAPTCHA code
*/
protected function generateCode()
{
$code = '';
if (function_exists('mb_strlen')) {
for($i = 1, $cslen = mb_strlen($this->charset, 'UTF-8'); $i <= $this->code_length; ++$i) {
$code .= mb_substr($this->charset, mt_rand(0, $cslen - 1), 1, 'UTF-8');
}
} else {
for($i = 1, $cslen = strlen($this->charset); $i <= $this->code_length; ++$i) {
$code .= substr($this->charset, mt_rand(0, $cslen - 1), 1);
}
}
return $code;
}
/**
* Validate a code supplied by the user
*
* Checks the entered code against the value stored in the session and/or database (if configured). Handles case sensitivity.
* Also removes the code from session/database if the code was entered correctly to prevent re-use attack.
*
* This function does not return a value.
*
* @see Securimage::$correct_code 'correct_code' property
*/
protected function validate()
{
if (!is_string($this->code) || strlen($this->code) == 0) {
$code = $this->getCode(true);
// returns stored code, or an empty string if no stored code was found
// checks the session and database if enabled
} else {
$code = $this->code;
}
if (is_array($code)) {
if (!empty($code)) {
$ctime = $code['time'];
$code = $code['code'];
$this->_timeToSolve = time() - $ctime;
} else {
$code = '';
}
}
if ($this->case_sensitive == false && preg_match('/[A-Z]/', $code)) {
// case sensitive was set from securimage_show.php but not in class
// the code saved in the session has capitals so set case sensitive to true
$this->case_sensitive = true;
}
$code_entered = trim( (($this->case_sensitive) ? $this->code_entered
: strtolower($this->code_entered))
);
$this->correct_code = false;
error_log($code.'::'.$code_entered);
if ($code != '') {
if (strpos($code, ' ') !== false) {
// for multi word captchas, remove more than once space from input
$code_entered = preg_replace('/\s+/', ' ', $code_entered);
$code_entered = strtolower($code_entered);
}
if ((string)$code === (string)$code_entered) {
$this->correct_code = true;
if ($this->no_session != true) {
$_SESSION['securimage_code_disp'] [$this->namespace] = '';
$_SESSION['securimage_code_value'][$this->namespace] = '';
$_SESSION['securimage_code_ctime'][$this->namespace] = '';
$_SESSION['securimage_code_audio'][$this->namespace] = '';
}
$this->clearCodeFromDatabase();
}
}
}
/**
* Save CAPTCHA data to session and database (if configured)
*/
protected function saveData()
{
if ($this->no_session != true) {
if (isset($_SESSION['securimage_code_value']) && is_scalar($_SESSION['securimage_code_value'])) {
// fix for migration from v2 - v3
unset($_SESSION['securimage_code_value']);
unset($_SESSION['securimage_code_ctime']);
}
$_SESSION['securimage_code_disp'] [$this->namespace] = $this->code_display;
$_SESSION['securimage_code_value'][$this->namespace] = $this->code;
$_SESSION['securimage_code_ctime'][$this->namespace] = time();
$_SESSION['securimage_code_audio'][$this->namespace] = null; // clear previous audio, if set
}
if ($this->use_database) {
$this->saveCodeToDatabase();
}
}
/**
* Save audio data to session and/or the configured database
*
* @param string $data The CAPTCHA audio data
*/
protected function saveAudioData($data)
{
if ($this->no_session != true) {
$_SESSION['securimage_code_audio'][$this->namespace] = $data;
}
if ($this->use_database) {
$this->saveAudioToDatabase($data);
}
}
/**
* Gets audio file contents from the session or database
*
* @return string|boolean Audio contents on success, or false if no audio found in session or DB
*/
protected function getAudioData()
{
if ($this->no_session != true) {
if (isset($_SESSION['securimage_code_audio'][$this->namespace])) {
return $_SESSION['securimage_code_audio'][$this->namespace];
}
}
if ($this->use_database) {
$this->openDatabase();
$code = $this->getCodeFromDatabase();
if (!empty($code['audio_data'])) {
return $code['audio_data'];
}
}
return false;
}
/**
* Saves the CAPTCHA data to the configured database.
*/
protected function saveCodeToDatabase()
{
$success = false;
$this->openDatabase();
if ($this->use_database && $this->pdo_conn) {
$id = $this->getCaptchaId(false);
$ip = $_SERVER['REMOTE_ADDR'];
if (empty($id)) {
$id = $ip;
}
$time = time();
$code = $this->code;
$code_disp = $this->code_display;
// This is somewhat expensive in PDO Sqlite3 (when there is something to delete)
// Clears previous captcha for this client from database so we can do a straight insert
// without having to do INSERT ... ON DUPLICATE KEY or a find/update
$this->clearCodeFromDatabase();
$query = "INSERT INTO {$this->database_table} ("
."id, code, code_display, namespace, created) "
."VALUES(?, ?, ?, ?, ?)";
$stmt = $this->pdo_conn->prepare($query);
$success = $stmt->execute(array($id, $code, $code_disp, $this->namespace, $time));
if (!$success) {
$err = $stmt->errorInfo();
$error = "Failed to insert code into database. {$err[1]}: {$err[2]}.";
if ($this->database_driver == self::SI_DRIVER_SQLITE3) {
$err14 = ($err[1] == 14);
if ($err14) $error .= sprintf(" Ensure database directory and file are writeable by user '%s' (%d).",
get_current_user(), getmyuid());
}
trigger_error($error, E_USER_WARNING);
}
}
return $success !== false;
}
/**
* Saves CAPTCHA audio to the configured database
*
* @param string $data Audio data
* @return boolean true on success, false on failure
*/
protected function saveAudioToDatabase($data)
{
$success = false;
$this->openDatabase();
if ($this->use_database && $this->pdo_conn) {
$id = $this->getCaptchaId(false);
$ip = $_SERVER['REMOTE_ADDR'];
$ns = $this->namespace;
if (empty($id)) {
$id = $ip;
}
$query = "UPDATE {$this->database_table} SET audio_data = :audioData WHERE id = :id AND namespace = :namespace";
$stmt = $this->pdo_conn->prepare($query);
$stmt->bindParam(':audioData', $data, PDO::PARAM_LOB);
$stmt->bindParam(':id', $id);
$stmt->bindParam(':namespace', $ns);
$success = $stmt->execute();
}
return $success !== false;
}
/**
* Opens a connection to the configured database.
*
* @see Securimage::$use_database Use database
* @see Securimage::$database_driver Database driver
* @see Securimage::$pdo_conn pdo_conn
* @return bool true if the database connection was successful, false if not
*/
protected function openDatabase()
{
$this->pdo_conn = false;
if ($this->use_database) {
$pdo_extension = 'PDO_' . strtoupper($this->database_driver);
if (!extension_loaded($pdo_extension)) {
trigger_error("Database support is turned on in Securimage, but the chosen extension $pdo_extension is not loaded in PHP.", E_USER_WARNING);
return false;
}
}
if ($this->database_driver == self::SI_DRIVER_SQLITE3) {
if (!file_exists($this->database_file)) {
$fp = fopen($this->database_file, 'w+');
if (!$fp) {
$err = error_get_last();
trigger_error("Securimage failed to create SQLite3 database file '{$this->database_file}'. Reason: {$err['message']}", E_USER_WARNING);
return false;
}
fclose($fp);
chmod($this->database_file, 0666);
} else if (!is_writeable($this->database_file)) {
trigger_error("Securimage does not have read/write access to database file '{$this->database_file}. Make sure permissions are 0666 and writeable by user '" . get_current_user() . "'", E_USER_WARNING);
return false;
}
}
try {
$dsn = $this->getDsn();
$options = array();
$this->pdo_conn = new PDO($dsn, $this->database_user, $this->database_pass, $options);
} catch (PDOException $pdoex) {
trigger_error("Database connection failed: " . $pdoex->getMessage(), E_USER_WARNING);
return false;
} catch (Exception $ex) {
trigger_error($ex->getMessage(), E_USER_WARNING);
return false;
}
try {
if (!$this->skip_table_check && !$this->checkTablesExist()) {
// create tables...
$this->createDatabaseTables();
}
} catch (Exception $ex) {
trigger_error($ex->getMessage(), E_USER_WARNING);
$this->pdo_conn = false;
return false;
}
if (mt_rand(0, 100) / 100.0 == 1.0) {
$this->purgeOldCodesFromDatabase();
}
return $this->pdo_conn;
}
/**
* Get the PDO DSN string for connecting to the database
*
* @see Securimage::$database_driver Database driver
* @throws Exception If database specific options are not configured
* @return string The DSN for connecting to the database
*/
protected function getDsn()
{
$dsn = sprintf('%s:', $this->database_driver);
switch($this->database_driver) {
case self::SI_DRIVER_SQLITE3:
$dsn .= $this->database_file;
break;
case self::SI_DRIVER_MYSQL:
case self::SI_DRIVER_PGSQL:
if (empty($this->database_host)) {
throw new Exception('Securimage::database_host is not set');
} else if (empty($this->database_name)) {
throw new Exception('Securimage::database_name is not set');
}
$dsn .= sprintf('host=%s;dbname=%s',
$this->database_host,
$this->database_name);
break;
}
return $dsn;
}
/**
* Checks if the necessary database tables for storing captcha codes exist
*
* @throws Exception If the table check failed for some reason
* @return boolean true if the database do exist, false if not
*/
protected function checkTablesExist()
{
$table = $this->pdo_conn->quote($this->database_table);
switch($this->database_driver) {
case self::SI_DRIVER_SQLITE3:
// query row count for sqlite, PRAGMA queries seem to return no
// rowCount using PDO even if there are rows returned
$query = "SELECT COUNT(id) FROM $table";
break;
case self::SI_DRIVER_MYSQL:
$query = "SHOW TABLES LIKE $table";
break;
case self::SI_DRIVER_PGSQL:
$query = "SELECT * FROM information_schema.columns WHERE table_name = $table;";
break;
}
$result = $this->pdo_conn->query($query);
if (!$result) {
$err = $this->pdo_conn->errorInfo();
if ($this->database_driver == self::SI_DRIVER_SQLITE3 &&
$err[1] === 1 && strpos($err[2], 'no such table') !== false)
{
return false;
}
throw new Exception("Failed to check tables: {$err[0]} - {$err[1]}: {$err[2]}");
} else if ($this->database_driver == self::SI_DRIVER_SQLITE3) {
// successful here regardless of row count for sqlite
return true;
} else if ($result->rowCount() == 0) {
return false;
} else {
return true;
}
}
/**
* Create the necessary databaes table for storing captcha codes.
*
* Based on the database adapter used, the tables will created in the existing connection.
*
* @see Securimage::$database_driver Database driver
* @return boolean true if the tables were created, false if not
*/
protected function createDatabaseTables()
{
$queries = array();
switch($this->database_driver) {
case self::SI_DRIVER_SQLITE3:
$queries[] = "CREATE TABLE \"{$this->database_table}\" (
id VARCHAR(40),
namespace VARCHAR(32) NOT NULL,
code VARCHAR(32) NOT NULL,
code_display VARCHAR(32) NOT NULL,
created INTEGER NOT NULL,
audio_data BLOB NULL,
PRIMARY KEY(id, namespace)
)";
$queries[] = "CREATE INDEX ndx_created ON {$this->database_table} (created)";
break;
case self::SI_DRIVER_MYSQL:
$queries[] = "CREATE TABLE `{$this->database_table}` (
`id` VARCHAR(40) NOT NULL,
`namespace` VARCHAR(32) NOT NULL,
`code` VARCHAR(32) NOT NULL,
`code_display` VARCHAR(32) NOT NULL,
`created` INT NOT NULL,
`audio_data` MEDIUMBLOB NULL,
PRIMARY KEY(id, namespace),
INDEX(created)
)";
break;
case self::SI_DRIVER_PGSQL:
$queries[] = "CREATE TABLE {$this->database_table} (
id character varying(40) NOT NULL,
namespace character varying(32) NOT NULL,
code character varying(32) NOT NULL,
code_display character varying(32) NOT NULL,
created integer NOT NULL,
audio_data bytea NULL,
CONSTRAINT pkey_id_namespace PRIMARY KEY (id, namespace)
)";
$queries[] = "CREATE INDEX ndx_created ON {$this->database_table} (created);";
break;
}
$this->pdo_conn->beginTransaction();
foreach($queries as $query) {
$result = $this->pdo_conn->query($query);
if (!$result) {
$err = $this->pdo_conn->errorInfo();
trigger_error("Failed to create table. {$err[1]}: {$err[2]}", E_USER_WARNING);
$this->pdo_conn->rollBack();
$this->pdo_conn = false;
return false;
}
}
$this->pdo_conn->commit();
return true;
}
/**
* Retrieves a stored code from the database for based on the captchaId or
* IP address if captcha ID not used.
*
* @return string|array Empty string if no code was found or has expired,
* otherwise returns array of code information.
*/
protected function getCodeFromDatabase()
{
$code = '';
if ($this->use_database == true && $this->pdo_conn) {
if (Securimage::$_captchaId !== null) {
$query = "SELECT * FROM {$this->database_table} WHERE id = ?";
$stmt = $this->pdo_conn->prepare($query);
$result = $stmt->execute(array(Securimage::$_captchaId));
} else {
$ip = $_SERVER['REMOTE_ADDR'];
$ns = $this->namespace;
// ip is stored in id column when no captchaId
$query = "SELECT * FROM {$this->database_table} WHERE id = ? AND namespace = ?";
$stmt = $this->pdo_conn->prepare($query);
$result = $stmt->execute(array($ip, $ns));
}
if (!$result) {
$err = $this->pdo_conn->errorInfo();
trigger_error("Failed to select code from database. {$err[0]}: {$err[1]}", E_USER_WARNING);
} else {
if ( ($row = $stmt->fetch()) !== false ) {
if (false == $this->isCodeExpired($row['created'])) {
if ($this->database_driver == self::SI_DRIVER_PGSQL && is_resource($row['audio_data'])) {
// pg bytea data returned as stream resource
$data = '';
while (!feof($row['audio_data'])) {
$data .= fgets($row['audio_data']);
}
$row['audio_data'] = $data;
}
$code = array(
'code' => $row['code'],
'code_disp' => $row['code_display'],
'time' => $row['created'],
'audio_data' => $row['audio_data'],
);
}
}
}
}
return $code;
}
/**
* Remove a stored code from the database based on captchaId or IP address.
*/
protected function clearCodeFromDatabase()
{
if ($this->pdo_conn) {
$ip = $_SERVER['REMOTE_ADDR'];
$ns = $this->pdo_conn->quote($this->namespace);
$id = Securimage::$_captchaId;
if (empty($id)) {
$id = $ip; // if no captchaId set, IP address is captchaId.
}
$id = $this->pdo_conn->quote($id);
$query = sprintf("DELETE FROM %s WHERE id = %s AND namespace = %s",
$this->database_table, $id, $ns);
$result = $this->pdo_conn->query($query);
if (!$result) {
trigger_error("Failed to delete code from database.", E_USER_WARNING);
}
}
}
/**
* Deletes old (expired) codes from the database
*/
protected function purgeOldCodesFromDatabase()
{
if ($this->use_database && $this->pdo_conn) {
$now = time();
$limit = (!is_numeric($this->expiry_time) || $this->expiry_time < 1) ? 86400 : $this->expiry_time;
$query = sprintf("DELETE FROM %s WHERE %s - created > %s",
$this->database_table,
$now,
$this->pdo_conn->quote("$limit", PDO::PARAM_INT));
$result = $this->pdo_conn->query($query);
}
}
/**
* Checks to see if the captcha code has expired and can no longer be used.
*
* @see Securimage::$expiry_time expiry_time
* @param int $creation_time The Unix timestamp of when the captcha code was created
* @return bool true if the code is expired, false if it is still valid
*/
protected function isCodeExpired($creation_time)
{
$expired = true;
if (!is_numeric($this->expiry_time) || $this->expiry_time < 1) {
$expired = false;
} else if (time() - $creation_time < $this->expiry_time) {
$expired = false;
}
return $expired;
}
/**
* Generate a wav file given the $letters in the code
*
* @param array $letters The letters making up the captcha
* @return string The audio content in WAV format
*/
protected function generateWAV($letters)
{
$wavCaptcha = new WavFile();
$first = true; // reading first wav file
if ($this->audio_use_sox && !is_executable($this->sox_binary_path)) {
throw new Exception("Path to SoX binary is incorrect or not executable");
}
foreach ($letters as $letter) {
$letter = strtoupper($letter);
try {
$letter_file = realpath($this->audio_path) . DIRECTORY_SEPARATOR . $letter . '.wav';
if ($this->audio_use_sox) {
$sox_cmd = sprintf("%s %s -t wav - %s",
$this->sox_binary_path,
$letter_file,
$this->getSoxEffectChain());
$data = `$sox_cmd`;
$l = new WavFile();
$l->setIgnoreChunkSizes(true);
$l->setWavData($data);
} else {
$l = new WavFile($letter_file);
}
if ($first) {
// set sample rate, bits/sample, and # of channels for file based on first letter
$wavCaptcha->setSampleRate($l->getSampleRate())
->setBitsPerSample($l->getBitsPerSample())
->setNumChannels($l->getNumChannels());
$first = false;
}
// append letter to the captcha audio
$wavCaptcha->appendWav($l);
// random length of silence between $audio_gap_min and $audio_gap_max
if ($this->audio_gap_max > 0 && $this->audio_gap_max > $this->audio_gap_min) {
$wavCaptcha->insertSilence( mt_rand($this->audio_gap_min, $this->audio_gap_max) / 1000.0 );
}
} catch (Exception $ex) {
// failed to open file, or the wav file is broken or not supported
// 2 wav files were not compatible, different # channels, bits/sample, or sample rate
throw new Exception("Error generating audio captcha on letter '$letter': " . $ex->getMessage());
}
}
/********* Set up audio filters *****************************/
$filters = array();
if ($this->audio_use_noise == true) {
// use background audio - find random file
$wavNoise = false;
$randOffset = 0;
/*
// uncomment to try experimental SoX noise generation.
// warning: sounds may be considered annoying
if ($this->audio_use_sox) {
$duration = $wavCaptcha->getDataSize() / ($wavCaptcha->getBitsPerSample() / 8) /
$wavCaptcha->getNumChannels() / $wavCaptcha->getSampleRate();
$duration = round($duration, 2);
$wavNoise = new WavFile();
$wavNoise->setIgnoreChunkSizes(true);
$noiseData = $this->getSoxNoiseData($duration,
$wavCaptcha->getNumChannels(),
$wavCaptcha->getSampleRate(),
$wavCaptcha->getBitsPerSample());
$wavNoise->setWavData($noiseData, true);
} else
*/
if ( ($noiseFile = $this->getRandomNoiseFile()) !== false) {
try {
$wavNoise = new WavFile($noiseFile, false);
} catch(Exception $ex) {
throw $ex;
}
// start at a random offset from the beginning of the wavfile
// in order to add more randomness
$randOffset = 0;
if ($wavNoise->getNumBlocks() > 2 * $wavCaptcha->getNumBlocks()) {
$randBlock = mt_rand(0, $wavNoise->getNumBlocks() - $wavCaptcha->getNumBlocks());
$wavNoise->readWavData($randBlock * $wavNoise->getBlockAlign(), $wavCaptcha->getNumBlocks() * $wavNoise->getBlockAlign());
} else {
$wavNoise->readWavData();
$randOffset = mt_rand(0, $wavNoise->getNumBlocks() - 1);
}
}
if ($wavNoise !== false) {
$mixOpts = array('wav' => $wavNoise,
'loop' => true,
'blockOffset' => $randOffset);
$filters[WavFile::FILTER_MIX] = $mixOpts;
$filters[WavFile::FILTER_NORMALIZE] = $this->audio_mix_normalization;
}
}
if ($this->degrade_audio == true) {
// add random noise.
// any noise level below 95% is intensely distorted and not pleasant to the ear
$filters[WavFile::FILTER_DEGRADE] = mt_rand(95, 98) / 100.0;
}
if (!empty($filters)) {
$wavCaptcha->filter($filters); // apply filters to captcha audio
}
return $wavCaptcha->__toString();
}
/**
* Gets and returns the path to a random noise file from the audio noise directory.
*
* @return bool|string false if a file could not be found, or a string containing the path to the file.
*/
public function getRandomNoiseFile()
{
$return = false;
if ( ($dh = opendir($this->audio_noise_path)) !== false ) {
$list = array();
while ( ($file = readdir($dh)) !== false ) {
if ($file == '.' || $file == '..') continue;
if (strtolower(substr($file, -4)) != '.wav') continue;
$list[] = $file;
}
closedir($dh);
if (sizeof($list) > 0) {
$file = $list[array_rand($list, 1)];
$return = $this->audio_noise_path . DIRECTORY_SEPARATOR . $file;
if (!is_readable($return)) $return = false;
}
}
return $return;
}
/**
* Get a random effect or chain of effects to apply to a segment of the
* audio file.
*
* These effects should increase the randomness of the audio for
* a particular letter/number by modulating the signal. The SoX effects
* used are *bend*, *chorus*, *overdrive*, *pitch*, *reverb*, *tempo*, and
* *tremolo*.
*
* For each effect selected, random parameters are supplied to the effect.
*
* @param int $numEffects How many effects to chain together
* @return string A string of valid SoX effects and their respective options.
*/
protected function getSoxEffectChain($numEffects = 2)
{
$effectsList = array('bend', 'chorus', 'overdrive', 'pitch', 'reverb', 'tempo', 'tremolo');
$effects = array_rand($effectsList, $numEffects);
$outEffects = array();
if (!is_array($effects)) $effects = array($effects);
foreach($effects as $effect) {
$effect = $effectsList[$effect];
switch($effect)
{
case 'bend':
$delay = mt_rand(0, 15) / 100.0;
$cents = mt_rand(-120, 120);
$dur = mt_rand(75, 400) / 100.0;
$outEffects[] = "$effect $delay,$cents,$dur";
break;
case 'chorus':
$gainIn = mt_rand(75, 90) / 100.0;
$gainOut = mt_rand(70, 95) / 100.0;
$chorStr = "$effect $gainIn $gainOut";
for ($i = 0; $i < mt_rand(2, 3); ++$i) {
$delay = mt_rand(20, 100);
$decay = mt_rand(10, 100) / 100.0;
$speed = mt_rand(20, 50) / 100.0;
$depth = mt_rand(150, 250) / 100.0;
$chorStr .= " $delay $decay $speed $depth -s";
}
$outEffects[] = $chorStr;
break;
case 'overdrive':
$gain = mt_rand(5, 25);
$color = mt_rand(20, 70);
$outEffects[] = "$effect $gain $color";
break;
case 'pitch':
$cents = mt_rand(-300, 300);
$outEffects[] = "$effect $cents";
break;
case 'reverb':
$reverberance = mt_rand(20, 80);
$damping = mt_rand(10, 80);
$scale = mt_rand(85, 100);
$depth = mt_rand(90, 100);
$predelay = mt_rand(0, 5);
$outEffects[] = "$effect $reverberance $damping $scale $depth $predelay";
break;
case 'tempo':
$factor = mt_rand(65, 135) / 100.0;
$outEffects[] = "$effect -s $factor";
break;
case 'tremolo':
$hz = mt_rand(10, 30);
$depth = mt_rand(40, 85);
$outEffects[] = "$effect $hz $depth";
break;
}
}
return implode(' ', $outEffects);
}
/**
* This function is not yet used.
*
* Generate random background noise from sweeping oscillators
*
* @param float $duration How long in seconds the generated sound will be
* @param int $numChannels Number of channels in output wav
* @param int $sampleRate Sample rate of output wav
* @param int $bitRate Bits per sample (8, 16, 24)
* @return string Audio data in wav format
*/
protected function getSoxNoiseData($duration, $numChannels, $sampleRate, $bitRate)
{
$shapes = array('sine', 'square', 'triangle', 'sawtooth', 'trapezium');
$steps = array(':', '+', '/', '-');
$selShapes = array_rand($shapes, 2);
$selSteps = array_rand($steps, 2);
$sweep0 = array();
$sweep0[0] = mt_rand(100, 700);
$sweep0[1] = mt_rand(1500, 2500);
$sweep1 = array();
$sweep1[0] = mt_rand(500, 1000);
$sweep1[1] = mt_rand(1200, 2000);
if (mt_rand(0, 10) % 2 == 0)
$sweep0 = array_reverse($sweep0);
if (mt_rand(0, 10) % 2 == 0)
$sweep1 = array_reverse($sweep1);
$cmd = sprintf("%s -c %d -r %d -b %d -n -t wav - synth noise create vol 0.3 synth %.2f %s mix %d%s%d vol 0.3 synth %.2f %s fmod %d%s%d vol 0.3",
$this->sox_binary_path,
$numChannels,
$sampleRate,
$bitRate,
$duration,
$shapes[$selShapes[0]],
$sweep0[0],
$steps[$selSteps[0]],
$sweep0[1],
$duration,
$shapes[$selShapes[1]],
$sweep1[0],
$steps[$selSteps[1]],
$sweep1[1]
);
$data = `$cmd`;
return $data;
}
/**
* Convert WAV data to MP3 using the Lame MP3 encoder binary
*
* @param string $data Contents of the WAV file to convert
* @return string MP3 file data
*/
protected function wavToMp3($data)
{
if (!file_exists(self::$lame_binary_path) || !is_executable(self::$lame_binary_path)) {
throw new Exception('Lame binary "' . $this->lame_binary_path . '" does not exist or is not executable');
}
// size of wav data input
$size = strlen($data);
// file descriptors for reading and writing to the Lame process
$descriptors = array(
0 => array('pipe', 'r'), // stdin
1 => array('pipe', 'w'), // stdout
2 => array('pipe', 'a'), // stderr
);
if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
// workaround for Windows conversion
// writing to STDIN seems to hang indefinitely after writing approximately 0xC400 bytes
$wavinput = tempnam(sys_get_temp_dir(), 'wav');
if (!$wavinput) {
throw new Exception('Failed to create temporary file for WAV to MP3 conversion');
}
file_put_contents($wavinput, $data);
$size = 0;
} else {
$wavinput = '-'; // stdin
}
// Mono, variable bit rate, 32 kHz sampling rate, read WAV from stdin, write MP3 to stdout
$cmd = sprintf("%s -m m -v -b 32 %s -", self::$lame_binary_path, $wavinput);
$proc = proc_open($cmd, $descriptors, $pipes);
if (!is_resource($proc)) {
throw new Exception('Failed to open process for MP3 encoding');
}
stream_set_blocking($pipes[0], 0); // set stdin to be non-blocking
for ($written = 0; $written < $size; $written += $len) {
// write to stdin until all WAV data is written
$len = fwrite($pipes[0], substr($data, $written, 0x20000));
if ($len === 0) {
// fwrite wrote no data, make sure process is still alive, otherwise wait for it to process
$status = proc_get_status($proc);
if ($status['running'] === false) break;
usleep(25000);
} else if ($written < $size) {
// couldn't write all data, small pause and try again
usleep(10000);
} else if ($len === false) {
// fwrite failed, should not happen
break;
}
}
fclose($pipes[0]);
$data = stream_get_contents($pipes[1]);
$err = trim(stream_get_contents($pipes[2]));
fclose($pipes[1]);
fclose($pipes[2]);
$return = proc_close($proc);
if ($wavinput != '-') unlink($wavinput); // delete temp file on Windows
if ($return !== 0) {
throw new Exception("Failed to convert WAV to MP3. Shell returned ({$return}): {$err}");
} else if ($written < $size) {
throw new Exception('Failed to convert WAV to MP3. Failed to write all data to encoder');
}
return $data;
}
/**
* Return a wav file saying there was an error generating file
*
* @return string The binary audio contents
*/
protected function audioError()
{
return @file_get_contents(dirname(__FILE__) . '/audio/en/error.wav');
}
/**
* Checks to see if headers can be sent and if any error has been output
* to the browser
*
* @return bool true if it is safe to send headers, false if not
*/
protected function canSendHeaders()
{
if (headers_sent()) {
// output has been flushed and headers have already been sent
return false;
} else if (strlen((string)ob_get_contents()) > 0) {
// headers haven't been sent, but there is data in the buffer that will break image and audio data
return false;
}
return true;
}
/**
* Return a random float between 0 and 0.9999
*
* @return float Random float between 0 and 0.9999
*/
function frand()
{
return 0.0001 * mt_rand(0,9999);
}
/**
* Convert an html color code to a Securimage_Color
* @param string $color
* @param Securimage_Color|string $default The defalt color to use if $color is invalid
*/
protected function initColor($color, $default)
{
if ($color == null) {
return new Securimage_Color($default);
} else if (is_string($color)) {
try {
return new Securimage_Color($color);
} catch(Exception $e) {
return new Securimage_Color($default);
}
} else if (is_array($color) && sizeof($color) == 3) {
return new Securimage_Color($color[0], $color[1], $color[2]);
} else {
return new Securimage_Color($default);
}
}
/**
* The error handling function used when outputting captcha image or audio.
*
* This error handler helps determine if any errors raised would
* prevent captcha image or audio from displaying. If they have
* no effect on the output buffer or headers, true is returned so
* the script can continue processing.
*
* See https://github.com/dapphp/securimage/issues/15
*
* @param int $errno PHP error number
* @param string $errstr String description of the error
* @param string $errfile File error occurred in
* @param int $errline Line the error occurred on in file
* @param array $errcontext Additional context information
* @return boolean true if the error was handled, false if PHP should handle the error
*/
public function errorHandler($errno, $errstr, $errfile = '', $errline = 0, $errcontext = array())
{
// get the current error reporting level
$level = error_reporting();
// if error was supressed or $errno not set in current error level
if ($level == 0 || ($level & $errno) == 0) {
return true;
}
return false;
}
}
/**
* Color object for Securimage CAPTCHA
*
* @version 3.0
* @since 2.0
* @package Securimage
* @subpackage classes
*
*/
class Securimage_Color
{
/**
* Red value (0-255)
* @var int
*/
public $r;
/**
* Gree value (0-255)
* @var int
*/
public $g;
/**
* Blue value (0-255)
* @var int
*/
public $b;
/**
* Create a new Securimage_Color object.
*
* Constructor expects 1 or 3 arguments.
*
* When passing a single argument, specify the color using HTML hex format.
*
* When passing 3 arguments, specify each RGB component (from 0-255)
* individually.
*
* Examples:
*
* $color = new Securimage_Color('#0080FF');
* $color = new Securimage_Color(0, 128, 255);
*
* @param string $color The html color code to use
* @throws Exception If any color value is not valid
*/
public function __construct($color = '#ffffff')
{
$args = func_get_args();
if (sizeof($args) == 0) {
$this->r = 255;
$this->g = 255;
$this->b = 255;
} else if (sizeof($args) == 1) {
// set based on html code
if (substr($color, 0, 1) == '#') {
$color = substr($color, 1);
}
if (strlen($color) != 3 && strlen($color) != 6) {
throw new InvalidArgumentException(
'Invalid HTML color code passed to Securimage_Color'
);
}
$this->constructHTML($color);
} else if (sizeof($args) == 3) {
$this->constructRGB($args[0], $args[1], $args[2]);
} else {
throw new InvalidArgumentException(
'Securimage_Color constructor expects 0, 1 or 3 arguments; ' . sizeof($args) . ' given'
);
}
}
/**
* Construct from an rgb triplet
*
* @param int $red The red component, 0-255
* @param int $green The green component, 0-255
* @param int $blue The blue component, 0-255
*/
protected function constructRGB($red, $green, $blue)
{
if ($red < 0) $red = 0;
if ($red > 255) $red = 255;
if ($green < 0) $green = 0;
if ($green > 255) $green = 255;
if ($blue < 0) $blue = 0;
if ($blue > 255) $blue = 255;
$this->r = $red;
$this->g = $green;
$this->b = $blue;
}
/**
* Construct from an html hex color code
*
* @param string $color
*/
protected function constructHTML($color)
{
if (strlen($color) == 3) {
$red = str_repeat(substr($color, 0, 1), 2);
$green = str_repeat(substr($color, 1, 1), 2);
$blue = str_repeat(substr($color, 2, 1), 2);
} else {
$red = substr($color, 0, 2);
$green = substr($color, 2, 2);
$blue = substr($color, 4, 2);
}
$this->r = hexdec($red);
$this->g = hexdec($green);
$this->b = hexdec($blue);
}
}