Current File : //usr/lib/python2.7/site-packages/salt/utils/win_functions.pyo
�
���^c @@ sg 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 m Z d d l
m Z yb 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 m Z m Z e Z Wn e k
r� e Z n Xd � Z d � Z d � Z e d
� Z d � Z e d � Z d
� Z d � Z e d � Z! d � Z" d d � Z# d � Z$ d � Z% d S( up
Various functions to be used by windows during start up and to monkey patch
missing functions in other modules
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionError( t range( t HWND_BROADCASTt WM_SETTINGCHANGEt SMTO_ABORTIFHUNGc C@ s t s t d f Sd S( u4
Only load if Win32 Libraries are installed
u This utility requires pywin32u
win_functions( t HAS_WIN32t False( ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt __virtual__ s
c C@ s t j � j � S( u�
This is a monkey patch for os.getppid. Used in:
- salt.utils.parsers
Returns:
int: The parent process id
( t psutilt Processt ppid( ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt get_parent_pid( s c C@ s4 t | t � } x | D] } | d k r t Sq Wt S( u�
Is the passed user a member of the Administrators group
Args:
name (str): The name to check
Returns:
bool: True if user is a member of the Administrators group, False
otherwise
u S-1-5-32-544u S-1-5-18( u S-1-5-32-544u S-1-5-18( t get_user_groupst TrueR ( t namet groupst group( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt is_admin3 s
c C@ se | d k r | g } n t j d | � } | s4 | St � } x! | D] } | j t | � � qD W| S( u
Get the groups to which a user belongs
Args:
name (str): The user name to query
sid (bool): True will return a list of SIDs, False will return a list of
group names
Returns:
list: A list of group names or sids
u SYSTEMN( t win32nett NetUserGetLocalGroupst Nonet sett addt get_sid_from_name( R t sidR t
ret_groupsR ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyR G s
c C@ sm | d k r d } n y t j d | � d } Wn. t j k
r_ } t d j | | � � � n Xt j | � S( u�
This is a tool for getting a sid from a name. The name can be any object.
Usually a user or a group
Args:
name (str): The name of the user or group for which to get the sid
Returns:
str: The corresponding SID
u NULL SIDi u User {0} not found: {1}N( R t
win32securityt LookupAccountNamet
pywintypest errorR t formatt ConvertSidToStringSid( R R t exc( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyR c s c C@ s� yz t j t j � } | d d k rd t j � } | d k rF d } qy t | � d k ry d } qy n | sy t j � } n Wn+ t j k
r� } t d j | � � � n X| s� t S| S( u�
Gets the user executing the process
Args:
with_domain (bool):
``True`` will prepend the user name with the machine name or domain
separated by a backslash
Returns:
str: The user name
i����u $u SYSTEMu S-1-5-18u Failed to get current user: {0}(
t win32apit
GetUserNameExt NameSamCompatiblet GetUserNameR R R R R! R ( t with_domaint user_namet test_userR# ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt get_current_user{ s
c C@ s y t j d | � d } Wn4 t j k
rP d j t j � d j � | g � SXt j d | � \ } } } d j | | g � S( u�
Gets the SAM name for a user. It basically prefixes a username without a
backslash with the computer name. If the user does not exist, a SAM
compatible name will be returned using the local hostname as the domain.
i.e. salt.utils.get_same_name('Administrator') would return 'DOMAIN.COM\Administrator'
.. note:: Long computer names are truncated to 15 characters
i u \i N(
R R R R R t joint platformt nodet uppert LookupAccountSid( t usernamet sid_objt domaint _( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt get_sam_name� s
$c @ s, t r( d � t j � f d � d � n d S( Ni c @ s | � k r t St S( N( R R ( t event( t ctrl_logoff_event( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt <lambda>� s i ( R R$ t SetConsoleCtrlHandler( ( ( R7 s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt enable_ctrl_logoff_handler� s
c C@ sJ | s t j d | � r6 d | j d d � d } n | s@ | St | � S( u�
Escape the argument for the cmd.exe shell.
See http://blogs.msdn.com/b/twistylittlepassagesallalike/archive/2011/04/23/everyone-quotes-arguments-the-wrong-way.aspx
First we escape the quote chars to produce a argument suitable for
CommandLineToArgvW. We don't need to do this for simple arguments.
Args:
arg (str): a single command line argument to escape for the cmd.exe shell
Kwargs:
escape (bool): True will call the escape_for_cmd_exe() function
which escapes the characters '()%!^"<>&|'. False
will not call the function and only quotes the cmd
Returns:
str: an escaped string suitable to be passed as a program argument to the cmd.exe shell
u (["\s])u "u \"( t ret searcht replacet escape_for_cmd_exe( t argt escape( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt escape_argument� s
c @ se d } t j d d j d � t | � D� � d � } d � | D� � � f d � } | j | | � S( ug
Escape an argument string to be suitable to be passed to
cmd.exe on Windows
This method takes an argument that is expected to already be properly
escaped for the receiving program to be properly parsed. This argument
will be further escaped to pass the interpolation performed by cmd.exe
unchanged.
Any meta-characters will be escaped, removing the ability to e.g. use
redirects or variables.
Args:
arg (str): a single command line argument to escape for cmd.exe
Returns:
str: an escaped string suitable to be passed as a program argument to cmd.exe
u
()%!^"<>&|u (u |c s@ s | ] } t j | � Vq d S( N( R; R@ ( t .0t char( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pys <genexpr>� s u )c S@ s" i | ] } d j | � | � q S( u ^{0}( R! ( RB RC ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pys
<dictcomp>� s c @ s | j d � } � | S( Ni ( R ( t mRC ( t meta_map( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt escape_meta_chars� s ( R; t compileR, t listt sub( R? t
meta_charst meta_reRF ( ( RE s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyR> � s
0u Environmentc C@ sO t j | � } t j d d t �} | j t t d | t d d � } | d k S( u
Send a WM_SETTINGCHANGE Broadcast to all Windows
Args:
message (str):
A string value representing the portion of the system that has been
updated and needs to be refreshed. Default is ``Environment``. These
are some common values:
- "Environment" : to effect a change in the environment variables
- "intl" : to effect a change in locale settings
- "Policy" : to effect a change in Group Policy Settings
- a leaf node in the registry
- the name of a section in the ``Win.ini`` file
See lParam within msdn docs for
`WM_SETTINGCHANGE <https://msdn.microsoft.com/en-us/library/ms725497%28VS.85%29.aspx>`_
for more information on Broadcasting Messages.
See GWL_WNDPROC within msdn docs for
`SetWindowLong <https://msdn.microsoft.com/en-us/library/windows/desktop/ms633591(v=vs.85).aspx>`_
for information on how to retrieve those messages.
.. note::
This will only affect new processes that aren't launched by services. To
apply changes to the path or registry to services, the host must be
restarted. The ``salt-minion``, if running as a service, will not see
changes to the environment until the system is restarted. Services
inherit their environment from ``services.exe`` which does not respond
to messaging events. See
`MSDN Documentation <https://support.microsoft.com/en-us/help/821761/changes-that-you-make-to-environment-variables-do-not-affect-services>`_
for more information.
CLI Example:
... code-block:: python
import salt.utils.win_functions
salt.utils.win_functions.broadcast_setting_change('Environment')
u user32t use_last_errori i� i ( t ctypest create_unicode_buffert WinDLLR t SendMessageTimeoutWR R R ( t messaget broadcast_messaget user32t result( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt broadcast_setting_change� s = c C@ sq t j d � } | j | � } d } | d k rm x: t d d � D]& } | | j | � d d d � 7} q@ Wn | S( u�
Converts a GUID to a compressed guid (SQUID)
Each Guid has 5 parts separated by '-'. For the first three each one will be
totally reversed, and for the remaining two each one will be reversed by
every other character. Then the final compressed Guid will be constructed by
concatenating all the reversed parts without '-'.
.. Example::
Input: 2BE0FA87-5B36-43CF-95C8-C68D6673FB94
Reversed: 78AF0EB2-63B5-FC34-598C-6CD86637BF49
Final Compressed Guid: 78AF0EB263B5FC34598C6CD86637BF49
Args:
guid (str): A valid GUID
Returns:
str: A valid compressed GUID (SQUID)
uO ^\{(\w{8})-(\w{4})-(\w{4})-(\w\w)(\w\w)-(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)\}$u i i Ni����( R; RG t matchR R R ( t guidt guid_patternt
guid_matcht squidt index( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt
guid_to_squid7 s 'c C@ s t j d � } | j | � } d } | d k rd | j d � d d d � d | j d � d d d � d | j d � d d d � d | j d
� d d d � | j d � d d d � d } x7 t d d
� D]& } | | j | � d d d � 7} q� W| d 7} n | S( u�
Converts a compressed GUID (SQUID) back into a GUID
Args:
squid (str): A valid compressed GUID
Returns:
str: A valid GUID
uG ^(\w{8})(\w{4})(\w{4})(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)(\w\w)$u u {i Ni����u -i i i i i i u }( R; RG RV R R R ( RZ t
squid_patternt squid_matchRW R[ ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt
squid_to_guidV s �$
(& t __doc__t
__future__R R R R- R; RM t salt.exceptionsR t salt.ext.six.movesR R R R$ R R t win32conR R R R R t ImportErrorR R
R R R R R+ R5 R: RA R> RU R\ R_ ( ( ( s< /usr/lib/python2.7/site-packages/salt/utils/win_functions.pyt <module> s:
# E
Mini Shell