PNG  IHDRX cHRMz&u0`:pQ<bKGD pHYsodtIME MeqIDATxw]Wug^Qd˶ 6`!N:!@xI~)%7%@Bh&`lnjVF29gΨ4E$|>cɚ{gk= %,a KX%,a KX%,a KX%,a KX%,a KX%,a KX%, b` ǟzeאfp]<!SJmɤY޲ڿ,%c ~ع9VH.!Ͳz&QynֺTkRR.BLHi٪:l;@(!MԴ=žI,:o&N'Kù\vRmJ雵֫AWic H@" !: Cé||]k-Ha oݜ:y F())u]aG7*JV@J415p=sZH!=!DRʯvɱh~V\}v/GKY$n]"X"}t@ xS76^[bw4dsce)2dU0 CkMa-U5tvLƀ~mlMwfGE/-]7XAƟ`׮g ewxwC4\[~7@O-Q( a*XGƒ{ ՟}$_y3tĐƤatgvێi|K=uVyrŲlLӪuܿzwk$m87k( `múcE)"@rK( z4$D; 2kW=Xb$V[Ru819קR~qloѱDyįݎ*mxw]y5e4K@ЃI0A D@"BDk_)N\8͜9dz"fK0zɿvM /.:2O{ Nb=M=7>??Zuo32 DLD@D| &+֎C #B8ַ`bOb $D#ͮҪtx]%`ES`Ru[=¾!@Od37LJ0!OIR4m]GZRJu$‡c=%~s@6SKy?CeIh:[vR@Lh | (BhAMy=݃  G"'wzn޺~8ԽSh ~T*A:xR[ܹ?X[uKL_=fDȊ؂p0}7=D$Ekq!/t.*2ʼnDbŞ}DijYaȲ(""6HA;:LzxQ‘(SQQ}*PL*fc\s `/d'QXW, e`#kPGZuŞuO{{wm[&NBTiiI0bukcA9<4@SӊH*؎4U/'2U5.(9JuDfrޱtycU%j(:RUbArLֺN)udA':uGQN"-"Is.*+k@ `Ojs@yU/ H:l;@yyTn}_yw!VkRJ4P)~y#)r,D =ě"Q]ci'%HI4ZL0"MJy 8A{ aN<8D"1#IJi >XjX֔#@>-{vN!8tRݻ^)N_╗FJEk]CT՟ YP:_|H1@ CBk]yKYp|og?*dGvzنzӴzjֺNkC~AbZƷ`.H)=!QͷVTT(| u78y֮}|[8-Vjp%2JPk[}ԉaH8Wpqhwr:vWª<}l77_~{s۴V+RCģ%WRZ\AqHifɤL36: #F:p]Bq/z{0CU6ݳEv_^k7'>sq*+kH%a`0ԣisqにtү04gVgW΂iJiS'3w.w}l6MC2uԯ|>JF5`fV5m`Y**Db1FKNttu]4ccsQNnex/87+}xaUW9y>ͯ骵G{䩓Գ3+vU}~jJ.NFRD7<aJDB1#ҳgSb,+CS?/ VG J?|?,2#M9}B)MiE+G`-wo߫V`fio(}S^4e~V4bHOYb"b#E)dda:'?}׮4繏`{7Z"uny-?ǹ;0MKx{:_pÚmFמ:F " .LFQLG)Q8qN q¯¯3wOvxDb\. BKD9_NN &L:4D{mm o^tֽ:q!ƥ}K+<"m78N< ywsard5+вz~mnG)=}lYݧNj'QJS{S :UYS-952?&O-:W}(!6Mk4+>A>j+i|<<|;ر^߉=HE|V#F)Emm#}/"y GII웻Jі94+v뾧xu~5C95~ūH>c@덉pʃ1/4-A2G%7>m;–Y,cyyaln" ?ƻ!ʪ<{~h~i y.zZB̃/,雋SiC/JFMmBH&&FAbϓO^tubbb_hZ{_QZ-sύodFgO(6]TJA˯#`۶ɟ( %$&+V'~hiYy>922 Wp74Zkq+Ovn錄c>8~GqܲcWꂎz@"1A.}T)uiW4="jJ2W7mU/N0gcqܗOO}?9/wìXžΏ0 >֩(V^Rh32!Hj5`;O28؇2#ݕf3 ?sJd8NJ@7O0 b־?lldщ̡&|9C.8RTWwxWy46ah嘦mh٤&l zCy!PY?: CJyв]dm4ǜҐR޻RլhX{FƯanшQI@x' ao(kUUuxW_Ñ줮[w8 FRJ(8˼)_mQ _!RJhm=!cVmm ?sFOnll6Qk}alY}; "baӌ~M0w,Ggw2W:G/k2%R,_=u`WU R.9T"v,<\Ik޽/2110Ӿxc0gyC&Ny޽JҢrV6N ``یeA16"J³+Rj*;BϜkZPJaÍ<Jyw:NP8/D$ 011z֊Ⱳ3ι֘k1V_"h!JPIΣ'ɜ* aEAd:ݺ>y<}Lp&PlRfTb1]o .2EW\ͮ]38؋rTJsǏP@芎sF\> P^+dYJLbJ C-xϐn> ι$nj,;Ǖa FU *择|h ~izť3ᤓ`K'-f tL7JK+vf2)V'-sFuB4i+m+@My=O҈0"|Yxoj,3]:cо3 $#uŘ%Y"y죯LebqtҢVzq¼X)~>4L׶m~[1_k?kxֺQ`\ |ٛY4Ѯr!)N9{56(iNq}O()Em]=F&u?$HypWUeB\k]JɩSع9 Zqg4ZĊo oMcjZBU]B\TUd34ݝ~:7ڶSUsB0Z3srx 7`:5xcx !qZA!;%͚7&P H<WL!džOb5kF)xor^aujƍ7 Ǡ8/p^(L>ὴ-B,{ۇWzֺ^k]3\EE@7>lYBȝR.oHnXO/}sB|.i@ɥDB4tcm,@ӣgdtJ!lH$_vN166L__'Z)y&kH;:,Y7=J 9cG) V\hjiE;gya~%ks_nC~Er er)muuMg2;֫R)Md) ,¶ 2-wr#F7<-BBn~_(o=KO㭇[Xv eN_SMgSҐ BS헃D%g_N:/pe -wkG*9yYSZS.9cREL !k}<4_Xs#FmҶ:7R$i,fi!~' # !6/S6y@kZkZcX)%5V4P]VGYq%H1!;e1MV<!ϐHO021Dp= HMs~~a)ަu7G^];git!Frl]H/L$=AeUvZE4P\.,xi {-~p?2b#amXAHq)MWǾI_r`S Hz&|{ +ʖ_= (YS(_g0a03M`I&'9vl?MM+m~}*xT۲(fY*V4x@29s{DaY"toGNTO+xCAO~4Ϳ;p`Ѫ:>Ҵ7K 3}+0 387x\)a"/E>qpWB=1 ¨"MP(\xp߫́A3+J] n[ʼnӼaTbZUWb={~2ooKױӰp(CS\S筐R*JغV&&"FA}J>G֐p1ٸbk7 ŘH$JoN <8s^yk_[;gy-;߉DV{c B yce% aJhDȶ 2IdйIB/^n0tNtџdcKj4϶v~- CBcgqx9= PJ) dMsjpYB] GD4RDWX +h{y`,3ꊕ$`zj*N^TP4L:Iz9~6s) Ga:?y*J~?OrMwP\](21sZUD ?ܟQ5Q%ggW6QdO+\@ ̪X'GxN @'4=ˋ+*VwN ne_|(/BDfj5(Dq<*tNt1х!MV.C0 32b#?n0pzj#!38}޴o1KovCJ`8ŗ_"]] rDUy޲@ Ȗ-;xџ'^Y`zEd?0„ DAL18IS]VGq\4o !swV7ˣι%4FѮ~}6)OgS[~Q vcYbL!wG3 7띸*E Pql8=jT\꘿I(z<[6OrR8ºC~ډ]=rNl[g|v TMTղb-o}OrP^Q]<98S¤!k)G(Vkwyqyr޽Nv`N/e p/~NAOk \I:G6]4+K;j$R:Mi #*[AȚT,ʰ,;N{HZTGMoּy) ]%dHء9Պ䠬|<45,\=[bƟ8QXeB3- &dҩ^{>/86bXmZ]]yޚN[(WAHL$YAgDKp=5GHjU&99v簪C0vygln*P)9^͞}lMuiH!̍#DoRBn9l@ xA/_v=ȺT{7Yt2N"4!YN`ae >Q<XMydEB`VU}u]嫇.%e^ánE87Mu\t`cP=AD/G)sI"@MP;)]%fH9'FNsj1pVhY&9=0pfuJ&gޤx+k:!r˭wkl03׼Ku C &ѓYt{.O.zҏ z}/tf_wEp2gvX)GN#I ݭ߽v/ .& и(ZF{e"=V!{zW`, ]+LGz"(UJp|j( #V4, 8B 0 9OkRrlɱl94)'VH9=9W|>PS['G(*I1==C<5"Pg+x'K5EMd؞Af8lG ?D FtoB[je?{k3zQ vZ;%Ɠ,]E>KZ+T/ EJxOZ1i #T<@ I}q9/t'zi(EMqw`mYkU6;[t4DPeckeM;H}_g pMww}k6#H㶏+b8雡Sxp)&C $@'b,fPߑt$RbJ'vznuS ~8='72_`{q纶|Q)Xk}cPz9p7O:'|G~8wx(a 0QCko|0ASD>Ip=4Q, d|F8RcU"/KM opKle M3#i0c%<7׿p&pZq[TR"BpqauIp$ 8~Ĩ!8Սx\ւdT>>Z40ks7 z2IQ}ItԀ<-%S⍤};zIb$I 5K}Q͙D8UguWE$Jh )cu4N tZl+[]M4k8֦Zeq֮M7uIqG 1==tLtR,ƜSrHYt&QP윯Lg' I,3@P'}'R˪e/%-Auv·ñ\> vDJzlӾNv5:|K/Jb6KI9)Zh*ZAi`?S {aiVDԲuy5W7pWeQJk֤#5&V<̺@/GH?^τZL|IJNvI:'P=Ϛt"¨=cud S Q.Ki0 !cJy;LJR;G{BJy޺[^8fK6)=yʊ+(k|&xQ2`L?Ȓ2@Mf 0C`6-%pKpm')c$׻K5[J*U[/#hH!6acB JA _|uMvDyk y)6OPYjœ50VT K}cǻP[ $:]4MEA.y)|B)cf-A?(e|lɉ#P9V)[9t.EiQPDѠ3ϴ;E:+Օ t ȥ~|_N2,ZJLt4! %ա]u {+=p.GhNcŞQI?Nd'yeh n7zi1DB)1S | S#ًZs2|Ɛy$F SxeX{7Vl.Src3E℃Q>b6G ўYCmtկ~=K0f(=LrAS GN'ɹ9<\!a`)֕y[uՍ[09` 9 +57ts6}b4{oqd+J5fa/,97J#6yν99mRWxJyѡyu_TJc`~W>l^q#Ts#2"nD1%fS)FU w{ܯ R{ ˎ󅃏џDsZSQS;LV;7 Od1&1n$ N /.q3~eNɪ]E#oM~}v֯FڦwyZ=<<>Xo稯lfMFV6p02|*=tV!c~]fa5Y^Q_WN|Vs 0ҘދU97OI'N2'8N֭fgg-}V%y]U4 峧p*91#9U kCac_AFңĪy뚇Y_AiuYyTTYЗ-(!JFLt›17uTozc. S;7A&&<ԋ5y;Ro+:' *eYJkWR[@F %SHWP 72k4 qLd'J "zB6{AC0ƁA6U.'F3:Ȅ(9ΜL;D]m8ڥ9}dU "v!;*13Rg^fJyShyy5auA?ɩGHRjo^]׽S)Fm\toy 4WQS@mE#%5ʈfFYDX ~D5Ϡ9tE9So_aU4?Ѽm%&c{n>.KW1Tlb}:j uGi(JgcYj0qn+>) %\!4{LaJso d||u//P_y7iRJ߬nHOy) l+@$($VFIQ9%EeKʈU. ia&FY̒mZ=)+qqoQn >L!qCiDB;Y<%} OgBxB!ØuG)WG9y(Ą{_yesuZmZZey'Wg#C~1Cev@0D $a@˲(.._GimA:uyw֬%;@!JkQVM_Ow:P.s\)ot- ˹"`B,e CRtaEUP<0'}r3[>?G8xU~Nqu;Wm8\RIkբ^5@k+5(By'L&'gBJ3ݶ!/㮻w҅ yqPWUg<e"Qy*167΃sJ\oz]T*UQ<\FԎ`HaNmڜ6DysCask8wP8y9``GJ9lF\G g's Nn͵MLN֪u$| /|7=]O)6s !ĴAKh]q_ap $HH'\1jB^s\|- W1:=6lJBqjY^LsPk""`]w)󭃈,(HC ?䔨Y$Sʣ{4Z+0NvQkhol6C.婧/u]FwiVjZka&%6\F*Ny#8O,22+|Db~d ~Çwc N:FuuCe&oZ(l;@ee-+Wn`44AMK➝2BRՈt7g*1gph9N) *"TF*R(#'88pm=}X]u[i7bEc|\~EMn}P瘊J)K.0i1M6=7'_\kaZ(Th{K*GJyytw"IO-PWJk)..axӝ47"89Cc7ĐBiZx 7m!fy|ϿF9CbȩV 9V-՛^pV̌ɄS#Bv4-@]Vxt-Z, &ֺ*diؠ2^VXbs֔Ìl.jQ]Y[47gj=幽ex)A0ip׳ W2[ᎇhuE^~q흙L} #-b۸oFJ_QP3r6jr+"nfzRJTUqoaۍ /$d8Mx'ݓ= OՃ| )$2mcM*cЙj}f };n YG w0Ia!1Q.oYfr]DyISaP}"dIӗթO67jqR ҊƐƈaɤGG|h;t]䗖oSv|iZqX)oalv;۩meEJ\!8=$4QU4Xo&VEĊ YS^E#d,yX_> ۘ-e\ "Wa6uLĜZi`aD9.% w~mB(02G[6y.773a7 /=o7D)$Z 66 $bY^\CuP. (x'"J60׿Y:Oi;F{w佩b+\Yi`TDWa~|VH)8q/=9!g߆2Y)?ND)%?Ǐ`k/sn:;O299yB=a[Ng 3˲N}vLNy;*?x?~L&=xyӴ~}q{qE*IQ^^ͧvü{Huu=R|>JyUlZV, B~/YF!Y\u_ݼF{_C)LD]m {H 0ihhadd nUkf3oٺCvE\)QJi+֥@tDJkB$1!Đr0XQ|q?d2) Ӣ_}qv-< FŊ߫%roppVBwü~JidY4:}L6M7f٬F "?71<2#?Jyy4뷢<_a7_=Q E=S1И/9{+93֮E{ǂw{))?maÆm(uLE#lïZ  ~d];+]h j?!|$F}*"4(v'8s<ŏUkm7^7no1w2ؗ}TrͿEk>p'8OB7d7R(A 9.*Mi^ͳ; eeUwS+C)uO@ =Sy]` }l8^ZzRXj[^iUɺ$tj))<sbDJfg=Pk_{xaKo1:-uyG0M ԃ\0Lvuy'ȱc2Ji AdyVgVh!{]/&}}ċJ#%d !+87<;qN޼Nفl|1N:8ya  8}k¾+-$4FiZYÔXk*I&'@iI99)HSh4+2G:tGhS^繿 Kتm0 вDk}֚+QT4;sC}rՅE,8CX-e~>G&'9xpW,%Fh,Ry56Y–hW-(v_,? ; qrBk4-V7HQ;ˇ^Gv1JVV%,ik;D_W!))+BoS4QsTM;gt+ndS-~:11Sgv!0qRVh!"Ȋ(̦Yl.]PQWgٳE'`%W1{ndΗBk|Ž7ʒR~,lnoa&:ü$ 3<a[CBݮwt"o\ePJ=Hz"_c^Z.#ˆ*x z̝grY]tdkP*:97YľXyBkD4N.C_[;F9`8& !AMO c `@BA& Ost\-\NX+Xp < !bj3C&QL+*&kAQ=04}cC!9~820G'PC9xa!w&bo_1 Sw"ܱ V )Yl3+ס2KoXOx]"`^WOy :3GO0g;%Yv㐫(R/r (s } u B &FeYZh0y> =2<Ϟc/ -u= c&׭,.0"g"7 6T!vl#sc>{u/Oh Bᾈ)۴74]x7 gMӒ"d]U)}" v4co[ ɡs 5Gg=XR14?5A}D "b{0$L .\4y{_fe:kVS\\O]c^W52LSBDM! C3Dhr̦RtArx4&agaN3Cf<Ԉp4~ B'"1@.b_/xQ} _߃҉/gٓ2Qkqp0շpZ2fԫYz< 4L.Cyυι1t@鎫Fe sYfsF}^ V}N<_`p)alٶ "(XEAVZ<)2},:Ir*#m_YӼ R%a||EƼIJ,,+f"96r/}0jE/)s)cjW#w'Sʯ5<66lj$a~3Kʛy 2:cZ:Yh))+a߭K::N,Q F'qB]={.]h85C9cr=}*rk?vwV렵ٸW Rs%}rNAkDv|uFLBkWY YkX מ|)1!$#3%y?pF<@<Rr0}: }\J [5FRxY<9"SQdE(Q*Qʻ)q1E0B_O24[U'],lOb ]~WjHޏTQ5Syu wq)xnw8~)c 쫬gٲߠ H% k5dƝk> kEj,0% b"vi2Wس_CuK)K{n|>t{P1򨾜j>'kEkƗBg*H%'_aY6Bn!TL&ɌOb{c`'d^{t\i^[uɐ[}q0lM˕G:‚4kb祔c^:?bpg… +37stH:0}en6x˟%/<]BL&* 5&fK9Mq)/iyqtA%kUe[ڛKN]Ě^,"`/ s[EQQm?|XJ߅92m]G.E΃ח U*Cn.j_)Tѧj̿30ڇ!A0=͜ar I3$C^-9#|pk!)?7.x9 @OO;WƝZBFU keZ75F6Tc6"ZȚs2y/1 ʵ:u4xa`C>6Rb/Yм)^=+~uRd`/|_8xbB0?Ft||Z\##|K 0>>zxv8۴吅q 8ĥ)"6>~\8:qM}#͚'ĉ#p\׶ l#bA?)|g g9|8jP(cr,BwV (WliVxxᡁ@0Okn;ɥh$_ckCgriv}>=wGzβ KkBɛ[˪ !J)h&k2%07δt}!d<9;I&0wV/ v 0<H}L&8ob%Hi|޶o&h1L|u֦y~󛱢8fٲUsւ)0oiFx2}X[zVYr_;N(w]_4B@OanC?gĦx>мgx>ΛToZoOMp>40>V Oy V9iq!4 LN,ˢu{jsz]|"R޻&'ƚ{53ўFu(<٪9:΋]B;)B>1::8;~)Yt|0(pw2N%&X,URBK)3\zz&}ax4;ǟ(tLNg{N|Ǽ\G#C9g$^\}p?556]/RP.90 k,U8/u776s ʪ_01چ|\N 0VV*3H鴃J7iI!wG_^ypl}r*jɤSR 5QN@ iZ#1ٰy;_\3\BQQ x:WJv츟ٯ$"@6 S#qe딇(/P( Dy~TOϻ<4:-+F`0||;Xl-"uw$Цi󼕝mKʩorz"mϺ$F:~E'ҐvD\y?Rr8_He@ e~O,T.(ފR*cY^m|cVR[8 JҡSm!ΆԨb)RHG{?MpqrmN>߶Y)\p,d#xۆWY*,l6]v0h15M˙MS8+EdI='LBJIH7_9{Caз*Lq,dt >+~ّeʏ?xԕ4bBAŚjﵫ!'\Ը$WNvKO}ӽmSşذqsOy?\[,d@'73'j%kOe`1.g2"e =YIzS2|zŐƄa\U,dP;jhhhaxǶ?КZ՚.q SE+XrbOu%\GتX(H,N^~]JyEZQKceTQ]VGYqnah;y$cQahT&QPZ*iZ8UQQM.qo/T\7X"u?Mttl2Xq(IoW{R^ ux*SYJ! 4S.Jy~ BROS[V|žKNɛP(L6V^|cR7i7nZW1Fd@ Ara{詑|(T*dN]Ko?s=@ |_EvF]׍kR)eBJc" MUUbY6`~V޴dJKß&~'d3i WWWWWW
Current Directory: /opt/saltstack/salt/lib/python3.10/site-packages/salt/utils
Viewing File: /opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/vt.py
""" :codeauthor: Pedro Algarvio (pedro@algarvio.me) salt.utils.vt ~~~~~~~~~~~~~ Virtual Terminal This code has been heavily inspired by Python's subprocess code, the `non blocking version of it`__, some minor online snippets about TTY handling with python including `Python's own ``pty`` source code`__ and `Pexpect`__ which has already surpassed some of the pitfalls that some systems would get us into. .. __: http://code.activestate.com/recipes/440554/ .. __: https://github.com/python/cpython/blob/3.3/Lib/pty.py .. __: https://github.com/pexpect/pexpect """ import errno import functools import logging import os import select import signal import subprocess import sys import time import salt.utils.crypt import salt.utils.data import salt.utils.stringutils from salt._logging import LOG_LEVELS mswindows = sys.platform == "win32" try: # pylint: disable=F0401,W0611 import msvcrt import win32api import win32con import win32process from win32file import ReadFile, WriteFile from win32pipe import PeekNamedPipe # pylint: enable=F0401,W0611 except ImportError: import fcntl import pty import struct import termios log = logging.getLogger(__name__) class TerminalException(Exception): """ Terminal specific exception """ def setwinsize(child, rows=80, cols=80): """ This sets the terminal window size of the child tty. This will cause a SIGWINCH signal to be sent to the child. This does not change the physical window size. It changes the size reported to TTY-aware applications like vi or curses -- applications that respond to the SIGWINCH signal. Thank you for the shortcut PEXPECT """ # pylint: disable=used-before-assignment TIOCSWINSZ = getattr(termios, "TIOCSWINSZ", -2146929561) if TIOCSWINSZ == 2148037735: # Same bits, but with sign. TIOCSWINSZ = -2146929561 # Note, assume ws_xpixel and ws_ypixel are zero. packed = struct.pack(b"HHHH", rows, cols, 0, 0) fcntl.ioctl(child, TIOCSWINSZ, packed) def getwinsize(child): """ This returns the terminal window size of the child tty. The return value is a tuple of (rows, cols). Thank you for the shortcut PEXPECT """ TIOCGWINSZ = getattr(termios, "TIOCGWINSZ", 1074295912) packed = struct.pack(b"HHHH", 0, 0, 0, 0) ioctl = fcntl.ioctl(child, TIOCGWINSZ, packed) return struct.unpack(b"HHHH", ioctl)[0:2] class Terminal: """ I'm a virtual terminal """ def __init__( self, args=None, executable=None, shell=False, cwd=None, env=None, preexec_fn=None, # Terminal Size rows=None, cols=None, # Logging options log_stdin=None, log_stdin_level="debug", log_stdout=None, log_stdout_level="debug", log_stderr=None, log_stderr_level="debug", log_sanitize=None, # sys.stdXYZ streaming options stream_stdout=None, stream_stderr=None, # Used for tests force_receive_encoding=__salt_system_encoding__, ): if not args and not executable: raise TerminalException( 'You need to pass at least one of "args", "executable" ' ) self.args = args self.executable = executable self.shell = shell self.cwd = cwd self.env = env self.preexec_fn = preexec_fn self.receive_encoding = force_receive_encoding if rows is None and cols is None: rows, cols = self.__detect_parent_terminal_size() elif rows is not None and cols is None: _, cols = self.__detect_parent_terminal_size() elif rows is None and cols is not None: rows, _ = self.__detect_parent_terminal_size() self.rows = rows self.cols = cols self.pid = None self.stdin = None self.stdout = None self.stderr = None self.child_fd = None self.child_fde = None self.partial_data_stdout = b"" self.partial_data_stderr = b"" self.closed = True self.flag_eof_stdout = False self.flag_eof_stderr = False self.terminated = True self.exitstatus = None self.signalstatus = None # status returned by os.waitpid self.status = None if stream_stdout is True: self.stream_stdout = sys.stdout elif stream_stdout is False: self.stream_stdout = None elif stream_stdout is not None: if ( not hasattr(stream_stdout, "write") or not hasattr(stream_stdout, "flush") or not hasattr(stream_stdout, "close") ): raise TerminalException( "'stream_stdout' needs to have at least 3 methods, " "'write()', 'flush()' and 'close()'." ) self.stream_stdout = stream_stdout else: raise TerminalException( "Don't know how to handle '{}' as the VT's " "'stream_stdout' parameter.".format(stream_stdout) ) if stream_stderr is True: self.stream_stderr = sys.stderr elif stream_stderr is False: self.stream_stderr = None elif stream_stderr is not None: if ( not hasattr(stream_stderr, "write") or not hasattr(stream_stderr, "flush") or not hasattr(stream_stderr, "close") ): raise TerminalException( "'stream_stderr' needs to have at least 3 methods, " "'write()', 'flush()' and 'close()'." ) self.stream_stderr = stream_stderr else: raise TerminalException( "Don't know how to handle '{}' as the VT's " "'stream_stderr' parameter.".format(stream_stderr) ) try: self._spawn() except Exception as err: # pylint: disable=W0703 # A lot can go wrong, so that's why we're catching the most general # exception type log.warning( "Failed to spawn the VT: %s", err, exc_info_on_loglevel=logging.DEBUG ) raise TerminalException(f"Failed to spawn the VT. Error: {err}") log.debug( "Child Forked! PID: %s STDOUT_FD: %s STDERR_FD: %s", self.pid, self.child_fd, self.child_fde, ) if log_sanitize: if not isinstance(log_sanitize, str): raise RuntimeError("'log_sanitize' needs to be a str type") self.log_sanitize = log_sanitize else: self.log_sanitize = None terminal_command = " ".join(self.args) if self.log_sanitize: terminal_command = terminal_command.replace(self.log_sanitize, ("*" * 6)) if ( 'decode("base64")' in terminal_command or "base64.b64decode(" in terminal_command ): log.debug("VT: Salt-SSH SHIM Terminal Command executed. Logged to TRACE") log.trace("Terminal Command: %s", terminal_command) else: log.debug("Terminal Command: %s", terminal_command) # Setup logging after spawned in order to have a pid value self.stdin_logger_level = LOG_LEVELS.get(log_stdin_level, log_stdin_level) if log_stdin is True: self.stdin_logger = logging.getLogger( f"{__name__}.{self.__class__.__name__}.PID-{self.pid}.STDIN" ) elif log_stdin is not None: if not isinstance(log_stdin, logging.Logger): raise RuntimeError("'log_stdin' needs to subclass `logging.Logger`") self.stdin_logger = log_stdin else: self.stdin_logger = None self.stdout_logger_level = LOG_LEVELS.get(log_stdout_level, log_stdout_level) if log_stdout is True: self.stdout_logger = logging.getLogger( "{}.{}.PID-{}.STDOUT".format( __name__, self.__class__.__name__, self.pid ) ) elif log_stdout is not None: if not isinstance(log_stdout, logging.Logger): raise RuntimeError("'log_stdout' needs to subclass `logging.Logger`") self.stdout_logger = log_stdout else: self.stdout_logger = None self.stderr_logger_level = LOG_LEVELS.get(log_stderr_level, log_stderr_level) if log_stderr is True: self.stderr_logger = logging.getLogger( "{}.{}.PID-{}.STDERR".format( __name__, self.__class__.__name__, self.pid ) ) elif log_stderr is not None: if not isinstance(log_stderr, logging.Logger): raise RuntimeError("'log_stderr' needs to subclass `logging.Logger`") self.stderr_logger = log_stderr else: self.stderr_logger = None def send(self, data): """ Send data to the terminal. You are responsible to send any required line feeds. """ return self._send(data) def sendline(self, data, linesep=os.linesep): """ Send the provided data to the terminal appending a line feed. """ return self.send(f"{data}{linesep}") def recv(self, maxsize=None): """ Receive data from the terminal as a (``stdout``, ``stderr``) tuple. If any of those is ``None`` we can no longer communicate with the terminal's child process. """ if maxsize is None: maxsize = 1024 elif maxsize < 1: maxsize = 1 return self._recv(maxsize) def close(self, terminate=True, kill=False): """ Close the communication with the terminal's child. If ``terminate`` is ``True`` then additionally try to terminate the terminal, and if ``kill`` is also ``True``, kill the terminal if terminating it was not enough. """ if not self.closed: if self.child_fd is not None: os.close(self.child_fd) self.child_fd = None if self.child_fde is not None: os.close(self.child_fde) self.child_fde = None time.sleep(0.1) if terminate: if not self.terminate(kill): raise TerminalException("Failed to terminate child process.") self.closed = True @property def has_unread_data(self): return self.flag_eof_stderr is False or self.flag_eof_stdout is False def _translate_newlines(self, data): if data is None or not data: return # PTY's always return \r\n as the line feeds return data.replace("\r\n", os.linesep) def __enter__(self): return self def __exit__(self, exc_type, exc_value, traceback): self.close(terminate=True, kill=True) # Wait for the process to terminate, to avoid zombies. if self.isalive(): self.wait() if mswindows: def _execute(self): raise NotImplementedError def _spawn(self): raise NotImplementedError def _recv(self, maxsize): raise NotImplementedError def _send(self, data): raise NotImplementedError def send_signal(self, sig): """ Send a signal to the process """ # pylint: disable=E1101 if sig == signal.SIGTERM: self.terminate() elif sig == signal.CTRL_C_EVENT: os.kill(self.pid, signal.CTRL_C_EVENT) elif sig == signal.CTRL_BREAK_EVENT: os.kill(self.pid, signal.CTRL_BREAK_EVENT) else: raise ValueError(f"Unsupported signal: {sig}") # pylint: enable=E1101 def terminate(self, force=False): """ Terminates the process """ try: win32api.TerminateProcess(self._handle, 1) except OSError: # ERROR_ACCESS_DENIED (winerror 5) is received when the # process already died. ecode = win32process.GetExitCodeProcess(self._handle) if ecode == win32con.STILL_ACTIVE: raise self.exitstatus = ecode kill = terminate else: def _spawn(self): if not isinstance(self.args, str) and self.shell is True: self.args = " ".join(self.args) parent, child = pty.openpty() # pylint: disable=used-before-assignment err_parent, err_child = os.pipe() child_name = os.ttyname(child) proc = subprocess.Popen( # pylint: disable=subprocess-popen-preexec-fn self.args, preexec_fn=functools.partial( self._preexec, child_name, self.rows, self.cols, self.preexec_fn ), shell=self.shell, # nosec executable=self.executable, cwd=self.cwd, stdin=child, stdout=child, stderr=err_child, env=self.env, close_fds=True, ) os.close(child) os.close(err_child) self.child_fd = parent self.child_fde = err_parent self.pid = proc.pid self.proc = proc self.closed = False self.terminated = False @staticmethod def _preexec(child_name, rows=80, cols=80, preexec_fn=None): # Disconnect from controlling tty. Harmless if not already # connected try: tty_fd = os.open("/dev/tty", os.O_RDWR | os.O_NOCTTY) if tty_fd >= 0: os.close(tty_fd) # which exception, shouldn't we catch explicitly .. ? except Exception: # pylint: disable=broad-except # Already disconnected. This happens if running inside cron pass try: os.setsid() except OSError: pass try: tty_fd = os.open("/dev/tty", os.O_RDWR | os.O_NOCTTY) if tty_fd >= 0: os.close(tty_fd) raise TerminalException(f"Could not open child pty, {child_name}") # which exception, shouldn't we catch explicitly .. ? except Exception: # pylint: disable=broad-except # Good! We are disconnected from a controlling tty. pass tty_fd = os.open(child_name, os.O_RDWR) setwinsize(tty_fd, rows, cols) if tty_fd < 0: raise TerminalException(f"Could not open child pty, {child_name}") else: os.close(tty_fd) if os.name != "posix": tty_fd = os.open("/dev/tty", os.O_WRONLY) if tty_fd < 0: raise TerminalException("Could not open controlling tty, /dev/tty") else: os.close(tty_fd) if preexec_fn is not None: preexec_fn() def _send(self, data): if self.child_fd is None: return None if not select.select([], [self.child_fd], [], 0)[1]: return 0 try: if self.stdin_logger: self.stdin_logger.log(self.stdin_logger_level, data) written = os.write(self.child_fd, data.encode(__salt_system_encoding__)) except OSError as why: if why.errno == errno.EPIPE: # broken pipe os.close(self.child_fd) self.child_fd = None return raise return written def _recv(self, maxsize): rfds = [] if self.child_fd: rfds.append(self.child_fd) if self.child_fde: rfds.append(self.child_fde) if not self.isalive(): if not rfds: self.close() return None, None rlist, _, _ = select.select(rfds, [], [], 0) if not rlist: self.flag_eof_stdout = self.flag_eof_stderr = True log.debug("End of file(EOL). Brain-dead platform.") if self.partial_data_stdout or self.partial_data_stderr: # There is data that was received but for which # decoding failed, attempt decoding again to generate # relevant exception self.close() return ( salt.utils.stringutils.to_unicode(self.partial_data_stdout), salt.utils.stringutils.to_unicode(self.partial_data_stderr), ) self.close() return None, None stderr = "" stdout = "" if self.child_fd: fd_flags = fcntl.fcntl(self.child_fd, fcntl.F_GETFL) if self.child_fde: fde_flags = fcntl.fcntl(self.child_fde, fcntl.F_GETFL) if self.child_fd: fcntl.fcntl(self.child_fd, fcntl.F_SETFL, fd_flags | os.O_NONBLOCK) if self.child_fde: fcntl.fcntl(self.child_fde, fcntl.F_SETFL, fde_flags | os.O_NONBLOCK) rlist, _, _ = select.select(rfds, [], [], 0) if not rlist: if not self.isalive(): self.flag_eof_stdout = self.flag_eof_stderr = True log.debug("End of file(EOL). Very slow platform.") return None, None def read_and_decode_fd(fd, maxsize, partial_data_attr=None): bytes_read = getattr(self, partial_data_attr, b"") # Only read one byte if we already have some existing data # to try and complete a split multibyte character bytes_read += os.read(fd, maxsize if not bytes_read else 1) try: decoded_data = self._translate_newlines( salt.utils.stringutils.to_unicode( bytes_read, self.receive_encoding ) ) if partial_data_attr is not None: setattr(self, partial_data_attr, b"") return decoded_data, False except UnicodeDecodeError as ex: max_multibyte_character_length = 4 if ex.start > ( len(bytes_read) - max_multibyte_character_length ) and ex.end == len(bytes_read): # We weren't able to decode the received data possibly # because it is a multibyte character split across # blocks. Save what data we have to try and decode # later. If the error wasn't caused by a multibyte # character being split then the error start position # should remain the same each time we get here but the # length of the bytes_read will increase so we will # give up and raise an exception instead. if partial_data_attr is not None: setattr(self, partial_data_attr, bytes_read) else: # We haven't been given anywhere to store partial # data so raise the exception instead raise # No decoded data to return, but indicate that there # is buffered data return "", True else: raise if self.child_fde in rlist and not self.flag_eof_stderr: try: stderr, partial_data = read_and_decode_fd( self.child_fde, maxsize, "partial_data_stderr" ) if not stderr and not partial_data: self.flag_eof_stderr = True stderr = None else: if self.stream_stderr: self.stream_stderr.write(stderr) self.stream_stderr.flush() if self.stderr_logger: stripped = stderr.rstrip() if self.log_sanitize: stripped = stripped.replace( self.log_sanitize, ("*" * 6) ) if stripped.startswith(os.linesep): stripped = stripped[len(os.linesep) :] if stripped: self.stderr_logger.log( self.stderr_logger_level, stripped ) except OSError: os.close(self.child_fde) self.child_fde = None self.flag_eof_stderr = True stderr = None finally: if self.child_fde is not None: fcntl.fcntl(self.child_fde, fcntl.F_SETFL, fde_flags) if self.child_fd in rlist and not self.flag_eof_stdout: try: stdout, partial_data = read_and_decode_fd( self.child_fd, maxsize, "partial_data_stdout" ) if not stdout and not partial_data: self.flag_eof_stdout = True stdout = None else: if self.stream_stdout: self.stream_stdout.write( salt.utils.stringutils.to_str(stdout) ) self.stream_stdout.flush() if self.stdout_logger: stripped = stdout.rstrip() if self.log_sanitize: stripped = stripped.replace( self.log_sanitize, ("*" * 6) ) if stripped.startswith(os.linesep): stripped = stripped[len(os.linesep) :] if stripped: self.stdout_logger.log( self.stdout_logger_level, stripped ) except OSError: os.close(self.child_fd) self.child_fd = None self.flag_eof_stdout = True stdout = None finally: if self.child_fd is not None: fcntl.fcntl(self.child_fd, fcntl.F_SETFL, fd_flags) # <---- Process STDOUT ------------------------------------------- return stdout, stderr def __detect_parent_terminal_size(self): try: TIOCGWINSZ = getattr(termios, "TIOCGWINSZ", 1074295912) packed = struct.pack(b"HHHH", 0, 0, 0, 0) ioctl = fcntl.ioctl(sys.stdin.fileno(), TIOCGWINSZ, packed) return struct.unpack(b"HHHH", ioctl)[0:2] except OSError: # Return a default value of 24x80 return 24, 80 # <---- Internal API ------------------------------------------------- # ----- Public API --------------------------------------------------> def getwinsize(self): """ This returns the terminal window size of the child tty. The return value is a tuple of (rows, cols). Thank you for the shortcut PEXPECT """ if self.child_fd is None: raise TerminalException( "Can't check the size of the terminal since we're not " "connected to the child process." ) return getwinsize(self.child_fd) def setwinsize(self, child, rows=80, cols=80): setwinsize(self.child_fd, rows, cols) def isalive( self, _waitpid=os.waitpid, _wnohang=os.WNOHANG, _wifexited=os.WIFEXITED, _wexitstatus=os.WEXITSTATUS, _wifsignaled=os.WIFSIGNALED, _wifstopped=os.WIFSTOPPED, _wtermsig=os.WTERMSIG, _os_error=os.error, _errno_echild=errno.ECHILD, _terminal_exception=TerminalException, ): """ This tests if the child process is running or not. This is non-blocking. If the child was terminated then this will read the exitstatus or signalstatus of the child. This returns True if the child process appears to be running or False if not. It can take literally SECONDS for Solaris to return the right status. """ if self.terminated: return False if self.has_unread_data is False: # This is for Linux, which requires the blocking form # of waitpid to get status of a defunct process. # This is super-lame. The flag_eof_* would have been set # in recv(), so this should be safe. waitpid_options = 0 else: waitpid_options = _wnohang try: pid, status = _waitpid(self.pid, waitpid_options) except ChildProcessError: # check if process is really dead or if it is just pretending and we should exit normally through the gift center polled = self.proc.poll() if polled is None: return True # process must have returned on it's own process the return code pid = self.pid status = polled except _os_error: err = sys.exc_info()[1] # No child processes if err.errno == _errno_echild: raise _terminal_exception( 'isalive() encountered condition where "terminated" ' "is 0, but there was no child process. Did someone " "else call waitpid() on our process?" ) else: raise # I have to do this twice for Solaris. # I can't even believe that I figured this out... # If waitpid() returns 0 it means that no child process # wishes to report, and the value of status is undefined. if pid == 0: try: ### os.WNOHANG # Solaris! pid, status = _waitpid(self.pid, waitpid_options) except _os_error as exc: # This should never happen... if exc.errno == _errno_echild: raise _terminal_exception( "isalive() encountered condition that should " "never happen. There was no child process. Did " "someone else call waitpid() on our process?" ) else: raise # If pid is still 0 after two calls to waitpid() then the # process really is alive. This seems to work on all platforms, # except for Irix which seems to require a blocking call on # waitpid or select, so I let recv take care of this situation # (unfortunately, this requires waiting through the timeout). if pid == 0: return True if pid == 0: return True if _wifexited(status): self.status = status self.exitstatus = _wexitstatus(status) self.signalstatus = None self.terminated = True elif _wifsignaled(status): self.status = status self.exitstatus = None self.signalstatus = _wtermsig(status) self.terminated = True elif _wifstopped(status): raise _terminal_exception( "isalive() encountered condition where child process is " "stopped. This is not supported. Is some other process " "attempting job control with our child pid?" ) return False def terminate(self, force=False): """ This forces a child process to terminate. It starts nicely with SIGHUP and SIGINT. If "force" is True then moves onto SIGKILL. This returns True if the child was terminated. This returns False if the child could not be terminated. """ if not self.closed: self.close(terminate=False) if not self.isalive(): return True try: self.send_signal(signal.SIGHUP) time.sleep(0.1) if not self.isalive(): return True self.send_signal(signal.SIGCONT) time.sleep(0.1) if not self.isalive(): return True self.send_signal(signal.SIGINT) time.sleep(0.1) if not self.isalive(): return True if force: self.send_signal(signal.SIGKILL) time.sleep(0.1) if not self.isalive(): return True else: return False return False except OSError: # I think there are kernel timing issues that sometimes cause # this to happen. I think isalive() reports True, but the # process is dead to the kernel. # Make one last attempt to see if the kernel is up to date. time.sleep(0.1) if not self.isalive(): return True else: return False def wait(self): """ This waits until the child exits internally consuming any remaining output from the child, thus, no blocking forever because the child has unread data. """ if self.isalive(): while self.isalive(): stdout, stderr = self.recv() if stdout is None: break if stderr is None: break else: raise TerminalException("Cannot wait for dead child process.") return self.exitstatus def send_signal(self, sig): """ Send a signal to the process """ os.kill(self.pid, sig) def kill(self): """ Kill the process with SIGKILL """ self.send_signal(signal.SIGKILL)