HEX

File: //lib/python3.9/site-packages/sos/policies/__pycache__/__init__.cpython-39.pyc
a

\��hzV�@sddlZddlZddlZddlZddlZddlZddlZddlZddlZddl	m
Z
ddlmZddl
mZmZmZmZmZmZmZddlmZddlmZmZmZmZddlmZmZddlm Z dd	l!m"Z#d
d�Z$iddddd
fdd�Z%Gdd�d�Z&dS)�N)�getpwuid)�fill)�	NO_PRESET�GENERIC_PRESETS�PRESETS_PATH�PresetDefaults�DESC�NOTE�OPTS)�PackageManager)�ImporterHelper�
import_module�get_human_readable�bold)�IndependentPlugin�ExperimentalPlugin)�
SoSOptions)�_soscCs0d|��}zt|t�WSty*YdS0dS)Nzsos.policies.distros.)r
�Policy�ImportError)�nameZ
policy_fqname�r�9/usr/lib/python3.9/site-packages/sos/policies/__init__.py�
import_policys

rT�c
Cs�d|vr|�d�Sddl}t|jj�}|��D]6}t|�D](}	|	j|d�r:|	||||d�|d<q.q:q.tj	dkrxt
d��d|vr�|jj��|d<|dS)N�policyr)�remote)�sysroot�init�
probe_runtime�remote_execZlinuxz%SoS is not supported on this platform)�getZsos.policies.distrosrZpoliciesZdistrosZget_modulesr�check�sys�platform�	ExceptionZGenericLinuxPolicy)
�cacherrrr Zremote_check�sos�helper�modulerrrr�load s"
�

r*c@sneZdZdZed�ZdZdZdZdZ	dgZ
dZdZdZ
de�iZeZdZdIdd�ZedJd
d��Zedd��Zedd��Zdd�Zdd�Zdd�Zdd�Zdd�Zdd�Zdd �ZdKd!d"�Z d#d$�Z!d%d&�Z"d'd(�Z#d)d*�Z$d+d,�Z%d-d.�Z&d/d0�Z'd1d2�Z(d3d4�Z)ed5d6��Z*dLd7d8�Z+d9d:�Z,d;d<�Z-dMd=d>�Z.d?d@�Z/dAdB�Z0dNdCdD�Z1d	d	d	e2�fdEdF�Z3dOdGdH�Z4d	S)Pra�Policies represent distributions that sos supports, and define the way
    in which sos behaves on those distributions. A policy should define at
    minimum a way to identify the distribution, and a package manager to allow
    for package based plugin enablement.

    Policies also control preferred ContainerRuntime()'s, upload support to
    default locations for distribution vendors, disclaimer text, and default
    presets supported by that distribution or vendor's products.

    Every Policy will also need at least one "tagging class" for plugins.

    :param sysroot: Set the sysroot for the system, if not /
    :type sysroot: ``str`` or ``None``

    :param probe_runtime: Should the Policy try to load a ContainerRuntime
    :type probe_runtime: ``bool``

    :param remote_exec:     If this policy is loaded for a remote node, use
                            this to facilitate executing commands via the
                            SoSTransport in use
    :type remote_exec:      ``SoSTranport.run_command()``

    :cvar os_release_name: The name of the distribution as it appears in the
                           os-release (-esque) file for the NAME variable.
    :vartype os_release_name: ``str``

    :cvar os_release_id: The ID variable to match in a distribution's release
                         file.
    :vartype os_release_id: ``str``

    :cvar os_release_file: The filepath of the distribution's os-release file
    :vartype os_release_file: ``str``

    :cvar vendor: The name of the vendor producing the distribution
    :vartype vendor: ``str``

    :cvar vendor_urls: List of URLs for the vendor's website, or support portal
    :vartype vendor_urls: ``list`` of ``tuples`` formatted
        ``(``description``, ``url``)``

    :cvar vendor_text: Additional text to add to the banner message
    :vartype vendor_text: ``str``

    :cvar name_pattern: The naming pattern to be used for naming archives
                        generated by sos. Values of `legacy`, and `friendly`
                        are preset patterns. May also be set to an explicit
                        custom pattern, see `get_archive_name()`
    :vartype name_pattern: ``str``
    ayThis command will collect system configuration and diagnostic information from this %(os_release_name)s system.

For more information on %(vendor)s visit:

  %(vendor_urls)s

The generated archive may contain data considered sensitive and its content should be reviewed by the originating organization before being passed to any third party.

%(changes_text)s

