U f`gRN@sBddlZddlZddlZddlZddlmZmZmZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZddlmZzddlmZWn ek rddlmZYnXedZdZd Zd d d d ddddddddddddddddddd gZd!d"ZdGd$d%Z d&d Z!dHd(dZ"d)d*Z#d+dZ$dId,dZ%d-dZ&dJd.dZ'eddddddddddf d/dZ(dKd0dZ)dLd2dZ*dMd4dZ+ej,fd5d6Z-d7dZ.d8dZ/d9dZ0d:dZ1d;dZ2ej3d<d=dZ4d>dZ5gfd?dZ6Gd@dAdAZ7GdBdCdCej8Z9GdDd d Z:GdEd d Z;GdFd d e<Z=dS)NN)PopenPIPESTDOUT)closing)deque)parse) parse_versionZsosFi,TIMEOUT_DEFAULTImporterHelperSoSTimeoutError TempFileUtilboldfile_is_binaryfileobjfindget_human_readablegrep import_module is_executablelistdirr path_exists path_isdir path_isfile path_islink path_joinrecursive_dict_values_by_key shell_outsos_get_command_outputtailc Cstd}zF|j|dd\}}}|s*|WStdd|d}|d|}|WStk r}z"td|d ||WYSd }~XYnXd S) z< Convert the version into a PEP440 compliant version scheme.z2^([0-9][0-9.]*(?:(?:a|b|rc|.post|.dev)[0-9]+)*)\+?)maxsplitz[+~]+.-+zUnable to format z to pep440 format: N)recompilesplitsubstrip Exceptionlogdebug)verZpublic_version_re_ZpublicZlocalZsanitized_localZpep440_versionerrr///usr/lib/python3/dist-packages/sos/utilities.pyformat_version_to_pep440Asr1TcCs|rt|}t|St|S)z6 Converts the version to PEP440 format before parsing )r1r)r,Zpep440Z ver_pep440r/r/r0sos_parse_versionRsr2c CsHt|d4}t|j|kr*|| d|W5QRSQRXdS)z,Returns the last number_of_bytes of filenamerbN)openosstatst_sizeseekread)filenameZnumber_of_bytesfr/r/r0r[s rcCs\t|trPzt||ddWStk rLtd|dttYSXnt|SdS)z@Returns a file-like object that can be used as a context managerutf-8encodingz fileobj: z could not be openedN) isinstancestrr5IOErrorr*r+rioStringIO)Z path_or_filemoder/r/r0rcs cCsHddddd}|D]*\}}||krt||d|Sq|S)zCConverts a number of bytes to a shorter, more human friendly formatli@)TGMKz.1f)itemsfloat)Z num_bytesZsizesZsymbolsizer/r/r0 convert_bytesos rPc strPz6t|ddg}jdko8tfdd|D WStk rNYnXt|dddB}z|d WW5QRd Stk rYW5QRd SXW5QRXd S) azHelper to determine if a given file contains binary content or not. This is especially helpful for `sos clean`, which cannot obfuscate binary data and instead, by default, will remove binary files. :param fname: The full path of the file to check binaryness of :type fname: ``str`` :returns: True if binary, else False :rtype: ``bool`` ztext/zinode/binaryc3s|]}j|VqdSN)Z mime_type startswith).0Z_mtZ_ftupr/r0 sz!file_is_binary..Ztrr>r?rFTN) magic_modmagicZdetect_from_filenamer@anyr)r5r:UnicodeDecodeError)fnameZ_mimesZtfiler/rUr0rxs    c cs|r"tj|tjj}||7}t|D]^\}}}|rV|tjj|krV|dd=|rht||shq,t||D]}tj||Vqtq,dS)zGenerator function to find files recursively. Usage:: for filename in find("*.properties", "/var/log/foobar"): print filename N) r6pathdirnamecountsepwalkfnmatchfilterjoin) Z file_patternZtop_dirZ max_depthZ path_patternZ base_depthr\dirlistZfilelistnamer/r/r0rs c s>g}|D]0}t|}|fdd|DW5QRXq|S)zReturns lines matched in fnames, where fnames can either be pathnames to files to grep through or open file objects to grep through line by linec3s|]}t|r|VqdSrR)r$match)rTlinepatternr/r0rVs zgrep..)rextend)riZfiles_or_pathsZmatchesZfopZfor/rhr0rs  $cs\tjddtjj}gfdd|D}rJ|fdd|D7}tdd|DS)z6Returns if a command matches an executable on the PATHPATHcsg|]}tj|qSr/)r6r\rc)rTp)commandr/r0 sz!is_executable..cs g|]}tj|dqS)/)r6r\rclstrip)rTcsysrootr/r0roscss|]}t|tjVqdSrR)r6accessX_OK)rTr\r/r/r0rVsz is_executable..)r6environgetr&r\pathseprY)rnrtpathsZ candidatesr/)rnrtr0rs c  sfdd} fdd} rBt}||j|jdtj}d|d<|r|D]"\}}|rv|||<q`||dq`|rt d rd |rd nd d |d|}t |}g}|D]F}| drd|krt |}|r||n ||q||q| rt| ddd}nt}z0t|d||r8tntd|d| d}| sbt|j||}n t||}r|jr| |qrnlz||r|ndWnRtk r|| r|d|_d||jdYW5QRWSX| r||dkrq|jdkr&d}n|}|j||jdW5QRWSQRXWnXt k r}z8| rv||j!t!j"krdd d dWY S|W5d}~XYnXdS)zExecute a command and return a dictionary of status and output, optionally changing root or current working directory before executing command. csbrdkrtrPttjttjttj r^tdSNrp) r6chrootsetgidpwdgetpwnamZpw_gidsetuidZpw_uidchdirpw_dirr/)rr|runasr/r0_child_prep_fns  z.sos_get_command_output.._child_prep_fncs,s|dkr|ttddS)N|{Gz?)poll terminater timesleep)proc)pollerr/r0 _check_pollersz-sos_get_command_output.._check_poller)HOMEZLOGNAMEZPWDZUSERzC.UTF-8LC_ALLNtimeoutztimeout z --foregroundrl zs rp*wr>r?FT)shellstdoutstderrbufsizeenvZ close_fdsZ preexec_fnr)ZstatusoutputZ truncated)~r)#r~rupdaterr6rwcopyrMpoprshlexr&rSglobrjappendr5rrr AsyncReaderr FakeReaderrunningwaitr)rclose get_contentsis_fullr returncodeOSErrorerrnoZENOENT)rnrrr|rrZ foregroundrQ sizelimitrZto_filerrrZpwd_userZcmd_envkeyvalueargsZ expanded_argsargZ expanded_argZ_outputrmreaderrer/)rr|rrr0rs              c sdd}zttt|g}Wn>tk rd}z tdd|jj|W5d}~XYnXfddt |tj D}rfdd|D}|S) aImports the module module_fqname and returns a list of defined classes from that module. If superclasses is defined then the classes returned will be subclasses of the specified superclass or superclasses. If superclasses is plural it must be a tuple of classes.r!rz"Error while trying to load module z: Ncsg|]\}}|jkr|qSr/) __module__)rTZcnameZclass_) module_fqnamer/r0roNs z!import_module..csg|]}t|r|qSr/) issubclass)rTm) superclassesr/r0roRs ) rpartition __import__globalslocals ImportErrorprint __class____name__inspectZ getmembersZisclass)rrZ module_namemodulermodulesr/)rrr0rBs  cCst||||ddS)zeShell out to an external command and return the output or the empty string in case of error. )rr|rr)r)cmdrr|Zrunatr/r/r0rWs r4cCsNdddddg}d}|dkr4|dkr4|d 7}|d }q|d |d ||S) NBZKiBZMiBZGiBZTiBrrHrg@r!r<r/)rOZ precisionsuffixesZ suffixindexr/r/r0r_s  cCs>|r,|tjkr,||s,tj||d}t||}||Sr{)r6r_rSr\rcrqgetattr)r\rtmethodrZ_methr/r/r0 _os_wrapperis   rcCs$d|krt||dtdSt||dS)Nrr)rexists)rrr\rtr/r/r0rqscCs t||dS)Nisdirrrr/r/r0rwscCs t||dS)Nisfilerrr/r/r0r{scCs t||dS)Nislinkrrr/r/r0rscCst||dtS)Nr)rr6rr/r/r0rsrscGs6|r$||s$tj||tj}tjj|f|SrR)rSr6r\rcrqr_)r\rtrmr/r/r0rscCs d|dS)a"Helper to make text bold in console output, without pulling in dependencies to the project unneccessarily. :param text: The text to make bold :type text: ``str`` :returns: The text wrapped in the ASCII codes to display as bold :rtype: ``str`` zzr/)textr/r/r0r s c sg}g||t|tr|D]\}||rB||krR|tq$ttr$z$|tfdd|DdWntk rYnXq$n ||fdd|DS)a Recursively compile all elements of a potentially nested dict by a set of keys. If a given key is a dict within ``dobj``, then _all_ elements within that dict, regardless of child keys, will be returned. For example, if a Plugin searches the devices dict for the 'storage' key, then all storage devices under the that dict (e.g. block, fibre, etc...) will be returned. However, if the Plugin specifies 'block' via ``keys``, then only the block devices within the devices['storage'] dict will be returned. Any elements passed here that are _not_ keys within the dict or any nested dicts will also be returned. :param dobj: The 'top-level' dict to intially search by :type dobj: ``dict`` :param keys: Which keys to compile elements from within ``dobj``. If no keys are given, all nested elements are returned :param keys: ``list`` of ``str`` :returns: All elements within the dict and any nested dicts :rtype: ``list`` c3s|]}|kr|VqdSrRr/)rTr)vr/r0rVsz/recursive_dict_values_by_key..rcsg|]}|kr|qSr/r/)rTd)_filtr/r0rosz0recursive_dict_values_by_key..)rjrAdictrMrr IndexErrorkeys)ZdobjrZ_itemskr/)rrr0rs,       c@s8eZdZdZddZeddZddZedd Zd S) rzUsed as a replacement AsyncReader for when we are writing directly to disk, and allows us to keep more simplified flows for executing, monitoring, and collecting command output. cCs||_||_dSrR)processrQ)selfrrQr/r/r0__init__szFakeReader.__init__cCsdS)NFr/rr/r/r0rszFakeReader.is_fullcCs|js dSdS)Nrlr)rQrr/r/r0rszFakeReader.get_contentscCs|jdkSrR)rrrr/r/r0rszFakeReader.runningN) rr __qualname____doc__rpropertyrrrr/r/r/r0rs rcs<eZdZdZfddZddZddZedd ZZ S) rzUsed to limit command output to a given size without deadlocking sos. Takes a sizelimit value in MB, and will compile stdout from Popen into a string that is limited to the given sizelimit. cs^t||_||_d|_d|_|r>|d}t||j|_t|jd|_d|_| dS)NirG)maxlenT) superrchanrQ chunksizeslotsintrrstart)rZchannelrrQrr/r0rs zAsyncReader.__init__c CsJz&|j|j}|sq$|j|qWnttfk r>YnXd|_dS)alReads from the channel (pipe) that is the output pipe for a called Popen. As we are reading from the pipe, the output is added to a deque. After the size of the deque exceeds the sizelimit earlier (older) entries are removed. This means the returned output is chunksize-sensitive, but is not really byte-sensitive. FN)rr:rrr ValueErrorrCr)rrgr/r/r0runs zAsyncReader.runcCsD|jrtdq|js.ddd|jDSddd|jDS)z-Returns the contents of the deque as a stringrrlcss|]}|ddVqdS)r>ignoreN)decoderTZlnr/r/r0rVsz+AsyncReader.get_contents..rcss|] }|VqdSrRr/rr/r/r0rVs)rrrrQrcrrr/r/r0rs  zAsyncReader.get_contentscCs|js dSt|j|jkS)z?Checks if the deque is full, implying that output was truncatedF)rlenrrr/r/r0rszAsyncReader.is_full) rrrrrrrrr __classcell__r/r/rr0rs   rc@s8eZdZdZddZddZddZdd Zd d Zd S) r zProvides a list of modules that can be imported in a package. Importable modules are located along the module __path__ list and modules are files that end in .py. cCs ||_dS)zopackage is a package module import my.package.module helper = ImporterHelper(my.package.module)N)package)rrr/r/r0r(szImporterHelper.__init__cCs tj|}tj|\}}|S)z-Returns the plugin module name given the path)r6r\basenamesplitext)rr\baserer-r/r/r0 _plugin_name.s zImporterHelper._plugin_namecsfdd|D}||S)Ncs(g|] }d|kr|dr|qS)rz.py)endswithr)rTZpluginrr/r0ro5s z9ImporterHelper._get_plugins_from_list..)sort)rZlist_pluginsr/rr0_get_plugins_from_list4s  z%ImporterHelper._get_plugins_from_listcCs0tj|r,ttd|}||}|r,|SgS)Nz*.py)r6r\rlistrr)rr\Zpy_filesZpnamesr/r/r0_find_plugins_in_dir;s   z#ImporterHelper._find_plugins_in_dircCs2g}|jjD] }tj|r |||q |S)zQReturns the list of importable modules in the configured python package. )r__path__r6r\rrjr)rrr\r/r/r0 get_modulesCs   zImporterHelper.get_modulesN) rrrrrrrrrr/r/r/r0r "s c@s$eZdZddZddZddZdS)r cCs||_g|_dSrR)tmp_dirfiles)rrr/r/r0rPszTempFileUtil.__init__cCs2tj|jd\}}t|d}|j||f|S)N)dirzw+)tempfileZmkstemprr6fdopenrr)rfdr[Zfobjr/r/r0newTs zTempFileUtil.newc Csh|jD]V\}}z||Wntk r6YnXzt|Wqtk rZYqXqg|_dSrR)rflushrr)r6unlink)rr[r<r/r/r0clean[s zTempFileUtil.cleanN)rrrrrrr/r/r/r0r Nsc@s eZdZdS)r N)rrrr/r/r/r0r ks)T)r=)NN)N)N)rNN)r4)>r6r~r$r subprocessrrrZloggingrarrrrZ threadingrrD contextlibr collectionsrZpackaging.versionrrrZ pkg_resourcesZ getLoggerr*rWr __all__r1r2rrrPrrrrrrrrr\rrrrrrr_rr rrZThreadrr r rr r/r/r/r0 s      "   z    6<,