O|bdZddlZddlZddlZddlZddlZddlZddlZddl Zddl Zddl Zddl Zddl ZddlZddlZdgZej"j$rGddej&Zn ej&ZGddZy)z] `FTPHost` is the central class of the `ftputil` library. See `__init__.py` for an example. NFTPHostceZdZfdZxZS)default_session_factorycfd|vrtjj|d<t||i|y)Nencoding)ftputil path_encodingDEFAULT_ENCODINGsuper__init__)selfargskwargs __class__s ,lib/python3.12/site-packages/ftputil/host.pyr z default_session_factory.__init__,s5 '%,%:%:%K%Kz" G d -f -)__name__ __module__ __qualname__r __classcell__)rs@rrr+s  . .rrcheZdZdZdZdZdZdZdZ d+ddd Z d Z d Z e d Z d ZdZdZdZe ej&j(dfdZdZd,dZd,dZdZd,dZd,dZdZd-dZdZdZd,dZ d.dZ!dZ"dZ#e#Z$d/d Z%d!Z&d"Z'd#Z(d0d$Z)d0d%Z*d1d&Z+d'Z,d(Z-d)Z.d*Z/y)2rz FTP host class. c||_||_|j|_tj j ||_tjj||_ |jj|_ |jjtjj5|jj}|j j!tj"j%||j&|_dddg|_d|_d|_d\|_|_|_d|_d|_y#1swYBxYw)z> Abstract initialization of `FTPHost` object. rNF).z../)_args_kwargs _make_session_sessionrpath_Pathstat_Stat_stat _lstat_cache stat_cacheenableerrorftplib_error_to_ftp_os_errorpwdnormpathtool as_str_path _encoding_cached_current_dir _children_fileclosedcurdirpardirsep _time_shiftuse_list_a_option)r rr current_dirs rr zFTPHost.__init__Vs   **, LL&&t, \\''- **11  ]] 7 7 --++-K'+yy'9'9 ((t~~(N(D $    .<* T[$("'-  s ;A$E  E)ctjj5|jj dddy#1swYyxYw)aX Try to keep the connection alive in order to avoid server timeouts. Note that this won't help if the connection has already timed out! In this case, `keep_alive` will raise an `TemporaryError`. (Actually, if you get a server timeout, the error - for a specific connection - will be permanent.) N)rr)r*r r+r s r keep_alivezFTPHost.keep_alives6]] 7 7 MM      s ?Act|jdd}|jj}|jdt}t j j5||i|}t|ds#t j jd|d|j|_ ddd|S#1swYSxYw)zp Return a new session object according to the current state of this `FTPHost` instance. Nsession_factoryrzsession instance z" must have an `encoding` attribute) rrcopypoprrr)r*hasattrNoEncodingErrorrr/)r rrfactorysessions rrzFTPHost._make_sessions zz!}""$**.0GH ]] 7 7 .t.v.G7J/mm33'{2TU%--DN  . .s A B--B7cN|j|ji|jS)z9 Return a copy of this `FTPHost` object. )rrrr;s r_copyz FTPHost._copys" t~~tzz:T\\::rc|jD]7}|jjs |jj |cSy#t j $rYPt j$rYdt$rYnt$rYxwxYw)z Return an available (i. e. one whose `_file` object is closed and doesn't have a timed-out server connection) child (`FTPHost` object) from the pool of children or `None` if there aren't any. N) r1r2r3r r+ftplib error_reply error_tempEOFErrorOSErrorr hosts r_available_childzFTPHost._available_childsNN! Dzz   MM%%'0 KC! F)))((  s#ABB1B;BBN)restc Ftjj||j}|j }|O|j }|j j|tjj||_ |j} |jj|r|} n|jj| |} |jj| \} } |j!| |jj+| ||||||d|vr|j,j/| |jS#tj"j$$r/tj"j'dj)| wxYw)a Return an open file(-like) object which is associated with this `FTPHost` object. The arguments `path`, `mode`, `buffering`, `encoding`, `errors` and `newlines` have the same meaning as for `open`. If `rest` is given as an integer, - reading will start at the byte (zero-based) `rest` - writing will overwrite the remote file from byte `rest` This method tries to reuse a child but will generate a new one if none is available. rzEremote directory '{}' doesn't exist or has insufficient access rights)mode bufferingrerrorsnewlinerPw)rr-r.r/rOrFr1appendfileFTPFiler2getcwdr!isabsjoinsplitchdirr)PermanentError FTPIOErrorformat_openr' invalidate) r r!rRrSrrTrUrPrNbasedireffective_path effective_direffective_files ropenz FTPHost.opens[6||''t~~'F$$& <:: 1 dayzFtime shift ({0:.2f} s) deviates more than {1:d} s from 15-minute unitsN)rs_FTPHost__rounded_time_shiftrr)TimeShiftErrorrart)r rurvhourrymaximum_deviations r__assert_valid_time_shiftz!FTPHost.__assert_valid_time_shiftjs f}&)$*C*CJ*O&P# 'd 2--..3:::F  J zD55jAA BEV V--..''-vj#>O:P'Q  Wrc|j||j}||k7r1|jj|j ||_yy)a\ Set the time shift value. By (my) definition, the time shift value is the difference of the time zone used in server listings and UTC, i. e. time_shift =def= t_server - utc <=> t_server = utc + time_shift <=> utc = t_server - time_shift The time shift is measured in seconds. N)!_FTPHost__assert_valid_time_shiftrur'rkr~r7)r ruold_time_shifts rset_time_shiftzFTPHost.set_time_shiftsP &&z2*  ' OO ! ! ##88DD  (rc|jS)z Return the time shift between FTP server and client. See the docstring of `set_time_shift` for more on this value. )r7r;s rruzFTPHost.time_shifts rcd} |j|d}|j |jj|}|j|tj}||z }|dkrktjj|tjj }|j#|j$dz}|j'|z }|j)|y #tjj$r=tjj dj |jwxYw#tjj$r tjj dwxYw) ai Synchronize the local times of FTP client and server. This is necessary to let `upload_if_newer` and `download_if_newer` work correctly. If `synchronize_times` isn't applicable (see below), the time shift can still be set explicitly with `set_time_shift`. This implementation of `synchronize_times` requires _all_ of the following: - The connection between server and client is established. - The client has write access to the directory that is current when `synchronize_times` is called. The common usage pattern of `synchronize_times` is to call it directly after the connection is established. (As can be concluded from the points above, this requires write access to the login directory.) If `synchronize_times` fails, it raises a `TimeShiftError`. _ftputil_sync_rVz,couldn't write helper file in directory '{}'z)could write helper file but not unlink itid%)tz)yearN)rhrjrr)r`rrarZr!getmtimeunlink FTPOSErrortimedatetime fromtimestamptimezoneutcreplacer timestampr)r helper_file_namefile_ server_timenowruserver_datetimes rsynchronize_timeszFTPHost.synchronize_timess_(, II.4E KKM )),,-=>K KK( )iik 3& + +'//== 1 1 5 5>O.55?;O;ORS;S5TO(224s:J J'G}}'' --..BII$++-X  }}'' --..;  s"C.,E .AE =FcHtjj||||y)zX Copy data from file-like object `source` to file-like object `target`. N)r file_transfer copyfileobj)sourcetargetmax_chunk_sizecallbacks rrzFTPHost.copyfileobjs ))&&.(Srctjj|d}tjj||d}||fS)z Return a `LocalFile` and `RemoteFile` as source and target, respectively. The strings `source_path` and `target_path` are the (absolute or relative) paths of the local and the remote file, respectively. rbwb)rr LocalFile RemoteFiler source_path target_path source_file target_files r _upload_fileszFTPHost._upload_filessA++55k4H ++66t[$O K''rc*|dvr tdtjj|dtjj ||j }|j ||\}}tjj||d|y) a Upload a file from the local source (name) to the remote target (name). If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. rpath argument `source` is emptyrpath_argument_namerF conditionalrN) IOErrorrr-raise_for_empty_pathr.r/rr copy_filer rrrrrs ruploadzFTPHost.uploads Y ;< < ))&X)N))&4>>)J#'#5#5ff#E ['' %( ( rc(tjj|d|dvr tdtjj ||j }|j ||\}}tjj||d|S)a7 Upload a file only if it's newer than the target on the remote host or if the target file does not exist. See the method `upload` for the meaning of the parameters. If an upload was necessary, return `True`, else return `False`. If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. rrrpath argument `target` is emptyrTr) rr-rrr.r/rrrrs rupload_if_newerzFTPHost.upload_if_newers  ))&X)N Y ;< <))&4>>)J#'#5#5ff#E [$$.. $/  rctjj||d}tjj|d}||fS)z Return a `RemoteFile` and `LocalFile` as source and target, respectively. The strings `source_path` and `target_path` are the (absolute or relative) paths of the remote and the local file, respectively. rr)rrrrrs r_download_fileszFTPHost._download_files(sA++66t[$O ++55k4H K''rc*tjj|d|dvr tdtjj ||j }|j ||\}}tjj||d|y) a Download a file from the remote source (name) to the local target (name). If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. rrrrrFrN) rr-rrr.r/rrrrs rdownloadzFTPHost.download4s  ))&X)N Y ;< <))&4>>)J#'#7#7#G ['' %( ( rc(|dvr tdtjj|dtjj ||j }|j ||\}}tjj||d|S)a; Download a file only if it's newer than the target on the local host or if the target file does not exist. See the method `download` for the meaning of the parameters. If a download was necessary, return `True`, else return `False`. If a callable `callback` is given, it's called after every chunk of transferred data. The chunk size is a constant defined in `file_transfer`. The callback will be called with a single argument, the data chunk that was transferred before the callback was called. rrrrrTr) rrr-rr.r/rrrrs rdownload_if_newerzFTPHost.download_if_newerGs Y ;< < ))&X)N))&4>>)J#'#7#7#G [$$.. $/  rc|j} |j|y#tjj$r/tjj dj |wxYw)z Raise an `InaccessibleLoginDirError` exception if we can't change to the login directory. This test is only reliable if the current directory is the login directory. z directory '{}' is not accessibleN)rZr^rr)r_InaccessibleLoginDirErrorra)r presumable_login_dirs r#_check_inaccessible_login_directoryz+FTPHost._check_inaccessible_login_directory`sa ${{}  JJ+ ,}}++ --99299:NO  s $A A0c\|j|j} |r+|j|||d|j|S|jj |\}}|j|||||j|S#|j|wxYw)a Run an FTP command on a path. The return value of the method is the return value of the command. If `descend_deeply` is true (the default is false), descend deeply, i. e. change the directory to the end of the path. r)rrZr^r!r])r commandr!descend_deeplyold_dirheadtails r_robust_ftp_commandzFTPHost._robust_ftp_commandps 002++-  4 tR( JJw  "YY__T2 d 4 tT* JJw DJJw sB7BB+c|jS)z4 Return the current directory path. )r0r;s rrZzFTPHost.getcwds'''rcvtjj||j}tjj 5|j j|ddd|jj|jj|j||_ y#1swYNxYw)z= Change the directory on the host to `path`. rN) rr-r.r/r)r*r cwdr!r,r\r0r r!s rr^z FTPHost.chdirs||''t~~'F ]] 7 7 $ MM  d # $$(99#5#5 IINN433T :$   $ $s B//B8ctjj|tjj||j}d}|j ||y)z Make the directory path on the remote host. The argument `mode` is ignored and only "supported" for similarity with `os.mkdir`. rctjj5|jj |dddy#1swYyxYwCallback function.N)rr)r*r mkdrs rrzFTPHost.mkdir..command6;; ( !!$' ( ( ( AA N)rr-rr.r/rr r!rRrs rmkdirz FTPHost.mkdirsJ  ))$/||''t~~'F (   $/rctjj|tjj||j}|j j |}|j|j}|j} tdt|D]}|j|j j|d|dzz} |j||t|dz k(sS|rVtjjdj!|}t"j$|_| |j|y#tjj$rV |j'|n?#tjj$r|j j)|sYnwxYwY!wxYw#|j|wxYw)at Make the directory `path`, but also make not yet existing intermediate directories, like `os.makedirs`. The value of `mode` is only accepted for compatibility with `os.makedirs` but otherwise ignored. If `exist_ok` is `False` (the default) and the leaf directory exists, raise a `PermanentError` with `errno` 17. rrNzpath {!r} exists)rr-rr.r/r!abspathr]r6rZrangelenr\r^r)r_raerrnoEEXISTrisdir) r r!rRexist_ok directoriesrindexnext_directory ftp_os_errors rmakedirszFTPHost.makedirss  ))$/||''t~~'Fyy  &jj* ++-$ q#k"23 +!%NDIINNK %RS)2"==77" $yy~>! ? " "2 JJw sbAG E(G :G =AG G 4FG 9G?G GG G G  G Gctjj|tjj||j}|j j |}|j|r.tjjdj|d} |j|||jj|y#|jj|wxYw)a  Remove the _empty_ directory `path` on the remote host. Compatibility note: Previous versions of ftputil could possibly delete non-empty directories as well, - if the server allowed it. This is no longer supported. rzdirectory '{}' not emptyctjj5|jj |dddy#1swYyxYwr)rr)r*r rmdrs rrzFTPHost.rmdir..commandrrN)rr-rr.r/r!rlistdirr)r_rarr'rcr r!rs rrmdirz FTPHost.rmdirs  ))$/||''t~~'Fyy  & << --../I/P/PQU/VW W ( -  $ $Wd 3 OO & &t ,DOO & &t ,s )CC4cPtjj|tjj||j}|j j |}|j j|s6|j j|s|j j|s2d} |j|||jj|ytjjd#|jj|wxYw)z Remove the file or link given by `path`. Raise a `PermanentError` if the path doesn't exist, but maybe raise other exceptions depending on the state of the server (e. g. timeout). rctjj5|jj |dddy#1swYyxYwr)rr)r*r deleters rrzFTPHost.remove..command(s6]]??/MM((.///rz>remove/unlink can only delete files and links, not directoriesN)rr-rr.r/r!risfileislinkexistsrr'rcr)r_rs rremovezFTPHost.removes  ))$/||''t~~'Fyy  & II  T "yy%99##D) / 1(($7**40--..S **40s ;DD%ctjj|tjj||j}|rd}n|d}n|}g} |j |}|D]u}|jj||} |j|j}tj|r|j!|||d |j#|w |j%|y#tj j$r)||j |tjYwxYw#tj j$rd}YwxYw#tj j$r*||j"|tjY?wxYw#tj j&$r)||j$|tjYywxYw)a Remove the given remote, possibly non-empty, directory tree. The interface of this method is rather complex, in favor of compatibility with `shutil.rmtree`. If `ignore_errors` is set to a true value, errors are ignored. If `ignore_errors` is a false value _and_ `onerror` isn't set, all exceptions occurring during the tree iteration and processing are raised. These exceptions are all of type `PermanentError`. To distinguish between error situations, pass in a callable for `onerror`. This callable must accept three arguments: `func`, `path` and `exc_info`. `func` is a bound method object, _for example_ `your_host_object.listdir`. `path` is the path that was the recent argument of the respective method (`listdir`, `remove`, `rmdir`). `exc_info` is the exception info as it's got from `sys.exc_info`. Implementation note: The code is copied from `shutil.rmtree` in Python 2.4 and adapted to ftputil. rcy)z Do nothing.Nrs r new_onerrorz#FTPHost.rmtree..new_onerrorVsrNc)zRe-raise exception.rrs rrz#FTPHost.rmtree..new_onerror]srr)rr-rr.r/rr)r_sysexc_infor!r\lstatst_moder#S_ISDIRrmtreerrr) r r! ignore_errorsonerrorrnamesname full_namerRs rrzFTPHost.rmtree;s*  ))$/||''t~~'F   _  "K <LL&E HD tT2I zz),44||D! I}kBHKK * H : JJt !}}++ <  dCLLN ; < ==//  }}33H Y GH}}'' :  D#,,. 9 :sKC:EE((F2:AE?EE%$E%(AF/.F/2AG87G8ctjj|dtjj|dtjj|j}tjj|j}j j |\}}j j |\}}fd}jd|vxsd|v}|rB||k(r=j} j||||j| y|||y#j| wxYw)zB Rename the `source` on the FTP host to `target`. rrrrcX tjj5jj ||dddj j |}j j |}jj|jj|y#1swYvxYw#j j |}j j |}jj|jj|wxYwN) rr)r*r renamer!rr'rc) source_arg target_argsource_absolute_pathtarget_absolute_pathr s rrename_with_cleanupz+FTPHost.rename..rename_with_cleanups A]]??AMM((Z@A (,yy'8'8'D$'+yy'8'8'D$**+?@**+?@AA (,yy'8'8'D$'+yy'8'8'D$**+?@**+?@s"B;B/B;/B84B;;A.D) N) rr-rr.r/r!r]rrZr^) r rr source_head source_tail target_head target_tailrpaths_contain_whitespacers ` rr zFTPHost.rename{s  ))&X)N ))&X)N))&4>>)J))&4>>)J#'99??6#: [#'99??6#: [ A 002$';$6#OC;._FTPHost_dir_command..callbacks' W\\000OPrz-aN)rr)r*r8r dir)r r!rrs` @r_FTPHost_dir_commandz*FTPHost._dir.._FTPHost_dir_commandsnE Q;; 6))MM%%dD(;MM%%dH5  6 L  6 Ls AA66BT)r)r)r r!rrs r_dirz FTPHost._dirs, (( $t)  rcLtjj||}tjj||j}|j j |}|Dcgc]-}tjj|||j/c}Scc}w)z Return a list of directories, files etc. in the directory named `path`. If the directory listing from the server can't be parsed with any of the available parsers raise a `ParserError`. r)rr-rr.r/r%_listdirsame_string_type_as)r r! original_pathitemsitems rrzFTPHost.listdirs  ))$/ ||''t~~'F ##D)  LL , ,]D$.. Q   s,2B!ctjj|tjj||j}|j j ||S)a Return an object similar to that returned by `os.lstat`. If the directory listing from the server can't be parsed with any of the available parsers, raise a `ParserError`. If the directory _can_ be parsed and the `path` is _not_ found, raise a `PermanentError`. (`_exception_for_missing_path` is an implementation aid and _not_ intended for use by ftputil clients.) r)rr-rr.r/r%_lstatr r!_exception_for_missing_paths rrz FTPHost.lstatsK  ))$/||''t~~'Fzz  'BCCrctjj|tjj||j}|j j ||S)a Return info from a "stat" call on `path`. If the directory containing `path` can't be parsed, raise a `ParserError`. If the directory containing `path` can be parsed but the `path` can't be found, raise a `PermanentError`. Also raise a `PermanentError` if there's an endless (cyclic) chain of symbolic links "behind" the `path`. (`_exception_for_missing_path` is an implementation aid and _not_ intended for use by ftputil clients.) r)rr-rr.r/r%r(s rr#z FTPHost.statsK  ))$/||''t~~'Fzz&ABBrc#Ktjj|dtjj||j} |j |}gg}}|D]Z} |jj|jj|| r|j| J|j| \|r|||f|D]X} |jj|| } |s|jj| r=|j| |||Ed{Z|s|||fyy#tj j$r}|||Yd}~yd}~wwxYw7Ew)z Iterate over directory tree and return a tuple (dirpath, dirnames, filenames) on each iteration, like the `os.walk` function (see https://docs.python.org/library/os.html#os.walk ). toprrN)rr-rr.r/rr)rr!rr\rWrwalk) r r,topdownr followlinksrerrdirsnondirsrr!s rr-z FTPHost.walksL  ))#%)Hll&&sT^^&D LL%E Bg %Dyytyy~~c489 D!t$  % tW$ $ JD99>>#t,D$))"2"24"899T7G[III JtW$ $!}}'' "  JsCA E+D5!B*E+ E+#E)$E+5E& E!E+!E&&E+c4tjj|tjj||j}|j j |}fd}|j|||jj|y)a Change the mode of a remote `path` (a string) to the integer `mode`. This integer uses the same bits as the mode value returned by the `stat` and `lstat` commands. If something goes wrong, raise a `TemporaryError` or a `PermanentError`, according to the status code returned by the server. In particular, a non-existent path usually causes a `PermanentError`. rctjj5|jj dj |dddy#1swYyxYw)rzSITE CHMOD 0{0:o} {1}N)rr)r*r voidcmdra)r r!rRs rrzFTPHost.chmod..command(sI;; R %%&=&D&DT4&PQ R R Rs ,AAN) rr-rr.r/r!rrr'rcrs ` rchmodz FTPHost.chmodsr  ))$/||''t~~'Fyy  & R   $/ ""4(rctd)Nzcannot serialize FTPHost object) TypeErrorr;s r __getstate__zFTPHost.__getstate__0s9::rc|Sr rr;s r __enter__zFTPHost.__enter__6s  rc$|jyNF)rj)r exc_typeexc_valexc_tbs r__exit__zFTPHost.__exit__;s r)rNNNNr )Fr=)FN)T)TNF)0rrr__doc__r r<rrFrOrhrjrp staticmethodr~rrrurrrMAX_COPY_CHUNK_SIZErrrrrrrrrrZr^rrrrrrr rrrr#r-r6r9r;rArrrrr>s-.''R  $*;-d??B43<44&0E, >(P,,@@ T T ( $ , ( & 2 " N(   0,4 l-:"HF>:@*0`@ DC"%>),;  r)rCrrrHr#rr ftputil.errorr ftputil.fileftputil.file_transfer ftputil.pathftputil.path_encodingftputil.session ftputil.stat ftputil.tool__all__r RUNNING_UNDER_PY39_AND_UPFTPrrrrrrQsx    + 22 .&** .%jjBBr