%(vendor_text)s
ZUnknownr)zExample URLzhttp://www.example.com/z</usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin�legacyFNTcCsdt�d�|_t�d�|_|��d|_||_t�|_t	g|_
||_|jsP|��||_
|�t�dS)aJSubclasses that choose to override this initializer should call
        super() to ensure that they get the required platform bits attached.
        super(SubClass, self).__init__(). Policies that require runtime
        tests to construct PATH must call self.set_exec_path() after
        modifying PATH in their own initializer.r'Zsos_uiN)�loggingZ	getLoggerZsoslog�ui_log�_parse_uname�case_idrr�package_managerr�valid_subclassesr �
set_exec_pathr�register_presetsr)�selfrrr rrr�__init__�szPolicy.__init__cCst�dS)a�
        This function is responsible for determining if the underlying system
        is supported by this policy.

        If `remote` is provided, it should be the contents of os-release from
        a remote host, or a similar vendor-specific file that can be used in
        place of a locally available file.

        :returns: ``True`` if the Policy should be loaded, else ``False``
        :rtype: ``bool``
        N)�NotImplementedError)�clsrrrrr"�s
zPolicy.checkcCsFt|d�s8g|_|jjD]}t|d�r|j�|���qtt|j��S)a#This property is used to determine the list of forbidden paths
        set by the policy. Note that this property will construct a
        *cumulative* list based on all subclasses of a given policy.

        :returns: All patterns of policy forbidden paths
        :rtype: ``list``
        �_forbidden_paths�set_forbidden_paths)�hasattrr8�	__class__�__mro__�extendr9�list�set)r4r7rrr�forbidden_paths�s	

zPolicy.forbidden_pathscCsgd�S)z�Use this to *append* policy-specifc forbidden paths that apply to
        all plugins. Setting this classmethod on an invidual policy will *not*
        override subclass-specific paths
        )z*.eggz*.pycz*.pyoz*.swpr)r7rrrr9�szPolicy.set_forbidden_pathscCs|jS)z�Are we running inside a container?

        :returns: ``True`` if in a container, else ``False``
        :rtype: ``bool``
        )�
_in_container�r4rrr�in_container�szPolicy.in_containercCsdS)z'
        Return the OS version
        NrrBrrr�dist_version�szPolicy.dist_versioncCsddlm}|S)zb
        Return the class object of the prefered archive format for this
        platform
        r)�TarFileArchive)Zsos.archiverE)r4rErrr�get_preferred_archive�szPolicy.get_preferred_archivecCs�|���d�d}|j}|jdj}d}d�dd�td�D��}|jdkrr|rVd|nd}d	}d
|�|�|��}nR|jdkr�|r�d|nd}|r�d|nd}d
}d
|�|�|�|�d|��}n|j}|�t	�
|��S)a^
        This function should return the filename of the archive without the
        extension.

        This uses the policy's `name_pattern` attribute to determine the name.
        There are two pre-defined naming patterns - `legacy` and `friendly`
        that give names like the following:

        * legacy - `sosreport-tux.123456-20171224185433`
        * friendly - `sosreport-tux-mylabel-123456-2017-12-24-ezcfcop.tar.xz`

        A custom name_pattern can be used by a policy provided that it
        defines name_pattern using a format() style string substitution.

        Usable substitutions are:

            * name  - the short hostname of the system
            * label - the label given by --label
            * case  - the case id given by --case-id
            * rand  - a random string of 7 alpha characters

        Note that if a datestamp is needed, the substring should be set
        in `name_pattern` in the format accepted by ``strftime()``.

        :returns: A name to be used for the archive, as expanded from
                  the Policy `name_pattern`
        :rtype: ``str``
        �.r�cmdlineoptsrcss|]}t�tj�VqdS�N)�random�choice�stringZascii_lowercase)�.0�xrrr�	<genexpr>��z*Policy.get_archive_name.<locals>.<genexpr>�r+z
-%Y%m%d%H%M%Sz
sosreport-Zfriendly�-z	-%Y-%m-%d)Zget_local_name�splitr/�commons�label�join�range�name_patternZsanitize_filename�time�strftime)r4rZcaserU�dateZrandZnstrrrr�get_archive_name�s 

zPolicy.get_archive_namecCs|SrIr)r4Zbinaryrrr�_get_pkg_name_for_binaryszPolicy._get_pkg_name_for_binarycCs|st��S|SrI)�tempfileZ
gettempdir)r4Zopt_tmp_dirrrr�get_tmp_dirszPolicy.get_tmp_dircCs6t|�dkr.|D]}t||jd�r|Sq|dS)azDetermine what subclass of a Plugin should be used based on the
        tagging classes assigned to the Plugin

        :param plugin_classes: The classes that the Plugin subclasses
        :type plugin_classes: ``list``

        :returns: The first tagging class that matches one of the Policy's
                  `valid_subclasses`
        :rtype: ``PluginDistroTag``
        �r)�len�
