File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/__pycache__/mac_utils.cpython-310.pyc
o
�N�g�7 � @ sX d Z ddlZddlZddlZddlZddlZddlZddlZ ddl
Z ddl Z ddl Z ddl
Z ddlZ ddlZ ddlZ ddlmZmZmZ zddlZW n eyS Y nw e jj�� d Ze�e �Z dZ e j j j!e j j j"d�Z#dd� Z$d d
� Z%d d � Z&d
d� Z'dd� Z(dd� Z)dd� Z*d%dd�Z+dd� Z,dd � Z-d&d d �Z.d&d d �Z/d&d!d"�Z0d#d$� Z1dS )'zD
Helper functions for use by mac modules
.. versionadded:: 2016.3.0
� N)�CommandExecutionError�SaltInvocationError�TimedProcTimeoutError�shellZ mac_utils)� cmd.run_allzcmd.runc C s t jj�� sdS tS )z
Load only on Mac OS
)FzOThe mac_utils utility could not be loaded: utility only works on MacOS systems.)�salt�utils�platformZ is_darwin�__virtualname__� r r �H/opt/saltstack/salt/lib/python3.10/site-packages/salt/utils/mac_utils.py� __virtual__/ s r
c
C s� t | t�stjjj| dd�} t| �D ]\}}t | | t�s%t| | �| |< qd�| �} t j
� � }dt |dt
jt
jdddd� }z
tjjj| fi |��}W n ty` } z td�| ||���d}~ww i }z|�� W n( ty� } z t|�|d< d |d
< d |d < |jj|d
< |W Y d}~S d}~ww |j|j}} |dur�tjj�|�� � }| dur�tjj�| �� � } |jj|d
< |jj |d < ||d< | |d
< |S )z,
Args:
cmd:
Returns:
F)�posix� NT) �cwdr �env�stdin�stdout�stderrZwith_communicate�timeout�bgz<Unable to run command '{}' with the context '{}', reason: {}r � r � �retcode�pid) �
isinstance�listr r �argsZ shlex_split� enumerate�str�join�os�environ�copy�
DEFAULT_SHELL�
subprocess�PIPEZtimed_subprocessZ TimedProc�OSErrorr �format�runr �processr r r Z stringutilsZto_str�rstrip�
returncode)
�cmd�idx�itemZrun_env�kwargs�proc�exc�ret�out�errr r r �_run_all= sb
�
� ���� �� r6 c C s | d � � }d|v r dS dS )z�
helper class to check the launchctl stderr.
launchctl does not always return bad exit code
if there is a failure
r zservice is disabledTF)�lower)r3 r5 r r r �_check_launchctl_stderr� s r8 c C s� t | �}t�d| |� |d dksd|d �� v r>d| � d�}|d�|d �7 }|d �|d �7 }|d
�|d �7 }t|��d S )
z�
Executes the passed command. Returns True if successful
:param str cmd: The command to run
:return: True if successful, otherwise False
:rtype: bool
:raises: Error if command fails or is not supported
z Execute return success %s: %rr r �
not supportedr �Command Failed: �
�Return Code: {}
� Output: {}
�
Error: {}
r T)r6 �log�debugr7 r( r �r- r3 �msgr r r �execute_return_success� s rC c C sv t | �}|d dksd|d �� v r7d| � d�}|d�|d �7 }|d�|d �7 }|d �|d
�7 }t|��|d S ) a
Executes the passed command. Returns the standard out if successful
:param str cmd: The command to run
:return: The standard out of the command if successful, otherwise returns
an error
:rtype: str
:raises: Error if command fails or is not supported
r r r9 r r: r; r< r= r> r )r6 r7 r( r rA r r r �execute_return_result� s rD c C s0 d| v r | � d�d S d| v r| � d�d S | S )a
Returns the data portion of a string that is colon separated.
:param str data: The string that contains the data to be parsed. Usually the
standard out from a command
For example:
``Time Zone: America/Denver``
will return:
``America/Denver``
z: r z:
)�split)�datar r r � parse_return� s
rG c C sL t | t�r | �� dvrd�| �}t|��| �� dv r dS dS t| �r$dS dS )a�
Helper function to validate the enabled parameter. Boolean values are
converted to "on" and "off". String values are checked to make sure they are
either "on" or "off"/"yes" or "no". Integer ``0`` will return "off". All
other integers will return "on"
:param enabled: Enabled can be boolean True or False, Integers, or string
values "on" and "off"/"yes" and "no".
:type: str, int, bool
:return: "on" or "off" or errors
:rtype: str
)�on�off�yes�nozk
Mac Power: Invalid String Value for Enabled.
String values must be 'on' or 'off'/'yes' or 'no'.
Passed: {})rH rJ rH rI )r r r7 r( r �bool)�enabledrB r r r �validate_enabled� s
�rN F� c C sP t |�D ]!}|r
t|� �n|� }t�d|||| � | |v r dS t�d� qdS )a�
Wait up to ``wait`` seconds for a system parameter to be changed before
deciding it hasn't changed.
:param str value: The value indicating a successful change
:param function check_fun: The function whose return is compared with
``value``
:param bool normalize_ret: Whether to normalize the return from
``check_fun`` with ``validate_enabled``
:param int wait: The maximum amount of seconds to wait for a system
parameter to change
z0Confirm update try: %d func:%r state:%s value:%sTr F)�rangerN r? r@ �time�sleep)�valueZ check_funZ
normalize_ret�wait�i�stater r r �confirm_updated� s � rW c O s� |� dd�}d| g}|�|� | dkrdg|d< d|d< tjjjdi |��}td |fi |��}t|�}|d s:|r_d
| � d �}|d �|d
�7 }|d�|d �7 }|d�|d �7 }t |��|re|d
S dS )a�
Run a launchctl command and raise an error if it fails
Args: additional args are passed to launchctl
sub_cmd (str): Sub command supplied to launchctl
Kwargs: passed to ``cmd.run_all``
return_stdout (bool): A keyword argument. If true return the stdout of
the launchctl command
Returns:
bool: ``True`` if successful
str: The stdout of the launchctl command if requested
Raises:
CommandExecutionError: If command fails
CLI Example:
.. code-block:: bash
import salt.utils.mac_service
salt.utils.mac_service.launchctl('debug', 'org.cups.cupsd')
�
return_stdoutF� launchctlZbootout�$ Zsuccess_retcodesZ python_shellr r z
Failed to z
service:
z stdout: {}
r z stderr: {}
r z retcode: {}TNr )
�pop�extendr r r Z clean_kwargs�__salt__r8 r( r )Zsub_cmdr r0 rX r- r3 �errorr4 r r r rY s"
� rY c
C s> t j�| |�}t�d|� |�� �d�s t�d|� i S t j�t j�|��s.t� d|� i S z t
j j �
|d��
}t�|�}W d � n1 sGw Y W n? tjy_ t� d|� i Y S tyy } zt�d||� i W Y d}~S d}~w tjjjy� t� d |� i Y S w d
|vr�t�d |� i S |||d �S )
z�
:param root: The root path of the plist file
:param file_name: The name of the plist file
:return: An empty dictionary if the plist file was invalid, otherwise, a dictionary with plist data
z)read_plist: Gathering service info for %sz.plistz read_plist: Not a plist file: %sz'read_plist: Ignoring broken symlink: %s�rbNzLread_plist: Unable to parse "%s" as it is invalid XML: InvalidFileException.z4Caught ValueError: '%s', while trying to parse '%s'.zTread_plist: Unable to parse "%s" as it is invalid XML: xml.parsers.expat.ExpatError.�Labelz>read_plist: Service does not contain a Label key. Skipping %s.)� file_name� file_path�plist)r! �pathr r? r@ r7 �endswith�exists�realpath�warningr r �filesZfopen�plistlib�loadZInvalidFileException�
ValueError�xml�parsersZexpatZ
ExpatError)�rootra rb �handlerc r5 r r r �_read_plist_fileE sR ���������rq c s� dt v r| st�d� dt d< t d S h d�}d� |�� fdd�t�d �D �� i }|D ]%}tjj� |�D ]\}}}|D ]}t
||�}|rO|||d
d � � < q<q5q,|t d< d t d< |S )
a�
This is a helper function for getting the available macOS services.
The strategy is to look through the known system locations for
launchd plist files, parse them, and use their information for
populating the list of services. Services can run without a plist
file present, but normally services which have an automated startup
will have a plist file, so this is a minor compromise.
�available_servicesz%Found context for available services.TZusing_cached_services> z/Library/LaunchDaemonsz/Library/LaunchAgentsz /System/Library/LaunchDaemonsz /System/Library/LaunchAgentsz /Users/{}/Library/LaunchAgentsc s( h | ]}t j�� �|��r� �|��qS r )r! rd �isdirr( )�.0�user�Z
agent_pathr r � <setcomp>� s ��z&_available_services.<locals>.<setcomp>z/Users/rc r` F) � __context__r? r@ �updater! �listdirr r rd Zos_walkrq r7 ) �refreshZ
launchd_paths�resultZ
launch_dirro �dirsri ra rF r rv r �_available_services� s0
��
���r~ c C s t �d� t| �S )at
Return a dictionary of all available services on the system
:param bool refresh: If you wish to refresh the available services
as this data is cached on the first run.
Returns:
dict: All available services
CLI Example:
.. code-block:: bash
import salt.utils.mac_service
salt.utils.mac_service.available_services()
zLoading available services)r? r@ r~ )r{ r r r rr � s
rr c C sD z t �d�d }W n
ttfy td��w | r t�|�d S |S )a�
Gets the UID or Username of the current console user.
:return: The uid or username of the console user.
:param bool username: Whether to return the username of the console
user instead of the UID. Defaults to False
:rtype: Interger of the UID, or a string of the username.
Raises:
CommandExecutionError: If we fail to get the UID.
CLI Example:
.. code-block:: bash
import salt.utils.mac_service
salt.utils.mac_service.console_user()
z /dev/console� z)Failed to get a UID for the console user.r )r! �statr' �
IndexErrorr �pwd�getpwuid)�username�uidr r r � console_user� s �r� c C sP zddg} t j| t jt jdd�}t�d� W dS t jy' t�d� Y dS w ) zL
Return whether macOS git is the standard OS stub or a real binary.
z/usr/bin/xcode-selectz-pr )r r r z Xcode command line tools presentFz$Xcode command line tools not presentT)r% �
check_callr& r? r@ �CalledProcessError)r- �_r r r � git_is_stub� s
�
�r� )FrO )F)2�__doc__�loggingr! rj r% rQ Zxml.parsers.expatrm Zsalt.grains.extrar Zsalt.modules.cmdmodZsalt.utils.argsZsalt.utils.filesZsalt.utils.pathZsalt.utils.platformZsalt.utils.stringutilsZsalt.utils.timed_subprocessZsalt.exceptionsr r r r� � ImportErrorZgrains�extrar r$ � getLogger�__name__r? r
�modulesZcmdmodZ_run_all_quietZ
_run_quietr] r
r6 r8 rC rD rG rN rW rY rq r~ rr r� r� r r r r �<module> sR �
�D
7
>
0
"