File: //usr/lib/python3/dist-packages/sos/cleaner/archives/__pycache__/__init__.cpython-310.pyc
o
i��dN; � @ sb d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlm Z dd� Z
G dd� d�Z dS )� N)�ProcessPoolExecutor)�file_is_binaryc C sN t �| �}tj�|d�}|�|� |�� tj�||j�d�d �d�d �S )N�cleaner�/����.tarr ) �tarfile�open�os�path�join�
extractall�close�name�split)� archive_path�tmpdir�archiver � r �?/usr/lib/python3/dist-packages/sos/cleaner/archives/__init__.py�extract_archive s
$r c @ s2 e Zd ZdZg ZdZdZdZdZdZ g Z
i Z dd� Z e
dd� �Zed d
� �Zed d � �Zd
d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Zed d � �Zd d � Zd!d"� Z d#d$� Z dBd%d&�Z d'd(� Z d)d*� Z d+d,� Z!d-d.� Z"d/d0� Z#d1d2� Z$d3d4� Z%d5d6� Z&d7d8� Z'd9d:� Z(d;d<� Z)d=d>� Z*d?d@� Z+dAS )C�SoSObfuscationArchivea A representation of an extracted archive or an sos archive build
directory which is used by SoSCleaner.
Each archive that needs to be obfuscated is loaded into an instance of this
class. All report-level operations should be contained within this class.
r � undeterminedFc C s� || _ | j | _|| _| j �d�d �d�d | _| j| _t�d�| _t�d�| _ | �
� | _ d| _ | �
� d| _| �d | j | jf � d S )
Nr r r r �sos�sos_uiF� zLoaded %s as type %s)r �final_archive_pathr r � archive_name�ui_name�logging� getLogger�soslog�ui_log�_load_skip_list� skip_list� is_extracted�
_load_self� archive_root�log_info� description)�selfr r r r r �__init__2 s
��z SoSObfuscationArchive.__init__c C s dS )z=Check if the archive is a well-known type we directly supportFr )�cls�arc_pathr r r �
check_is_typeC s z#SoSObfuscationArchive.check_is_typec C s d| j j�� v S )Nr )� __class__�__name__�lower�r* r r r �is_sosH s z SoSObfuscationArchive.is_sosc C s
d| j v S )N�insights)� type_namer2 r r r � is_insightsL s
z!SoSObfuscationArchive.is_insightsc C s | j r t�| j�| _d S d S �N)�
is_tarfiler r r �tarobjr2 r r r r& P s �z SoSObfuscationArchive._load_selfc C s g S )a/ Return a list of ObfuscationArchives that represent additional
archives found within the target archive. For example, an archive from
`sos collect` will return a list of ``SoSReportArchive`` objects.
This should be overridden by individual types of ObfuscationArchive's
r r2 r r r �get_nested_archivesT s z)SoSObfuscationArchive.get_nested_archivesc C s0 | j r| jj}|�� r|jS tjS tj�| j �S )z|Set the root path for the archive that should be prepended to any
filenames given to methods in this class.
)
r8 r9 � firstmember�isdirr r
�sepr �abspathr )r* �toplevelr r r �get_archive_root] s z&SoSObfuscationArchive.get_archive_rootc C s | j �d�| jd |�� dS )z9Helper to easily format ui messages on a per-report basisz {:<50} {}z :N)r" �info�formatr �r* �msgr r r �
report_msgi s z SoSObfuscationArchive.report_msgc C s d| j |f S )Nz[cleaner:%s] %s)r rC r r r � _fmt_log_msgm s z"SoSObfuscationArchive._fmt_log_msgc C � | j �| �|�� d S r7 )r! �debugrF rC r r r � log_debugp � z SoSObfuscationArchive.log_debugc C rG r7 )r! rA rF rC r r r r( s rJ z SoSObfuscationArchive.log_infoc C s g d�S )zyProvide a list of files and file regexes to skip obfuscation on
Returns: list of files and file regexes
)z
proc/kallsymsz
sosreport-z sys/firmwarezsys/fszsys/kernel/debugz
sys/moduler r2 r r r r# v s z%SoSObfuscationArchive._load_skip_listc C s$ zt �| j�W S ty Y dS w )NF)r r8 r � Exceptionr2 r r r r8 � s
�z SoSObfuscationArchive.is_tarfilec C s< | � |�}|r | �d| � t�|� | jd7 _dS dS )z�Remove a file from the archive. This is used when cleaner encounters
a binary file, which we cannot reliably obfuscate.
z&Removing binary file '%s' from archive� N)�
get_file_pathr( r
�remove�removed_file_count)r* �fname�
full_fnamer r r � remove_file� s
�z!SoSObfuscationArchive.remove_filec C s6 | j s| js | �� | _tj�| j|�S tj�| j|�S )z�Based on the type of archive we're dealing with, do whatever that
archive requires to a provided **relative** filepath to be able to
access it within the archive
)r% r' r@ r
r r �extracted_path)r* rP r r r �format_file_name� s
z&SoSObfuscationArchive.format_file_namec
C s� | j du r+| jr+| �|�}z | j�|��� �d�W S ty* | �d| � Y dS w z t | �|�d��
}|�� W d � W S 1 sDw Y W dS t
yi } z| �d|� d|� �� W Y d}~dS d}~ww ) z�Return the content from the specified fname. Particularly useful for
tarball-type archives so we can retrieve prep file contents prior to
extracting the entire archive
Fzutf-8z.Unable to retrieve %s: no such file in archiver �rNzFailed to get contents of z: ) r% r8 rT r9 � extractfile�read�decode�KeyErrorrI r rK )r* rP �filename�to_read�errr r r �get_file_content� s&
��(���z&SoSObfuscationArchive.get_file_contentc C sX | j r|s
| �d� | �� | _d| _n| j| _t�� dkr�| �d� t� | j�D ]y\}}}z[|D ]}tj
� ||�}t� |�j
}t�||t jB � q0|D ];}tj
� ||�} tj
�| �r`tj
�| �raqKt�| tj�rot�| tj�s�| �d| �| j�d � t�| t jt jB � qKW q( ty� }
z
| �d|
� W Y d }
~
q(d }
~
ww | �d| j � d S ) Nz
Extracting...Tr z)Verifying permissions of archive contentsz!Adding owner rw permissions to %sr z#Error while trying to set perms: %szExtracted path is %s)r8 rE � extract_selfrS r% r r
�getuidrI �walkr r �stat�st_mode�chmod�S_IRWXU�exists�islink�access�R_OK�W_OKr �S_IRUSR�S_IWUSRrK ) r* �quiet�dirname�dirs�files�_dir�_dirname�
_dir_permsrZ rP r\ r r r �extract� sD
����� ��z SoSObfuscationArchive.extractc C s. | j �| j|�}|| _t�| j |� || _ dS )z�Rename the top-level directory to new_name, which should be an
obfuscated string that scrubs the hostname from the top-level dir
which would be named after the unobfuscated sos report
N)rS �replacer r
�rename)r* �new_name�_pathr r r �rename_top_dir� s
z$SoSObfuscationArchive.rename_top_dirc C s | j r
| j�d�r dS dS dS )z�Return the compression type used by the archive, if any. This is
then used by SoSCleaner to generate a policy-derived compression
command to repack the archive
�xz�gzN)r8 r �endswithr2 r r r �get_compression� s
z%SoSObfuscationArchive.get_compressionc C s� d}| j d }i }|r$|d| 7 }|d| 7 }|dkr ddi}ndd i}| �d
| � tj|fd |i|��}|j| j tj�| j�d d
� |� � |S )zIPack the extracted archive as a tarfile to then be re-compressed
�wz-obfuscated.tarz:%sz.%sry �preset� �
compresslevel� zBuilding tar file %s�moderL )�arcname)
rS rI r r �addr
r r r r )r* �methodr� �tarpath�
compr_args�tarr r r �build_tar_file� s
�z$SoSObfuscationArchive.build_tar_filec
C s� z| � |�| _W n ty } z| �d| � � d}~ww | �d| j � z| �� W dS tyK } z| �d| � | �d� W Y d}~dS d}~ww )z�Execute the compression command, and set the appropriate final
archive path for later reference by SoSCleaner on a per-archive basis
z*Exception while re-compressing archive: %sNzCompressed to %sz)Failed to remove extraction directory: %sz/Failed to remove temporary extraction directory)r� r rK rI �remove_extracted_pathrE )r* r� r\ r r r �compress s ����z SoSObfuscationArchive.compressc C s, dd� }| � d| j � tj| j|d� dS )z�After the tarball has been re-compressed, remove the extracted path
so that we don't take up that duplicate space any longer during
execution
c S s6 t �|tj� t j�|�rt �|� d S t�|� d S r7 ) r
rc ra rk r �isfilerN �shutil�rmtree)�actionr �excr r r �force_delete_file s zFSoSObfuscationArchive.remove_extracted_path.<locals>.force_delete_filez Removing %s)�onerrorN)rI rS r� r� )r* r� r r r r� s z+SoSObfuscationArchive.remove_extracted_pathc C sJ t d��}|�t| j| j�}|�� }|W d � S 1 s w Y dS )z}Extract an archive into our tmpdir so that we may inspect it or
iterate through its contents for obfuscation
rL N)r �submitr r r �result)r* �_pool� _path_futurer r r r r^ $ s
�$�z"SoSObfuscationArchive.extract_selfc c sr � t �| j�D ]/\}}}|D ]}t j�||�}t j�|�r |V q|D ]}t j�||�}t j�|�r5|V q#qdS )z.Iterator for a list of symlinks in the archiveN)r
r` rS r r rf )r* rm rn ro rp �_dirpathrZ �_fnamer r r � get_symlinks/ s � � ���z"SoSObfuscationArchive.get_symlinksc c sP � t �| j�D ] \}}}|D ]}t j�||�d��}t j�|�r!q|V qqdS )z�Iterator for a list of files in the archive, to allow clean to
iterate over.
Will not include symlinks, as those are handled separately
r N)r
r` rS r r �lstriprf )r* rm rn ro rZ r� r r r �
get_file_list; s � ��z#SoSObfuscationArchive.get_file_listc C s* g }t �| j�D ]
\}}}|�|� q|S )z3Return a list of all directories within the archive)r
r` rS �append)r* �dir_listrm rn ro r r r �get_directory_listI s z(SoSObfuscationArchive.get_directory_listc C s | j �|� | j|7 _dS )z�Called when a file has finished being parsed and used to track
total substitutions made and number of files that had changes made
N)�
file_sub_listr� �total_sub_count)r* rP �countr r r �update_sub_countP s z&SoSObfuscationArchive.update_sub_countc C s* t j�| j|�d��}t j�|�r|S dS )zReturn the filepath of a specific file within the archive so that
it may be selectively inspected if it exists
r r )r
r r rS r� re )r* rP rw r r r rM W s z#SoSObfuscationArchive.get_file_pathc C sT t j�| �|��st j�| �|��sdS | jD ]}|�|�s$t�||�r' dS qdS )a% Checks the provided filename against a list of filepaths to not
perform obfuscation on, as defined in self.skip_list
Positional arguments:
:param filename str: Filename relative to the extracted
archive root
TF) r
r r� rM rf r$ �
startswith�re�match)r* rZ �_skipr r r �should_skip_file^ s
�
�z&SoSObfuscationArchive.should_skip_filec C sF g d�}|D ] }t �||�r dS q| �|�}tj�|�r!t|�S dS )aa Determine if the file should be removed or not, due to an inability
to reliably obfuscate that file based on the filename.
:param fname: Filename relative to the extracted archive root
:type fname: ``str``
:returns: ``True`` if the file cannot be reliably obfuscated
:rtype: ``bool``
) z.*\.gz$z.*\.xz$z
.*\.bzip2$z .*\.tar\..*z.*\.txz$z.*\.tgz$z.*\.bin$z .*\.journal$z.*\~$TF)r� r� rM r
r r� r )r* rP �obvious_removes�_arc_reg�
_full_pathr r r �should_remove_fileq s
�
z(SoSObfuscationArchive.should_remove_fileN)F),r0 �
__module__� __qualname__�__doc__r� r� rO r5 r) � is_nested�
skip_files�
prep_filesr+ � classmethodr. �propertyr3 r6 r& r: r@ rE rF rI r( r# r8 rR rT r] rs rx r| r� r� r� r^ r� r� r� r� rM r� r� r r r r r ! sX
%
r ) r r
r� ra r r� �concurrent.futuresr �
sos.utilitiesr r r r r r r �<module> s