3
�f5+ � @ s� d dl Z d dlZd dlZd dlZd dlmZ d dlmZ d dlm Z d dl
m Z d dl m
Z
mZ d dlmZ yeej� jd�ZW n ek
r� dZY nX G d d
� d
e�ZG d d � d �ZdS )
� N)� OrderedDict)� SoSComponent)�
import_policy)�Plugin)�bold�ImporterHelper)�fill�x c s� e Zd ZdZdZdZdZdZddiZ� fdd�Z e
dd � �Z d
d � Z d d
� Z
dd� Zdd� Zdd� Zdd� Zdd� Zdd� Z� ZS )� SoSHelperz�Provide better, more in-depth help for specific parts of sos than is
provided in either standard --help output or in manpages.
zDetailed help infomationF�topic� c s" t t| �j|||� | jj| _d S )N)�superr
�__init__�optsr )�self�parser�argsZcmdline)� __class__� � /usr/lib/python3.6/__init__.pyr + s zSoSHelper.__init__c C s* d|_ |jdd�}|jdddddd � d S )
Nzsos help TOPIC [options]zHelp Information Optionsz<These options control what detailed information is displayedr ZTOPICr �?z/name of the topic or component to show help for)�metavar�default�nargs�help)�usageZadd_argument_group� add_argument)�clsr Zhelp_grpr r r �add_parser_options/ s z SoSHelper.add_parser_optionsc C sB | j jjd�d }dddd�}||kr>| j jj||| �| j _d S )N�.r �cleaner� collector)�clean�mask�collect)r r �split�replace)r Z_com�_replacer r r �sanitize_topic_component: s z"SoSHelper.sanitize_topic_componentc C s� | j js| j� tjd� | j� y | j� }W n@ tk
rn } z$td| j j|f � tjd� W Y d d }~X nX |r�y t � }|j
|� |j � W q� tk
r� } ztd| � W Y d d }~X q�X ntd| j j � d S )Nr z Could not load help for '%s': %s� zError loading help: %sz No help section found for '%s') r r �display_self_help�sys�exitr( �get_obj_for_topic� Exception�print� HelpSectionZ display_help�display)r �klass�errZhtr r r �executeD s"
zSoSHelper.executec C s� dddddddd�}d }| j j|krJtjd
| j j �}t||| j j �}n>| j| j| j| jd �}x&|D ] }| j jj |�rf|| � }P qfW |S ) z�Based on the help topic we're after, try to smartly decide which
object we need to manipulate in order to get help information.
Z SoSReportr Z
SoSCleaner� SoSCollectorZRemoteTransportZClusterZPolicy)�reportzreport.pluginsr r! zcollector.transportszcollector.clusters�policiesNzsos.)zreport.plugins.z policies.zcollector.transports.zcollector.clusters.)
r r � importlib�
import_module�getattr�_get_plugin_variant�_get_policy_by_name�_get_collect_transport�_get_collect_cluster�
startswith)r Z
static_mapr �modZ_helpZ_secr r r r- \ s(
zSoSHelper.get_obj_for_topicc C s2 ddl m} | jjjd�d }||kr.|| S d S )Nr )�
TRANSPORTSr r) ���)Zsos.collector.sosnoderA r r r% )r rA Z
_transportr r r r= | s
z SoSHelper._get_collect_transportc C sX ddl m} dd l}|j|jjd�}x.|D ]&}|d | jjjd�d kr*|d S q*W d S )Nr )r5 �clustersr r) rB ) Z
sos.collectorr5 Zsos.collector.clustersZ
_load_modulesr! rC r r r% )r r5 �sosrC Zclusterr r r r> � s
z SoSHelper._get_collect_clusterc C sd t jd| jj �}| j� tj|tj�}dd� |D �}x(|D ] }|j� r<| j j
|j� �}|S q<W d S )Nzsos.c S s" g | ]}t |d t�r|d �qS )r) )�
issubclassr )�.0�mr r r �
<listcomp>� s z1SoSHelper._get_plugin_variant.<locals>.<listcomp>) r8 r9 r r Zload_local_policy�inspectZ
getmembersZisclass�__subclasses__�policyZ match_plugin)r r@ ZmemsZpluginsZpluginr r r r r; � s
z SoSHelper._get_plugin_variantc C sl | j jjd�d }dd l}t|jj�}x@|j� D ]4}x.t|�D ]"}|j j
� j dd�}||kr>|S q>W q0W d S )Nr r) r rK r rB ) r r r% Zsos.policies.distrosr r7 ZdistrosZ get_modulesr �__name__�lowerr& )r Z_topicrD Z_helperr@ rK Z_pr r r r< � s z SoSHelper._get_policy_by_namec C s� t dd�}|jdtd� � |jd�}td�}|jd| � td�}|jd | � |jd
�}|jd � d d
ddddd�}x.|D ]&}|jdt|�d�|| � �dd� q~W |j� dS )zhDisplays the help information for this component directly, that is
help for `sos help`.
zDetailed help for sos helpz�The 'help' sub-command is used to provide more detailed information on different sub-commands available to sos as well as different components at play within those sub-commands.ah SoS - officially pronounced "ess-oh-ess" - is a diagnostic and supportability utility used by several Linux distributions as an easy-to-use tool for standardized data collection. The most known component of which is %s (formerly sosreport) which is used to collect troubleshooting information into an archive for review by sysadmins or technical support teams.z
sos reportz How to search using sos helpz$component.$topic.$subtopicz<To get more information on a given topic, use the form '%s'.z sos help report.plugins.kernelz\For example '%s' will provide more information on the kernel plugin for the report function.zAvailable Help Sectionsz�The following help sections are available. Additional help topics and subtopics may be displayed within their respective help section.
z#Detailed help on the report commandz'Information on the plugin design of sosz!Information on a specific $pluginz"Detailed help on the clean commandz$Detailed help on the collect commandz+How sos operates on different distributions)r6 zreport.pluginszreport.plugins.$pluginr" r$ r7 � z<36F)�newlineN)r0 �add_textr � add_sectionr1 )r Z self_helpZsubsectr Zrep_exZ
avail_help�sectionsZsectr r r r* � s8
zSoSHelper.display_self_help)rL �
__module__� __qualname__�__doc__ZdescZconfigure_loggingZ load_policyZ
load_probeZ arg_defaultsr � classmethodr r( r4 r- r= r> r; r< r* �
__classcell__r r )r r r
s
r
c @ sH e Zd ZdZddd�Zdd� Zddd �Zdd
d �Zdd d
�Zdd� Z dS )r0 z�This class is used to build the output displayed by `sos help` in a
standard fashion that provides easy formatting controls.
r c C s || _ || _|| _t� | _dS )a�
:param title: The title of the output section, will be prominently
displayed
:type title: ``str``
:param content: The text content to be displayed with this section
:type content: ``str``
:param indent: If the section should be nested, set this to a multiple
of 4.
:type indent: ``int``
N)�title�content�indentr rR )r rX rY rZ r r r r � s
zHelpSection.__init__c C s
|| _ dS )z�Set or override the title for this help section
:param title: The name to set for this help section
:type title: ``str``
N)rX )r rX r r r � set_title� s zHelpSection.set_titleTc C s, | j r|rdnd}|| }| j |7 _ dS )z�Add body text to this section. If content for this section already
exists, append the new ``content`` after a newline.
:param content: The text to add to the section
:type content: ``str``
z
�
N)rY )r rY rO �lnr r r rP � s zHelpSection.add_textc C s | j |||� | j| S )ac Add a section of text to the help section that will be displayed
when the HelpSection object is printed.
Sections will be printed *in the order added*.
This will return a subsection object with which block(s) of text may be
added to the subsection associated with ``title``.
:param title: The title of the subsection being added
:type title: ``str``
:param content: The text the new section should contain
:type content: ``str``
:returns: The newly created subsection for ``title``
:rtype: ``HelpSection``
)� _add_sectionrR )r rX rY rZ r r r rQ s zHelpSection.add_sectionc C s( || j krtd��t|||�| j |< dS )z�Internal method used to add a new subsection to this help output
:param title: The title of the subsection being added
:type title: ``str`
z(A section with that title already existsN)rR r. r0 )r rX rY rZ r r r r^ s
zHelpSection._add_sectionc C sl t tt| j�t| jd�� x&| jj� D ]}t t|t| jd�� q&W x$| jD ]}t d� | j| j � qJW dS )zWPrint the HelpSection contents, including any subsections, to
console.
)�widthZinitial_indentr N)
r/ r r rX �TERMSIZErZ rY �
splitlinesrR r1 )r r] Zsectionr r r r1 ' s zHelpSection.displayN)r r r )T)r r )r r )
rL rS rT rU r r[ rP rQ r^ r1 r r r r r0 � s
r0 )rI r8 r+ �os� collectionsr Z
sos.componentr Z sos.policiesr Zsos.report.pluginsr Z
sos.utilitiesr r �textwrapr �min�get_terminal_size�columnsr` r. r
r0 r r r r �<module> s
A