3
�f6O � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlmZ d dl m Z d dl
m Z d dl m
Z
d dlmZ d dlmZ d d lmZ d d
lmZmZ G d d � d �ZG d
d� d�ZdS )� N)�SUPPRESS)�datetime)�getpass)�rmtree)�Path)� __version__)�TarFileArchive)�
SoSOptions)� TempFileUtil� shell_outc
@ s� e Zd ZdZdZi ZdZdZdZdZ dddddddddd dd
d � Z
d d
dddgZ dd� Z dd� Z
dd� Zdd� Zd7dd�Zdd � Zd d � Zed d � �Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd8d+d,�Zd-d.� Zd/d0� Z d1d2� Z d3d4� Z d5d6� Z dS )9� SoSComponenta� Any sub-command that sos supports needs to subclass SoSComponent in
order to be properly supported by the sos binary.
This class contains the standardized entrypoint for subcommands, as well as
building out supported options from both globally shared option lists, and
options supported by that specific subcommand.
When sos initializes, it will load an unintialized instance of each class
found within one recursion of the module root directory that subclasses
SoSComponent.
If sos is able to match the user-specified subcommand to one that exists
locally, then that SoSComponent is initialized, logging is setup, and a
policy is loaded. From there, the component's execute() method takes over.
Added in 4.0
ZunsetTF�autoz/etc/sos/sos.confN� � r ) �batch�compression_type� config_file�debug�encrypt� encrypt_key� encrypt_pass�quiet�threads�tmp_dir�sysroot� verbosityzsos_logs/sos.logzsos_reports/manifest.jsonzsos_commands/process/ps_*zsos_commands/selinux/ps_*z+sos_commands/systemd/systemctl_status_--allc C s� || _ || _|| _d| _d | _d | _d | _d | _y dd l}|j|j | j
� � W n t k
rb Y nX t | j
d�| _| jr�| j� | j
j| j� | j� | _| j�r | j� }t� | _tjj|� s�tj|tj� r�d| }|d7 }t j j |� | j d� || _ t!j"d| j d�| _t#| j�| _| j$� | jd k �r�| jj%d t&� | jj%d
d j'| j�� | jj%d t(j)� � | jj%d
d� | jj%dd� | jj%dd� | jj%d| j� | jj%d| j*� | jj%d| j+j,� | jj-d� d S )NFr )� arg_defaultsztemporary directory %s z"does not exist or is not writable
� zsos.)�prefix�dir�version�cmdline� Z
start_timeZend_timer Zrun_timeZ compression�tmpdirZtmpdir_fs_type�policyZ
components).�parser�argsr! � exit_process�archiver# �
tempfile_util�manifest�signal�SIGTERM�get_exit_handler� Exceptionr �
_arg_defaults�opts� load_policy�load_local_policy�updater � load_options�configure_logging�get_tmpdir_default� SoSMetadata�os�path�isdir�access�W_OK�sys�stderr�write�_exitZsys_tmp�tempfileZmkdtempr
�_setup_logging� add_fieldr �joinr Znow� tmpfstyper$ Zdistro� add_section)�selfr% Z parsed_argsZ cmdline_argsr+ r# �msg� rI � /usr/lib/python3.6/component.py�__init__Q sT
zSoSComponent.__init__c C s^ y.dd l }|jj| jj| jd�| _| jj| _W n tk
rL | jd� Y nX | jj � | _
d S )Nr )r Z
probe_runtime) Z sos.policiesZpolicies�loadr0 r �
load_prober$ �KeyboardInterruptr@ Zis_rootZ_is_root)rG �sosrI rI rJ r2 � s z SoSComponent.load_local_policyc C s t �d S )N)�NotImplementedError)rG rI rI rJ �execute� s zSoSComponent.executec s � fdd�}|S )Nc s d� _ � j� d S )NT)r' r@ )Zsignum�frame)rG rI rJ � exit_handler� s z3SoSComponent.get_exit_handler.<locals>.exit_handlerrI )rG rS rI )rG rJ r- � s z SoSComponent.get_exit_handlerc C s( |r | j jd� | j j|� t|��d S )Nr )�ui_log�error�
SystemExit)rG rU rH rI rI rJ r@ � s zSoSComponent._exitc C s� | j jrtjj| j j�}ntjdd�p(d}tjdd�r\tjdd�r\tjjtjd�|jd��}tdd|f �j � | _
| j
d kr�t d
� t j
d � |S ) z�If --tmp-dir is not specified, provide a default location.
Normally this is /var/tmp, but if we detect we are in a container, then
use a standardized env var to redirect to the host's filesystem instead
ZTMPDIRNz/var/tmpZHOSTZ container�/z!stat --file-system --format=%s %sz%TZtmpfsz�WARNING: tmp-dir is set to a tmpfs filesystem. This may increase memory pressure and cause instability on low memory systems, or when using --all-logs.� )r0 r r8 r9 �abspath�getenvrD �lstripr �striprE �print�timeZsleep)rG r# rI rI rJ r6 � s
z SoSComponent.get_tmpdir_defaultc s6 dd� � j j� j� D �}|r2t� fdd�|D ��S dS )Nc S s g | ]}|j d �r|�qS )�list)�
startswith)�.0�orI rI rJ �
<listcomp>� s z6SoSComponent.check_listing_options.<locals>.<listcomp>c s g | ]}t � j|��qS rI )�getattrr0 )ra �opt)rG rI rJ rc � s F)r0 �dict�keys�any)rG r0 rI )rG rJ �check_listing_options� s z"SoSComponent.check_listing_optionsc C s dS )ziThis should be overridden by each subcommand to add its own unique
options to the parser
NrI )�clsr% rI rI rJ �add_parser_options� s z SoSComponent.add_parser_optionsc s� t � j| jj| j�|jdd�d�}|jdd�}x�|j� D ]�\}}||jj� ks8|dg dgkr^q8|d kr�xFd D ]>}t |�t t
||��@ � � rlt ||� fd d
�t
||�D �� qlW ||j| kr8t |||� q8W |S )
a. (Re-)apply options specified via the cmdline to an options instance
There are several cases where we may need to re-apply the options from
the cmdline over previously loaded options - for instance when an
option is specified in both a config file and cmdline, or a preset and
the cmdline, or all three.
Use this to re-apply cmdline option overrides to anything that may
change the default values of options
Positional arguments:
:param opts: SoSOptions object to update
F)Z
preset_filter)r Nr �enable_plugins� skip_plugins� only_pluginsc s g | ]}|� kr|�qS rI rI )ra �x)�commonrI rJ rc � s z;SoSComponent.apply_options_from_cmdline.<locals>.<listcomp>)rl rm rn )rl rm rn ) r Z from_argsr% �
parse_argsr! rf �itemsr rg �setrd �setattr)rG r0 ZcmdoptsZcodictre �valZooptrI )rp rJ �apply_options_from_cmdline� s
$z'SoSComponent.apply_options_from_cmdlinec C sj t | jd�}x | jjD ]}|jtkrd|_qW |j| jj| jj � d| j
ksVd| j
krf|j| jjd� t j � dkr�t j
jtj� d�}t j
j|�r�|j|| jj � | j|�}d| _t|d��rf|j| jd k�r
| jj|j�| _| j�s
tjjd |j � | jj� | _d
|_| j�s | jj� | _|j | jj � | j|�}t| jj d ��rf| jj j dk�rf| j | jj j � |S ) zxCompile arguments loaded from defaults, config files, and the
command line into a usable set of options
)r Nz--cleanz--mask�cleanr z.config/sos/sos.conf�presetzUnknown preset: '%s'
Tr ) r r/ r% Z_actions�defaultr Zupdate_from_confr& r Z componentr! r8 �getuidr9 rD r �home�existsrv rx �hasattrr$ Z find_presetr= r> r? Z probe_presetZ list_presets�merger0 r �set_loggers_verbosity)rG r0 ZoptionZuserconfrI rI rJ r4 � s8
zSoSComponent.load_optionsc C sn y4| j r| j j� | jr"| jj� | jr2t| j� W n4 tk
rh } ztd|| jf � W Y d d }~X nX d S )Nz6Failed to finish cleanup: %s
Contents may remain in %s)r( �cleanupr) rw r# r r. r] )rG �errrI rI rJ r� . s
zSoSComponent.cleanupc C sb d}t jjd�r&t jjd�| j_d}n t jjd�rFt jjd�| j_d}| jj|� | jj|� d S )NzFNo encryption environment variables set, archive will not be encryptedZ
SOSENCRYPTKEYz+Encryption key set via environment variableZSOSENCRYPTPASSz2Encryption passphrase set via environment variable) r8 �environ�getr0 r r �soslog�inforT )rG rH rI rI rJ �_set_encrypt_from_env_vars< s z'SoSComponent._set_encrypt_from_env_varsc C s� | j js�d }x|d
kr$td�j� }qW |dkr<td�| j _q�|dkrRtd�| j _q�|dkrd| j� q�d | j _d | j _| jj d� | j
j d � n| j� d S ) N�P�K�E�NzLSpecify encryption method [P]assphrase, [K]ey, [E]nv vars, [N]o encryption: z Specify encryption passphrase: zSpecify encryption key: z@User specified --encrypt, but chose no encryption when prompted.z Archive will not be encrypted)r� r� r� r� ) r0 r �input�upperr r r r� r� r� rT Zwarning)rG Z_encrI rI rJ �_get_encryption_methodH s
z#SoSComponent._get_encryption_methodc C s� | j jr| j� | j js | j jr$dnd| j j| j jd�}|sF| jj� }tjj | j
|�}| j j dkr�| jj � }||| j
| j| j j
|| j| j�| _n"t|| j
| j| j j
|| j| j�| _| jj| j jdk� d S )NTF)r �keyZpasswordr
rX )r0 r r� r r r$ Zget_archive_namer8 r9 rD r# r Zget_preferred_archiver r r* r( r Z set_debugr )rG �nameZenc_optsZ archive_nameZ auto_archiverI rI rJ �
setup_archive` s(
zSoSComponent.setup_archivec C sb | j j� }xR| jD ]H}xBt|�j|�D ]0}tjj||�}x dD ]}| j j||d� q>W q&W qW d S )N�(--upload-pass[\s=]+)\S+�$(--upload-url[\s=]+\S+://.*:)([^@]*)�!(--upload-s3-secret-key[\s=]+)\S+z
\1********)r� r� r� ) r( Zget_archive_path�files_with_upload_passwdr Zglobr8 r9 �relpathZ do_file_sub)rG Z _arc_pathr9 �f�rerI rI rJ �_obfuscate_upload_passwords{ s
z(SoSComponent._obfuscate_upload_passwordsc C sJ t jtj�}|jt jd�� |j| jjdkr2t j nt j
� | j j |� d S )Nz %(message)sr )
�logging�
StreamHandlerr= �stdout� setFormatter� Formatter�setLevelr0 r �DEBUG�INFOrT �
addHandler)rG Z
ui_consolerI rI rJ �add_ui_log_to_stdout� s
z!SoSComponent.add_ui_log_to_stdoutc C s\ t | dd �r |r | jjtj� t | dd �rX|rJ| jjdkrJ| jjtj� n| jjtj� d S )N�flog�consoler ) rd r� r� r� r� r0 r r� ZWARNING)rG r rI rI rJ r � s z"SoSComponent.set_loggers_verbosityc C sh t jd�| _| jjt j� d| _| j� sn| j� | _t j | j�| _| jj
t j d�� | jjt j � | jj
| j� | jjs�t j tj�| _| jj
t j d�� | j| jj� | jj
| j� n4t j tj�}|j
t j d�� |jt j� | jj
|� t jd�| _| jj| jjdk�rt jnt j � | j� �sR| j� | _t j | j�}|j
t j d�� | jj
|� | jj�sd| j� dS )z�Creates the log handler that shall be used by all components and any
and all related bits to those components that need to log either to the
console or to the log file for that run of sos.
rO Nz&%(asctime)s %(levelname)s: %(message)sz %(message)sZsos_uir )r� Z getLoggerr� r� r� r� ri �
get_temp_fileZ sos_log_filer� r� r� r� r� r0 r r= r� r� r r r> ZERRORrT Zsos_ui_log_filer� )rG Z console_errZ ui_fhandlerrI rI rJ rB � s<
zSoSComponent._setup_loggingc C s
| j j� S )N)r) �new)rG rI rI rJ r� � s zSoSComponent.get_temp_file)r N)r ) �__name__�
__module__� __qualname__�__doc__Zdescr r5 r1 rM Z
root_requiredr/ r� rK r2 rQ r- r@ r6 ri � classmethodrk rv r4 r� r� r� r� r� r� r rB r� rI rI rI rJ r sV 8
/3
.r c @ sV e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z g fdd�Z
ddd�Z dS )r7 a8 This class is used to record metadata from a sos execution that will
then be stored as a JSON-formatted manifest within the final tarball.
It can be extended by adding further instances of SoSMetadata to represent
dict-like structures throughout the various sos bits that record to
metadata
c C s
i | _ d S )N)�_values)rG rI rI rJ rK � s zSoSMetadata.__init__c c s" x | j j� D ]}|d V q W d S )Nr )r� rr )rG �itemrI rI rJ �__iter__� s zSoSMetadata.__iter__c C s
| j | S )N)r� )rG r� rI rI rJ � __getitem__� s zSoSMetadata.__getitem__c C s, y
| j | S tk
r& t|��Y nX d S )N)r� r. �AttributeError)rG �attrrI rI rJ � __getattr__� s
zSoSMetadata.__getattr__c C s || j |< dS )z@Add a key, value entry to the current metadata instance
N)r� )rG Z
field_name�contentrI rI rJ rC � s zSoSMetadata.add_fieldc C s t � | j|< | j| S )zCAdds a new instance of SoSMetadata to the current instance
)r7 r� )rG Z section_namerI rI rJ rF � s zSoSMetadata.add_sectionc C s t |t�std��|| j|< dS )z�Add a named list element to the current instance. If content is not
supplied, then add an empty list that can alter be appended to
zcontent added must be listN)�
isinstancer_ � TypeErrorr� )rG Z list_namer� rI rI rJ �add_list� s
zSoSMetadata.add_listNc C s t j| dd� |d�S )z�Convert contents of this SoSMetdata instance, and all other nested
instances (sections), into a json-formatted output.
Used to write manifest.json to the final archives.
c S s t | dt| ��S )Nr� )rd �str)rb rI rI rJ �<lambda> s z&SoSMetadata.get_json.<locals>.<lambda>)ry �indent)�json�dumps)rG r� rI rI rJ �get_json� s zSoSMetadata.get_json)N) r� r� r� r� rK r� r� r� rC rF r� r� rI rI rI rJ r7 � s r7 )r� r� r8 rA r= r^ �argparser r r Zshutilr Zpathlibr rO r Z sos.archiver Z sos.optionsr Z
sos.utilitiesr
r r r7 rI rI rI rJ �<module> s& 4