RSiVdZddlZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddl m Z ddl mZddl mZdd l mZdd l mZdd lmZd d gZdejvZGdd e ZGddeZGdd eZejdkr6 ddlZejedgz ZGddeZdS#e$rYdSwxYwdS)aq This module contains the main FTPServer class which listens on a host:port and dispatches the incoming connections to a handler. The concurrency is handled asynchronously by the main process thread, meaning the handler cannot block otherwise the whole server will hang. Other than that we have 2 subclasses changing the asynchronous concurrency model using multiple threads or processes. You might be interested in these in case your code contains blocking parts which cannot be adapted to the base async model or if the underlying filesystem is particularly slow, see: https://github.com/giampaolo/pyftpdlib/issues/197 https://github.com/giampaolo/pyftpdlib/issues/212 Two classes are provided: - ThreadingFTPServer - MultiprocessFTPServer ...spawning a new thread or process every time a client connects. The main thread will be async-based and be used only to accept new connections. Every time a new connection comes in that will be dispatched to a separate thread/process which internally will run its own IO loop. This way the handler handling that connections will be free to block without hanging the whole FTP server. N)Acceptor)PREFIX) PREFIX_MPROC)config_logging)debug)is_logging_configured)logger)fork_processes FTPServerThreadedFTPServerbsdcteZdZdZdZdZddZdZdZe d Z d Z d Z dd Z ddZdZdZdZdS)r aCreates a socket listening on
, dispatching the requests to a (typically FTPHandler class). Depending on the type of address specified IPv4 or IPv6 connections (or both, depending from the underlying system) will be accepted. All relevant session information is stored in class attributes described below. - (int) max_cons: number of maximum simultaneous connections accepted (defaults to 512). Can be set to 0 for unlimited but it is recommended to always have a limit to avoid running out of file descriptors (DoS). - (int) max_cons_per_ip: number of maximum connections accepted for the same IP address (defaults to 0 == unlimited). irNdctj||||_||_g|_t |dr|tt|ddr-|}| d| |n| || |dS)aoCreates a socket listening on 'address' dispatching connections to a 'handler'. - (tuple) address_or_socket: the (host, port) pair on which the command channel will listen for incoming connections or an existent socket object. - (instance) handler: the handler class to use. - (instance) ioloop: a pyftpdlib.ioloop.IOLoop instance - (int) backlog: the maximum number of queued connections passed to listen(). If a connection request arrives when the queue is full the client may raise ECONNRESET. Defaults to 5. ioloopget_ssl_contextlistenNr) r__init__handlerbacklogip_maphasattrrcallablegetattr setblocking set_socketbind_af_unspecifiedr)selfaddress_or_socketrrrsocks E/home/jrussi/.local/lib/python3.11/site-packages/pyftpdlib/servers.pyrzFTPServer.__init__Ws" $v....    7- . . &  # # % % % G-x>> ? ? 8$D   Q    OOD ! ! ! !  $ $%6 7 7 7 Gc|SNr s r# __enter__zFTPServer.__enter__xs r$c.|dSr&) close_all)r argss r#__exit__zFTPServer.__exit__{s r$cD|jddS)z>The address this server is listening on as a (ip, port) tuple.N)socket getsocknamer(s r#addresszFTPServer.address~s!{&&((!,,r$c4t|jjSr&)lenr socket_mapr(s r#_map_lenzFTPServer._map_lens4;)***r$cN|jsdS||jkS)z?Return True if the server is willing to accept new connections.T)max_consr6r(s r#_accept_new_conszFTPServer._accept_new_conss&} 44==??dm3 3r$Fcd}tst|rtnt|jjr(|jjdd|jjd}nd}|rdnd}dt vr t|jtr|d z }nNd t vr t|jtr|d z }n%t|jtr|d z }n|d z }tj d|ztj d|jjtj d|tjd||jtjd||jjt$jdkrtjd|jjtjd||jtjd|jpdtjd|jpdtjd|jjpdtjd|jjtjd|jjt5|jddrtjd|jjt5|jddr!tjd|jjdSdS) Nc |jdz|jjzS#t$r7 |jdz|jzcYS#t$rt |cYcYSwxYwwxYw)N.) __module__ __class____name__AttributeErrorstr)objs r# get_fqnamez(FTPServer._log_start..get_fqnames $~+cm.DDD! $ $ $$>C/#,>>>>%$$$s88OOOOO$ $s) A8AAAAA)prefixrz->z prefork + r z multi-threadMultiprocessFTPServerz multi-processasynczunknown (custom class)zconcurrency model: zmasquerade (NAT) address: %szpassive ports: %sz poller: %rzauthorizer: %rposixzuse sendfile(): %sz handler: %rzmax connections: %s unlimitedzmax connections per ip: %sz timeout: %sz banner: %rzmax login attempts: %rcertfilezSSL certfile: %rkeyfilezSSL keyfile: %r)r rrrr passive_ports__all__ issubclassr>r rGr r infomasquerade_addressrr authorizerosname use_sendfiler8max_cons_per_iptimeoutbannermax_login_attemptsrrKrL)r preforkrC pasv_portsmodels r# _log_startzFTPServer._log_starts $ $ $%&& G '"E,,v F F F F < %  *1--- *2..JJ J '/ R ' ) )j N-/ / ) ^ #EE $ / /J N15 5 / _ $EE  2 2 . W EE - -E )E1222 *DL,K     '444 \::dk#:#:;;; %zz$,2I'J'JKKK 7g   L-t|/H I I I ]JJt|$<$<=== *DM,H[III ($*>*M+     ]DL$8$GKHHH \4<#6777 -t|/NOOO 4<T 2 2 D L+T\-B C C C 4<D 1 1 B L*DL,@ A A A A A B Br$Trc|o|}|dkrItjdkr9|std|r|dt |n|r|t |jdrdnd}tjd ||j d |j dtj fz|r |j ||n+#ttf$rtjd YnwxYw|rQ|r9tjd tj ||d Sd S|j ||d S)aStart serving. - (float) timeout: the timeout passed to the underlying IO loop expressed in seconds. - (bool) blocking: if False loop once and then return the timeout of the next scheduled call next to expire soonest (if any). - (bool) handle_exit: when True catches KeyboardInterrupt and SystemExit exceptions (generally caused by SIGTERM / SIGINT signals) and gracefully exits after cleaning up resources. Also, logs server start and stop. - (int) worker_processes: pre-fork a certain number of child processes before starting. Each child process will keep using a 1-thread, async concurrency model, handling multiple concurrent connections. If the number is None or <= 0 the number of usable cores available on this machine is detected and used. It is a good idea to use this option in case the app risks blocking for too long on a single function call (e.g. hard-disk is slow, long DB query on auth etc.). By splitting the work load over multiple processes the delay introduced by a blocking function call is amortized and divided by the number of worker processes. rrIz8'worker_processes' and 'blocking' are mutually exclusiveT)rZ ssl_protocolzFTPS (FTP over SSL)FTPz+>>> starting %s server on %s:%s, pid=%i <<>> shutting down FTP server, pid=%i, %s open socket(s) <<C49C C4C1-C40C11C44AE+<%E+*E+c #t$r(tjtjYnwxYw|dS)z)Called to handle any uncaught exceptions.N)rsr rurvrwrxr(s r#rtzFTPServer.handle_error=sU 1  1 1 1 L-// 0 0 0 0 0 1 s /55c4|jS)zSStop serving and also disconnects all currently connected clients. )rrxr(s r#r+zFTPServer.close_allEs{  """r$Nr)F)NTTr)r?r= __qualname____doc__r8rVrr)r-propertyr2r6r9r]rkr|rtr+r'r$r#r r ?s(HOB--X-+++4448B8B8B8BvOPD0D0D0D0L.'.'.'`#####r$cheZdZdZdZdZdZdZddZdZ dZ dZ d Z d Z d ZddZdZdZdZdS) _SpawnerBasez[Base class shared by multiple threads/process dispatcher. Not supposed to be used. Nrct|||||g|_|j|j|j|j|_dS)N)rr)_errback) r r _active_tasksr call_everyrefresh_interval_refresh_tasksrt_active_tasks_idler)r r!rrrs r#rz_SpawnerBase.__init__^sl #WVW     #';#9#9  !  &$:$ $    r$c td)Nzmust be implemented in subclass)NotImplementedErrorr r,kwargss r# _start_taskz_SpawnerBase._start_taskis!"CDDDr$ct|j|jkr|t|jSr&)r4rr8rr(s r#r6z_SpawnerBase._map_lenls? t! " "dm 3 3    ! ! !4%&&&r$cP|jrtjdt|jd|j5g}|jD]A}|s||,||B||_ddddS#1swxYwYdSdS)zhjoin() terminated tasks and update internal _tasks list. This gets called every X secs. zrefreshing tasks (z join() potentials)N)rr rr4_lockis_alive _join_taskrn)r newts r#rz_SpawnerBase._refresh_tasksus   ) LS);%<%<    ) )+&&A::<<&**** 1 %(" ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) ) )sABB Bc |j5}||_ |nI#t$r<}|jtjkr!t d|Yd}~ddddSd}~wwxYw|j}|jj}t|dd}|}|j s |jj r|j s |j r |||jj rY|}|j sG|j|}|r"tjt#|dnd}|r |||kr|}n#t$t&f$r|j Ynt$r}t*jdkr|jdkrt1|j D]e} t5j|gggd#t$r= t7jd |j ||j |=n#t:$rYnwxYwYbwxYwnYd}~nd}~wwxYw|j s |jj r|j ddddS#1swxYwYdS) z8Serve handler's IO loop in a separate thread or process.z.call: %s._loop(); add_channel() returned EBADFN poll_timeout)rWrnti6'rzdiscarding broken socket %r)rfactory add_channelOSErrorerrnoEBADFrpollschedrr5_tasks_exitis_set reheapifytimesleepminrdresetrSrTwinerrorlistkeysselectr rPKeyError) r rrerrr sched_pollrsoonest_timeoutfds r#_loopz_SpawnerBase._loops [ " "J ;f#GN ##%%%%   9 ++H$FFFJ ;J ;J ;J ;J ;J ;J ;J ; ;D*J"4>>L*O!5 ;%+\%85 ;j''))5 ;2;(6_5555|*/*4*,, &0D"L22444.8jllO.D $ 3+B+B C C C*.2$;+3.==.:O;*:6%%%JNN$$$$$w$3<5+@+@"&v'8'='='?'?"@"@ ) )B ) & rdBA > > > >#* ) ) )!)$*K(E(.(9"(=%&%&%&)/(9"(=(='/!)!)!)$(D!) ) ) ) ) ) ) ) 7!5 ;%+\%85 ;j''))5 ;+J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;J ;sJ8J A>%A9'J8A99A>>AJA:E J*IJ IAIG/.I/ H6 :(H#"H6 # H0 -H6 /H0 0H6 3I5H6 6I;JI0JJ Jct|||}||j|j||j|fd}t||_| t|dr| |j 5|j |ddddS#1swxYwYdSdS)Nftpd)targetr,rTpid)r r|r unregister_filenorrreprrTstartrrxrrrn)r r"rzrrs r#r|z_SpawnerBase.handle_accepteds&++D$==   K " "7? 3 3 3  z !A$ZZAF GGIIIq%     - -"))!,,, - - - - - - - - - - - - - - - - - -  s/CCCc:t|dSr&)r r]r(s r#r]z_SpawnerBase._log_startsT"""""r$?Tc|j|r|o|}|r| |j||n#t t f$rYnwxYw|r?|r'tjd| | dSdS|j||dS)Nz4>>> shutting down FTP server (%s active workers) <<<) rclearr]rrcrdrer rPr6r+)r rWrfrgris r#rkz_SpawnerBase.serve_forevers   0*(C "!!!    (3333%z2     !KN       ! ! K  Wh / / / / /sAA'&A'ct|drltjd| ts|dSt j|jtj dS#t$rYdSwxYwdS)N terminatezterminate()ing task ) rr r_BSDrrSkillrsignalSIGKILLProcessLookupErrorr rs r#_terminate_taskz_SpawnerBase._terminate_tasks 1k " "  L555 6 6 6 3KKMMMMM GAE6>22222%      sA,$A,, A:9A:ctjd|||j|rtjd||jdSdS)Nzjoin()ing task z$task %r remained alive after %r secs)r rjoin join_timeoutrwarningrs r#rz_SpawnerBase._join_tasksr ,q,,--- t !!! ::<<  N64;L       r$cl|j|j|j5|jD]}|||jD]}|||jdd=dddn #1swxYwYt |dSr&) rcancelrrrrrrr r+rs r#r+z_SpawnerBase.close_alls  '')))  Z & &' ( ($$Q''''' # #"""""111%  & & & & & & & & & & & & & & & D!!!!!sA BBBr)rTT)r?r=rrrrrrrrr6rrr|r]rkrrr+r'r$r#rrQs L E E     EEE''')))&L;L;L;\---*###0000(    " " " " "r$rcXeZdZdZdZejZejZ dZ dS)r zuA modified version of base FTPServer class which spawns a thread every time a new connection is established. rc$tj|i|Sr&) threadingThreadrs r#rzThreadedFTPServer._start_task3s0000r$N) r?r=rrrrLockrEventrrr'r$r#r r (sR L IN  E IO  E11111r$rIrGceZdZdZejZejZej dkrej dZ nej Z dZ dS)rGzA modified version of base FTPServer class which spawns a process every time a new connection is established. forkserverfork)methodc&|jj|i|Sr&) _mp_contextProcessrs r#rz!MultiprocessFTPServer._start_taskQs/t'/@@@@r$N) r?r=rrmultiprocessingrrrrget_start_method get_contextrrr'r$r#rGrGBs  )O(**E)O)++E0/11\AA9o9HHH 9o9;;  A A A A Ar$)rrrSrrsysrrrvrrrirrrrr r rZr rNplatformrr rr rTrrrGrsr'r$r#rsB >  &&&&&&###### + ,  J#J#J#J#J#J#J#J#dT"T"T"T"T"9T"T"T"n 1 1 1 1 1 1 1 17gA +,, A A A A AL A A A A A      sB??CC