/usr/share/php/Net/FTP.php is in php-net-ftp 1.4.0a3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
/**
* Net_FTP main file.
*
* This file must be included to use the Net_FTP package.
*
* PHP versions 4 and 5
*
* LICENSE: This source file is subject to version 3.0 of the PHP license
* that is available through the world-wide-web at the following URI:
* http://www.php.net/license/3_0.txt. If you did not receive a copy of
* the PHP License and are unable to obtain it through the web, please
* send a note to license@php.net so we can mail you a copy immediately.
*
* @category Networking
* @package FTP
* @author Tobias Schlitt <toby@php.net>
* @author Jorrit Schippers <jschippers@php.net>
* @copyright 1997-2008 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version CVS: $Id$
* @link http://pear.php.net/package/Net_FTP
* @since File available since Release 0.0.1
*/
/**
* Include PEAR.php to obtain the PEAR base class
*/
require_once 'PEAR.php';
/**
* Option to let the ls() method return only files.
*
* @since 1.3
* @name NET_FTP_FILES_ONLY
* @see Net_FTP::ls()
*/
define('NET_FTP_FILES_ONLY', 0, true);
/**
* Option to let the ls() method return only directories.
*
* @since 1.3
* @name NET_FTP_DIRS_ONLY
* @see Net_FTP::ls()
*/
define('NET_FTP_DIRS_ONLY', 1, true);
/**
* Option to let the ls() method return directories and files (default).
*
* @since 1.3
* @name NET_FTP_DIRS_FILES
* @see Net_FTP::ls()
*/
define('NET_FTP_DIRS_FILES', 2, true);
/**
* Option to let the ls() method return the raw directory listing from ftp_rawlist()
*
* @since 1.3
* @name NET_FTP_RAWLIST
* @see Net_FTP::ls()
*/
define('NET_FTP_RAWLIST', 3, true);
/**
* Option to indicate that non-blocking features should not be used in
* put(). This will also disable the listener functionality as a side effect.
*
* @since 1.4a1
* @name NET_FTP_BLOCKING
* @see Net_FTP::put()
*/
define('NET_FTP_BLOCKING', 1, true);
/**
* Option to indicate that non-blocking features should be used if available in
* put(). This will also enable the listener functionality.
*
* This is the default behaviour.
*
* @since 1.4a1
* @name NET_FTP_NONBLOCKING
* @see Net_FTP::put()
*/
define('NET_FTP_NONBLOCKING', 2, true);
/**
* Error code to indicate a failed connection
* This error code indicates, that the connection you tryed to set up
* could not be established. Check your connection settings (host & port)!
*
* @since 1.3
* @name NET_FTP_ERR_CONNECT_FAILED
* @see Net_FTP::connect()
*/
define('NET_FTP_ERR_CONNECT_FAILED', -1);
/**
* Error code to indicate a failed login
* This error code indicates, that the login to the FTP server failed. Check
* your user data (username & password).
*
* @since 1.3
* @name NET_FTP_ERR_LOGIN_FAILED
* @see Net_FTP::login()
*/
define('NET_FTP_ERR_LOGIN_FAILED', -2);
/**
* Error code to indicate a failed directory change
* The cd() method failed. Ensure that the directory you wanted to access exists.
*
* @since 1.3
* @name NET_FTP_ERR_DIRCHANGE_FAILED
* @see Net_FTP::cd()
*/
define('NET_FTP_ERR_DIRCHANGE_FAILED', 2); // Compatibillity reasons!
/**
* Error code to indicate that Net_FTP could not determine the current path
* The pwd() method failed and could not determine the path you currently reside
* in on the FTP server.
*
* @since 1.3
* @name NET_FTP_ERR_DETERMINEPATH_FAILED
* @see Net_FTP::pwd()
*/
define('NET_FTP_ERR_DETERMINEPATH_FAILED', 4); // Compatibillity reasons!
/**
* Error code to indicate that the creation of a directory failed
* The directory you tryed to create could not be created. Check the
* access rights on the parent directory!
*
* @since 1.3
* @name NET_FTP_ERR_CREATEDIR_FAILED
* @see Net_FTP::mkdir()
*/
define('NET_FTP_ERR_CREATEDIR_FAILED', -4);
/**
* Error code to indicate that the EXEC execution failed.
* The execution of a command using EXEC failed. Ensure, that your
* FTP server supports the EXEC command.
*
* @since 1.3
* @name NET_FTP_ERR_EXEC_FAILED
* @see Net_FTP::execute()
*/
define('NET_FTP_ERR_EXEC_FAILED', -5);
/**
* Error code to indicate that the SITE command failed.
* The execution of a command using SITE failed. Ensure, that your
* FTP server supports the SITE command.
*
* @since 1.3
* @name NET_FTP_ERR_SITE_FAILED
* @see Net_FTP::site()
*/
define('NET_FTP_ERR_SITE_FAILED', -6);
/**
* Error code to indicate that the CHMOD command failed.
* The execution of CHMOD failed. Ensure, that your
* FTP server supports the CHMOD command and that you have the appropriate
* access rights to use CHMOD.
*
* @since 1.3
* @name NET_FTP_ERR_CHMOD_FAILED
* @see Net_FTP::chmod()
*/
define('NET_FTP_ERR_CHMOD_FAILED', -7);
/**
* Error code to indicate that a file rename failed
* The renaming of a file on the server failed. Ensure that you have the
* appropriate access rights to rename the file.
*
* @since 1.3
* @name NET_FTP_ERR_RENAME_FAILED
* @see Net_FTP::rename()
*/
define('NET_FTP_ERR_RENAME_FAILED', -8);
/**
* Error code to indicate that the MDTM command failed
* The MDTM command is not supported for directories. Ensure that you gave
* a file path to the mdtm() method, not a directory path.
*
* @since 1.3
* @name NET_FTP_ERR_MDTMDIR_UNSUPPORTED
* @see Net_FTP::mdtm()
*/
define('NET_FTP_ERR_MDTMDIR_UNSUPPORTED', -9);
/**
* Error code to indicate that the MDTM command failed
* The MDTM command failed. Ensure that your server supports the MDTM command.
*
* @since 1.3
* @name NET_FTP_ERR_MDTM_FAILED
* @see Net_FTP::mdtm()
*/
define('NET_FTP_ERR_MDTM_FAILED', -10);
/**
* Error code to indicate that a date returned by the server was misformated
* A date string returned by your server seems to be missformated and could not be
* parsed. Check that the server is configured correctly. If you're sure, please
* send an email to the auhtor with a dumped output of
* $ftp->ls('./', NET_FTP_RAWLIST); to get the date format supported.
*
* @since 1.3
* @name NET_FTP_ERR_DATEFORMAT_FAILED
* @see Net_FTP::mdtm(), Net_FTP::ls()
*/
define('NET_FTP_ERR_DATEFORMAT_FAILED', -11);
/**
* Error code to indicate that the SIZE command failed
* The determination of the filesize of a file failed. Ensure that your server
* supports the SIZE command.
*
* @since 1.3
* @name NET_FTP_ERR_SIZE_FAILED
* @see Net_FTP::size()
*/
define('NET_FTP_ERR_SIZE_FAILED', -12);
/**
* Error code to indicate that a local file could not be overwritten
* You specified not to overwrite files. Therefore the local file has not been
* overwriten. If you want to get the file overwriten, please set the option to
* do so.
*
* @since 1.3
* @name NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN
* @see Net_FTP::get(), Net_FTP::getRecursive()
*/
define('NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN', -13);
/**
* Error code to indicate that a local file could not be overwritten
* Also you specified to overwrite the local file you want to download to,
* it has not been possible to do so. Check that you have the appropriate access
* rights on the local file to overwrite it.
*
* @since 1.3
* @name NET_FTP_ERR_OVERWRITELOCALFILE_FAILED
* @see Net_FTP::get(), Net_FTP::getRecursive()
*/
define('NET_FTP_ERR_OVERWRITELOCALFILE_FAILED', -14);
/**
* Error code to indicate that the file you wanted to upload does not exist
* The file you tried to upload does not exist. Ensure that it exists.
*
* @since 1.3
* @name NET_FTP_ERR_LOCALFILENOTEXIST
* @see Net_FTP::put(), Net_FTP::putRecursive()
*/
define('NET_FTP_ERR_LOCALFILENOTEXIST', -15);
/**
* Error code to indicate that a remote file could not be overwritten
* You specified not to overwrite files. Therefore the remote file has not been
* overwriten. If you want to get the file overwriten, please set the option to
* do so.
*
* @since 1.3
* @name NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN
* @see Net_FTP::put(), Net_FTP::putRecursive()
*/
define('NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN', -16);
/**
* Error code to indicate that the upload of a file failed
* The upload you tried failed. Ensure that you have appropriate access rights
* to upload the desired file.
*
* @since 1.3
* @name NET_FTP_ERR_UPLOADFILE_FAILED
* @see Net_FTP::put(), Net_FTP::putRecursive()
*/
define('NET_FTP_ERR_UPLOADFILE_FAILED', -17);
/**
* Error code to indicate that you specified an incorrect directory path
* The remote path you specified seems not to be a directory. Ensure that
* the path you specify is a directory and that the path string ends with
* a /.
*
* @since 1.3
* @name NET_FTP_ERR_REMOTEPATHNODIR
* @see Net_FTP::putRecursive(), Net_FTP::getRecursive()
*/
define('NET_FTP_ERR_REMOTEPATHNODIR', -18);
/**
* Error code to indicate that you specified an incorrect directory path
* The local path you specified seems not to be a directory. Ensure that
* the path you specify is a directory and that the path string ends with
* a /.
*
* @since 1.3
* @name NET_FTP_ERR_LOCALPATHNODIR
* @see Net_FTP::putRecursive(), Net_FTP::getRecursive()
*/
define('NET_FTP_ERR_LOCALPATHNODIR', -19);
/**
* Error code to indicate that a local directory failed to be created
* You tried to create a local directory through getRecursive() method,
* which has failed. Ensure that you have the appropriate access rights
* to create it.
*
* @since 1.3
* @name NET_FTP_ERR_CREATELOCALDIR_FAILED
* @see Net_FTP::getRecursive()
*/
define('NET_FTP_ERR_CREATELOCALDIR_FAILED', -20);
/**
* Error code to indicate that the provided hostname was incorrect
* The hostname you provided was invalid. Ensure to provide either a
* full qualified domain name or an IP address.
*
* @since 1.3
* @name NET_FTP_ERR_HOSTNAMENOSTRING
* @see Net_FTP::setHostname()
*/
define('NET_FTP_ERR_HOSTNAMENOSTRING', -21);
/**
* Error code to indicate that the provided port was incorrect
* The port number you provided was invalid. Ensure to provide either a
* a numeric port number greater zero.
*
* @since 1.3
* @name NET_FTP_ERR_PORTLESSZERO
* @see Net_FTP::setPort()
*/
define('NET_FTP_ERR_PORTLESSZERO', -22);
/**
* Error code to indicate that you provided an invalid mode constant
* The mode constant you provided was invalid. You may only provide
* FTP_ASCII or FTP_BINARY.
*
* @since 1.3
* @name NET_FTP_ERR_NOMODECONST
* @see Net_FTP::setMode()
*/
define('NET_FTP_ERR_NOMODECONST', -23);
/**
* Error code to indicate that you provided an invalid timeout
* The timeout you provided was invalid. You have to provide a timeout greater
* or equal to zero.
*
* @since 1.3
* @name NET_FTP_ERR_TIMEOUTLESSZERO
* @see Net_FTP::Net_FTP(), Net_FTP::setTimeout()
*/
define('NET_FTP_ERR_TIMEOUTLESSZERO', -24);
/**
* Error code to indicate that you provided an invalid timeout
* An error occured while setting the timeout. Ensure that you provide a
* valid integer for the timeount and that your PHP installation works
* correctly.
*
* @since 1.3
* @name NET_FTP_ERR_SETTIMEOUT_FAILED
* @see Net_FTP::Net_FTP(), Net_FTP::setTimeout()
*/
define('NET_FTP_ERR_SETTIMEOUT_FAILED', -25);
/**
* Error code to indicate that the provided extension file doesn't exist
* The provided extension file does not exist. Ensure to provided an
* existant extension file.
*
* @since 1.3
* @name NET_FTP_ERR_EXTFILENOTEXIST
* @see Net_FTP::getExtensionsFile()
*/
define('NET_FTP_ERR_EXTFILENOTEXIST', -26);
/**
* Error code to indicate that the provided extension file is not readable
* The provided extension file is not readable. Ensure to have sufficient
* access rights for it.
*
* @since 1.3
* @name NET_FTP_ERR_EXTFILEREAD_FAILED
* @see Net_FTP::getExtensionsFile()
*/
define('NET_FTP_ERR_EXTFILEREAD_FAILED', -27);
/**
* Error code to indicate that the deletion of a file failed
* The specified file could not be deleted. Ensure to have sufficient
* access rights to delete the file.
*
* @since 1.3
* @name NET_FTP_ERR_EXTFILEREAD_FAILED
* @see Net_FTP::rm()
*/
define('NET_FTP_ERR_DELETEFILE_FAILED', -28);
/**
* Error code to indicate that the deletion of a directory faild
* The specified file could not be deleted. Ensure to have sufficient
* access rights to delete the file.
*
* @since 1.3
* @name NET_FTP_ERR_EXTFILEREAD_FAILED
* @see Net_FTP::rm()
*/
define('NET_FTP_ERR_DELETEDIR_FAILED', -29);
/**
* Error code to indicate that the directory listing failed
* PHP could not list the directory contents on the server. Ensure
* that your server is configured appropriate.
*
* @since 1.3
* @name NET_FTP_ERR_RAWDIRLIST_FAILED
* @see Net_FTP::ls()
*/
define('NET_FTP_ERR_RAWDIRLIST_FAILED', -30);
/**
* Error code to indicate that the directory listing failed
* The directory listing format your server uses seems not to
* be supported by Net_FTP. Please send the output of the
* call ls('./', NET_FTP_RAWLIST); to the author of this
* class to get it supported.
*
* @since 1.3
* @name NET_FTP_ERR_DIRLIST_UNSUPPORTED
* @see Net_FTP::ls()
*/
define('NET_FTP_ERR_DIRLIST_UNSUPPORTED', -31);
/**
* Error code to indicate failed disconnecting
* This error code indicates, that disconnection was not possible.
*
* @since 1.3
* @name NET_FTP_ERR_DISCONNECT_FAILED
* @see Net_FTP::disconnect()
*/
define('NET_FTP_ERR_DISCONNECT_FAILED', -32);
/**
* Error code to indicate that the username you provided was invalid.
* Check that you provided a non-empty string as the username.
*
* @since 1.3
* @name NET_FTP_ERR_USERNAMENOSTRING
* @see Net_FTP::setUsername()
*/
define('NET_FTP_ERR_USERNAMENOSTRING', -33);
/**
* Error code to indicate that the username you provided was invalid.
* Check that you provided a non-empty string as the username.
*
* @since 1.3
* @name NET_FTP_ERR_PASSWORDNOSTRING
* @see Net_FTP::setPassword()
*/
define('NET_FTP_ERR_PASSWORDNOSTRING', -34);
/**
* Error code to indicate that the provided extension file is not loadable
* The provided extension file is not loadable. Ensure to have a correct file
* syntax.
*
* @since 1.3.3
* @name NET_FTP_ERR_EXTFILELOAD_FAILED
* @see Net_FTP::getExtensionsFile()
*/
define('NET_FTP_ERR_EXTFILELOAD_FAILED', -35);
/**
* Error code to indicate that the directory listing pattern provided is not a
* string.
*
* @since 1.4.0a1
* @name NET_FTP_ERR_ILLEGALPATTERN
* @see Net_FTP::setDirMatcher()
*/
define('NET_FTP_ERR_ILLEGALPATTERN', -36);
/**
* Error code to indicate that the directory listing matcher map provided is not an
* array.
*
* @since 1.4.0a1
* @name NET_FTP_ERR_ILLEGALMAP
* @see Net_FTP::setDirMatcher()
*/
define('NET_FTP_ERR_ILLEGALMAP', -37);
/**
* Error code to indicate that the directory listing matcher map provided contains
* wrong values (ie: it contains non-numerical values)
*
* @since 1.4.0a1
* @name NET_FTP_ERR_ILLEGALMAPVALUE
* @see Net_FTP::setDirMatcher()
*/
define('NET_FTP_ERR_ILLEGALMAPVALUE', -38);
/**
* Error code indicating that bad options were supplied to the
* put() method.
*
* @since 1.4a1
* @name NET_FTP_ERR_BADOPTIONS
* @see Net_FTP::put()
*/
define('NET_FTP_ERR_BADOPTIONS', -39);
/**
* Class for comfortable FTP-communication
*
* This class provides comfortable communication with FTP-servers. You may do
* everything enabled by the PHP-FTP-extension and further functionalities, like
* recursive-deletion, -up- and -download. Another feature is to create directories
* recursively.
*
* @category Networking
* @package FTP
* @author Tobias Schlitt <toby@php.net>
* @author Jorrit Schippers <jschippers@php.net>
* @copyright 1997-2008 The PHP Group
* @license http://www.php.net/license/3_0.txt PHP License 3.0
* @version Release: 1.4.0a3
* @link http://pear.php.net/package/Net_FTP
* @since 0.0.1
* @access public
*/
class Net_FTP extends PEAR
{
/**
* The host to connect to
*
* @access private
* @var string
*/
var $_hostname;
/**
* The port for ftp-connection (standard is 21)
*
* @access private
* @var int
*/
var $_port = 21;
/**
* The username for login
*
* @access private
* @var string
*/
var $_username;
/**
* The password for login
*
* @access private
* @var string
*/
var $_password;
/**
* Determine whether to use passive-mode (true) or active-mode (false)
*
* Is null when it hasn't been explicitly set
*
* @access private
* @var bool
*/
var $_passv = null;
/**
* The standard mode for ftp-transfer
*
* @access private
* @var int
*/
var $_mode = FTP_BINARY;
/**
* This holds the handle for the ftp-connection
*
* If null, the connection hasn't been setup yet. If false, the connection
* attempt has failed. Else, it contains an ftp resource.
*
* @access private
* @var resource
*/
var $_handle = null;
/**
* Contains the timeout for FTP operations
*
* @access private
* @var int
* @since 1.3
*/
var $_timeout = 90;
/**
* Saves file-extensions for ascii- and binary-mode
*
* The array contains 2 sub-arrays ("ascii" and "binary"), which both contain
* file-extensions without the "." (".php" = "php").
*
* @access private
* @var array
*/
var $_file_extensions;
/**
* ls match
* Matches the ls entries against a regex and maps the resulting array to
* speaking names
*
* The values are set in the constructor because of line length constaints.
*
* Typical lines for the Windows format:
* 07-05-07 08:40AM 4701 SomeFile.ext
* 04-29-07 10:28PM <DIR> SomeDir
*
* @access private
* @var array
* @since 1.3
*/
var $_ls_match = null;
/**
* matcher
* Stores the matcher for the current connection
*
* @access private
* @var array
* @since 1.3
*/
var $_matcher = null;
/**
* Holds all Net_FTP_Observer objects
* that wish to be notified of new messages.
*
* @var array
* @access private
* @since 1.3
*/
var $_listeners = array();
/**
* Is true when a login has been performed
* and was successful
*
* @access private
* @var boolean
* @since 1.4
*/
var $_loggedin = false;
/**
* This generates a new FTP-Object. The FTP-connection will not be established,
* yet.
* You can leave $host and $port blank, if you want. The $host will not be set
* and the $port will be left at 21. You have to set the $host manualy before
* trying to connect or with the connect() method.
*
* @param string $host (optional) The hostname
* @param int $port (optional) The port
* @param int $timeout (optional) Sets the standard timeout
*
* @access public
* @return void
* @see Net_FTP::setHostname(), Net_FTP::setPort(), Net_FTP::connect()
*/
function Net_FTP($host = null, $port = null, $timeout = 90)
{
$this->PEAR();
if (isset($host)) {
$this->setHostname($host);
}
if (isset($port)) {
$this->setPort($port);
}
$this->_timeout = $timeout;
$this->_file_extensions[FTP_ASCII] = array();
$this->_file_extensions[FTP_BINARY] = array();
$this->_ls_match = array(
'unix' => array(
'pattern' => '/(?:(d)|.)([rwxts-]{9})\s+(\w+)\s+([\w\d-()?.]+)\s+'.
'([\w\d-()?.]+)\s+(\w+)\s+(\S+\s+\S+\s+\S+)\s+(.+)/',
'map' => array(
'is_dir' => 1,
'rights' => 2,
'files_inside' => 3,
'user' => 4,
'group' => 5,
'size' => 6,
'date' => 7,
'name' => 8,
)
),
'windows' => array(
'pattern' => '/([0-9\-]+\s+[0-9:APM]+)\s+((<DIR>)|\d+)\s+(.+)/',
'map' => array(
'date' => 1,
'size' => 2,
'is_dir' => 3,
'name' => 4,
)
)
);
}
/**
* This function generates the FTP-connection. You can optionally define a
* hostname and/or a port. If you do so, this data is stored inside the object.
*
* @param string $host (optional) The Hostname
* @param int $port (optional) The Port
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_CONNECT_FAILED
*/
function connect($host = null, $port = null)
{
$this->_matcher = null;
if (isset($host)) {
$this->setHostname($host);
}
if (isset($port)) {
$this->setPort($port);
}
$handle = @ftp_connect($this->getHostname(), $this->getPort(),
$this->_timeout);
if (!$handle) {
$this->_handle = false;
return $this->raiseError("Connection to host failed",
NET_FTP_ERR_CONNECT_FAILED);
} else {
$this->_handle =& $handle;
return true;
}
}
/**
* This function close the FTP-connection
*
* @access public
* @return bool|PEAR_Error Returns true on success, PEAR_Error on failure
*/
function disconnect()
{
$res = @ftp_close($this->_handle);
if (!$res) {
return PEAR::raiseError('Disconnect failed.',
NET_FTP_ERR_DISCONNECT_FAILED);
}
$this->_handle = null;
return true;
}
/**
* This logs you into the ftp-server. You are free to specify username and
* password in this method. If you specify it, the values will be taken into
* the corresponding attributes, if do not specify, the attributes are taken.
*
* If connect() has not been called yet, a connection will be setup
*
* @param string $username (optional) The username to use
* @param string $password (optional) The password to use
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_LOGIN_FAILED
*/
function login($username = null, $password = null)
{
if ($this->_handle === null) {
$res = $this->connect();
if (PEAR::isError($res)) {
return $res;
}
}
if (!isset($username)) {
$username = $this->getUsername();
} else {
$this->setUsername($username);
}
if (!isset($password)) {
$password = $this->getPassword();
} else {
$this->setPassword($password);
}
$res = @ftp_login($this->_handle, $username, $password);
if (!$res) {
return $this->raiseError("Unable to login", NET_FTP_ERR_LOGIN_FAILED);
} else {
$this->_loggedin = true;
// distinguish between null and false, null means this setting wasn't
// explicitly changed, so we only change it when setPassive or
// setActive was called by the user
if ($this->_passv === true) {
$this->setPassive();
} elseif ($this->_passv === false) {
$this->setActive();
}
return true;
}
}
/**
* This changes the currently used directory. You can use either an absolute
* directory-path (e.g. "/home/blah") or a relative one (e.g. "../test").
*
* @param string $dir The directory to go to.
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_DIRCHANGE_FAILED
*/
function cd($dir)
{
$erg = @ftp_chdir($this->_handle, $dir);
if (!$erg) {
return $this->raiseError("Directory change failed",
NET_FTP_ERR_DIRCHANGE_FAILED);
} else {
return true;
}
}
/**
* Show's you the actual path on the server
* This function questions the ftp-handle for the actual selected path and
* returns it.
*
* @access public
* @return mixed The actual path or PEAR::Error
* @see NET_FTP_ERR_DETERMINEPATH_FAILED
*/
function pwd()
{
$res = @ftp_pwd($this->_handle);
if (!$res) {
return $this->raiseError("Could not determine the actual path.",
NET_FTP_ERR_DETERMINEPATH_FAILED);
} else {
return $res;
}
}
/**
* This works similar to the mkdir-command on your local machine. You can either
* give it an absolute or relative path. The relative path will be completed
* with the actual selected server-path. (see: pwd())
*
* @param string $dir Absolute or relative dir-path
* @param bool $recursive (optional) Create all needed directories
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_CREATEDIR_FAILED
*/
function mkdir($dir, $recursive = false)
{
$dir = $this->_constructPath($dir);
$savedir = $this->pwd();
$this->pushErrorHandling(PEAR_ERROR_RETURN);
$e = $this->cd($dir);
$this->popErrorHandling();
if ($e === true) {
$this->cd($savedir);
return true;
}
$this->cd($savedir);
if ($recursive === false) {
$res = @ftp_mkdir($this->_handle, $dir);
if (!$res) {
return $this->raiseError("Creation of '$dir' failed",
NET_FTP_ERR_CREATEDIR_FAILED);
} else {
return true;
}
} else {
// do not look at the first character, as $dir is absolute,
// it will always be a /
if (strpos(substr($dir, 1), '/') === false) {
return $this->mkdir($dir, false);
}
if (substr($dir, -1) == '/') {
$dir = substr($dir, 0, -1);
}
$parent = substr($dir, 0, strrpos($dir, '/'));
$res = $this->mkdir($parent, true);
if ($res === true) {
$res = $this->mkdir($dir, false);
}
if ($res !== true) {
return $res;
}
return true;
}
}
/**
* This method tries executing a command on the ftp, using SITE EXEC.
*
* @param string $command The command to execute
*
* @access public
* @return mixed The result of the command (if successfull), otherwise
* PEAR::Error
* @see NET_FTP_ERR_EXEC_FAILED
*/
function execute($command)
{
$res = @ftp_exec($this->_handle, $command);
if (!$res) {
return $this->raiseError("Execution of command '$command' failed.",
NET_FTP_ERR_EXEC_FAILED);
} else {
return $res;
}
}
/**
* Execute a SITE command on the server
* This method tries to execute a SITE command on the ftp server.
*
* @param string $command The command with parameters to execute
*
* @access public
* @return mixed True if successful, otherwise PEAR::Error
* @see NET_FTP_ERR_SITE_FAILED
*/
function site($command)
{
$res = @ftp_site($this->_handle, $command);
if (!$res) {
return $this->raiseError("Execution of SITE command '$command' failed.",
NET_FTP_ERR_SITE_FAILED);
} else {
return $res;
}
}
/**
* This method will try to chmod the file specified on the server
* Currently, you must give a number as the the permission argument (777 or
* similar). The file can be either a relative or absolute path.
* NOTE: Some servers do not support this feature. In that case, you will
* get a PEAR error object returned. If successful, the method returns true
*
* @param mixed $target The file or array of files to set permissions for
* @param integer $permissions The mode to set the file permissions to
*
* @access public
* @return mixed True if successful, otherwise PEAR::Error
* @see NET_FTP_ERR_CHMOD_FAILED
*/
function chmod($target, $permissions)
{
// If $target is an array: Loop through it.
if (is_array($target)) {
for ($i = 0; $i < count($target); $i++) {
$res = $this->chmod($target[$i], $permissions);
if (PEAR::isError($res)) {
return $res;
} // end if isError
} // end for i < count($target)
return true;
} else {
$res = $this->site("CHMOD " . $permissions . " " . $target);
if (!$res) {
return PEAR::raiseError("CHMOD " . $permissions . " " . $target .
" failed", NET_FTP_ERR_CHMOD_FAILED);
} else {
return $res;
}
} // end if is_array
} // end method chmod
/**
* This method will try to chmod a folder and all of its contents
* on the server. The target argument must be a folder or an array of folders
* and the permissions argument have to be an integer (i.e. 777).
* The file can be either a relative or absolute path.
* NOTE: Some servers do not support this feature. In that case, you
* will get a PEAR error object returned. If successful, the method
* returns true
*
* @param mixed $target The folder or array of folders to
* set permissions for
* @param integer $permissions The mode to set the folder
* and file permissions to
*
* @access public
* @return mixed True if successful, otherwise PEAR::Error
* @see NET_FTP_ERR_CHMOD_FAILED, NET_FTP_ERR_DETERMINEPATH_FAILED,
* NET_FTP_ERR_RAWDIRLIST_FAILED, NET_FTP_ERR_DIRLIST_UNSUPPORTED
*/
function chmodRecursive($target, $permissions)
{
static $dir_permissions;
if (!isset($dir_permissions)) { // Making directory specific permissions
$dir_permissions = $this->_makeDirPermissions($permissions);
}
// If $target is an array: Loop through it
if (is_array($target)) {
for ($i = 0; $i < count($target); $i++) {
$res = $this->chmodRecursive($target[$i], $permissions);
if (PEAR::isError($res)) {
return $res;
} // end if isError
} // end for i < count($target)
} else {
$remote_path = $this->_constructPath($target);
// Chmod the directory itself
$result = $this->chmod($remote_path, $dir_permissions);
if (PEAR::isError($result)) {
return $result;
}
// If $remote_path last character is not a slash, add one
if (substr($remote_path, strlen($remote_path)-1) != "/") {
$remote_path .= "/";
}
$dir_list = array();
$mode = NET_FTP_DIRS_ONLY;
$dir_list = $this->ls($remote_path, $mode);
foreach ($dir_list as $dir_entry) {
if ($dir_entry['name'] == '.' || $dir_entry['name'] == '..') {
continue;
}
$remote_path_new = $remote_path.$dir_entry["name"]."/";
// Chmod the directory we're about to enter
$result = $this->chmod($remote_path_new, $dir_permissions);
if (PEAR::isError($result)) {
return $result;
}
$result = $this->chmodRecursive($remote_path_new, $permissions);
if (PEAR::isError($result)) {
return $result;
}
} // end foreach dir_list as dir_entry
$file_list = array();
$mode = NET_FTP_FILES_ONLY;
$file_list = $this->ls($remote_path, $mode);
foreach ($file_list as $file_entry) {
$remote_file = $remote_path.$file_entry["name"];
$result = $this->chmod($remote_file, $permissions);
if (PEAR::isError($result)) {
return $result;
}
} // end foreach $file_list
} // end if is_array
return true; // No errors
} // end method chmodRecursive
/**
* Rename or move a file or a directory from the ftp-server
*
* @param string $remote_from The remote file or directory original to rename or
* move
* @param string $remote_to The remote file or directory final to rename or
* move
*
* @access public
* @return bool $res True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_RENAME_FAILED
*/
function rename ($remote_from, $remote_to)
{
$res = @ftp_rename($this->_handle, $remote_from, $remote_to);
if (!$res) {
return $this->raiseError("Could not rename ".$remote_from." to ".
$remote_to." !", NET_FTP_ERR_RENAME_FAILED);
}
return true;
}
/**
* This will return logical permissions mask for directory.
* if directory has to be readable it have also be executable
*
* @param string $permissions File permissions in digits for file (i.e. 666)
*
* @access private
* @return string File permissions in digits for directory (i.e. 777)
*/
function _makeDirPermissions($permissions)
{
$permissions = (string)$permissions;
// going through (user, group, world)
for ($i = 0; $i < strlen($permissions); $i++) {
// Read permission is set but execute not yet
if ((int)$permissions{$i} & 4 and !((int)$permissions{$i} & 1)) {
// Adding execute flag
$permissions{$i} = (int)$permissions{$i} + 1;
}
}
return (string)$permissions;
}
/**
* This will return the last modification-time of a file. You can either give
* this function a relative or an absolute path to the file to check.
* NOTE: Some servers will not support this feature and the function works
* only on files, not directories! When successful,
* it will return the last modification-time as a unix-timestamp or, when
* $format is specified, a preformated timestring.
*
* @param string $file The file to check
* @param string $format (optional) The format to give the date back
* if not set, it will return a Unix timestamp
*
* @access public
* @return mixed Unix timestamp, a preformated date-string or PEAR::Error
* @see NET_FTP_ERR_MDTMDIR_UNSUPPORTED, NET_FTP_ERR_MDTM_FAILED,
* NET_FTP_ERR_DATEFORMAT_FAILED
*/
function mdtm($file, $format = null)
{
$file = $this->_constructPath($file);
if ($this->_checkRemoteDir($file) !== false) {
return $this->raiseError("Filename '$file' seems to be a directory.",
NET_FTP_ERR_MDTMDIR_UNSUPPORTED);
}
$res = @ftp_mdtm($this->_handle, $file);
if ($res == -1) {
return $this->raiseError("Could not get last-modification-date of '".
$file."'.", NET_FTP_ERR_MDTM_FAILED);
}
if (isset($format)) {
$res = date($format, $res);
if (!$res) {
return $this->raiseError("Date-format failed on timestamp '".$res.
"'.", NET_FTP_ERR_DATEFORMAT_FAILED);
}
}
return $res;
}
/**
* This will return the size of a given file in bytes. You can either give this
* function a relative or an absolute file-path. NOTE: Some servers do not
* support this feature!
*
* @param string $file The file to check
*
* @access public
* @return mixed Size in bytes or PEAR::Error
* @see NET_FTP_ERR_SIZE_FAILED
*/
function size($file)
{
$file = $this->_constructPath($file);
$res = @ftp_size($this->_handle, $file);
if ($res == -1) {
return $this->raiseError("Could not determine filesize of '$file'.",
NET_FTP_ERR_SIZE_FAILED);
} else {
return $res;
}
}
/**
* This method returns a directory-list of the current directory or given one.
* To display the current selected directory, simply set the first parameter to
* null
* or leave it blank, if you do not want to use any other parameters.
* <br><br>
* There are 4 different modes of listing directories. Either to list only
* the files (using NET_FTP_FILES_ONLY), to list only directories (using
* NET_FTP_DIRS_ONLY) or to show both (using NET_FTP_DIRS_FILES, which is
* default).
* <br><br>
* The 4th one is the NET_FTP_RAWLIST, which returns just the array created by
* the ftp_rawlist()-function build into PHP.
* <br><br>
* The other function-modes will return an array containing the requested data.
* The files and dirs are listed in human-sorted order, but if you select
* NET_FTP_DIRS_FILES the directories will be added above the files,
* but although both sorted.
* <br><br>
* All elements in the arrays are associative arrays themselves. They have the
* following structure:
* <br><br>
* Dirs:<br>
* ["name"] => string The name of the directory<br>
* ["rights"] => string The rights of the directory (in style
* "rwxr-xr-x")<br>
* ["user"] => string The owner of the directory<br>
* ["group"] => string The group-owner of the directory<br>
* ["files_inside"]=> string The number of files/dirs inside the
* directory excluding "." and ".."<br>
* ["date"] => int The creation-date as Unix timestamp<br>
* ["is_dir"] => bool true, cause this is a dir<br>
* <br><br>
* Files:<br>
* ["name"] => string The name of the file<br>
* ["size"] => int Size in bytes<br>
* ["rights"] => string The rights of the file (in style
* "rwxr-xr-x")<br>
* ["user"] => string The owner of the file<br>
* ["group"] => string The group-owner of the file<br>
* ["date"] => int The creation-date as Unix timestamp<br>
* ["is_dir"] => bool false, cause this is a file<br>
*
* @param string $dir (optional) The directory to list or null, when listing
* the current directory.
* @param int $mode (optional) The mode which types to list (files,
* directories or both).
*
* @access public
* @return mixed The directory list as described above or PEAR::Error on failure
* @see NET_FTP_DIRS_FILES, NET_FTP_DIRS_ONLY, NET_FTP_FILES_ONLY,
* NET_FTP_RAWLIST, NET_FTP_ERR_DETERMINEPATH_FAILED,
* NET_FTP_ERR_RAWDIRLIST_FAILED, NET_FTP_ERR_DIRLIST_UNSUPPORTED
*/
function ls($dir = null, $mode = NET_FTP_DIRS_FILES)
{
if (!isset($dir)) {
$dir = @ftp_pwd($this->_handle);
if (!$dir) {
return $this->raiseError("Could not retrieve current directory",
NET_FTP_ERR_DETERMINEPATH_FAILED);
}
}
if (($mode != NET_FTP_FILES_ONLY) && ($mode != NET_FTP_DIRS_ONLY) &&
($mode != NET_FTP_RAWLIST)) {
$mode = NET_FTP_DIRS_FILES;
}
switch ($mode) {
case NET_FTP_DIRS_FILES:
$res = $this->_lsBoth($dir);
break;
case NET_FTP_DIRS_ONLY:
$res = $this->_lsDirs($dir);
break;
case NET_FTP_FILES_ONLY:
$res = $this->_lsFiles($dir);
break;
case NET_FTP_RAWLIST:
$res = @ftp_rawlist($this->_handle, $dir);
break;
}
return $res;
}
/**
* This method will delete the given file or directory ($path) from the server
* (maybe recursive).
*
* Whether the given string is a file or directory is only determined by the
* last sign inside the string ("/" or not).
*
* If you specify a directory, you can optionally specify $recursive as true,
* to let the directory be deleted recursive (with all sub-directories and files
* inherited).
*
* You can either give a absolute or relative path for the file / dir. If you
* choose to use the relative path, it will be automatically completed with the
* actual selected directory.
*
* @param string $path The absolute or relative path to the file/directory.
* @param bool $recursive Recursively delete everything in $path
* @param bool $filesonly When deleting recursively, only delete files so the
* directory structure is preserved
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_DELETEFILE_FAILED, NET_FTP_ERR_DELETEDIR_FAILED,
* NET_FTP_ERR_REMOTEPATHNODIR
*/
function rm($path, $recursive = false, $filesonly = false)
{
$path = $this->_constructPath($path);
if ($this->_checkRemoteDir($path) === true) {
if ($recursive) {
return $this->_rmDirRecursive($path, $filesonly);
} else {
return $this->_rmDir($path);
}
} else {
return $this->_rmFile($path);
}
}
/**
* This function will download a file from the ftp-server. You can either
* specify an absolute path to the file (beginning with "/") or a relative one,
* which will be completed with the actual directory you selected on the server.
* You can specify the path to which the file will be downloaded on the local
* machine, if the file should be overwritten if it exists (optionally, default
* is no overwriting) and in which mode (FTP_ASCII or FTP_BINARY) the file
* should be downloaded (if you do not specify this, the method tries to
* determine it automatically from the mode-directory or uses the default-mode,
* set by you).
* If you give a relative path to the local-file, the script-path is used as
* basepath.
*
* @param string $remote_file The absolute or relative path to the file to
* download
* @param string $local_file The local file to put the downloaded in
* @param bool $overwrite (optional) Whether to overwrite existing file
* @param int $mode (optional) Either FTP_ASCII or FTP_BINARY
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN,
* NET_FTP_ERR_OVERWRITELOCALFILE_FAILED,
* NET_FTP_ERR_OVERWRITELOCALFILE_FAILED
*/
function get($remote_file, $local_file, $overwrite = false, $mode = null)
{
if (!isset($mode)) {
$mode = $this->checkFileExtension($remote_file);
}
$remote_file = $this->_constructPath($remote_file);
if (@file_exists($local_file) && !$overwrite) {
return $this->raiseError("Local file '".$local_file.
"' exists and may not be overwriten.",
NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN);
}
if (@file_exists($local_file) &&
!@is_writeable($local_file) && $overwrite) {
return $this->raiseError("Local file '".$local_file.
"' is not writeable. Can not overwrite.",
NET_FTP_ERR_OVERWRITELOCALFILE_FAILED);
}
if (@function_exists('ftp_nb_get')) {
$res = @ftp_nb_get($this->_handle, $local_file, $remote_file, $mode);
while ($res == FTP_MOREDATA) {
$this->_announce('nb_get');
$res = @ftp_nb_continue($this->_handle);
}
} else {
$res = @ftp_get($this->_handle, $local_file, $remote_file, $mode);
}
if (!$res) {
return $this->raiseError("File '".$remote_file.
"' could not be downloaded to '$local_file'.",
NET_FTP_ERR_OVERWRITELOCALFILE_FAILED);
} else {
return true;
}
}
/**
* This function will upload a file to the ftp-server. You can either specify a
* absolute path to the remote-file (beginning with "/") or a relative one,
* which will be completed with the actual directory you selected on the server.
* You can specify the path from which the file will be uploaded on the local
* maschine, if the file should be overwritten if it exists (optionally, default
* is no overwriting) and in which mode (FTP_ASCII or FTP_BINARY) the file
* should be downloaded (if you do not specify this, the method tries to
* determine it automatically from the mode-directory or uses the default-mode,
* set by you).
* If you give a relative path to the local-file, the script-path is used as
* basepath.
*
* @param string $local_file The local file to upload
* @param string $remote_file The absolute or relative path to the file to
* upload to
* @param bool $overwrite (optional) Whether to overwrite existing file
* @param int $mode (optional) Either FTP_ASCII or FTP_BINARY
* @param int $options (optional) Flags describing the behaviour of this
* function. Currently NET_FTP_BLOCKING and
* NET_FTP_NONBLOCKING are supported, of which
* NET_FTP_NONBLOCKING is the default.
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_LOCALFILENOTEXIST,
* NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN,
* NET_FTP_ERR_UPLOADFILE_FAILED, NET_FTP_NONBLOCKING, NET_FTP_BLOCKING
*/
function put($local_file, $remote_file, $overwrite = false, $mode = null,
$options = 0)
{
if ($options & (NET_FTP_BLOCKING | NET_FTP_NONBLOCKING) ===
(NET_FTP_BLOCKING | NET_FTP_NONBLOCKING)) {
return $this->raiseError('Bad options given: NET_FTP_NONBLOCKING and '.
'NET_FTP_BLOCKING can\'t both be set',
NET_FTP_ERR_BADOPTIONS);
}
$usenb = ! ($options & (NET_FTP_BLOCKING == NET_FTP_BLOCKING));
if (!isset($mode)) {
$mode = $this->checkFileExtension($local_file);
}
$remote_file = $this->_constructPath($remote_file);
if (!@file_exists($local_file)) {
return $this->raiseError("Local file '$local_file' does not exist.",
NET_FTP_ERR_LOCALFILENOTEXIST);
}
if ((@ftp_size($this->_handle, $remote_file) != -1) && !$overwrite) {
return $this->raiseError("Remote file '".$remote_file.
"' exists and may not be overwriten.",
NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN);
}
if (function_exists('ftp_alloc')) {
ftp_alloc($this->_handle, filesize($local_file));
}
if ($usenb && function_exists('ftp_nb_put')) {
$res = @ftp_nb_put($this->_handle, $remote_file, $local_file, $mode);
while ($res == FTP_MOREDATA) {
$this->_announce('nb_put');
$res = @ftp_nb_continue($this->_handle);
}
} else {
$res = @ftp_put($this->_handle, $remote_file, $local_file, $mode);
}
if (!$res) {
return $this->raiseError("File '$local_file' could not be uploaded to '"
.$remote_file."'.",
NET_FTP_ERR_UPLOADFILE_FAILED);
} else {
return true;
}
}
/**
* This functionality allows you to transfer a whole directory-structure from
* the remote-ftp to your local host. You have to give a remote-directory
* (ending with '/') and the local directory (ending with '/') where to put the
* files you download.
* The remote path is automatically completed with the current-remote-dir, if
* you give a relative path to this function. You can give a relative path for
* the $local_path, too. Then the script-basedir will be used for comletion of
* the path.
* The parameter $overwrite will determine, whether to overwrite existing files
* or not. Standard for this is false. Fourth you can explicitly set a mode for
* all transfer actions done. If you do not set this, the method tries to
* determine the transfer mode by checking your mode-directory for the file
* extension. If the extension is not inside the mode-directory, it will get
* your default mode.
*
* Since 1.4 no error will be returned when a file exists while $overwrite is
* set to false.
*
* @param string $remote_path The path to download
* @param string $local_path The path to download to
* @param bool $overwrite (optional) Whether to overwrite existing files
* (true) or not (false, standard).
* @param int $mode (optional) The transfermode (either FTP_ASCII or
* FTP_BINARY).
*
* @access public
* @return mixed True on succes, otherwise PEAR::Error
* @see NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN,
* NET_FTP_ERR_OVERWRITELOCALFILE_FAILED, NET_FTP_ERR_OVERWRITELOCALFILE_FAILED,
* NET_FTP_ERR_REMOTEPATHNODIR, NET_FTP_ERR_LOCALPATHNODIR,
* NET_FTP_ERR_CREATELOCALDIR_FAILED
*/
function getRecursive($remote_path, $local_path, $overwrite = false,
$mode = null)
{
$remote_path = $this->_constructPath($remote_path);
if ($this->_checkRemoteDir($remote_path) !== true) {
return $this->raiseError("Given remote-path '".$remote_path.
"' seems not to be a directory.",
NET_FTP_ERR_REMOTEPATHNODIR);
}
if (!@file_exists($local_path)) {
$res = @mkdir($local_path);
if (!$res) {
return $this->raiseError("Could not create dir '$local_path'",
NET_FTP_ERR_CREATELOCALDIR_FAILED);
}
} elseif (!@is_dir($local_path)) {
return $this->raiseError("Given local-path '".$local_path.
"' seems not to be a directory.",
NET_FTP_ERR_LOCALPATHNODIR);
}
$dir_list = array();
$dir_list = $this->ls($remote_path, NET_FTP_DIRS_ONLY);
if (PEAR::isError($dir_list)) {
return $dir_list;
}
foreach ($dir_list as $dir_entry) {
if ($dir_entry['name'] != '.' && $dir_entry['name'] != '..') {
$remote_path_new = $remote_path.$dir_entry["name"]."/";
$local_path_new = $local_path.$dir_entry["name"]."/";
$result = $this->getRecursive($remote_path_new,
$local_path_new, $overwrite, $mode);
if ($this->isError($result)) {
return $result;
}
}
}
$file_list = array();
$file_list = $this->ls($remote_path, NET_FTP_FILES_ONLY);
if (PEAR::isError($file_list)) {
return $file_list;
}
foreach ($file_list as $file_entry) {
$remote_file = $remote_path.$file_entry["name"];
$local_file = $local_path.$file_entry["name"];
$result = $this->get($remote_file, $local_file, $overwrite, $mode);
if ($this->isError($result) &&
$result->getCode() != NET_FTP_ERR_OVERWRITELOCALFILE_FORBIDDEN) {
return $result;
}
}
return true;
}
/**
* This functionality allows you to transfer a whole directory-structure from
* your local host to the remote-ftp. You have to give a remote-directory
* (ending with '/') and the local directory (ending with '/') where to put the
* files you download. The remote path is automatically completed with the
* current-remote-dir, if you give a relative path to this function. You can
* give a relative path for the $local_path, too. Then the script-basedir will
* be used for comletion of the path.
* The parameter $overwrite will determine, whether to overwrite existing files
* or not.
* Standard for this is false. Fourth you can explicitly set a mode for all
* transfer actions done. If you do not set this, the method tries to determine
* the transfer mode by checking your mode-directory for the file-extension. If
* the extension is not inside the mode-directory, it will get your default
* mode.
*
* @param string $local_path The path to download to
* @param string $remote_path The path to download
* @param bool $overwrite (optional) Whether to overwrite existing files
* (true) or not (false, standard).
* @param int $mode (optional) The transfermode (either FTP_ASCII or
* FTP_BINARY).
*
* @access public
* @return mixed True on succes, otherwise PEAR::Error
* @see NET_FTP_ERR_LOCALFILENOTEXIST,
* NET_FTP_ERR_OVERWRITEREMOTEFILE_FORBIDDEN,
* NET_FTP_ERR_UPLOADFILE_FAILED, NET_FTP_ERR_LOCALPATHNODIR,
* NET_FTP_ERR_REMOTEPATHNODIR
*/
function putRecursive($local_path, $remote_path, $overwrite = false,
$mode = null)
{
$remote_path = $this->_constructPath($remote_path);
if (!file_exists($local_path) || !is_dir($local_path)) {
return $this->raiseError("Given local-path '".$local_path.
"' seems not to be a directory.",
NET_FTP_ERR_LOCALPATHNODIR);
}
// try to create directory if it doesn't exist
$old_path = $this->pwd();
if ($this->isError($this->cd($remote_path))) {
$res = $this->mkdir($remote_path);
if ($this->isError($res)) {
return $res;
}
}
$this->cd($old_path);
if ($this->_checkRemoteDir($remote_path) !== true) {
return $this->raiseError("Given remote-path '".$remote_path.
"' seems not to be a directory.",
NET_FTP_ERR_REMOTEPATHNODIR);
}
$dir_list = $this->_lsLocal($local_path);
foreach ($dir_list["dirs"] as $dir_entry) {
// local directories do not have arrays as entry
$remote_path_new = $remote_path.$dir_entry."/";
$local_path_new = $local_path.$dir_entry."/";
$result = $this->putRecursive($local_path_new,
$remote_path_new, $overwrite, $mode);
if ($this->isError($result)) {
return $result;
}
}
foreach ($dir_list["files"] as $file_entry) {
$remote_file = $remote_path.$file_entry;
$local_file = $local_path.$file_entry;
$result = $this->put($local_file, $remote_file, $overwrite, $mode);
if ($this->isError($result)) {
return $result;
}
}
return true;
}
/**
* This checks, whether a file should be transfered in ascii- or binary-mode
* by it's file-extension. If the file-extension is not set or
* the extension is not inside one of the extension-dirs, the actual set
* transfer-mode is returned.
*
* @param string $filename The filename to be checked
*
* @access public
* @return int Either FTP_ASCII or FTP_BINARY
*/
function checkFileExtension($filename)
{
if (($pos = strrpos($filename, '.')) === false) {
return $this->_mode;
} else {
$ext = substr($filename, $pos + 1);
}
if (isset($this->_file_extensions[$ext])) {
return $this->_file_extensions[$ext];
}
return $this->_mode;
}
/**
* Set the hostname
*
* @param string $host The hostname to set
*
* @access public
* @return bool True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_HOSTNAMENOSTRING
*/
function setHostname($host)
{
if (!is_string($host)) {
return PEAR::raiseError("Hostname must be a string.",
NET_FTP_ERR_HOSTNAMENOSTRING);
}
$this->_hostname = $host;
return true;
}
/**
* Set the Port
*
* @param int $port The port to set
*
* @access public
* @return bool True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_PORTLESSZERO
*/
function setPort($port)
{
if (!is_int($port) || ($port < 0)) {
PEAR::raiseError("Invalid port. Has to be integer >= 0",
NET_FTP_ERR_PORTLESSZERO);
}
$this->_port = $port;
return true;
}
/**
* Set the Username
*
* @param string $user The username to set
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_USERNAMENOSTRING
*/
function setUsername($user)
{
if (empty($user) || !is_string($user)) {
return PEAR::raiseError('Username $user invalid.',
NET_FTP_ERR_USERNAMENOSTRING);
}
$this->_username = $user;
return true;
}
/**
* Set the password
*
* @param string $password The password to set
*
* @access private
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_PASSWORDNOSTRING
*/
function setPassword($password)
{
if (empty($password) || !is_string($password)) {
return PEAR::raiseError('Password xxx invalid.',
NET_FTP_ERR_PASSWORDNOSTRING);
}
$this->_password = $password;
return true;
}
/**
* Set the transfer-mode. You can use the predefined constants
* FTP_ASCII or FTP_BINARY. The mode will be stored for any further transfers.
*
* @param int $mode The mode to set
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_NOMODECONST
*/
function setMode($mode)
{
if (($mode == FTP_ASCII) || ($mode == FTP_BINARY)) {
$this->_mode = $mode;
return true;
} else {
return $this->raiseError('FTP-Mode has either to be FTP_ASCII or'.
'FTP_BINARY', NET_FTP_ERR_NOMODECONST);
}
}
/**
* Set the transfer-method to passive mode
*
* @access public
* @return void
*/
function setPassive()
{
$this->_passv = true;
if ($this->_handle != null && $this->_loggedin) {
@ftp_pasv($this->_handle, true);
}
}
/**
* Set the transfer-method to active mode
*
* @access public
* @return void
*/
function setActive()
{
$this->_passv = false;
if ($this->_handle != null && $this->_loggedin) {
@ftp_pasv($this->_handle, false);
}
}
/**
* Set the timeout for FTP operations
*
* Use this method to set a timeout for FTP operation. Timeout has to be an
* integer.
*
* @param int $timeout the timeout to use
*
* @access public
* @return bool True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_TIMEOUTLESSZERO, NET_FTP_ERR_SETTIMEOUT_FAILED
*/
function setTimeout ( $timeout = 0 )
{
if (!is_int($timeout) || ($timeout < 0)) {
return PEAR::raiseError('Timeout '.$timeout.
' is invalid, has to be an integer >= 0',
NET_FTP_ERR_TIMEOUTLESSZERO);
}
$this->_timeout = $timeout;
if (isset($this->_handle) && is_resource($this->_handle)) {
$res = @ftp_set_option($this->_handle, FTP_TIMEOUT_SEC, $timeout);
} else {
$res = true;
}
if (!$res) {
return PEAR::raiseError("Set timeout failed.",
NET_FTP_ERR_SETTIMEOUT_FAILED);
}
return true;
}
/**
* Adds an extension to a mode-directory
*
* The mode-directory saves file-extensions coresponding to filetypes
* (ascii e.g.: 'php', 'txt', 'htm',...; binary e.g.: 'jpg', 'gif', 'exe',...).
* The extensions have to be saved without the '.'. And
* can be predefined in an external file (see: getExtensionsFile()).
*
* The array is build like this: 'php' => FTP_ASCII, 'png' => FTP_BINARY
*
* To change the mode of an extension, just add it again with the new mode!
*
* @param int $mode Either FTP_ASCII or FTP_BINARY
* @param string $ext Extension
*
* @access public
* @return void
*/
function addExtension($mode, $ext)
{
$this->_file_extensions[$ext] = $mode;
}
/**
* This function removes an extension from the mode-directories
* (described above).
*
* @param string $ext The extension to remove
*
* @access public
* @return void
*/
function removeExtension($ext)
{
if (isset($this->_file_extensions[$ext])) {
unset($this->_file_extensions[$ext]);
}
}
/**
* This get's both (ascii- and binary-mode-directories) from the given file.
* Beware, if you read a file into the mode-directory, all former set values
* will be unset!
*
* Example file contents:
* [ASCII]
* asc = 0
* txt = 0
* [BINARY]
* bin = 1
* jpg = 1
*
* @param string $filename The file to get from
*
* @access public
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_EXTFILENOTEXIST, NET_FTP_ERR_EXTFILEREAD_FAILED
*/
function getExtensionsFile($filename)
{
if (!file_exists($filename)) {
return $this->raiseError("Extensions-file '$filename' does not exist",
NET_FTP_ERR_EXTFILENOTEXIST);
}
if (!is_readable($filename)) {
return $this->raiseError("Extensions-file '$filename' is not readable",
NET_FTP_ERR_EXTFILEREAD_FAILED);
}
$exts = @parse_ini_file($filename, true);
if (!is_array($exts)) {
return $this->raiseError("Extensions-file '$filename' could not be".
"loaded", NET_FTP_ERR_EXTFILELOAD_FAILED);
}
$this->_file_extensions = array();
if (isset($exts['ASCII'])) {
foreach (array_keys($exts['ASCII']) as $ext) {
$this->_file_extensions[$ext] = FTP_ASCII;
}
}
if (isset($exts['BINARY'])) {
foreach (array_keys($exts['BINARY']) as $ext) {
$this->_file_extensions[$ext] = FTP_BINARY;
}
}
return true;
}
/**
* Returns the hostname
*
* @access public
* @return string The hostname
*/
function getHostname()
{
return $this->_hostname;
}
/**
* Returns the port
*
* @access public
* @return int The port
*/
function getPort()
{
return $this->_port;
}
/**
* Returns the username
*
* @access public
* @return string The username
*/
function getUsername()
{
return $this->_username;
}
/**
* Returns the password
*
* @access public
* @return string The password
*/
function getPassword()
{
return $this->_password;
}
/**
* Returns the transfermode
*
* @access public
* @return int The transfermode, either FTP_ASCII or FTP_BINARY.
*/
function getMode()
{
return $this->_mode;
}
/**
* Returns, whether the connection is set to passive mode or not
*
* @access public
* @return bool True if passive-, false if active-mode
*/
function isPassive()
{
return $this->_passv;
}
/**
* Returns the mode set for a file-extension
*
* @param string $ext The extension you wanna ask for
*
* @return int Either FTP_ASCII, FTP_BINARY or NULL (if not set a mode for it)
* @access public
*/
function getExtensionMode($ext)
{
return @$this->_file_extensions[$ext];
}
/**
* Get the currently set timeout.
* Returns the actual timeout set.
*
* @access public
* @return int The actual timeout
*/
function getTimeout()
{
return ftp_get_option($this->_handle, FTP_TIMEOUT_SEC);
}
/**
* Adds a Net_FTP_Observer instance to the list of observers
* that are listening for messages emitted by this Net_FTP instance.
*
* @param object &$observer The Net_FTP_Observer instance to attach
* as a listener.
*
* @return boolean True if the observer is successfully attached.
* @access public
* @since 1.3
*/
function attach(&$observer)
{
if (!is_a($observer, 'Net_FTP_Observer')) {
return false;
}
$this->_listeners[$observer->getId()] = &$observer;
return true;
}
/**
* Removes a Net_FTP_Observer instance from the list of observers.
*
* @param object $observer The Net_FTP_Observer instance to detach
* from the list of listeners.
*
* @return boolean True if the observer is successfully detached.
* @access public
* @since 1.3
*/
function detach($observer)
{
if (!is_a($observer, 'Net_FTP_Observer') ||
!isset($this->_listeners[$observer->getId()])) {
return false;
}
unset($this->_listeners[$observer->getId()]);
return true;
}
/**
* Sets the directory listing matcher
*
* Use this method to set the directory listing matcher to a specific pattern.
* Indicate the pattern as a perl regular expression and give an array
* containing as keys the fields selected in the regular expression and as
* values the offset of the subpattern in the pattern.
*
* Example:
* $pattern = '/(?:(d)|.)([rwxt-]+)\s+(\w+)\s+([\w\d-]+)\s+([\w\d-]+)\s+(\w+)
* \s+(\S+\s+\S+\s+\S+)\s+(.+)/',
* $matchmap = array(
* 'is_dir' => 1,
* 'rights' => 2,
* 'files_inside' => 3,
* 'user' => 4,
* 'group' => 5,
* 'size' => 6,
* 'date' => 7,
* 'name' => 8,
* )
*
* Make sure at least the is_dir and name keys are set. The is_dir key should
* point to a subpattern that is empty for non-directories and non-empty
* for directories.
*
* @param string $pattern The new matcher pattern to use
* @param array $matchmap An mapping from key to subpattern offset
*
* @since 1.4.0a1
* @access public
* @return bool|PEAR_Error True if matcher set successfully, PEAR_Error
* otherwise
* @see NET_FTP_ERR_ILLEGALPATTERN,
* NET_FTP_ERR_ILLEGALMAP
* NET_FTP_ERR_ILLEGALMAPVALUE
*/
function setDirMatcher($pattern, $matchmap)
{
if (!is_string($pattern)) {
return $this->raiseError('The supplied pattern is not a string',
NET_FTP_ERR_ILLEGALPATTERN);
}
if (!is_array($matchmap)) {
return $this->raiseError('The supplied pattern is not an array',
NET_FTP_ERR_ILLEGALMAP);
} else {
foreach ($matchmap AS $val) {
if (!is_numeric($val)) {
return $this->raiseError('The supplied pattern contains'.
'invalid value '.$val,
NET_FTP_ERR_ILLEGALMAPVALUE);
}
}
}
$this->_matcher = array('pattern' => $pattern, 'map' => $matchmap);
return true;
}
/**
* Informs each registered observer instance that a new message has been
* sent.
*
* @param mixed $event A hash describing the net event.
*
* @access private
* @since 1.3
* @return void
*/
function _announce($event)
{
foreach ($this->_listeners as $listener) {
$listener->notify($event);
}
}
/**
* Rebuild the path, if given relative
*
* This method will make a relative path absolute by prepending the current
* remote directory in front of it.
*
* @param string $path The path to check and construct
*
* @access private
* @return string The build path
*/
function _constructPath($path)
{
if ((substr($path, 0, 1) != '/') && (substr($path, 0, 2) != './')) {
$actual_dir = @ftp_pwd($this->_handle);
if (substr($actual_dir, -1) != '/') {
$actual_dir .= '/';
}
$path = $actual_dir.$path;
}
return $path;
}
/**
* Checks whether the given path is a remote directory by trying to
* chdir() into it (and back out)
*
* @param string $path Path to check
*
* @access private
* @return mixed True if $path is a directory, otherwise false, PEAR_Error
* when an error occurs in determining path type
*/
function _checkRemoteDir($path)
{
$pwd = $this->pwd();
if ($this->isError($pwd)) {
return $pwd;
}
$res = $this->cd($path);
$this->cd($pwd);
return $this->isError($res, NET_FTP_ERR_DIRCHANGE_FAILED) === false;
}
/**
* This will remove a file
*
* @param string $file The file to delete
*
* @access private
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_DELETEFILE_FAILED
*/
function _rmFile($file)
{
if (substr($file, 0, 1) != "/") {
$actual_dir = @ftp_pwd($this->_handle);
if (substr($actual_dir, (strlen($actual_dir) - 2), 1) != "/") {
$actual_dir .= "/";
}
$file = $actual_dir.$file;
}
$res = @ftp_delete($this->_handle, $file);
if (!$res) {
return $this->raiseError("Could not delete file '$file'.",
NET_FTP_ERR_DELETEFILE_FAILED);
} else {
return true;
}
}
/**
* This will remove a dir
*
* @param string $dir The dir to delete
*
* @access private
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_REMOTEPATHNODIR, NET_FTP_ERR_DELETEDIR_FAILED
*/
function _rmDir($dir)
{
if (substr($dir, (strlen($dir) - 1), 1) != "/") {
return $this->raiseError("Directory name '".$dir.
"' is invalid, has to end with '/'",
NET_FTP_ERR_REMOTEPATHNODIR);
}
$res = @ftp_rmdir($this->_handle, $dir);
if (!$res) {
return $this->raiseError("Could not delete directory '$dir'.",
NET_FTP_ERR_DELETEDIR_FAILED);
} else {
return true;
}
}
/**
* This will remove a dir and all subdirs and -files
*
* @param string $dir The dir to delete recursively
* @param bool $filesonly Only delete files so the directory structure is
* preserved
*
* @access private
* @return mixed True on success, otherwise PEAR::Error
* @see NET_FTP_ERR_REMOTEPATHNODIR, NET_FTP_ERR_DELETEDIR_FAILED
*/
function _rmDirRecursive($dir, $filesonly = false)
{
if (substr($dir, (strlen($dir) - 1), 1) != "/") {
return $this->raiseError("Directory name '".$dir.
"' is invalid, has to end with '/'",
NET_FTP_ERR_REMOTEPATHNODIR);
}
$file_list = $this->_lsFiles($dir);
foreach ($file_list as $file) {
$file = $dir.$file["name"];
$res = $this->rm($file);
if ($this->isError($res)) {
return $res;
}
}
$dir_list = $this->_lsDirs($dir);
foreach ($dir_list as $new_dir) {
if ($new_dir["name"] == '.' || $new_dir["name"] == '..') {
continue;
}
$new_dir = $dir.$new_dir["name"]."/";
$res = $this->_rmDirRecursive($new_dir, $filesonly);
if ($this->isError($res)) {
return $res;
}
}
if (!$filesonly) {
$res = $this->_rmDir($dir);
}
if (PEAR::isError($res)) {
return $res;
} else {
return true;
}
}
/**
* Lists up files and directories
*
* @param string $dir The directory to list up
*
* @access private
* @return array An array of dirs and files
*/
function _lsBoth($dir)
{
$list_splitted = $this->_listAndParse($dir);
if (PEAR::isError($list_splitted)) {
return $list_splitted;
}
if (!is_array($list_splitted["files"])) {
$list_splitted["files"] = array();
}
if (!is_array($list_splitted["dirs"])) {
$list_splitted["dirs"] = array();
}
$res = array();
@array_splice($res, 0, 0, $list_splitted["files"]);
@array_splice($res, 0, 0, $list_splitted["dirs"]);
return $res;
}
/**
* Lists up directories
*
* @param string $dir The directory to list up
*
* @access private
* @return array An array of dirs
*/
function _lsDirs($dir)
{
$list = $this->_listAndParse($dir);
if (PEAR::isError($list)) {
return $list;
}
return $list["dirs"];
}
/**
* Lists up files
*
* @param string $dir The directory to list up
*
* @access private
* @return array An array of files
*/
function _lsFiles($dir)
{
$list = $this->_listAndParse($dir);
if (PEAR::isError($list)) {
return $list;
}
return $list["files"];
}
/**
* This lists up the directory-content and parses the items into well-formated
* arrays.
* The results of this array are sorted (dirs on top, sorted by name;
* files below, sorted by name).
*
* @param string $dir The directory to parse
*
* @access private
* @return array Lists of dirs and files
* @see NET_FTP_ERR_RAWDIRLIST_FAILED
*/
function _listAndParse($dir)
{
$dirs_list = array();
$files_list = array();
$dir_list = @ftp_rawlist($this->_handle, $dir);
if (!is_array($dir_list)) {
return PEAR::raiseError('Could not get raw directory listing.',
NET_FTP_ERR_RAWDIRLIST_FAILED);
}
foreach ($dir_list AS $k=>$v) {
if (strncmp($v, 'total: ', 7) == 0 && preg_match('/total: \d+/', $v)) {
unset($dir_list[$k]);
break; // usually there is just one line like this
}
}
// Handle empty directories
if (count($dir_list) == 0) {
return array('dirs' => $dirs_list, 'files' => $files_list);
}
// Exception for some FTP servers seem to return this wiered result instead
// of an empty list
if (count($dirs_list) == 1 && $dirs_list[0] == 'total 0') {
return array('dirs' => array(), 'files' => $files_list);
}
if (!isset($this->_matcher) || PEAR::isError($this->_matcher)) {
$this->_matcher = $this->_determineOSMatch($dir_list);
if (PEAR::isError($this->_matcher)) {
return $this->_matcher;
}
}
foreach ($dir_list as $entry) {
$m = array();
if (!preg_match($this->_matcher['pattern'], $entry, $m)) {
continue;
}
$entry = array();
foreach ($this->_matcher['map'] as $key=>$val) {
$entry[$key] = $m[$val];
}
$entry['stamp'] = $this->_parseDate($entry['date']);
if ($entry['is_dir']) {
$dirs_list[] = $entry;
} else {
$files_list[] = $entry;
}
}
@usort($dirs_list, array("Net_FTP", "_natSort"));
@usort($files_list, array("Net_FTP", "_natSort"));
$res["dirs"] = (is_array($dirs_list)) ? $dirs_list : array();
$res["files"] = (is_array($files_list)) ? $files_list : array();
return $res;
}
/**
* Determine server OS
* This determines the server OS and returns a valid regex to parse
* ls() output.
*
* @param array &$dir_list The raw dir list to parse
*
* @access private
* @return mixed An array of 'pattern' and 'map' on success, otherwise
* PEAR::Error
* @see NET_FTP_ERR_DIRLIST_UNSUPPORTED
*/
function _determineOSMatch(&$dir_list)
{
foreach ($dir_list as $entry) {
foreach ($this->_ls_match as $match) {
if (preg_match($match['pattern'], $entry)) {
return $match;
}
}
}
$error = 'The list style of your server seems not to be supported. Please'.
'email a "$ftp->ls(NET_FTP_RAWLIST);" output plus info on the'.
'server to the maintainer of this package to get it supported!'.
'Thanks for your help!';
return PEAR::raiseError($error, NET_FTP_ERR_DIRLIST_UNSUPPORTED);
}
/**
* Lists a local directory
*
* @param string $dir_path The dir to list
*
* @access private
* @return array The list of dirs and files
*/
function _lsLocal($dir_path)
{
$dir = dir($dir_path);
$dir_list = array();
$file_list = array();
while (false !== ($entry = $dir->read())) {
if (($entry != '.') && ($entry != '..')) {
if (is_dir($dir_path.$entry)) {
$dir_list[] = $entry;
} else {
$file_list[] = $entry;
}
}
}
$dir->close();
$res['dirs'] = $dir_list;
$res['files'] = $file_list;
return $res;
}
/**
* Function for use with usort().
* Compares the list-array-elements by name.
*
* @param string $item_1 first item to be compared
* @param string $item_2 second item to be compared
*
* @access private
* @return int < 0 if $item_1 is less than $item_2, 0 if equal and > 0 otherwise
*/
function _natSort($item_1, $item_2)
{
return strnatcmp($item_1['name'], $item_2['name']);
}
/**
* Parse dates to timestamps
*
* @param string $date Date
*
* @access private
* @return int Timestamp
* @see NET_FTP_ERR_DATEFORMAT_FAILED
*/
function _parseDate($date)
{
// Sep 10 22:06 => Sep 10, <year> 22:06
$res = array();
if (preg_match('/([A-Za-z]+)[ ]+([0-9]+)[ ]+([0-9]+):([0-9]+)/', $date,
$res)) {
$year = date('Y');
$month = $res[1];
$day = $res[2];
$hour = $res[3];
$minute = $res[4];
$date = "$month $day, $year $hour:$minute";
$tmpDate = strtotime($date);
if ($tmpDate > time()) {
$year--;
$date = "$month $day, $year $hour:$minute";
}
} elseif (preg_match('/^\d\d-\d\d-\d\d/', $date)) {
// 09-10-04 => 09/10/04
$date = str_replace('-', '/', $date);
}
$res = strtotime($date);
if (!$res) {
return $this->raiseError('Dateconversion failed.',
NET_FTP_ERR_DATEFORMAT_FAILED);
}
return $res;
}
}
?>
|