issubclassr1)r4Zplugin_classes�prrr�match_plugins

zPolicy.match_plugincs0tg|j}|r|tg7}t�fdd�|D��S)a#
        Verifies that the plugin_class should execute under this policy

        :param plugin_class: The tagging class being checked
        :type plugin_class: ``PluginDistroTag``

        :returns: ``True`` if the `plugin_class` is allowed by the policy
        :rtype: ``bool``
        c3s|]}t�|�VqdSrI)rb)rM�class_��plugin_classrrrO9s�z)Policy.validate_plugin.<locals>.<genexpr>)rr1r�any)r4rgZexperimentalr1rrfr�validate_plugin,s

�zPolicy.validate_plugincCsdS)z>
        This function is called prior to collection.
        NrrBrrr�pre_work<szPolicy.pre_workcCsdS)zR
        This function is called after the sos report has been generated.
        NrrBrrr�	post_workAszPolicy.post_workcCs|j�|�S)z�Wrapper to retrieve a package from the Policy's package manager

        :param pkg: The name of the package
        :type pkg: ``str``

        :returns: The first package that matches `pkg`
        :rtype: ``str``
        )r0�pkg_by_name)r4�pkgrrrrlFs	zPolicy.pkg_by_namecCsBt��\}}}}}}||_||_||_|��ddk|_||_dS)Nr`ZSMP)r$�uname�system�hostname�releaserSZsmp�machine)r4roZnoderq�versionrr�_rrrr.Qs�zPolicy._parse_unamecCs
||_dS)z9Set common host data for the Policy to reference
        N)rT)r4rTrrr�set_commonsZszPolicy.set_commonscCs|tjd<dS)N�PATH)�os�environ)r4�pathrrr�	_set_PATH_szPolicy._set_PATHcCs|�|j�dSrI)rzrvrBrrrr2bszPolicy.set_exec_pathcCst��dkS)z�This method should return true if the user calling the script is
        considered to be a superuser

        :returns: ``True`` if user is superuser, else ``False``
        :rtype: ``bool``
        r)rw�getuidrBrrr�is_rooteszPolicy.is_rootcCsdS)zRReturns the string name of the hashlib-supported checksum algorithm
        to useZsha256rrBrrr�get_preferred_hash_namenszPolicy.get_preferred_hash_namecCs�|�d�|�d�|�dtd��dtd��d��|�d�d	d
ddd
�}|�d�}|�d�|��D](\}}|jdd�|d�|d��dd�qhdS)NzSoS Policiesz�Policies help govern how SoS operates on across different distributions of Linux. They control aspects such as plugin enablement, $PATH determination, how/which package managers are queried, default upload specifications, and more.z0When SoS intializes most functions, for example z
sos reportz and zsos collecta�, one of the first operations is to determine the correct policy to load for the local system. Policies will determine the proper package manager to use, any applicable container runtime(s), and init systems so that SoS and report plugins can properly function for collections. Generally speaking a single policy will map to a single distribution; for example there are separate policies for Debian, Ubuntu, RHEL, and Fedora.zRIt is currently not possible for users to directly control which policy is loaded.z*The Google Cloud-Optimized OS distributionzThe Debian distributionz=Red Hat family distributions, not necessarily including forkszUbuntu/Canonical distributions)zpolicies.coszpolicies.debianzpolicies.redhatzpolicies.ubuntuzSee Alsoz9For more information on distribution policies, see below
� z>8z<20z<30F)�newline)Z	set_title�add_textrZadd_section�items)r7�sectionZpolsZseealsoZpol�valuerrr�display_helpss2
������
�zPolicy.display_helpcCs�|s|sdS|r&|j�td|����|r~|j�td|�d���|j�tdt|j�����|j�tdt|j�j����n|j�td|�d���|r�|j�d|���d	|���|j�td
��dS)ahDisplay final information about a generated archive

        :param archive: The name of the archive that was generated
        :type archive: ``str``

        :param directory: The build directory for sos if --build was used
        :type directory: ``str``

        :param checksum: The checksum of the archive
        :type checksum: ``str``

        :param archivestat: stat() information for the archive
        :type archivestat: `os.stat_result`

        :param map_file: If sos clean was invoked, the location of the mapping
                         file for this run
        :type map_file: ``str``
        Fz3
A mapping of obfuscated elements is available at
	z3
Your sos report has been generated and saved in:
	�
z Size	z Owner	z3Your sos report build tree has been generated in:
	r~�	z7
Please send this file to your support representative.
N)	r-�infortr�st_sizer�st_uid�pw_namer})r4�archiveZ	directoryZchecksumZarchivestatZmap_filerrr�display_results�s>���������zPolicy.display_resultscCsn|jdjrd}nd}d}|j|j|j|��|j|jd|d�}d}|��D]}|t||dd	�d
}qN|S)a_This method is used to prepare the preamble text to display to
        the user in non-batch mode. If your policy sets self.os_release_name,
        that text will be substituted accordingly. You can also override this
        method to do something more complicated.

        :returns: Formatted banner message string
        :rtype: ``str``
        rHz,Changes CAN be made to system configuration.z0No changes will be made to system configuration.�H�tmpdir)�os_release_name�vendor�vendor_urls�vendor_textr��changes_textrF)Zreplace_whitespacer�)	rTZallow_system_changes�msgr�r��_fmt_vendor_urlsr��
splitlinesr)r4r��widthZ_msgZ_fmt�linerrr�get_msg�s	�zPolicy.get_msgcs.tdd�|jD���d��fdd�|jD��S)z�Formats all items in the ``vendor_urls`` class attr into a usable
        string for the banner message.

        :returns:   Formatted string of URLS
        :rtype:     ``str``
        css|]}t|d�VqdS)rN)ra)rM�vrrrrO�rPz*Policy._fmt_vendor_urls.<locals>.<genexpr>r�c3s.|]&}d|dd����d|d��VqdS)r�r�<z : r`Nr)rM�url�r�rrrO�s)�maxr�rVrBrr�rr��s�zPolicy._fmt_vendor_urlscCs|r
