o O6ufO @sxddlZddlZddlZddlZddlmZmZmZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlZddlZddlmZddlmZzddlmZWneyaddlmZYnwdZz ddlZeedZWn&eefyed Z dd l!m"Z"d Z#e $d e"e#d ddd YnwdZ%gdZ&ddZ'dOddZ(ddZ)dPddZ*dQddZ+d d!Z,dRd"d#Z-d$d%Z.dSd&d'Z/e%ddddddddddf d(d)Z0dSd*d+Z1dTd-d.Z2dUd0d1Z3ej4fd2d3Z5d4d5Z6d6d7Z7d8d9Z8d:d;Z9dd?d@ZGdEdFdFZ?GdGdHdHej@ZAGdIdJdJeBZCGdKdLdLZDGdMdNdNeEZFdS)VN)PopenPIPESTDOUT)closing)deque)parse) parse_versionFTsos)fillzWARNING: Failed to load 'magic' module version >= 0.4.20 which sos aims to use for detecting binary files. A less effective method will be used. It is recommended to install proper python3-magic package with the module.  H)replace_whitespacei,)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}z#|j|dd\}}}|s|WStdd|d}|d|}|WStyG}ztd|d ||WYd }~Sd }~ww) 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)verpublic_version_re_publiclocalsanitized_localpep440_versionerrr9//usr/lib/python3/dist-packages/sos/utilities.pyformat_version_to_pep440Msr;cCs|r t|}t|St|S)z6 Converts the version to PEP440 format before parsing )r;r)r1pep440 ver_pep440r9r9r:sos_parse_version^sr>cCsTt|d}t|j|kr|| d|WdS1s#wYdS)z,Returns the last number_of_bytes of filenamerbN)openosstatst_sizeseekread)filenamenumber_of_bytesfr9r9r:r#gs $r#rcCsZt|tr)zt||WSty(td}|d|dtt YSwt|S)z@Returns a file-like object that can be used as a context managerr z fileobj: z could not be opened) isinstancestrrAIOErrorlogging getLoggerr0rioStringIO) path_or_filemoder/r9r9r:ros    r@cCs^t|}||kr||dS||kr||dS||kr"||dS||kr,||dS|S)zCConverts a number of bytes to a shorter, more human friendly formatz.1fTz.1fGz.1fMz.1fK)float)bytes_KMGTfnr9r9r: convert_bytes|s    r_c str'zt|ddg}jdkotfdd|D WSty&Ynwt|d }z|dWWdd StyKYWdd Sw1sOwYdS) 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) mime_type startswith).0_mt_ftupr9r: z!file_is_binary..trr$NFT) magic_modmagicdetect_from_filenameencodinganyr.rArFUnicodeDecodeError)fname_mimestfiler9rfr:rs*       rc cs|rtj|tjj}||7}t|D]/\}}}|r,|tjj|kr,|dd=|r5t||s5qt||D] }tj||Vq;qdS)zGenerator function to find files recursively. Usage:: for filename in find("*.properties", "/var/log/foobar"): print filename N) rBpathdirnamecountsepwalkfnmatchfilterjoin) file_patterntop_dir max_depth path_pattern base_depthrtdirlistfilelistnamer9r9r:rs rc sRg}|D]"}t|}|fdd|DWdn1s!wYq|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|VqdSra)r)match)rdlinepatternr9r:rhszgrep..N)rextend)rfiles_or_pathsmatchesfopfor9rr:rs rcs\tjddtjj}gfdd|D}r%|fdd|D7}tdd|DS)z6Returns if a command matches an executable on the PATHPATHcsg|] }tj|qSr9)rBrtr{)rdp)commandr9r: z!is_executable..cs g|] }tj|dqS)/)rBrtr{lstrip)rdcsysrootr9r:rscss|] }t|tjVqdSra)rBaccessX_OK)rdrtr9r9r:rhsz is_executable..)rBenvirongetr+rtpathsepro)rrpaths candidatesr9)rrr:rs rc  sfdd} fdd} r!t}||j|jdtj}d|d<|rB|D]\}}|r;|||<q0||dq0|rWt d rWd |rMd nd d |d|}t |}g}|D]#}| dr~d|vr~t |}|rx||q`||q`||q`| rt| d}nt}ztt|d||rtntd|d| d}| st|j||}nt||}r|jr| ||jsn,z ||r|ndWn ty|| r|d|_d||jdYWSw| r||dur |dus|}|j}Wn)ty+}z| r||j t j!kr%dd d dWYd}~S|d}~ww|j"dks8|j"dkr:d}|j"||dS)zExecute a command and return a dictionary of status and output, optionally changing root or current working directory before executing command. csfr dkr tr(ttjttjttj r1tdSdSNr) rBchrootsetgidpwdgetpwnampw_gidsetuidpw_uidchdirpw_dirr9)rrrunasr9r:_child_prep_fns  z.sos_get_command_output.._child_prep_fncs,s |dkr|ttddS)N|{Gz?)poll terminatertimesleep)proc)pollerr9r: _check_pollersz-sos_get_command_output.._check_poller)HOMELOGNAMEPWDUSERzC.UTF-8LC_ALLNtimeoutztimeout z --foregroundr zs r*wFT)shellstdoutstderrbufsizeenv close_fds preexec_fnr)statusoutput truncated~)#rrupdaterrBrcopyitemspoprshlexr+rcglobrappendrArrr AsyncReaderr FakeReaderrunningwaitr.rclose get_contentsis_fullrOSErrorerrnoENOENT returncode)rrrrrr foregroundr` sizelimitrto_filerrrpwd_usercmd_envkeyvalueargs expanded_argsarg expanded_arg_outputrreaderrrer9)rrrrr:r"s                   r"c sdd}z ttt|g}Wnty-}ztdd|jj|d}~wwfddt |tj D}rGfdd|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|qSr9) __module__)rdcnameclass_) module_fqnamer9r:rcs z!import_module..csg|] }t|r|qSr9) issubclass)rdm) superclassesr9r:rgr) rpartition __import__globalslocals ImportErrorprint __class____name__inspect getmembersisclass)rr module_namemodulermodulesr9)rrr:rWs    rcCst||||ddS)zeShell out to an external command and return the output or the empty string in case of error. )rrrr)r")cmdrrrunatr9r9r:r!ls r!r@cCsVgd}d}|dkr|dkr|d7}|d}|dkr|dks|d|d||S) N)BKiBMiBGiBTiBrrTr$g@r&rIr9)size precisionsuffixes suffixindexr9r9r:rtsrcCs>|r|tjkr||stj||d}t||}||Sr)rBrwrcrtr{rgetattr)rtrmethodr_methr9r9r: _os_wrapper~s   rcCs$d|vr t||dtdSt||dS)Nrr)rexists)rrrtrr9r9r:rs rcC t||dS)Nisdirrrr9r9r:r rcCr)Nisfilerrr9r9r:rrrcCr)Nislinkrrr9r9r:rrrcCst||dtS)Nr)rrBrr9r9r:rrrcGs8|r||stj||tj}tjj|g|RSra)rcrBrtr{rrw)rtrrr9r9r:rsrcCs 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`` zzr9)textr9r9r:rs rc sg}g||t|trS|D]?\}||r!||vr)|tqttrQz|tfdd|DdWn tyIYnwqn||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 |] }|vr|VqdSrar9)rdr)vr9r:rhsz/recursive_dict_values_by_key..rcsg|]}|vr|qSr9r9)rdd)_filtr9r:rsz0recursive_dict_values_by_key..)rrKdictrrr IndexErrorkeys)dobjr _itemskr9)rrr:r s2        r 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||_||_dSra)processr`)selfr$r`r9r9r:__init__ zFakeReader.__init__cCsdS)NFr9r%r9r9r:rszFakeReader.is_fullcCs|jsdSdS)Nrr)r`r(r9r9r:rrzFakeReader.get_contentscCs|jduSra)r$rr(r9r9r:rszFakeReader.runningN) rr __qualname____doc__r&propertyrrrr9r9r9r:rs 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)NirU)maxlenT) superr&chanr` chunksizeslotsintrrstart)r%channelrr`rr9r:r&s  zAsyncReader.__init__c CsJz |j|j}|s n|j|qWn ttfyYnwd|_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. TFN)r.rFr/rr ValueErrorrMr)r%rr9r9r:runs   zAsyncReader.runcCsH|jr td|js|jsddd|jDSddd|jDS)z-Returns the contents of the deque as a stringrrcss|] }|ddVqdS)zutf-8ignoreN)decoderdlnr9r9r:rh,riz+AsyncReader.get_contents..rcss|]}|VqdSrar9r9r9r9r:rh.s)rrrr`r{rr(r9r9r:r%s  zAsyncReader.get_contentscCs|jsdSt|j|jkS)z?Checks if the deque is full, implying that output was truncatedF)r0lenrr(r9r9r:r0szAsyncReader.is_full) rrr)r*r&r6rr+r __classcell__r9r9r4r:rs   rc@s8eZdZdZddZddZddZdd Zd d Zd S) rzProvides 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)r%r=r9r9r:r&>s zImporterHelper.__init__cCs tj|}tj|\}}|S)z-Returns the plugin module name given the path)rBrtbasenamesplitext)r%rtbaserextr9r9r: _plugin_nameDs zImporterHelper._plugin_namecsfdd|D}||S)Ncs(g|]}d|vr|dr|qS)r&z.py)endswithrB)rdpluginr(r9r:rKs z9ImporterHelper._get_plugins_from_list..)sort)r%list_pluginsr9r(r:_get_plugins_from_listJs z%ImporterHelper._get_plugins_from_listcCs0tj|rttd|}||}|r|SgS)Nz*.py)rBrtrlistrrH)r%rtpy_filespnamesr9r9r:_find_plugins_in_dirQs  z#ImporterHelper._find_plugins_in_dircCs2g}|jjD]}tj|r|||q|S)zQReturns the list of importable modules in the configured python package. )r=__path__rBrtrrrL)r%rGrtr9r9r: get_modulesYs   zImporterHelper.get_modulesN) rrr)r*r&rBrHrLrNr9r9r9r:r8s rc@s$eZdZddZddZddZdS)rcCs||_g|_dSra)tmp_dirfiles)r%rOr9r9r:r&fr'zTempFileUtil.__init__cCs2tj|jd\}}t|d}|j||f|S)N)dirzw+)tempfilemkstemprOrBfdopenrPr)r%fdrqfobjr9r9r:newjs zTempFileUtil.newc Csb|jD](\}}z ||Wn tyYnwzt|Wqty+Yqwg|_dSra)rPflushrr.rBunlink)r%rqrIr9r9r:cleanqs    zTempFileUtil.cleanN)rrr)r&rWrZr9r9r9r:rds rc@s eZdZdS)rN)rrr)r9r9r9r:rsr)T)rJ)rTrUrVrW)NNra)rNN)r@)GrBrr)r subprocessrrrrNryrrrrR threadingrrP contextlibr collectionsrpackaging.versionrrr pkg_resourcesrkrlrm__file__AttributeErrorrOr/textwrapr msgwarningr__all__r;r>r#rr_rrrrr"rr!rrtrrrrrrrwrrr rThreadrobjectrrrrr9r9r9r:s            "   |    6=,