RSigS ddlZddlZddlZddlZddlmZddlmZ ddlZddl Z n#e $rdxZ ZYnwxYwdgZ dddd d d d d ddddd Z GddZ ejdkre dgz Z Gdde ZdSdS)N)FilesystemError)memoize AbstractedFSJanFebMarAprMayJunJulAugSepOctNovDec) r ceZdZdZdZedZedZejdZejdZe e j dkfdZ d Z d Zd Zd Zd Zd.dZdZdZdZdZdZdZdZdZdZdZee drdZneZee drdZd Z d!Z!d"Z"d#Z#d$Z$d%Z%d&Z&e'd'Z(nd(Z(e)d)Z*nd*Z*d/d,Z+d/d-Z,dS)0raA class used to interact with the file system, providing a cross-platform interface compatible with both Windows and UNIX style filesystems where all paths use "/" separator. AbstractedFS distinguishes between "real" filesystem paths and "virtual" ftp paths emulating a UNIX chroot jail where the user can not escape its home directory (example: real "/home/user" path will be seen as "/" by the client) It also provides some utility methods and wraps around all os.* calls involving operations against the filesystem like creating files or removing directories. FilesystemError exception can be raised from within any of the methods below in order to send a customized error string to the client. c0d|_||_||_dS)z - (str) root: the user "real" home directory (e.g. '/home/user') - (instance) cmd_channel: the FTPHandler class instance. /N)_cwd_root cmd_channelselfrootr#s I/home/jrussi/.local/lib/python3.11/site-packages/pyftpdlib/filesystems.py__init__zAbstractedFS.__init__?s   &c|jS)zThe user home directory.r"r%s r'r&zAbstractedFS.rootMs zr)c|jS)z#The user current working directory.r!r,s r'cwdzAbstractedFS.cwdRs yr)c||_dSNr+r%paths r'r&zAbstractedFS.rootWs  r)c||_dSr1r.r2s r'r/zAbstractedFS.cwd[s  r)ntcr|r|drdStj|S)Nr T) startswithosr3isabs)r3_windowss r'_isabszAbstractedFS._isabsas8  ,, 4w}}T"""r)c||r tj|}nBtjtj|j|}tjdkr|dd}|dddkr|dd}|dddk||sd}|S)amNormalize a "virtual" ftp pathname (typically the raw string coming from client) depending on the current working directory. Example (having "/foo" as current working directory): >>> ftpnorm('bar') '/foo/bar' Note: directory separators are system independent ("/"). Pathname returned is always absolutized. \r Nrz//r)r;r8r3normpathjoinr/sepreplacer%ftppathps r'ftpnormzAbstractedFS.ftpnormks ;;w   B  ))AA  dh!@!@AAA 6T>> $$$Aetmm!""Aetmm {{1~~ Ar)ctj|jtjkr2tj||S||dd}tjtj|j|S)aETranslate a "virtual" ftp pathname (typically the raw string coming from client) into equivalent absolute "real" filesystem pathname. Example (having "/home/user" as root directory): >>> ftp2fs("foo") '/home/user/foo' Note: directory separators are system dependent. rN)r8r3r>r&r@rEr?rBs r'ftp2fszAbstractedFS.ftp2fss 7  DI & &"& 0 07##DLL$9$9:: : W%%abb)A7##BGLLA$>$>?? ?r)c||r tj|}nBtjtj|j|}||sdS|tjd}|t|jd}| dsd|z}|S)a Translate a "real" filesystem pathname into equivalent absolute "virtual" ftp pathname depending on the user's root directory. Example (having "/home/user" as root directory): >>> fs2ftp("/home/user/foo") '/foo' As for ftpnorm, directory separators are system independent ("/") and pathname returned is always absolutized. On invalid pathnames escaping from user's root directory (e.g. "/home" when root is "/home/user") always return "/". r N) r;r8r3r>r?r& validpathrAr@lenr7)r%fspathrDs r'fs2ftpzAbstractedFS.fs2ftps ;;v   B  ((AA  di!@!@AAA~~a   3 IIbfc " " c$)nn ||C   aAr)cN||j}||}|tjs|tjz }|tjs|tjz }|dt ||kS)a/Check whether the path belongs to user's home directory. Expected argument is a "real" filesystem pathname. If path is a symbolic link it is resolved to check its real destination. Pathnames escaping from user's root directory are considered not valid. r)realpathr&endswithr8r@rJ)r%r3r&s r'rIzAbstractedFS.validpaths}}TY''}}T""}}RV$$  BFND}}RV$$  BFNDAD M"d**r)c"t||S)z"Open a file returning its handler.)open)r%filenamemodes r'rQzAbstractedFS.opensHd###r)NwbcGdd}d|v}dt_tj||||\}}tj||} || |S)zA wrap around tempfile.mkstemp creating a file with a unique name. Unlike mkstemp it returns an object with a file-like interface. ceZdZdZdZdS))AbstractedFS.mkstemp..FileWrapperc"||_||_dSr1)filename)r%fdr[s r'r(z2AbstractedFS.mkstemp..FileWrapper.__init__s   r)c,t|j|Sr1)getattrrZ)r%attrs r' __getattr__z5AbstractedFS.mkstemp..FileWrapper.__getattr__sty$///r)N)__name__ __module__ __qualname__r(r`r)r' FileWrapperrXs2 ! ! ! 0 0 0 0 0r)reb2)text)tempfileTMP_MAXmkstempr8fdopen) r%suffixprefixdirrSrerhr\r[rZs r'rkzAbstractedFS.mkstemps}  0 0 0 0 0 0 0 0$#FFCdCCCDyT""{4&&&r)cbtj||||_dS)zvChange the current directory. If this method is overridden it is vital that `cwd` attribute gets set. N)r8chdirrLr/r2s r'rqzAbstractedFS.chdirs( ;;t$$r)c.tj|dS)zCreate the specified directory.N)r8mkdirr2s r'rszAbstractedFS.mkdir r)c*tj|Sz List the content of a directory.r8listdirr2s r'rxzAbstractedFS.listdirz$r)c*tj|Srvrwr2s r' listdirinfozAbstractedFS.listdirinforyr)c.tj|dS)zRemove the specified directory.N)r8rmdirr2s r'r}zAbstractedFS.rmdirrtr)c.tj|dS)zRemove the specified file.N)r8remover2s r'rzAbstractedFS.removes $r)c0tj||dS)z2Rename the specified src file to the dst filename.N)r8rename)r%srcdsts r'rzAbstractedFS.renames #sr)chttdsttj||dS)zChange file/directory mode.chmodN)hasattrr8NotImplementedErrorr)r%r3rSs r'rzAbstractedFS.chmods2r7## &% % tr)c*tj|S)z/Perform a stat() system call on the given path.)r8statr2s r'rzAbstractedFS.stat swt}}r)c0tj|||fS)z)Perform a utime() call on the given path.)r8utime)r%r3timevals r'rzAbstractedFS.utimesxw0111r)lstatc*tj|S)z-Like stat but does not follow symbolic links.)r8rr2s r'rzAbstractedFS.lstats8D>> !r)readlinkc*tj|S)z_Return a string representing the path to which a symbolic link points. )r8rr2s r'rzAbstractedFS.readlink"s;t$$ $r)c@tj|S)zReturn True if path is a file.)r8r3isfiler2s r'rzAbstractedFS.isfile*w~~d###r)c@tj|S)z'Return True if path is a symbolic link.)r8r3islinkr2s r'rzAbstractedFS.islink.rr)c@tj|S)z#Return True if path is a directory.)r8r3isdirr2s r'rzAbstractedFS.isdir2sw}}T"""r)c@tj|S)z/Return the size of the specified file in bytes.)r8r3getsizer2s r'rzAbstractedFS.getsize6swt$$$r)c@tj|S)zMReturn the last modified time as a number of seconds since the epoch.)r8r3getmtimer2s r'rzAbstractedFS.getmtime:sw%%%r)c@tj|S)zReturn the canonical version of path eliminating any symbolic links encountered in the path (if they are supported by the operating system). )r8r3rNr2s r'rNzAbstractedFS.realpath?s w%%%r)c@tj|S)znReturn True if path refers to an existing path, including a broken or circular symbolic link. )r8r3lexistsr2s r'rzAbstractedFS.lexistsFswt$$$r)cZ tj|jS#t$r|cYSwxYw)zReturn the username associated with user id. If this can't be determined return raw uid instead. On Windows just return "owner". )pwdgetpwuidpw_nameKeyErrorr%uids r'get_user_by_uidzAbstractedFS.get_user_by_uidN>  |C((00       **cdS)Nownerrdrs r'rzAbstractedFS.get_user_by_uidZ7r)cZ tj|jS#t$r|cYSwxYw)zReturn the group name associated with group id. If this can't be determined return raw gid instead. On Windows just return "group". )grpgetgrgidgr_namerr%gids r'get_group_by_gidzAbstractedFS.get_group_by_gid_rrcdS)Ngrouprdrs r'rzAbstractedFS.get_group_by_gidkrr)Tc#tKtfd}tfd}jjr tj}n tj}d}t dd}tj} |D]} tj || } | } n#ttf$r|rYOwxYwtj| j} | j}|sd}| j}|| j}|| j}|| j}| | jz |krdnd} t*|jd tj||}nD#t0$r7|}t*|jd tjd|}YnwxYw| jd ztjk}|r/|- | d z|| z} n#ttf$r|sYnwxYw| d |d d |d d |d d |dd |d | d}|jjjjVdS)axReturn an iterator object that yields the entries of given directory emulating the "/bin/ls -lA" UNIX command output. - (str) basedir: the absolute dirname. - (list) listing: the names of the entries in basedir - (bool) ignore_err: when False raise exception if os.lstat() call fails. On platforms which do not support the pwd and grp modules (such as Windows), ownership is printed as "owner" and "group" as a default, and number of hard links is always "1". On UNIX systems, the actual owner, group, and number of links are printed. This is how output appears to client: -rw-rw-rw- 1 owner group 7045120 Sep 02 3:47 music.mp3 drwxrwxrwx 1 owner group 0 Aug 31 18:50 e-books -rw-rw-rw- 1 owner group 380 Sep 02 3:40 module.py c.|Sr1)r)rr%s r'rz1AbstractedFS.format_list..get_user_by_uids'',, ,r)c.|Sr1)r)rr%s r'rz2AbstractedFS.format_list..get_group_by_gids((-- -r)iNrNrz%d %Yz%d %H:%M z -> z>38z>8 )rr# use_gmt_timestimegmtime localtimer^r8r3r?rOSErrorrrfilemodest_modest_nlinkst_sizest_uidst_gidst_mtime _months_maptm_monstrftime ValueErrorS_IFLNKencodeencodingunicode_errors)r%basedirlisting ignore_errrrtimefunc SIX_MONTHSrnowbasenamerZstpermsnlinkssizeunamegnamemtimefmtstrmtimestrrlines` r' format_listzAbstractedFS.format_listps,  - - - -  -  . . . .  .   ) &{HH~H' 4T22ikk; ; H7<<22D ZZ%%_-   H  M"*--E[F :D#OBI..E$$RY//EHR[))E"%r{!2Z!?!?XXZF  ---M&%000   !  ---M*e444  j5(T\9F (.'&088D>>AHH1% D++ )4+;+J    s; ; s6B//CC7*E"">F#"F#GG,+G,c# K|jjr tj}n tj}dd|D}dd|D}d|vsd|vsd|vr|dz }d|vr|d z }d |v} d |v} d |v} d |v} d|v} d|v}d|v}d|v}d|v}|D]}it j||} ||}n#ttf$r|rYQwxYw|j dztj k}|r'| r|dkrdd <n|dkrdd <ndd <| r|d <n| rdd <| r|d <| r |j d <| r8 tjd||jd <n#t $rYnwxYw| r8 tjd||jd<n#t $rYnwxYw|rt%|j dzd<|r |jd<|r |jd<|r|jdd|jdd<dfdt/D}|d|d }||jj|jjVd!S)"aYReturn an iterator object that yields the entries of a given directory or of a single file in a form suitable with MLSD and MLST commands. Every entry includes a list of "facts" referring the listed element. See RFC-3659, chapter 7, to see what every single fact stands for. - (str) basedir: the absolute dirname. - (list) listing: the names of the entries in basedir - (str) perms: the string referencing the user permissions. - (str) facts: the list of "facts" to be returned. - (bool) ignore_err: when False raise exception if os.stat() call fails. Note that "facts" returned may change depending on the platform and on what user specified by using the OPTS command. This is how output could appear to the client issuing a MLSD request: type=file;size=156;perm=r;modify=20071029155301;unique=8012; music.mp3 type=dir;size=0;perm=el;modify=20071127230206;unique=801e33; ebooks type=file;size=211;perm=r;modify=20071103093626;unique=192; module.py rTcg|]}|dv| S)arwrd.0xs r' z,AbstractedFS.format_mlsx..s>>>q~~1~~~r)cg|]}|dv| S)celmprdrs r'rz,AbstractedFS.format_mlsx..s"AAA!0@0@A0@0@0@r)wafcdrDtypepermrmodifycreatez unix.modezunix.uidzunix.giduniquer.cdirz..pdirrorZz %Y%m%d%H%M%Sirgc,g|]}|d|dS)=;rd)rrretfactss r'rz,AbstractedFS.format_mlsx..Fs.HHH1A&& &&&HHHr)rrN)r#rrrrr?r8r3rrrrS_IFDIRrrrrst_ctimeoctrrst_devst_inosortedkeysrrr)r%rrrfactsrrpermdirpermfile show_type show_perm show_size show_modify show_create show_modeshow_uidshow_gid show_uniquerrZrr factstringrrs @r' format_mlsxzAbstractedFS.format_mlsxs4   ) &{HH~H''>>e>>>??77AAuAAABB 5LLcUllu sNG %<< sNGeO eO eO %' %' 5( &&%' L L HH7<<22D YYt___-   H  Z%'DL8E 013+1((!T))+1((+0(/'.HV$.'-HV$0'/HV$ .#%:  )-&(=(=**HX&& "D )-&(=(=**HX&&"D >(+BJ,<(=(=% 1')y$ 1')y$ D(* %C%C%Cbi%C%C%C"HHHHx}}0G0GHHHJ!118111D++ )4+;+J    UL L s6 C##C:8C:&F FF&F<< G G )rTrTNrU)T)-rarbrc__doc__r(propertyr&r/setter staticmethodr8r[r;rErGrLrIrQrkrqrsrxr{r}rrrrrrrrrrrrrrNrrrrrrrrdr)r'rr,s$ ' ' 'XX [[ ZZ  go###\#>@@@$6+++($$$''''0%%%       222 wr7 " " " " wr:% % % %$$$$$$###%%%&&& &&&%%%                  ````Dyyyyyyr)posixUnixFilesystemc*eZdZdZdZdZdZdZdS)rzRepresents the real UNIX filesystem. Differently from AbstractedFS the client will login into /home/ and will be able to escape its home directory and navigate the real filesystem. cLt|||||_dSr1)rr(r/r$s r'r(zUnixFilesystem.__init__]s%  ! !$k : : :DHHHr)c,||Sr1)rE)r%rCs r'rGzUnixFilesystem.ftp2fsbs<<(( (r)c|Sr1rd)r%rKs r'rLzUnixFilesystem.fs2ftpesMr)cdS)NTrdr2s r'rIzUnixFilesystem.validpathhs 4r)N)rarbrcrr(rGrLrIrdr)r'rrUsZ       ) ) )        r))r8rrir exceptionsrutilsrrr ImportError__all__rrr[rrdr)r'r!sW   ''''''JJJJJJJC###                 *________L7g  !!Gs ' 33