EVOLUTION-MANAGER
Edit File: archive.cpython-36.pyc
3 �f�r � @ s� d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlmZ d dl m Z d dl m Z d dl mZ y d dlZW n ek r� Y nX dZdZdZd ZG d d � d e�ZG d d � d e�ZG dd� de�ZdS )� N)�datetime)�Lock)� find_spec)�sos_get_command_output�file�linkZnode�dirc @ s� e Zd ZdZedd� �Zejd�ZdZ dZ e � Z dd� Z d d � Zd d � Zd d� Zdd� Zdd� Zd+dd�Zd,dd�Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Z d)d*� Z dS )-�Archivez!Abstract base class for archives.c C s | j S )z6Returns the archive class's name as a string. )�__name__)�cls� r � /usr/lib/python3.6/archive.py� archive_type+ s zArchive.archive_typeZsosZunsetFc C s d| j � |f S )Nz[archive:%s] %s)r )�self�msgr r r � _format_msg8 s zArchive._format_msgc C s || _ d S )N)�_debug)r �debugr r r � set_debug; s zArchive.set_debugc C s | j j| j|�� d S )N)�log�errorr )r r r r r � log_error> s zArchive.log_errorc C s | j j| j|�� d S )N)r Zwarningr )r r r r r �log_warnA s zArchive.log_warnc C s | j j| j|�� d S )N)r �infor )r r r r r �log_infoD s zArchive.log_infoc C s | j s d S | jj| j|�� d S )N)r r r r )r r r r r � log_debugG s zArchive.log_debugNc C s t �d S )N)�NotImplementedError)r �src�dest�forcer r r �add_fileO s zArchive.add_file�wc C s t �d S )N)r )r �contentr �moder r r � add_stringR s zArchive.add_stringc C s t �d S )N)r )r r" r r r r � add_binaryU s zArchive.add_binaryc C s t �d S )N)r )r �source� link_namer r r �add_linkX s zArchive.add_linkc C s t �d S )N)r )r �pathr r r �add_dir[ s zArchive.add_dirc C s t �d S )N)r )r r) r# �devicer r r �add_node^ s zArchive.add_nodec C s t �dS )z�Return a temporary directory that clients of the archive may use to write content to. The content of the path is guaranteed to be included in the generated archive.N)r )r r r r � get_tmp_dira s zArchive.get_tmp_dirc C s t �dS )z�Return the maximum file name length this archive can support. This is the lesser of the name length limit of the archive format and any temporary file system based cache.N)r )r r r r �name_maxg s zArchive.name_maxc C s dS )aT Return a string representing the path to the temporary archive. For archive classes that implement in-line handling this will be the archive file itself. Archives that use a directory based cache prior to packaging should return the path to the temporary directory where the report content is locatedNr )r r r r �get_archive_pathm s zArchive.get_archive_pathc C s dS )z:Clean up any temporary resources used by an Archive class.Nr )r r r r �cleanupv s zArchive.cleanupc C s | j � dS )a Finalize an archive object via method. This may involve creating An archive that is subsequently compressed or simply closing an archive that supports in-line handling. If method is automatic then the following methods are tried in order: xz, gzipN)�close)r �methodr r r �finalizez s zArchive.finalize)NF)r! ) r � __module__� __qualname__�__doc__� classmethodr �loggingZ getLoggerr �_namer r � _path_lockr r r r r r r r$ r% r( r* r, r- r. r/ r0 r3 r r r r r ( s. r c @ s� e Zd ZdZdZdZdZd5dd�Zdd� Zdd � Z d6d d �Z d7dd�Z dd� Z d8dd�Z d9dd�Zdd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd:d%d&�Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Z d3d4� Z dS );�FileCacheArchivezd Abstract superclass for archive types that use a temporary cache directory in the file system. � Nc C s� || _ tjj| j |g�|kr,tjj||�| _ || _|| _|| _|| _|pJd| _ || _ tjj ||�| _ | j � tj| j d� W d Q R X | jd| j f � d S )N�/i� z*initialised empty FileCacheArchive at '%s')r9 �osr) � commonprefix�relpath�_tmp_dirZ_policyZ_threads�enc_opts�sysroot�manifest�join� _archive_rootr: �makedirsr )r �name�tmpdir�policy�threadsrB rC rD r r r �__init__� s zFileCacheArchive.__init__c C s( t jj|�r|jt j�}t jj| j|�S )N)r> r) �isabs�lstrip�seprE rF )r rH r r r � dest_path� s zFileCacheArchive.dest_pathc C sB | j s|j| j �r|S |d tjkr2|dd � }tjj| j |�S )Nr � )rC � startswithr> rO r) rE )r r) r r r � join_sysroot� s z FileCacheArchive.join_sysroot� c s� | j d| � | j� |}� fdd�}|jd�s4|}n&tjj| j|��rJ|ntjj|�d }|}g }x2|dkr�|dkr�tjj|�\}} |j| � |}qdW |j � � } d} �x|D � ]�} tjj | | �} || �s�q�tjj | | �} tjj | �s�| j d| � tjj | ��r�tjj| ��r�tj | �} tjj| �d }tjj || �}| j||d�}tjj|�}tjj| ��rntjj| |�} | j d | | f � tj| | � q�| j d | � tj| |� | }q�W |S ) a� Create leading path components The standard python `os.makedirs` is insufficient for our needs: it will only create directories, and ignores the fact that some path components may be symbolic links. :param src: The source path in the host file system for which leading components should be created, or the path to an sos_* virtual directory inside the archive. Host paths must be absolute (initial '/'), and sos_* directory paths must be a path relative to the root of the archive. :param mode: An optional mode to be used when creating path components. :returns: A rewritten destination path in the case that one or more symbolic links in intermediate components of the path have altered the path destination. zMaking leading paths for %sc s | j tjj� d��S )z>Test whether path ``path`` is inside the archive. r< )rR r> r) rE )r) )�rootr r � in_archive� s z8FileCacheArchive._make_leading_paths.<locals>.in_archiver= r r< zMaking path %s)r# zMaking symlink '%s' -> '%s'zMaking directory %s)r rF rR r> r) �isdirrS �split�append�reverserE �exists�islink�readlink�_make_leading_paths�normpathrM r@ �symlink�mkdir)r r r# r rV �src_dirr) Z path_comps�head�tailZabs_pathZsrc_path�comp�targetZ target_dirZ target_srcr )rU r r^ � sN z$FileCacheArchive._make_leading_pathsFc C sb |p | j |�}|tkr |}ntjj|�d }|s4|S tjj|�r\tjj|� r\td| ��n2tjj|�s�|tkrt|ntjj|�d }| j|� dd� }|r�|S tjj|��r^tj |�}d} |t kr�t j |j � r�t| |df ��|tko�t j|j � �rt| |df ��|tk�r0||j � �r0t| |df ��|tk�rZt j|j � �rZt| |d f ��d S |S ) a4 Check a new destination path in the archive. Since it is possible for multiple plugins to collect the same paths, and since plugins can now run concurrently, it is possible for two threads to race in archive methods: historically the archive class only needed to test for the actual presence of a path, since it was impossible for another `Archive` client to enter the class while another method invocation was being dispatched. Deal with this by implementing a locking scheme for operations that modify the path structure of the archive, and by testing explicitly for conflicts with any existing content at the specified destination path. It is not an error to attempt to create a path that already exists in the archive so long as the type of the object to be added matches the type of object already found at the path. It is an error to attempt to re-create an existing path with a different path type (for example, creating a symbolic link at a path already occupied by a regular file). :param src: the source path to be copied to the archive :param path_type: the type of object to be copied :param dest: an optional destination path :param force: force file creation even if the path exists :returns: An absolute destination path if the path should be copied now or `None` otherwise r z'path '%s' exists and is not a directoryc S s( t tj| �tj| �tj| �tj| �g�S )N)�any�stat�S_ISBLK�S_ISCHR�S_ISFIFO�S_ISSOCK)r# r r r � is_special4 s z/FileCacheArchive.check_path.<locals>.is_specialz path '%s' exists and is not a %sz regular filez symbolic linkz special fileZ directoryN)rP �P_DIRr> r) rX r[ rW � ValueErrorr^ �lstat�P_FILErh �S_ISREG�st_mode�P_LINK�S_ISLNK�P_NODE�S_ISDIR) r r � path_typer r �dest_dirrb rm �stZve_msgr r r � check_path s8 zFileCacheArchive.check_pathc C s� ydt j|�}|jd�s |jd�rDtj||� t j||j|jfd� n tj||� t j ||j |j � W n4 t k r� } z| j d||f � W Y d d }~X nX d S )Nz/sys/z/proc/)�nsz&caught '%s' setting attributes of '%s')r> rh rR �shutilZcopymode�utime� st_atime_ns� st_mtime_nsZcopystat�chown�st_uid�st_gid� Exceptionr )r r r rh �er r r �_copy_attributesP s z!FileCacheArchive._copy_attributesc C s | j �� |s|}| j|t|d�}|s(d S t|dd �s�ytj||� W nJ tk r� } z.|jd�s~|jd�rln| jd||f � W Y d d }~X nX | j ||� d| }n<|j d� t |d�� }x|D ]}|j |� q�W W d Q R X d }| j d || jf � W d Q R X d S ) N)r �readz/sys/z/proc/zFile %s not collected: '%s'z'%s'r r! z open filez!added %s to FileCacheArchive '%s')r: r{ rq �getattrr} �copy�OSErrorrR r r� �seek�open�writer rF )r r r r r� � file_name�f�liner r r r ^ s, $ zFileCacheArchive.add_filer! c C s� | j �� |}| j|tdd�}tj||dd��R}t|t�rD|jdd�}|j|� t j j |�rf| j ||� | j d|| jf � W d Q R X W d Q R X d S )NT)r zutf-8)�encoding�utf8�ignorez-added string at '%s' to FileCacheArchive '%s')r: r{ rq �codecsr� � isinstance�bytes�decoder� r> r) r[ r� r rF )r r" r r# r r� r r r r$ � s zFileCacheArchive.add_stringc C sd | j �T | j|t�}|s d S tj|dd d��}|j|� W d Q R X | jd|| jf � W d Q R X d S )N�wb)r� z,added binary content at '%s' to archive '%s')r: r{ rq r� r� r� r rF )r r" r r� r r r r% � s zFileCacheArchive.add_binaryc C s� | j d||f � | j�H | j|t�}|s.d S tjj|�s\tj||� | j d||| jf � W d Q R X | j d|||f � tjj |�}tjj tjj ||��}| j |�}dd� }tjj |��s�tjj|��r>|}tjj |�}tjj |tj|��}tjj||�}|||��r | j d||f � d S | j d||f � | j||� nbtjj|��rf| j d| � | j|� n:tjj|��r�| j d | � | j|� n| j d ||f � d S ) Nz adding symlink at '%s' -> '%s'z-added symlink at '%s' to '%s' in archive '%s'z.Link follow up: source=%s link_name=%s dest=%sc S s� t jj| �}t jj|�s.t jjt jj||��}t jj| �} | |krFdS yt j| � W n2 tk r� } z|jdkrtdS � W Y dd}~X nX dS )z�Return ``True`` if the symbolic link ``link_name`` is part of a file system loop, or ``False`` otherwise. T�( NF) r> r) �dirnamerM �realpathrE rh r� �errno)r' r& Zlink_dirr� r r r �is_loop� s z*FileCacheArchive.add_link.<locals>.is_loopz#Link '%s' - '%s' loops: skipping...z'Adding link %s -> %s for link follow upz Adding dir %s for link follow upz!Adding file %s for link follow upz)No link follow up: source=%s link_name=%s)r r: r{ rt r> r) �lexistsr` rF r� r� rE rP r[ r\ r] r@ r( rW r* �isfiler ) r r& r' r Z source_dirZhost_path_nameZdest_path_namer� ry r r r r( � sH zFileCacheArchive.add_linkc C s" | j � | j|t� W dQ R X dS )zmCreate a directory in the archive. :param path: the path in the host file system to add N)r: r{ rn )r r) r r r r* � s zFileCacheArchive.add_dirc C s� | j |t�}|sd S tjj|�s�ytj|||� W nL tk r~ } z0|jtjkrjd}| j d||f � d S |�W Y d d }~X nX | j ||� d S )NzOperation not permittedzadd_node: %s - mknod '%s') r{ rv r> r) r[ �mknodr� r� ZEPERMr r� )r r) r# r+ r r� r r r r r, � s zFileCacheArchive.add_nodec C s* dt jkr"t jd }t j| j|�S dS d S )N� PC_NAME_MAX� )r> �pathconf_names�pathconfrF )r Z pc_name_maxr r r r. s zFileCacheArchive.name_maxc C s | j S )N)rF )r r r r r- s z FileCacheArchive.get_tmp_dirc C s | j S )N)rF )r r r r r/ s z!FileCacheArchive.get_archive_pathc C s2 t jt jj| j|�|d� | jd|| jf � dS )zsCreate path, including leading components. Used by sos.sosreport to set up sos_* directories. )r# z2created directory at '%s' in FileCacheArchive '%s'N)r> rG r) rE rF r )r r) r# r r r rG s zFileCacheArchive.makedirsc C s | j |�}tj|dddd�S )N�rzutf-8r� )r� �errors)rP r� r� )r r) r r r � open_file s zFileCacheArchive.open_filec C s t jj| j�rtj| j� d S )N)r> r) rW rF r} Zrmtree)r r r r r0 s zFileCacheArchive.cleanupc C sf t j� }| jj}|| }| jjd|� | jjd|� | jjd|� | j| jjdd�tjj dd�� dS ) z�Adds component-agnostic data to the manifest so that individual SoSComponents do not need to redundantly add these manually Zend_time�run_timeZ compression� )�indent� sos_reportsz manifest.jsonN) r ZnowrD Z start_timeZ add_fieldr$ Zget_jsonr> r) rE )r r2 �end�startr� r r r �add_final_manifest_data s z(FileCacheArchive.add_final_manifest_datac C sN |j | j�| _tjj| j| j�}tj| j|� || _tjj| j| j� �| _ dS )zeRename the archive to an obfuscated version using an initialized SoSCleaner instance N) Zobfuscate_stringr9 r> r) rE rA �renamerF rH � _archive_name)r ZcleanerZ _new_rootr r r �rename_archive_root+ s z$FileCacheArchive.rename_archive_rootc C s� t jt jB }t|d�r(|j}|j|B }n|}|}d}| j|��}|j� }W dQ R X t|t �sh|j dd�}t j ||||d�\} } | r�| j | |� nd} | S )a� Apply a regexp substitution to a file in the archive. :param path: Path in the archive where the file can be found :type path: ``str`` :param regexp: A regex to match the contents of the file :type regexp: ``str`` or compiled ``re`` object :param subst: The substitution string to be used to replace matches within the file :type subst: ``str`` :returns: Number of replacements made :rtype: ``int`` �patternr< Nr� r� )�flagsr ) �re� IGNORECASE� MULTILINE�hasattrr� r� r� r� r� �strr� �subnr$ ) r r) ZregexpZsubstZ common_flagsr� r� r" �readable�resultZ replacementsr r r � do_file_sub5 s" z FileCacheArchive.do_file_subc C s� | j d| j|f � y| j|�}W n2 tk rT } z| jd| � | j� S d }~X nX | j� | j d| jtj | j�j f � | j d r�y | j |�S tk r� } zd}| jd||f � |S d }~X q�X n|S d S )Nz)finalizing archive '%s' using method '%s'z-An error occurred compressing the archive: %sz built archive at '%s' (size=%d)Zencryptz)An error occurred encrypting the archive:z%s %s) r rF �_build_archiver� r rH r0 r� r> rh �st_sizerB �_encrypt)r r2 �res�errr� Zexp_msgr r r r3 Z s& zFileCacheArchive.finalizec C s� |j dd�}|d7 }d| }d}| jd rD|d| jd 7 }||7 }| jd r�d | jd j d d � }d |i}|d 7 }d| }||7 }t|d|d�}|d dkr�|S |d dkr�| jd r�d}q�d}n d|d }t|��dS )a� Encrypts the compressed archive using GPG. If encryption fails for any reason, it should be logged by sos but not cause execution to stop. The assumption is that the unencrypted archive would still be of use to the user, and/or that the end user has another means of securing the archive. Returns the name of the encrypted archive, or raises an exception to signal that encryption failed and the unencrypted archive name should be used. z sosreport-zsecured-sosreport-z.gpgzgpg --batch -o %s N�keyz --trust-model always -e -r %s Zpasswordz%sz'"r< Zsos_gpgz-c --passphrase-fd 0 z!/bin/bash -c "echo $sos_gpg | %s"r )Ztimeout�envZstatus� z Specified key not in keyringzCould not read passphrasezgpg exited with code %s)�replacerB r r� )r �archiveZarc_nameZenc_cmdr� Zpasswdr� r r r r r� r s, zFileCacheArchive._encrypt)N)rT )NF)NF)r! )rT ) r r4 r5 r6 rA rF r� rL rP rS r^ r{ r� r r$ r% r( r* r, r. r- r/ rG r� r0 r� r� r� r3 r� r r r r r; � s6 \ K $ G %r; c s` e Zd ZdZdZdZd� fdd� Zddd�Zdd � Zd d � Z d d � Z � fdd�Z dd� Z � Z S )�TarFileArchivez: archive class using python TarFile to create tar archivesNFc s: t t| �j|||||||� d| _tjj|| j� �| _d S )N�tar) �superr� rL �_suffixr> r) rE rH r� )r rH rI rJ rK rB rC rD )� __class__r r rL � s zTarFileArchive.__init__c C sP |j |_d|j |jd< d|j |jd< |r4||_n|j|_|j|_|j |_ d S )Nz%.9fZatimeZctime) �st_mtime�mtime�st_atime� pax_headers�st_ctimer# rs r� Zuidr� �gid)r Ztar_info�fstatr# r r r �set_tarinfo_from_stat� s z$TarFileArchive.set_tarinfo_from_statc s� |j ttjj| j�d �d � � � s*| j� dddg}t� fdd�|D ��rNd S ytj� �}W n tk rp |S X | j r�| j � �}|r�||j d< | j ||� |S ) NrQ z /version.txt$z/sos_logs(/.*)?z/sos_reports(/.*)?c 3 s | ]}t j|� �V qd S )N)r� �match)�.0�skip)� orig_pathr r � <genexpr>� s z9TarFileArchive.copy_permissions_filter.<locals>.<genexpr>zRHT.security.selinux���) rH �lenr> r) rX rF rg rh r� �_with_selinux_context�get_selinux_contextr� r� )r ZtarinfoZskipsr� �contextr )r� r �copy_permissions_filter� s z&TarFileArchive.copy_permissions_filterc C s, yt j|�\}}|S tk r& d S X d S )N)�selinuxZ getfileconr� )r r) Zrc�cr r r r� � s z"TarFileArchive.get_selinux_contextc C s d| j | jf S )Nz%s.%s)rF r� )r r r r rH � s zTarFileArchive.namec s t t| �j� S )N)r� r� r. )r )r� r r r. � s zTarFileArchive.name_maxc C s� |dkr t d�d k rdnd}|jd�}| jd| | _|dkrHddi}nd d i}tj| jfd d | i|��}xLdD ]D}tjjtjj| j |��s�qr|j tjj| j |�| j � d|� �d� qrW |j | j | j | j d� |j � | jd| 7 _| j� S )N�autoZlzmaZxzZgzipZipz.%sZ compresslevel� Zpreset� r# zw:%s� version.txtr� �sos_logsr= )�arcname)r� �filter)r� r� r� )r �stripr� �tarfiler� r> r) r[ rE rF �addr9 r� r1 r� rH )r r2 Z _comp_mode�kwargsr� Z_contentr r r r� � s( z TarFileArchive._build_archive)N)N)r r4 r5 r6 r2 r� rL r� r� r� rH r. r� � __classcell__r r )r� r r� � s r� )r> r� r} r8 r� r� rh r� r Z threadingr �importlib.utilr Z sos.utilitiesr r� � ImportErrorrq rt rv rn �objectr r; r� r r r r �<module> s4 [