Server : Apache/2.4.52 (Ubuntu) System : Linux webserver 6.8.0-49-generic #49~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Nov 6 17:42:15 UTC 2 x86_64 User : www-data ( 33) PHP Version : 8.1.2-1ubuntu2.21 Disable Function : NONE Directory : /lib/python3/dist-packages/sos/__pycache__/ |
o
i��d�F � @ 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
� Z dd� Z dd� Z
dd� Zd0dd�Zdd� Zdd� Zedd� �Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd1d&d'�Zd(d)� Zd*d+� Zd,d-� Z d.d/� Z dS )2� 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
�unsetTF�autoz/etc/sos/sos.confN� � r ) �batch�compression_type� config_file�debug�encrypt� encrypt_key� encrypt_pass�quiet�threads�tmp_dir�sysroot� verbosityc C s� || _ || _|| _d| _d | _d | _d | _d | _zdd l}|�|j | �
� � W n t y0 Y nw | j �
| j� | �� | _| jr~| �� }t� | _tj�|�rUt�|tj�shd| }|d7 }tj�|� | � d� || _ t j d| j d�| _t | j�| _| �!� | j"r�| �#� | jd ur�| j�$dt%� | j�$d d
�&| j�� | j�$d t'�(� � | j�$d d
� | j�$dd
� | j�$dd
� | j�$d| j� | j�$d| j)� | j�$d| j*j+� | j�,d� d S d S )NFr ztemporary directory %s z"does not exist or is not writable
� zsos.)�prefix�dir�version�cmdline� �
start_time�end_timer �run_time� compression�tmpdir�tmpdir_fs_type�policy�
components)-�parser�argsr! � exit_process�archiver' �
tempfile_util�manifest�signal�SIGTERM�get_exit_handler� Exception�
_arg_defaults�update� arg_defaults� load_options�opts�configure_logging�get_tmpdir_default� SoSMetadata�os�path�isdir�access�W_OK�sys�stderr�write�_exit�sys_tmp�tempfile�mkdtempr
�_setup_logging� load_policy�load_local_policy� add_fieldr �joinr �now� tmpfstyper) �distro� add_section)�selfr+ � parsed_args� cmdline_argsr1 r' �msg� rV �//usr/lib/python3/dist-packages/sos/component.py�__init__H sX �
�
�zSoSComponent.__init__c C s\ zdd l }|jj| jj| jd�| _| jj| _W n ty% | �d� Y nw | j� � | _
d S )Nr )r �
probe_runtime) � sos.policies�policies�loadr9 r �
load_prober) �KeyboardInterruptrE �is_root�_is_root)rR �sosrV rV rW rK s � �z SoSComponent.load_local_policyc C s t ��N)�NotImplementedError�rR rV rV rW �execute� s zSoSComponent.executec s � fdd�}|S )Nc s d� _ � �� d S )NT)r- rE )�signum�framerd rV rW � exit_handler� s z3SoSComponent.get_exit_handler.<locals>.exit_handlerrV )rR rh rV rd rW r3 � s z SoSComponent.get_exit_handlerc C s$ |r| j �d� | j �|� t|��)Nr )�ui_log�error�
SystemExit)rR rj rU rV rV rW rE � s zSoSComponent._exitc C s� | j jr
tj�| j j�}nt�dd�pd}t�dd�r.t�dd�r.tj�t�d�|�d��}tdd|f �� � | _
| j
d krGt d
� t �
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
�TMPDIRNz/var/tmp�HOST� container�/z!stat --file-system --format=%s %sz%T�tmpfsz�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.� )r9 r r= r> �abspath�getenvrM �lstripr �striprO �print�time�sleep)rR r' rV rV rW r; � s
��
z SoSComponent.get_tmpdir_defaultc s6 dd� � j �� �� D �}|rt� fdd�|D ��S d S )Nc S s g | ] }|� d �r|�qS )�list)�
startswith)�.0�orV rV rW �
<listcomp>� s z6SoSComponent.check_listing_options.<locals>.<listcomp>c s g | ]}t � j|��qS rV )�getattrr9 )r{ �optrd rV rW r} � s )r9 �dict�keys�any)rR r9 rV rd rW �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
NrV )�clsr+ rV rV rW �add_parser_options� s z SoSComponent.add_parser_optionsc s� t � j| j�| j�|jdd�d�}|jdd�}|�� D ]F\}}||j�� vs-|dg dfv r.q|dv rTdD ] }t |�t t
||��@ � � rSt ||� fdd�t
||�D �� q4||j| krat |||� q|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)�
preset_filter�r7 Nr )�enable_plugins� skip_plugins� only_pluginsc s g | ]}|� vr|�qS rV rV )r{ �x��commonrV rW r} � s �z;SoSComponent.apply_options_from_cmdline.<locals>.<listcomp>) r � from_argsr+ �
parse_argsr! r� �itemsr7 r� �setr~ �setattr)rR r9 �cmdopts�codictr �val�ooptrV r� rW �apply_options_from_cmdline� s$
� � �z'SoSComponent.apply_options_from_cmdlinec C s� t | jd�}| jjD ]
}|jtkrd|_q
|�| jj| jj � d| j
v s)d| j
v r1|�| jjd� t � � dkrNt j
�t�� d�}t j
�|�rN|�|| jj � | �|�}|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)r r5 r+ �_actions�defaultr �update_from_confr, r � componentr! r= �getuidr> rM r �home�existsr� )rR r9 �option�userconfrV rV rW r8 � s
�
zSoSComponent.load_optionsc
C sv z | j r | j �� | jr| j�� | jr t| j� W d S W d S ty: } ztd|| jf � W Y d }~d S d }~ww )Nz6Failed to finish cleanup: %s
Contents may remain in %s)r. �cleanupr/ r� r' r r4 rv )rR �errrV rV rW r�
s
����zSoSComponent.cleanupc C sb d}t j�d�rt j�d�| j_d}nt j�d�r#t j�d�| j_d}| j�|� | j�|� d S )NzFNo encryption environment variables set, archive will not be encrypted�
SOSENCRYPTKEYz+Encryption key set via environment variable�SOSENCRYPTPASSz2Encryption passphrase set via environment variable) r= �environ�getr9 r r �soslog�infori )rR rU rV rV rW �_set_encrypt_from_env_vars s z'SoSComponent._set_encrypt_from_env_varsc C s� | j jsLd }|dvrtd��� }|dvs
|dkr td�| j _d S |dkr,td�| j _d S |dkr6| �� d S d | j _d | j _| j� d� | j
� d � d S | �� d S )
N)�P�K�E�NzLSpecify encryption method [P]assphrase, [K]ey, [E]nv vars, [N]o encryption: r� z Specify encryption passphrase: r� zSpecify encryption key: r� z@User specified --encrypt, but chose no encryption when prompted.z Archive will not be encrypted) r9 r �input�upperr r r r� r� r� ri �warning)rR �_encrV rV rW �_get_encryption_method' s( ��� z#SoSComponent._get_encryption_methodc C s� | j jr| �� | j js| j jrdnd| j j| j jd�}|s#| j�� }tj� | j
|�}| j j dkrH| j� � }||| j
| j| j j
|| j| j�| _nt|| j
| j| j j
|| j| j�| _| j�| j jdk� d S )NTF)r �key�passwordr rq )r9 r r� r r r) �get_archive_namer= r> rM r' r �get_preferred_archiver r r0 r. r � set_debugr )rR �name�enc_opts� archive_name� auto_archiverV rV rW �
setup_archive? s2 ��
�
�zSoSComponent.setup_archivec C sJ t �tj�}|�t �d�� |�| jjdkrt j nt j
� | j � |� d S )N� %(message)sr )
�logging�
StreamHandlerrB �stdout� setFormatter� Formatter�setLevelr9 r �DEBUG�INFOri �
addHandler)rR �
ui_consolerV rV rW �add_ui_log_to_stdoutZ s �z!SoSComponent.add_ui_log_to_stdoutc C sZ |r$| j r | j �tj� | jjdkr| j�tj� d S | j�tj� d S | j�tj� d S �Nr )�flogr� r� r� r9 r �console�WARNING)rR r rV rV rW �set_loggers_verbosityb s z"SoSComponent.set_loggers_verbosityc C sf t �d�| _| j�t j� d| _| �� s7| �� | _t � | j�| _| j�
t � d�� | j�t j � | j�
| j� | jjsZt � tj�| _| j�
t � d�� | �| jj� | j�
| j� nt � tj�}|�
t � d�� |�t j� | j�
|� t �d�| _| j�| jjdkr�t jnt j � | �� s�| �� | _t � | j�}|�
t � d�� | j�
|� | jjs�| �� dS 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.
ra Nz&%(asctime)s %(levelname)s: %(message)sr� �sos_uir )r� � getLoggerr� r� r� r� r� �
get_temp_file� sos_log_filer� r� r� r� r� r9 r rB r� r� r� r rC �ERRORri �sos_ui_log_filer� )rR � console_err� ui_fhandlerrV rV rW rI m sD
� �
� �zSoSComponent._setup_loggingc C s
| j �� S rb )r/ �newrd rV rV rW r� � �
zSoSComponent.get_temp_file)r N)r ) �__name__�
__module__� __qualname__�__doc__�descr7 r: rJ r] �
root_requiredr5 rX rK re r3 rE r; r� � classmethodr� r� r8 r� r� r� r� r� r� rI r� rV rV rV rW r sP �7
/
.r c @ sV e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z g fdd�Z
ddd�Z dS )r< 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 rb ��_valuesrd rV rV rW rX � r� zSoSMetadata.__init__c c s � | j �� D ]}|d V qd S r� )r� r� �rR �itemrV rV rW �__iter__� s � �zSoSMetadata.__iter__c C s
| j | S rb r� r� rV rV rW � __getitem__� r� zSoSMetadata.__getitem__c C s$ z| j | W S ty t|��w rb )r� r4 �AttributeError)rR �attrrV rV rW � __getattr__� s
�zSoSMetadata.__getattr__c C s || j |< dS )z@Add a key, value entry to the current metadata instance
Nr� )rR �
field_name�contentrV rV rW rL � s zSoSMetadata.add_fieldc C s t � | j|< | j| S )zCAdds a new instance of SoSMetadata to the current instance
)r< r� )rR � section_namerV rV rW rQ � s
zSoSMetadata.add_sectionc C s t |t�s td��|| 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)�
isinstancery � TypeErrorr� )rR � list_namer� rV rV rW �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� )r~ �str)r| rV rV rW �<lambda>� s z&SoSMetadata.get_json.<locals>.<lambda>)r� �indent)�json�dumps)rR r� rV rV rW �get_json� s �zSoSMetadata.get_jsonrb ) r� r� r� r� rX r� r� r� rL rQ r� r� rV rV rV rW r< � s r< )r� r� r= rG rB rw �argparser r r �shutilr �pathlibr ra r � sos.archiver � sos.optionsr �
sos.utilitiesr
r r r< rV rV rV rW �<module> s(