Current File : //usr/lib/python2.7/site-packages/salt/modules/mac_service.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l Z d d l
Z d d l Z d d l Z d d l
m Z d d l m Z d d l m Z d Z i d d 6Z e j e � Z d
� Z d � Z d � Z d
� Z e d � Z d � Z d � Z d � Z! d d d � Z# d d � Z$ d d � Z% d d � Z& d d � Z' d d � Z( d d d � Z) d � Z* d � Z+ d d � Z, d d d � Z- d d � Z. d d � Z/ d S( u]
The service module for macOS
.. versionadded:: 2016.3.0
This module has support for services in the following locations.
.. code-block:: bash
/System/Library/LaunchDaemons/
/System/Library/LaunchAgents/
/Library/LaunchDaemons/
/Library/LaunchAgents/
# As of version "2019.2.0" support for user-specific services were added.
/Users/foo/Library/LaunchAgents/
.. note::
As of the 2019.2.0 release, if a service is located in a ``LaunchAgent``
path and a ``runas`` user is NOT specified, the current console user will
be used to properly interact with the service.
i ( t absolute_importt unicode_literalst print_functionN( t CommandExecutionError( t LooseVersion( t sixu serviceu listu list_c C@ s� t j j j � s t d f St j j j d � s; t d f St j j j d � sZ t d f St t d � t d � k r� t d f St S( u'
Only for macOS with launchctl
uG Failed to load the mac_service module:
Only available on macOS systems.u launchctluM Failed to load the mac_service module:
Required binary not found: "launchctl"u plutiluJ Failed to load the mac_service module:
Required binary not found: "plutil"u osreleaseu 10.11uD Failed to load the mac_service module:
Requires macOS 10.11 or newer(
t saltt utilst platformt is_darwint Falset patht whicht
_LooseVersiont
__grains__t __virtualname__( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt __virtual__5 s
c C@ s� | | k r | | Sxc t j | � D]R } | d j � | k rD | St j j | d � \ } } | j � | k r$ | Sq$ Wt � S( u+
Checks to see if the given service is in the given services.
:param str name: Service label, file name, or full path
:param dict services: The currently available services.
:return: The service information for the service, otherwise
an empty dictionary
:rtype: dict
u file_pathu file_name( R t
itervaluest lowert osR t splitextt dict( t namet servicest servicet basenamet ext( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt _name_in_servicesL s
c C@ s� t d � } | j � } t | | � } | r2 | Sy& t d sW t d j | � � � n Wn t k
rk n Xt d d t � } t | | � } | s� t d j | � � � n | S( u�
Get information about a service. If the service is not found, raise an
error
:param str name: Service label, file name, or full path
:return: The service information for the service, otherwise an Error
:rtype: dict
u mac_utils.available_servicesu using_cached_servicesu Service not found: {0}t refresh( t __utils__R R t __context__R t formatt KeyErrort True( R R R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt _get_servicei s
c C@ s� t | � } y | d d } Wn t k
r2 t SXt | t � r� xq t j | j d i � � D]Q \ } } | t k r� t j
j | � r� t S| t k r^ t j
j | � r^ t Sq^ Wn | t k r� t St S( uQ
Check if the service should always be running based on the KeepAlive Key
in the service plist.
:param str name: Service label, file name, or full path
:return: True if the KeepAlive key is set to True, False if set to False or
not set in the plist at all.
:rtype: bool
.. versionadded:: 2019.2.0
u plistu KeepAliveu PathState( t showR R
t
isinstanceR R t iteritemst getR! R R t exists( R t service_infot
keep_alivet _filet value( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt _always_running_service� s
( c C@ sz t | � } | d } d } d | k rG t d � } d j | � } n | t k rp d j | | d d � } n | | f S( u
Returns the domain/service target and path for a service. This is used to
determine whether or not a service should be loaded in a user space or
system space.
:param str name: Service label, file name, or full path
:param bool service_target: Whether to return a full
service target. This is needed for the enable and disable
subcommands of /bin/launchctl. Defaults to False
:return: Tuple of the domain/service target and the path to the service.
:rtype: tuple
.. versionadded:: 2019.2.0
u file_pathu systemu LaunchAgentsu mac_utils.console_useru gui/{}u {}/{}u plistu Label( R" R R R! ( R t service_targetR R t
domain_targett uid( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt _get_domain_target� s
c C@ s$ t | � d } d | k r t St S( u�
Checks to see if the provided service is a LaunchAgent
:param str name: Service label, file name, or full path
:return: True if a LaunchAgent, False if not.
:rtype: bool
.. versionadded:: 2019.2.0
u file_pathu LaunchAgents( R" R
R! ( R R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt
_launch_agent� s c C@ s
t | � S( u�
Show properties of a launchctl service
:param str name: Service label, file name, or full path
:return: The service information if the service is found
:rtype: dict
CLI Example:
.. code-block:: bash
salt '*' service.show org.cups.cupsd # service label
salt '*' service.show org.cups.cupsd.plist # file name
salt '*' service.show /System/Library/LaunchDaemons/org.cups.cupsd.plist # full path
( R" ( R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyR# � s c O@ s t d | | | � S( u�
Run a launchctl command and raise an error if it fails
:param str sub_cmd: Sub command supplied to launchctl
:param tuple args: Tuple containing additional arguments to pass to
launchctl
:param dict kwargs: Dictionary containing arguments to pass to
``cmd.run_all``
:param bool return_stdout: A keyword argument. If true return the stdout
of the launchctl command
:return: ``True`` if successful, raise ``CommandExecutionError`` if not, or
the stdout of the launchctl command if requested
:rtype: bool, str
CLI Example:
.. code-block:: bash
salt '*' service.launchctl debug org.cups.cupsd
u mac_utils.launchctl( R ( t sub_cmdt argst kwargs( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt launchctl s c C@ sx | rb t | � } | d d } | rI t | � rI t d d t � } n t d | d t d | �St d d t d | �S( u�
Run launchctl list and return the output
:param str name: The name of the service to list
:param str runas: User to run launchctl commands
:return: If a name is passed returns information about the named service,
otherwise returns a list of all services and pids
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' service.list
salt '*' service.list org.cups.cupsd
u plistu Labelu mac_utils.console_usert usernameu listt
return_stdoutt runas( R" R1 R R! R5 ( R R8 R t label( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt list_* s c C@ s) t | d t �d } t d | d | �S( u�
Enable a launchd service. Raises an error if the service fails to be enabled
:param str name: Service label, file name, or full path
:param str runas: User to run launchctl commands
:return: ``True`` if successful or if the service is already enabled
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.enable org.cups.cupsd
R- i u enableR8 ( R0 R! R5 ( R R8 R- ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt enableS s c C@ s) t | d t �d } t d | d | �S( u�
Disable a launchd service. Raises an error if the service fails to be
disabled
:param str name: Service label, file name, or full path
:param str runas: User to run launchctl commands
:return: ``True`` if successful or if the service is already disabled
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.disable org.cups.cupsd
R- i u disableR8 ( R0 R! R5 ( R R8 R- ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt disablek s c C@ s( t | � \ } } t d | | d | �S( u
Start a launchd service. Raises an error if the service fails to start
.. note::
To start a service in macOS the service must be enabled first. Use
``service.enable`` to enable the service.
:param str name: Service label, file name, or full path
:param str runas: User to run launchctl commands
:return: ``True`` if successful or if the service is already running
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.start org.cups.cupsd
u bootstrapR8 ( R0 R5 ( R R8 R. R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt start� s c C@ s( t | � \ } } t d | | d | �S( u@
Stop a launchd service. Raises an error if the service fails to stop
.. note::
Though ``service.stop`` will unload a service in macOS, the service
will start on next boot unless it is disabled. Use ``service.disable``
to disable the service
:param str name: Service label, file name, or full path
:param str runas: User to run launchctl commands
:return: ``True`` if successful or if the service is already stopped
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.stop org.cups.cupsd
u bootoutR8 ( R0 R5 ( R R8 R. R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt stop� s c C@ s3 t | � r t | d | �n t | d | �t S( uj
Unloads and reloads a launchd service. Raises an error if the service
fails to reload
:param str name: Service label, file name, or full path
:param str runas: User to run launchctl commands
:return: ``True`` if successful
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.restart org.cups.cupsd
R8 ( t enabledR> R= R! ( R R8 ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt restart� s c C@ s4 | r t d | � Sy t | � Wn! t k
rE } t j | � d SX| ro t | � ro t d d t � } n t d | � } d } x� | j � D]w } d | k r� q� n t
j | | j � d � r� | j � d j
� r| r� | d 7} n | | j � d 7} qq� q� Wt | � r0t | � r0| r0d
S| S( uO
Return the status for a service.
:param str name: Used to find the service from launchctl. Can be any part
of the service name or a regex expression.
:param str sig: Find the service with status.pid instead. Note that
``name`` must still be provided.
:param str runas: User to run launchctl commands
:return: The PID for the service if it is running, or 'loaded' if the
service should not always have a PID, or otherwise an empty string
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' service.status cups
u
status.pidu u mac_utils.console_userR6 R8 u PIDi����i u
u loaded( t __salt__R" R t logt errorR1 R R! R: t
splitlinest ret searcht splitt isdigitR, R? ( R t sigR8 t msgt outputt pidst line( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt status� s,
c C@ s+ y t | � t SWn t k
r& t SXd S( u
Check that the given service is available.
:param str name: The name of the service
:return: True if the service is available, otherwise False
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.available com.openssh.sshd
N( R" R! R R
( R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt available s
c C@ s t | � S( u?
The inverse of service.available
Check that the given service is not available.
:param str name: The name of the service
:return: True if the service is not available, otherwise False
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.missing com.openssh.sshd
( RO ( R ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt missing( s c C@ s4 y t d | d | � t SWn t k
r/ t SXd S( uU
Check if the specified service is enabled
:param str name: The name of the service to look up
:param str runas: User to run launchctl commands
:return: True if the specified service enabled, otherwise False
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.enabled org.cups.cupsd
R R8 N( R: R! R R
( R R8 ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyR? ; s
u systemc C@ s� t d | d t d | �} x� | j d � D]q } | | k r+ | j d � d j d � d } | j d � d } | | k r q� d | j � k r� t St Sq+ q+ Wt S(
u�
Check if the specified service is not enabled. This is the opposite of
``service.enabled``
:param str name: The name to look up
:param str runas: User to run launchctl commands
:param str domain: domain to check for disabled services. Default is system.
:return: True if the specified service is NOT enabled, otherwise False
:rtype: bool
CLI Example:
.. code-block:: bash
salt '*' service.disabled org.cups.cupsd
u print-disabledR7 R8 u
u =>i u "i u true( R5 R! RG R R
( R R8 t domaint disabledR t srv_nameRN ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyRR T s !c C@ s< t d | � } t t d � j � � } t t | | � � S( uD
Return a list of services that are enabled or available. Can be used to
find the name of a service.
:param str runas: User to run launchctl commands
:return: A list of all the services available or enabled
:rtype: list
CLI Example:
.. code-block:: bash
salt '*' service.get_all
R8 u mac_utils.available_services( t get_enabledt listR t keyst sortedt set( R8 R? RO ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt get_ally s c C@ s� t d | � } g | j � D] } | ^ q } g } xH | D]@ } | j d � rV q; n | j d � \ } } } | j | � q; Wt t | � � S( u@
Return a list of all services that are enabled. Can be used to find the
name of a service.
:param str runas: User to run launchctl commands
:return: A list of all the services enabled on the system
:rtype: list
CLI Example:
.. code-block:: bash
salt '*' service.get_enabled
R8 u PIDu ( R: RD t
startswithRG t appendRW RX ( R8 t stdoutRM t
service_linesR? t pidRN R9 ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyRT � s
(0 t __doc__t
__future__R R R t loggingR RE t salt.utils.filesR t salt.utils.patht salt.utils.platformt salt.utils.stringutilst salt.exceptionsR t salt.utils.versionsR R
t salt.extR R t __func_alias__t getLoggert __name__RB R R R" R, R
R0 R1 R# R5 t NoneR: R; R< R= R> R@ RN RO RP R? RR RY RT ( ( ( s< /usr/lib/python2.7/site-packages/salt/modules/mac_service.pyt <module> sH
+ ( ) ) ; %
Mini Shell