3
�f�M � ' @ s� d dl Z d dlZd dlZd dlmZmZmZ d dlZd dlZd dl Z d dl
Z
d dl Z d dl Z d dl
Z
d dlZd dlZd dlmZ d dlmZ yd dlmZ W n ek
r� d dlmZ Y nX dZyd dlZeje � dZW nP ee fk
�r, ej d �Z d d
l m!Z! d Z"e j#d e!e"d
dd� d � Y nX dZ$ddddddddddddd d d d d d!d"d#d$d%d&gZ%d'd(� Z&dPd)d*�Z'd+d&� Z(dQd-d�Z)dVd3d4�Z*d5d� Z+dWd6d�Z,d7d� Z-dXd8d�Z.e$dddddddddf
d9d%�Z/dYd:d�Z0dZd;d$�Z1d[d=d�Z2e j3fd>d?�Z4d@d � Z5dAd � Z6dBd � Z7dCd!� Z8dDd � Z9e j:dE�dFd"�Z;dGd� Z<g fdHd#�Z=G dIdJ� dJ�Z>G dKdL� dLe
j?�Z@G dMd� deA�ZBG dNd� d�ZCG dOd� deD�ZEdS )\� N)�Popen�PIPE�STDOUT)�closing)�deque)�parse)�
parse_versionFT�sos)�fillz�WARNING: 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 )Zreplace_whitespacei, �TIMEOUT_DEFAULT�ImporterHelper�SoSTimeoutError� TempFileUtil�bold�file_is_binary�fileobj�find�get_human_readable�grep�
import_module�
is_executable�listdirr � path_exists�
path_isdir� path_isfile� path_islink� path_join� recursive_dict_values_by_key� shell_out�sos_get_command_output�tailc C s� t jd�}yB|j| dd�\}}}|s(| S t jdd|�jd�}|� d|� �}|S tk
r� } ztjd| � d |� �� | S d
}~X nX d
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)�re�compile�split�sub�strip� Exception�log�debug)�verZpublic_version_re�_ZpublicZlocalZsanitized_localZpep440_version�err� r3 � /usr/lib/python3.6/utilities.py�format_version_to_pep440L s r5 c C s |rt | �}t|�S t| �S )z6 Converts the version to PEP440 format before parsing )r5 r )r0 Zpep440Z
ver_pep440r3 r3 r4 �sos_parse_version] s r6 c
C s< t | d��(}tj| �j|kr*|j| d� |j� S Q R X dS )z,Returns the last number_of_bytes of filename�rb� N)�open�os�stat�st_size�seek�read)�filenameZnumber_of_bytes�fr3 r3 r4 r" f s �rc C sX t | t�rLy
t| |�S tk
rH tjd�}|jd| � ttj � �S X nt| �S dS )z@Returns a file-like object that can be used as a context managerr z fileobj: %s could not be openedN)
�
isinstance�strr9 �IOError�logging� getLoggerr/ r �io�StringIO)Z path_or_file�moder. r3 r3 r4 r n s
r# �
� � �( c C sd t | �}| |kr d|| S | |kr0d|| S | |krDd|| S | |krXd|| S d| S dS )zCConverts a number of bytes to a shorter, more human friendly formatz%.1fTz%.1fGz%.1fMz%.1fKz%dN)�float)Zbytes_�K�M�G�T�fnr3 r3 r4 �
convert_bytes{ s rT c s� t rNy4tj| �� ddg}� jdko8t� fdd�|D �� S tk
rL Y nX t| d��*}y|jd� dS tk
r| d S X W d
Q R X d
S ) az Helper 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/�binaryc 3 s | ]}� j j|�V qd S )N)Z mime_type�
startswith)�.0Z_mt)�_ftupr3 r4 � <genexpr>� s z!file_is_binary.<locals>.<genexpr>Ztrr# FTN) � magic_mod�magic�detect_from_filename�encoding�anyr- r9 r> �UnicodeDecodeError)�fnameZ_mimesZtfiler3 )rX r4 r � s
c c s� |r"t jj|�jt jj�}||7 }xrt j|�D ]d\}}}|rX|jt jj�|krX|dd�= |rltj||� rlq.x$tj|| �D ]}t jj||�V qzW q.W dS )z�Generator function to find files recursively.
Usage::
for filename in find("*.properties", "/var/log/foobar"):
print filename
N) r: �path�dirname�count�sep�walk�fnmatch�filter�join) Z file_patternZtop_dirZ max_depthZ path_patternZ
base_depthra ZdirlistZfilelist�namer3 r3 r4 r � s
c sB g }x8|D ]0}t |�� }|j� fdd�|D �� W dQ R X q
W |S )z�Returns lines matched in fnames, where fnames can either be pathnames to
files to grep through or open file objects to grep through line by linec 3 s | ]}t j� |�r|V qd S )N)r( �match)rW �line)�patternr3 r4 rY � s zgrep.<locals>.<genexpr>N)r �extend)rl Zfiles_or_pathsZmatchesZfopZfor3 )rl r4 r � s
&c s\ t jjdd�jt jj�}� g� fdd�|D � }�rJ|�fdd�|D �7 }tdd� |D ��S )z6Returns if a command matches an executable on the PATH�PATH� c s g | ]}t jj|� ��qS r3 )r: ra rh )rW �p)�commandr3 r4 �
<listcomp>� s z!is_executable.<locals>.<listcomp>c s g | ]}t jj� |jd ���qS )�/)r: ra rh �lstrip)rW �c)�sysrootr3 r4 rr � s c s s | ]}t j|t j�V qd S )N)r: �access�X_OK)rW ra r3 r3 r4 rY � s z is_executable.<locals>.<genexpr>)r: �environ�getr* ra �pathsepr^ )rq rv �pathsZ
candidatesr3 )rq rv r4 r � s c sb � �fdd�} �fdd�} t jj� }
d|
d< |r`x.|j� D ]"\}}|rP||
|< q:|
j|d� q:W |r�td�r�d |rvd
nd || f } tj| �}g }xN|D ]F}|jd �r�d
|kr�t j |�}|r�|j
|� q�|j |� q�|j |� q�W |
r�t |
d�}nt
}y�t|d||�rtnt
d|
d| d�}|
�s.t|j||�}n
t||�}��rXxr|j�rT| |� �q@W nZy|j|�rh|nd� W n@ tk
�r� |j� |
�r�|j� d|_d|j� |jd�S X |
�r�|j� x|j� dk�rԐq�W |j� }|j}W nP tk
�r6 } z2|
�r|j� |j t j k�r"dd d d�S |�W Y dd}~X nX |j dk�sP|j dk�rTd}|j ||d�S )z�Execute a command and return a dictionary of status and output,
optionally changing root or current working directory before
executing command.
c s( �r�dkrt j�� � r$t j� � d S )Nrs )r: �chroot�chdirr3 )r~ r} r3 r4 �_child_prep_fn� s
z.sos_get_command_output.<locals>._child_prep_fnc s, � � s| j � dkr | j� t�tjd� d S )N�| g{�G�z�?)�poll� terminater �time�sleep)�proc)�pollerr3 r4 �
_check_poller� s z-sos_get_command_output.<locals>._check_pollerzC.UTF-8�LC_ALLN�timeoutztimeout %s %ds %sz --foregroundro rs �*�wFr# T)�shell�stdout�stderr�bufsize�envZ close_fdsZ
preexec_fnr� )Zstatus�output� truncated� �~ � ���) r: ry �copy�items�popr �shlexr* rV �globrm �appendr9 r r r � AsyncReaderr� �
FakeReader�running�waitr- r� �close� get_contents�is_fullr� �OSError�errno�ENOENT�
returncode)rq r� r� r} r~ r� Z
foregroundrU � sizelimitr� Zto_filer r� Zcmd_env�key�value�argsZ
expanded_args�argZ expanded_argZ_outputrp �readerr� r� �er3 )r~ r} r� r4 r! � s~
c s� � j d�d }yt� t� t� |g�}W n> tk
rd } z"td� � d|jj� �� |�W Y dd}~X nX � fdd�tj |tj
�D �}�r��fdd�|D �}|S )
a Imports 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% r# z"Error while trying to load module z: Nc s g | ]\}}|j � kr|�qS r3 )�
__module__)rW ZcnameZclass_)�
module_fqnamer3 r4 rr W s z!import_module.<locals>.<listcomp>c s g | ]}t |� �r|�qS r3 )�
issubclass)rW �m)� superclassesr3 r4 rr [ s r� ) �
rpartition�
__import__�globals�locals� ImportError�print� __class__�__name__�inspectZ
getmembersZisclass)r� r� Z module_name�moduler� �modulesr3 )r� r� r4 r K s
c C s t | |||d�d S )zeShell out to an external command and return the output or the empty
string in case of error.
)r� r} r~ r� )r! )�cmdr� r} Zrunatr3 r3 r4 r ` s r8 c C sJ dddddg}d}x$| dkr6|dk r6|d 7 }| d
} qW d || || f S ) N�BZKiBZMiBZGiBZTiBr i � r# g �@z%.*f%sr3 )�sizeZ precision�suffixesZ suffixindexr3 r3 r4 r h s c C s> |r,|t jkr,| j|�s,t jj|| jd��} t||�}|| �S )Nrs )r: rd rV ra rh rt �getattr)ra rv �methodr� Z_methr3 r3 r4 � _os_wrapperr s
r� c C s$ d| krt | |dtd�S t | |d�S )Nr� r� )r� �exists)r� r� )ra rv r3 r3 r4 r z s c C s t | |d�S )N�isdir)r� )ra rv r3 r3 r4 r � s c C s t | |d�S )N�isfile)r� )ra rv r3 r3 r4 r � s c C s t | |d�S )N�islink)r� )ra rv r3 r3 r4 r � s c C s t | |dt�S )Nr )r� r: )ra rv r3 r3 r4 r � s )rv c G s8 |r&| j |� r&tjj|| jtj��} tjj| f|�� S )N)rV r: ra rh rt rd )ra rv rp r3 r3 r4 r � s c C s d| d S )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``
z[1mz[0mr3 )�textr3 r3 r4 r � s
c s� g }g � |j |� t| t�r�x�| j� D ]�\}�� j|� | sF||krV|j t��� q&t�t�r&y$|j t�fdd�|D ��d � W n tk
r� Y nX � j �j� � q&W n
|j | � � fdd�|D �S )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``
c 3 s | ]}|� kr� | V qd S )Nr3 )rW r� )�vr3 r4 rY � s z/recursive_dict_values_by_key.<locals>.<genexpr>r c s g | ]}|� kr|�qS r3 r3 )rW �d)�_filtr3 r4 rr � s z0recursive_dict_values_by_key.<locals>.<listcomp>)rm rB �dictr� r� r �
IndexError�keys)Zdobjr� Z_items�kr3 )r� r� r4 r � s&
c @ s8 e Zd ZdZdd� Zedd� �Zdd� Zedd � �Zd
S ) r� z�Used 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.
c C s || _ || _d S )N)�processrU )�selfr� rU r3 r3 r4 �__init__� s zFakeReader.__init__c C s dS )NFr3 )r� r3 r3 r4 r� � s zFakeReader.is_fullc C s | j s
dS dS )Nro r� )rU )r� r3 r3 r4 r� � s zFakeReader.get_contentsc C s | j j� d kS )N)r� r� )r� r3 r3 r4 r� � s zFakeReader.runningN) r� r� � __qualname__�__doc__r� �propertyr� r� r� r3 r3 r3 r4 r� � s
r� c s< e Zd ZdZ� fdd�Zdd� Zdd� Zedd � �Z� Z S )
r� z�Used 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.
c sb t t| �j� || _|| _d| _d | _|rB|d }t|| j �| _t| jd�| _d| _ | j
� d S )Ni i )�maxlenT) �superr� r� �chanrU � chunksize�slots�intr r� �start)r� Zchannelr� rU )r� r3 r4 r� � s zAsyncReader.__init__c C sN y*x$| j j| j�}|sP | jj|� qW W n ttfk
rB Y nX d| _dS )al Reads 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)r� r> r� r r� �
ValueErrorrD r� )r� rk r3 r3 r4 �run s zAsyncReader.runc C sL x| j rtjd� qW | js2djdd� | jD ��S djdd� | jD ��S dS )z-Returns the contents of the deque as a stringg{�G�z�?ro c s s | ]}|j d d�V qdS )zutf-8�ignoreN)�decode)rW �lnr3 r3 r4 rY s z+AsyncReader.get_contents.<locals>.<genexpr>r� c s s | ]
}|V qd S )Nr3 )rW r� r3 r3 r4 rY " s N)r� r� r� rU rh r )r� r3 r3 r4 r� s
zAsyncReader.get_contentsc C s | j s
dS t| j�| j kS )z?Checks if the deque is full, implying that output was truncatedF)r� �lenr )r� r3 r3 r4 r� $ s zAsyncReader.is_full)
r� r� r� r� r� r� r� r� r� �
__classcell__r3 r3 )r� r4 r� � s
r� c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
r z�Provides 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.
c C s
|| _ dS )zopackage is a package module
import my.package.module
helper = ImporterHelper(my.package.module)N)�package)r� r� r3 r3 r4 r� 2 s zImporterHelper.__init__c C s t jj|�}t jj|�\}}|S )z-Returns the plugin module name given the path)r: ra �basename�splitext)r� ra �baseri Zextr3 r3 r4 � _plugin_name8 s zImporterHelper._plugin_namec s � fdd�|D �}|j � |S )Nc s( g | ] }d |kr|j d�r� j|��qS )r� z.py)�endswithr� )rW Zplugin)r� r3 r4 rr ? s z9ImporterHelper._get_plugins_from_list.<locals>.<listcomp>)�sort)r� Zlist_�pluginsr3 )r� r4 �_get_plugins_from_list> s
z%ImporterHelper._get_plugins_from_listc C s0 t jj|�r,ttd|��}| j|�}|r,|S g S )Nz*.py)r: ra r� �listr r� )r� ra Zpy_filesZpnamesr3 r3 r4 �_find_plugins_in_dirE s
z#ImporterHelper._find_plugins_in_dirc C s6 g }x,| j jD ] }tjj|�r|j| j|�� qW |S )zQReturns the list of importable modules in the configured python
package. )r� �__path__r: ra r� rm r� )r� r� ra r3 r3 r4 � get_modulesM s
zImporterHelper.get_modulesN) r� r� r� r� r� r� r� r� r� r3 r3 r3 r4 r , s c @ s$ e Zd Zdd� Zdd� Zdd� ZdS )r c C s || _ g | _d S )N)�tmp_dir�files)r� r� r3 r3 r4 r� Z s zTempFileUtil.__init__c C s2 t j| jd�\}}tj|d�}| jj||f� |S )N)�dirzw+)�tempfileZmkstempr� r: �fdopenr� r� )r� �fdr` Zfobjr3 r3 r4 �new^ s zTempFileUtil.newc C sl x`| j D ]V\}}y|j� |j� W n tk
r8 Y nX ytj|� W q tk
r\ Y qX qW g | _ d S )N)r� �flushr� r- r: �unlink)r� r` r@ r3 r3 r4 �cleane s
zTempFileUtil.cleanN)r� r� r� r� r� r� r3 r3 r3 r4 r X s c @ s e Zd ZdS )r N)r� r� r� r3 r3 r3 r4 r s s )T)rA � � � @� )r� r� r r )NN)N)N)rL NN)r8 )Fr: r( r� �
subprocessr r r rE rf r� r� r� r� Z threadingr� rG �
contextlibr � collectionsr Zpackaging.versionr r r� Z
pkg_resourcesrZ r[ r\ �__file__�AttributeErrorrF r. �textwrapr
�msgZwarningr
�__all__r5 r6 r" r rT r r r r r! r r r ra r� r r r r r rd r r r r� ZThreadr� �objectr r r� r r3 r3 r3 r4 �<module> s�
"
"
n
6=,