i|_|j�|�dS)aAdd new presets to this policy object.

            Merges the presets dictionary ``presets`` into this ``Policy``
            object, or replaces the current presets if ``replace`` is
            ``True``.

            ``presets`` should be a dictionary mapping ``str`` preset names
            to ``<class PresetDefaults>`` objects specifying the command
            line defaults.

            :param presets: dictionary of presets to add or replace
            :param replace: replace presets rather than merge new presets.
        N)�presets�update)r4r��replacerrrr3�szPolicy.register_presetscCs(|j��D]\}}||kr
|Sq
dS)z�Find a preset profile matching the specified preset string.

            :param preset: a string containing a preset profile name.
            :returns: a matching PresetProfile.
        N)r�r�)r4�preset�matchr�rrr�find_preset
s
zPolicy.find_presetcCs
|jtS)z�Return a ``PresetDefaults`` object matching the runing host.

            Stub method to be implemented by derived policy classes.

            :returns: a ``PresetDefaults`` object.
        )r�rrBrrr�probe_presetszPolicy.probe_presetc	
Cs(|p|j}tj�|�sdSt�|�D]�}tj�||�}t|dd��B}zt�|�}Wn"t	ytYWd�q$Yn0Wd�n1s�0Y|�
�D]�}t|t�d�}||}t
|vr�|t
nd|_t|vr�|tnd|_t|v�r|tD]}t|j||t|�q�d|_||j|<q�q$dS)z�Load presets from disk.

            Read JSON formatted preset data from the specified path,
            or the default location at ``/etc/sos/presets.d``.

            :param presets_path: a directory containing JSON presets.
        Nzutf-8)�encoding)�optsrF)�presets_pathrwry�exists�listdirrV�open�jsonr*�
ValueError�keysrrr�descr	�noter
�setattrr��builtinr�)	r4r�Zpreset_pathZpfZpreset_datar��pd�data�argrrr�load_presets#s(
4
zPolicy.load_presetscCs\|j}|std��||jvr,td|�d���t||||d�}d|_||j|j<|�|�dS)z�Add a new on-disk preset and write it to the configured
            presets path.

            :param preset: the new PresetDefaults to add
        zPreset name cannot be emptyzA preset with name 'z' already exists)rr�r�r�FN)r�r�r�rr�r�write)r4rr�r�r�r�r�rrr�
add_presetCs
zPolicy.add_presetcCs\|r||jvrtd|�d���|j|}|jr@td|j�d���|�|j�|j�|�dS)NzUnknown profile: '�'zCannot delete built-in preset ')r�r�r�r�deleter��pop)r4rr�rrr�
del_presetVs
zPolicy.del_preset)NTN)r)F)NN)F)N)r)5�__name__�
__module__�__qualname__�__doc__rtr�r�Zos_release_fileZ
os_release_idr�r�r�rvrXrr�rr�rAr5�classmethodr"�propertyr@r9rCrDrFr\r]r_rdrirjrkrlr.rurzr2r|r}r�r�r�r�r3r�r�r�rr�r�rrrrr8sd2



5
		
)�
9

	
 r)'r,rwr$rYr�r^rJrLr#�pwdr�textwraprZsos.presetsrrrrrr	r
Zsos.policies.package_managersrZ
sos.utilitiesrr
rrZsos.report.pluginsrrZsos.optionsrr'rrtrr*rrrrr�<module>s*$