/usr/share/pyshared/fs/ftpfs.py is in python-fs 0.3.0-2.
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 | """
fs.ftpfs
========
FTPFS is a filesystem for accessing an FTP server (uses ftplib in standard library)
"""
__all__ = ['FTPFS']
import fs
from fs.base import *
from fs.path import pathsplit
from ftplib import FTP, error_perm, error_temp, error_proto, error_reply
try:
from ftplib import _GLOBAL_DEFAULT_TIMEOUT
_FTPLIB_TIMEOUT = True
except ImportError:
_GLOBAL_DEFAULT_TIMEOUT = None
_FTPLIB_TIMEOUT = False
import threading
from time import sleep
import datetime
import re
from socket import error as socket_error
try:
from functools import wraps
except ImportError:
wraps = lambda f: lambda f: f
try:
from cStringIO import StringIO
except ImportError:
from StringIO import StringIO
import time
import sys
# -----------------------------------------------
# Taken from http://www.clapper.org/software/python/grizzled/
# -----------------------------------------------
class Enum(object):
def __init__(self, *names):
self._names_map = dict((name, i) for i, name in enumerate(names))
def __getattr__(self, name):
return self._names_map[name]
MONTHS = ('jan', 'feb', 'mar', 'apr', 'may', 'jun',
'jul', 'aug', 'sep', 'oct', 'nov', 'dec')
MTIME_TYPE = Enum('UNKNOWN', 'LOCAL', 'REMOTE_MINUTE', 'REMOTE_DAY')
"""
``MTIME_TYPE`` identifies how a modification time ought to be interpreted
(assuming the caller cares).
- ``LOCAL``: Time is local to the client, granular to (at least) the minute
- ``REMOTE_MINUTE``: Time is local to the server and granular to the minute
- ``REMOTE_DAY``: Time is local to the server and granular to the day.
- ``UNKNOWN``: Time's locale is unknown.
"""
ID_TYPE = Enum('UNKNOWN', 'FULL')
"""
``ID_TYPE`` identifies how a file's identifier should be interpreted.
- ``FULL``: The ID is known to be complete.
- ``UNKNOWN``: The ID is not set or its type is unknown.
"""
# ---------------------------------------------------------------------------
# Globals
# ---------------------------------------------------------------------------
now = time.time()
current_year = time.localtime().tm_year
# ---------------------------------------------------------------------------
# Classes
# ---------------------------------------------------------------------------
class FTPListData(object):
"""
The `FTPListDataParser` class's ``parse_line()`` method returns an
instance of this class, capturing the parsed data.
:IVariables:
name : str
The name of the file, if parsable
try_cwd : bool
``True`` if the entry might be a directory (i.e., the caller
might want to try an FTP ``CWD`` command), ``False`` if it
cannot possibly be a directory.
try_retr : bool
``True`` if the entry might be a retrievable file (i.e., the caller
might want to try an FTP ``RETR`` command), ``False`` if it
cannot possibly be a file.
size : long
The file's size, in bytes
mtime : long
The file's modification time, as a value that can be passed to
``time.localtime()``.
mtime_type : `MTIME_TYPE`
How to interpret the modification time. See `MTIME_TYPE`.
id : str
A unique identifier for the file. The unique identifier is unique
on the *server*. On a Unix system, this identifier might be the
device number and the file's inode; on other system's, it might
be something else. It's also possible for this field to be ``None``.
id_type : `ID_TYPE`
How to interpret the identifier. See `ID_TYPE`.
"""
def __init__(self, raw_line):
self.raw_line = raw_line
self.name = None
self.try_cwd = False
self.try_retr = False
self.size = 0
self.mtime_type = MTIME_TYPE.UNKNOWN
self.mtime = 0
self.id_type = ID_TYPE.UNKNOWN
self.id = None
class FTPListDataParser(object):
"""
An ``FTPListDataParser`` object can be used to parse one or more lines
that were retrieved by an FTP ``LIST`` command that was sent to a remote
server.
"""
def __init__(self):
pass
def parse_line(self, ftp_list_line):
"""
Parse a line from an FTP ``LIST`` command.
:Parameters:
ftp_list_line : str
The line of output
:rtype: `FTPListData`
:return: An `FTPListData` object describing the parsed line, or
``None`` if the line could not be parsed. Note that it's
possible for this method to return a partially-filled
`FTPListData` object (e.g., one without a name).
"""
buf = ftp_list_line
if len(buf) < 2: # an empty name in EPLF, with no info, could be 2 chars
return None
c = buf[0]
if c == '+':
return self._parse_EPLF(buf)
elif c in 'bcdlps-':
return self._parse_unix_style(buf)
i = buf.find(';')
if i > 0:
return self._parse_multinet(buf, i)
if c in '0123456789':
return self._parse_msdos(buf)
return None
# UNIX ls does not show the year for dates in the last six months.
# So we have to guess the year.
#
# Apparently NetWare uses ``twelve months'' instead of ``six months''; ugh.
# Some versions of ls also fail to show the year for future dates.
def _guess_time(self, month, mday, hour=0, minute=0):
year = None
t = None
for year in range(current_year - 1, current_year + 100):
t = self._get_mtime(year, month, mday, hour, minute)
if (now - t) < (350 * 86400):
return t
return 0
def _get_mtime(self, year, month, mday, hour=0, minute=0, second=0):
return time.mktime((year, month, mday, hour, minute, second, 0, 0, -1))
def _get_month(self, buf):
if len(buf) == 3:
for i in range(0, 12):
if buf.lower().startswith(MONTHS[i]):
return i+1
return -1
def _parse_EPLF(self, buf):
result = FTPListData(buf)
# see http://cr.yp.to/ftp/list/eplf.html
#"+i8388621.29609,m824255902,/,\tdev"
#"+i8388621.44468,m839956783,r,s10376,\tRFCEPLF"
i = 1
for j in range(1, len(buf)):
if buf[j] == '\t':
result.name = buf[j+1:]
break
if buf[j] == ',':
c = buf[i]
if c == '/':
result.try_cwd = True
elif c == 'r':
result.try_retr = True
elif c == 's':
result.size = long(buf[i+1:j])
elif c == 'm':
result.mtime_type = MTIME_TYPE.LOCAL
result.mtime = long(buf[i+1:j])
elif c == 'i':
result.id_type = ID_TYPE.FULL
result.id = buf[i+1:j-i-1]
i = j + 1
return result
def _parse_unix_style(self, buf):
# UNIX-style listing, without inum and without blocks:
# "-rw-r--r-- 1 root other 531 Jan 29 03:26 README"
# "dr-xr-xr-x 2 root other 512 Apr 8 1994 etc"
# "dr-xr-xr-x 2 root 512 Apr 8 1994 etc"
# "lrwxrwxrwx 1 root other 7 Jan 25 00:17 bin -> usr/bin"
#
# Also produced by Microsoft's FTP servers for Windows:
# "---------- 1 owner group 1803128 Jul 10 10:18 ls-lR.Z"
# "d--------- 1 owner group 0 May 9 19:45 Softlib"
#
# Also WFTPD for MSDOS:
# "-rwxrwxrwx 1 noone nogroup 322 Aug 19 1996 message.ftp"
#
# Also NetWare:
# "d [R----F--] supervisor 512 Jan 16 18:53 login"
# "- [R----F--] rhesus 214059 Oct 20 15:27 cx.exe"
#
# Also NetPresenz for the Mac:
# "-------r-- 326 1391972 1392298 Nov 22 1995 MegaPhone.sit"
# "drwxrwxr-x folder 2 May 10 1996 network"
result = FTPListData(buf)
buflen = len(buf)
c = buf[0]
if c == 'd':
result.try_cwd = True
if c == '-':
result.try_retr = True
if c == 'l':
result.try_retr = True
result.try_cwd = True
state = 1
i = 0
tokens = buf.split()
for j in range(1, buflen):
if (buf[j] == ' ') and (buf[j - 1] != ' '):
if state == 1: # skipping perm
state = 2
elif state == 2: # skipping nlink
state = 3
if ((j - i) == 6) and (buf[i] == 'f'): # NetPresenz
state = 4
elif state == 3: # skipping UID/GID
state = 4
elif state == 4: # getting tentative size
try:
size = long(buf[i:j])
except ValueError:
pass
state = 5
elif state == 5: # searching for month, else getting tentative size
month = self._get_month(buf[i:j])
if month >= 0:
state = 6
else:
size = long(buf[i:j])
elif state == 6: # have size and month
mday = long(buf[i:j])
state = 7
elif state == 7: # have size, month, mday
if (j - i == 4) and (buf[i+1] == ':'):
hour = long(buf[i])
minute = long(buf[i+2:i+4])
result.mtime_type = MTIME_TYPE.REMOTE_MINUTE
result.mtime = self._guess_time(month, mday, hour, minute)
elif (j - i == 5) and (buf[i+2] == ':'):
hour = long(buf[i:i+2])
minute = long(buf[i+3:i+5])
result.mtime_type = MTIME_TYPE.REMOTE_MINUTE
result.mtime = self._guess_time(month, mday, hour, minute)
elif j - i >= 4:
year = long(buf[i:j])
result.mtimetype = MTIME_TYPE.REMOTE_DAY
result.mtime = self._get_mtime(year, month, mday)
else:
break
result.name = buf[j+1:]
state = 8
elif state == 8: # twiddling thumbs
pass
i = j + 1
while (i < buflen) and (buf[i] == ' '):
i += 1
#if state != 8:
#return None
result.size = size
if c == 'l':
i = 0
while (i + 3) < len(result.name):
if result.name[i:i+4] == ' -> ':
result.name = result.name[:i]
break
i += 1
# eliminate extra NetWare spaces
if (buf[1] == ' ') or (buf[1] == '['):
namelen = len(result.name)
if namelen > 3:
result.name = result.name.strip()
return result
def _parse_multinet(self, buf, i):
# MultiNet (some spaces removed from examples)
# "00README.TXT;1 2 30-DEC-1996 17:44 [SYSTEM] (RWED,RWED,RE,RE)"
# "CORE.DIR;1 1 8-SEP-1996 16:09 [SYSTEM] (RWE,RWE,RE,RE)"
# and non-MultiNet VMS:
#"CII-MANUAL.TEX;1 213/216 29-JAN-1996 03:33:12 [ANONYMOU,ANONYMOUS] (RWED,RWED,,)"
result = FTPListData(buf)
result.name = buf[:i]
buflen = len(buf)
if i > 4:
if buf[i-4:i] == '.DIR':
result.name = result.name[0:-4]
result.try_cwd = True
if not result.try_cwd:
result.try_retr = True
try:
i = buf.index(' ', i)
i = _skip(buf, i, ' ')
i = buf.index(' ', i)
i = _skip(buf, i, ' ')
j = i
j = buf.index('-', j)
mday = long(buf[i:j])
j = _skip(buf, j, '-')
i = j
j = buf.index('-', j)
month = self._get_month(buf[i:j])
if month < 0:
raise IndexError
j = _skip(buf, j, '-')
i = j
j = buf.index(' ', j)
year = long(buf[i:j])
j = _skip(buf, j, ' ')
i = j
j = buf.index(':', j)
hour = long(buf[i:j])
j = _skip(buf, j, ':')
i = j
while (buf[j] != ':') and (buf[j] != ' '):
j += 1
if j == buflen:
raise IndexError # abort, abort!
minute = long(buf[i:j])
result.mtimetype = MTIME_TYPE.REMOTE_MINUTE
result.mtime = self._get_mtime(year, month, mday, hour, minute)
except IndexError:
pass
return result
def _parse_msdos(self, buf):
# MSDOS format
# 04-27-00 09:09PM <DIR> licensed
# 07-18-00 10:16AM <DIR> pub
# 04-14-00 03:47PM 589 readme.htm
buflen = len(buf)
i = 0
j = 0
try:
result = FTPListData(buf)
j = buf.index('-', j)
month = long(buf[i:j])
j = _skip(buf, j, '-')
i = j
j = buf.index('-', j)
mday = long(buf[i:j])
j = _skip(buf, j, '-')
i = j
j = buf.index(' ', j)
year = long(buf[i:j])
if year < 50:
year += 2000
if year < 1000:
year += 1900
j = _skip(buf, j, ' ')
i = j
j = buf.index(':', j)
hour = long(buf[i:j])
j = _skip(buf, j, ':')
i = j
while not (buf[j] in 'AP'):
j += 1
if j == buflen:
raise IndexError
minute = long(buf[i:j])
if buf[j] == 'A':
j += 1
if j == buflen:
raise IndexError
if buf[j] == 'P':
hour = (hour + 12) % 24
j += 1
if j == buflen:
raise IndexError
if buf[j] == 'M':
j += 1
if j == buflen:
raise IndexError
j = _skip(buf, j, ' ')
if buf[j] == '<':
result.try_cwd = True
j = buf.index(' ', j)
else:
i = j
j = buf.index(' ', j)
result.size = long(buf[i:j])
result.try_retr = True
j = _skip(buf, j, ' ')
result.name = buf[j:]
result.mtimetype = MTIME_TYPE.REMOTE_MINUTE
result.mtime = self._get_mtime(year, month, mday, hour, minute)
except IndexError:
pass
return result
# ---------------------------------------------------------------------------
# Public Functions
# ---------------------------------------------------------------------------
def parse_ftp_list_line(ftp_list_line):
"""
Convenience function that instantiates an `FTPListDataParser` object
and passes ``ftp_list_line`` to the object's ``parse_line()`` method,
returning the result.
:Parameters:
ftp_list_line : str
The line of output
:rtype: `FTPListData`
:return: An `FTPListData` object describing the parsed line, or
``None`` if the line could not be parsed. Note that it's
possible for this method to return a partially-filled
`FTPListData` object (e.g., one without a name).
"""
return FTPListDataParser().parse_line(ftp_list_line)
# ---------------------------------------------------------------------------
# Private Functions
# ---------------------------------------------------------------------------
def _skip(s, i, c):
while s[i] == c:
i += 1
if i == len(s):
raise IndexError
return i
class _FTPFile(object):
""" A file-like that provides access to a file being streamed over ftp."""
def __init__(self, ftpfs, ftp, path, mode):
if not hasattr(self, '_lock'):
self._lock = threading.RLock()
self.ftpfs = ftpfs
self.ftp = ftp
self.path = path
self.mode = mode
self.read_pos = 0
self.write_pos = 0
self.closed = False
if 'r' in mode or 'a' in mode:
self.file_size = ftpfs.getsize(path)
self.conn = None
path = _encode(path)
#self._lock = ftpfs._lock
if 'r' in mode:
self.ftp.voidcmd('TYPE I')
self.conn = ftp.transfercmd('RETR '+path, None)
elif 'w' in mode or 'a' in mode:
self.ftp.voidcmd('TYPE I')
if 'a' in mode:
self.write_pos = self.file_size
self.conn = self.ftp.transfercmd('APPE '+path)
else:
self.conn = self.ftp.transfercmd('STOR '+path)
@synchronize
def read(self, size=None):
if self.conn is None:
return ''
chunks = []
if size is None:
while 1:
data = self.conn.recv(4096)
if not data:
self.conn.close()
self.conn = None
self.ftp.voidresp()
break
chunks.append(data)
self.read_pos += len(data)
return ''.join(chunks)
remaining_bytes = size
while remaining_bytes:
read_size = min(remaining_bytes, 4096)
data = self.conn.recv(read_size)
if not data:
self.conn.close()
self.conn = None
self.ftp.voidresp()
break
chunks.append(data)
self.read_pos += len(data)
remaining_bytes -= len(data)
return ''.join(chunks)
@synchronize
def write(self, data):
data_pos = 0
remaining_data = len(data)
while remaining_data:
chunk_size = min(remaining_data, 4096)
self.conn.sendall(data[data_pos:data_pos+chunk_size])
data_pos += chunk_size
remaining_data -= chunk_size
self.write_pos += chunk_size
def __enter__(self):
return self
def __exit__(self,exc_type,exc_value,traceback):
self.close()
@synchronize
def flush(self):
return
def seek(self, pos, where=fs.SEEK_SET):
# Ftp doesn't support a real seek, so we close the transfer and resume
# it at the new position with the REST command
# I'm not sure how reliable this method is!
if not self.file_size:
raise ValueError("Seek only works with files open for read")
self._lock.acquire()
try:
current = self.tell()
new_pos = None
if where == fs.SEEK_SET:
new_pos = pos
elif where == fs.SEEK_CUR:
new_pos = current + pos
elif where == fs.SEEK_END:
new_pos = self.file_size + pos
if new_pos < 0:
raise ValueError("Can't seek before start of file")
if self.conn is not None:
self.conn.close()
finally:
self._lock.release()
self.close()
self._lock.acquire()
try:
self.ftp = self.ftpfs._open_ftp()
self.ftp.sendcmd('TYPE I')
self.ftp.sendcmd('REST %i' % (new_pos))
self.__init__(self.ftpfs, self.ftp, _encode(self.path), self.mode)
self.read_pos = new_pos
finally:
self._lock.release()
#raise UnsupportedError('ftp seek')
@synchronize
def tell(self):
if 'r' in self.mode:
return self.read_pos
else:
return self.write_pos
@synchronize
def close(self):
if self.conn is not None:
self.conn.close()
self.conn = None
self.ftp.voidresp()
if self.ftp is not None:
self.ftp.close()
self.closed = True
if 'w' in self.mode or 'a' in self.mode:
self.ftpfs._on_file_written(self.path)
def __iter__(self):
return self.next()
def next(self):
""" Line iterator
This isn't terribly efficient. It would probably be better to do
a read followed by splitlines.
"""
endings = '\r\n'
chars = []
append = chars.append
read = self.read
join = ''.join
while True:
char = read(1)
if not char:
if chars:
yield join(chars)
break
append(char)
if char in endings:
line = join(chars)
del chars[:]
c = read(1)
if not char:
yield line
break
if c in endings and c != char:
yield line + c
else:
yield line
append(c)
def ftperrors(f):
@wraps(f)
def deco(self, *args, **kwargs):
self._lock.acquire()
try:
self._enter_dircache()
try:
try:
ret = f(self, *args, **kwargs)
except Exception, e:
self._translate_exception(args[0] if args else '', e)
finally:
self._leave_dircache()
finally:
self._lock.release()
if not self.use_dircache:
self.clear_dircache()
return ret
return deco
def _encode(s):
if isinstance(s, unicode):
return s.encode('utf-8')
return s
class FTPFS(FS):
_locals = threading.local()
def __init__(self, host='', user='', passwd='', acct='', timeout=_GLOBAL_DEFAULT_TIMEOUT,
port=21,
dircache=True,
max_buffer_size=128*1024*1024):
""" Connect to a FTP server.
:param host: Host to connect to
:param user: Username, or a blank string for anonymous
:param passwd: Password, if required
:param acct: Accounting information (few servers require this)
:param timeout: Timeout in seconds
:param port: Port to connection (default is 21)
:param dircache: If True then directory information will be cached,
which will speed up operations such as getinfo, isdi, isfile, but
changes to the ftp file structure will not be visible until
`~fs.ftpfs.FTPFS.clear_dircache` is called
:param dircache: If True directory information will be cached for fast access
:param max_buffer_size: Number of bytes to hold before blocking write operations
"""
super(FTPFS, self).__init__()
self.host = host
self.port = port
self.user = user
self.passwd = passwd
self.acct = acct
self.timeout = timeout
self.use_dircache = dircache
self.get_dircache()
self.max_buffer_size = max_buffer_size
self._cache_hint = False
self._locals._ftp = None
self._thread_ftps = set()
self.ftp
@synchronize
def cache_hint(self, enabled):
self._cache_hint = enabled
@synchronize
def _enter_dircache(self):
self.get_dircache()
count = getattr(self._locals, '_dircache_count', 0)
count += 1
self._locals._dircache_count = count
@synchronize
def _leave_dircache(self):
self._locals._dircache_count -= 1
if not self._locals._dircache_count and not self._cache_hint:
self.clear_dircache()
assert self._locals._dircache_count >= 0, "dircache count should never be negative"
@synchronize
def get_dircache(self):
dircache = getattr(self._locals, '_dircache', None)
if dircache is None:
dircache = {}
self._locals._dircache = dircache
self._locals._dircache_count = 0
return dircache
@synchronize
def _on_file_written(self, path):
self.clear_dircache(dirname(path))
@synchronize
def _readdir(self, path):
dircache = self.get_dircache()
dircache_count = self._locals._dircache_count
if dircache_count:
cached_dirlist = dircache.get(path)
if cached_dirlist is not None:
return cached_dirlist
dirlist = {}
parser = FTPListDataParser()
def on_line(line):
#print repr(line)
if not isinstance(line, unicode):
line = line.decode('utf-8')
info = parser.parse_line(line)
if info:
info = info.__dict__
dirlist[info['name']] = info
try:
self.ftp.dir(_encode(path), on_line)
except error_reply:
pass
dircache[path] = dirlist
return dirlist
@synchronize
def clear_dircache(self, *paths):
"""
Clear cached directory information.
:param path: Path of directory to clear cache for, or all directories if
None (the default)
"""
dircache = self.get_dircache()
if not paths:
dircache.clear()
else:
for path in paths:
dircache.pop(path, None)
@synchronize
def _check_path(self, path):
base, fname = pathsplit(abspath(path))
dirlist = self._readdir(base)
if fname and fname not in dirlist:
raise ResourceNotFoundError(path)
return dirlist, fname
def _get_dirlist(self, path):
base, fname = pathsplit(abspath(path))
dirlist = self._readdir(base)
return dirlist, fname
@synchronize
def get_ftp(self):
if getattr(self._locals, '_ftp', None) is None:
self._locals._ftp = self._open_ftp()
ftp = self._locals._ftp
self._thread_ftps.add(ftp)
return self._locals._ftp
@synchronize
def set_ftp(self, ftp):
self._locals._ftp = ftp
ftp = property(get_ftp, set_ftp)
@synchronize
def _open_ftp(self):
try:
ftp = FTP()
if _FTPLIB_TIMEOUT:
ftp.connect(self.host, self.port, self.timeout)
else:
ftp.connect(self.host, self.port)
ftp.login(self.user, self.passwd, self.acct)
except socket_error, e:
raise RemoteConnectionError(str(e), details=e)
return ftp
def __getstate__(self):
state = super(FTPFS, self).__getstate__()
del state["_thread_ftps"]
return state
def __setstate__(self,state):
super(FTPFS, self).__setstate__(state)
self._thread_ftps = set()
self.ftp
def __str__(self):
return '<FTPFS %s>' % self.host
def __unicode__(self):
return u'<FTPFS %s>' % self.host
@convert_os_errors
def _translate_exception(self, path, exception):
""" Translates exceptions that my be thrown by the ftp code in to
FS exceptions
TODO: Flesh this out with more specific exceptions
"""
if isinstance(exception, socket_error):
raise RemoteConnectionError(str(exception), details=exception)
elif isinstance(exception, error_temp):
code, message = str(exception).split(' ', 1)
raise RemoteConnectionError(str(exception), path=path, msg="FTP error: %s (see details)" % str(exception), details=exception)
elif isinstance(exception, error_perm):
code, message = str(exception).split(' ', 1)
code = int(code)
if code == 550:
raise ResourceNotFoundError(path)
if code == 552:
raise StorageSpaceError
raise PermissionDeniedError(str(exception), path=path, msg="FTP error: %s (see details)" % str(exception), details=exception)
raise exception
@ftperrors
def close(self):
for ftp in self._thread_ftps:
ftp.close()
self._thread_ftps.clear()
self.closed = True
@ftperrors
def open(self, path, mode='r'):
mode = mode.lower()
if 'r' in mode:
if not self.isfile(path):
raise ResourceNotFoundError(path)
if 'w' in mode or 'a' in mode:
self.clear_dircache(dirname(path))
ftp = self._open_ftp()
f = _FTPFile(self, ftp, path, mode)
return f
@ftperrors
def exists(self, path):
if path in ('', '/'):
return True
dirlist, fname = self._get_dirlist(path)
return fname in dirlist
@ftperrors
def isdir(self, path):
if path in ('', '/'):
return True
dirlist, fname = self._get_dirlist(path)
info = dirlist.get(fname)
if info is None:
return False
return info['try_cwd']
@ftperrors
def isfile(self, path):
if path in ('', '/'):
return False
dirlist, fname = self._get_dirlist(path)
info = dirlist.get(fname)
if info is None:
return False
return not info['try_cwd']
@ftperrors
def listdir(self, path="./", wildcard=None, full=False, absolute=False, dirs_only=False, files_only=False):
path = normpath(path)
if not self.exists(path):
raise ResourceNotFoundError(path)
if not self.isdir(path):
raise ResourceInvalidError(path)
paths = self._readdir(path).keys()
return self._listdir_helper(path, paths, wildcard, full, absolute, dirs_only, files_only)
@ftperrors
def makedir(self, path, recursive=False, allow_recreate=False):
if path in ('', '/'):
return
def checkdir(path):
self.clear_dircache(dirname(path), path)
try:
self.ftp.mkd(_encode(path))
except error_reply:
return
except error_perm, e:
if recursive or allow_recreate:
return
if str(e).split(' ', 1)[0]=='550':
raise DestinationExistsError(path)
else:
raise
if recursive:
for p in recursepath(path):
checkdir(p)
else:
base = dirname(path)
if not self.exists(base):
raise ParentDirectoryMissingError(path)
if not allow_recreate:
if self.exists(path):
if self.isfile(path):
raise ResourceInvalidError(path)
raise DestinationExistsError(path)
checkdir(path)
@ftperrors
def remove(self, path):
if not self.exists(path):
raise ResourceNotFoundError(path)
if not self.isfile(path):
raise ResourceInvalidError(path)
self.clear_dircache(dirname(path))
self.ftp.delete(_encode(path))
@ftperrors
def removedir(self, path, recursive=False, force=False):
if not self.exists(path):
raise ResourceNotFoundError(path)
if self.isfile(path):
raise ResourceInvalidError(path)
if not force:
for checkpath in self.listdir(path):
raise DirectoryNotEmptyError(path)
try:
if force:
for rpath in self.listdir(path, full=True):
try:
if self.isfile(rpath):
self.remove(rpath)
elif self.isdir(rpath):
self.removedir(rpath, force=force)
except FSError:
pass
self.clear_dircache(dirname(path), path)
self.ftp.rmd(_encode(path))
except error_reply:
pass
if recursive:
try:
self.removedir(dirname(path), recursive=True)
except DirectoryNotEmptyError:
pass
@ftperrors
def rename(self, src, dst):
self.clear_dircache(dirname(src), dirname(dst), src, dst)
try:
self.ftp.rename(_encode(src), _encode(dst))
except error_perm, exception:
code, message = str(exception).split(' ', 1)
if code == "550":
if not self.exists(dirname(dst)):
raise ParentDirectoryMissingError(dst)
except error_reply:
pass
@ftperrors
def getinfo(self, path):
dirlist, fname = self._check_path(path)
if not fname:
return {}
info = dirlist[fname].copy()
info['modified_time'] = datetime.datetime.fromtimestamp(info['mtime'])
info['created_time'] = info['modified_time']
return info
@ftperrors
def getsize(self, path):
size = None
if self._locals._dircache_count:
dirlist, fname = self._check_path(path)
size = dirlist[fname].get('size')
if size is not None:
return size
self.ftp.sendcmd('TYPE I')
size = self.ftp.size(_encode(path))
if size is None:
dirlist, fname = self._check_path(path)
size = dirlist[fname].get('size')
if size is None:
raise OperationFailedError('getsize', path)
return size
@ftperrors
def desc(self, path):
dirlist, fname = self._check_path(path)
if fname not in dirlist:
raise ResourceNotFoundError(path)
return dirlist[fname].get('raw_line', 'No description available')
@ftperrors
def move(self, src, dst, overwrite=False, chunk_size=16384):
if not overwrite and self.exists(dst):
raise DestinationExistsError(dst)
self.clear_dircache(dirname(src), dirname(dst))
try:
self.rename(src, dst)
except error_reply:
pass
except:
self.copy(src, dst)
self.remove(src)
@ftperrors
def movedir(self, src, dst, overwrite=False, ignore_errors=False, chunk_size=16384):
self.clear_dircache(src, dst, dirname(src), dirname(dst))
super(FTPFS, self).movedir(src, dst, overwrite, ignore_errors, chunk_size)
@ftperrors
def copydir(self, src, dst, overwrite=False, ignore_errors=False, chunk_size=16384):
self.clear_dircache(src, dst, dirname(src), dirname(dst))
super(FTPFS, self).copydir(src, dst, overwrite, ignore_errors, chunk_size)
if __name__ == "__main__":
ftp_fs = FTPFS('ftp.ncsa.uiuc.edu')
ftp_fs.cache_hint(True)
from fs.browsewin import browse
browse(ftp_fs)
#ftp_fs = FTPFS('127.0.0.1', 'user', '12345', dircache=True)
#f = ftp_fs.open('testout.txt', 'w')
#f.write("Testing writing to an ftp file!")
#f.write("\nHai!")
#f.close()
#ftp_fs.createfile(u"\N{GREEK CAPITAL LETTER KAPPA}", 'unicode!')
#kappa = u"\N{GREEK CAPITAL LETTER KAPPA}"
#ftp_fs.makedir(kappa)
#print repr(ftp_fs.listdir())
#print repr(ftp_fs.listdir())
#ftp_fs.makedir('a/b/c/d', recursive=True)
#print ftp_fs.getsize('/testout.txt')
#print f.read()
#for p in ftp_fs:
# print p
#from fs.utils import print_fs
#print_fs(ftp_fs)
#print ftp_fs.getsize('test.txt')
#from fs.browsewin import browse
#browse(ftp_fs)
|