
    -_g9                     J    d dl Z d dlZd dlmZ  G d d      Z G d de      Zy)    N)sos_get_command_outputc                       e Zd ZdZdZdZdZdZdZdZ	dZ
ddZed        Zed        Z	 	 ddZd ZddZd	 Zd
 Zd Zd Zd Zd Zd Zy)PackageManagerau  Encapsulates a package manager. If you provide a query_command to the
    constructor it should print each package on the system in the following
    format::

        package name|package.version

    You may also subclass this class and provide a _generate_pkg_list method to
    build the list of packages and versions.

    :cvar query_command: The command to use for querying packages
    :vartype query_command: ``str`` or ``None``

    :cvar verify_command: The command to use for verifying packages
    :vartype verify_command: ``str`` or ``None``

    :cvar verify_filter: Optional filter to use for controlling package
                         verification
    :vartype verify_filter: ``str or ``None``

    :cvar files_command: The command to use for getting file lists for packages
    :vartype files_command: ``str`` or ``None``

    :cvar chroot: Perform a chroot when executing `files_command`
    :vartype chroot: ``bool``

    :cvar remote_exec: If package manager is on a remote system (e.g. for
                       sos collect), use this to execute commands
    :vartype remote_exec: ``SoSTransport.run_command()``
    Nc                 B    d | _         g | _        || _        |r|| _        y y N)	_packagesfilesremote_execchroot)selfr   r
   s      H/usr/lib/python3/dist-packages/sos/policies/package_managers/__init__.py__init__zPackageManager.__init__8   s'    
& DK     c                 R    | j                   | j                          | j                   S r   )r   _generate_pkg_listr   s    r   packageszPackageManager.packages@   s"    >>!##%~~r   c                 r    | j                   j                  j                         j                  dd      d   S )Npackage   )maxsplitr   )	__class____name__lowersplitr   s    r   manager_namezPackageManager.manager_nameF   s0    ~~&&,,.44Y4KANNr   c                     | j                   r| j                  |||||      }nt        ||||      }|d   dk(  r|d   S y)a
  
        Runs a package manager command, either via sos_get_command_output() if
        local, or via a SoSTransport's run_command() if this needs to be run
        remotely, as in the case of remote nodes for use during `sos collect`.

        :param command:     The command to execute
        :type command:      ``str``

        :param timeout:     Timeout for command to run, in seconds
        :type timeout:      ``int``

        :param need_root:   Does the command require root privileges?
        :type need_root:    ``bool``

        :param env:         Environment variables to set
        :type env:          ``dict`` with keys being env vars to define

        :param use_shell:   If running remotely, does the command require
                            obtaining a shell?
        :type use_shell:      ``bool``

        :param chroot:      If necessary, chroot command execution to here
        :type chroot:       ``None`` or ``str``

        :returns:   The output of the command
        :rtype:     ``str``
        )r   envstatusr   output )r
   r   )r   commandtimeout	need_rootr   	use_shellr   rets           r   exec_cmdzPackageManager.exec_cmdJ   sS    : ""7GYYOC('&-02Cx=Ax=  r   c                 ^    t        j                  | j                  j                         |      S )z
        Get a list of packages that match name.

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

        :returns: List of all packages matching `name`
        :rtype: ``list``
        )fnmatchfilterr   keysr   names     r   all_pkgs_by_namezPackageManager.all_pkgs_by_names   s"     ~~dmm002D99r   c                     t        j                  ||      }| j                  D cg c]  }|j                  |      s| c}S c c}w )aL  
        Get a list of packages that match regex_name.

        :param regex_name: The regex to use for matching package names against
        :type regex_name: ``str``

        :param flags: Flags for the `re` module when matching `regex_name`

        :returns: All packages matching `regex_name`
        :rtype: ``list``
        )recompiler   match)r   
regex_nameflagsregpkgs        r   all_pkgs_by_name_regexz%PackageManager.all_pkgs_by_name_regex   s6     jjU+#}}?		#???s
   AAc                 @    	 | j                   |   S # t        $ r Y yw xY w)z
        Get a single package that matches name.

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

        :returns: The first package that matches `name`
        :rtype: ``str``
        N)r   	Exceptionr,   s     r   pkg_by_namezPackageManager.pkg_by_name   s(    	==&& 		s    	c                     t         a+  
        Using the output of `query_command`, build the _packages dict.

        This should be overridden by distinct package managers and be a
        generator for _generate_pkg_list which will insert the packages into
        the _packages dict.

        This method should yield a tuple of name, version, release for each
        package parsed. If the package manager or distribution does not use a
        release field, set it to None.

        :param pkg_list: The output of the result of `query_command`
        :type pkg_list:  ``str``
        NotImplementedErrorr   pkg_lists     r   _parse_pkg_listzPackageManager._parse_pkg_list   
     "!r   c                 6   | j                   i | _         | j                  rz| j                  }| j                  |d| j                        }| j	                  |      D ];  }|d   |d   j                  d      |d   | j                  d| j                   |d   <   = yy)	am  Generates a dictionary of packages for internal use by the package
        manager in the format::

            {'package_name': {'name': 'package_name',
                              'version': 'major.minor.version',
                              'release': 'package release' or None,
                              'pkg_manager': 'package manager name'}}

        N   r#   r   r   r   .   )r-   versionreleasepkg_manager)r   query_commandr'   r   rA   r   r   )r   cmdr@   r6   s       r   r   z!PackageManager._generate_pkg_list   s     >>!DN$$C}}S"T[[}IH++H5 F"1v||C0"1v#'#4#4	*s1v&	 r   c                 >    || j                   v r| j                   |   S y)zReturns the entry in self.packages for pkg if it exists

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

        :returns: Package name and version, if package exists
        :rtype: ``dict`` if found, else ``None``
        N)r   )r   r6   s     r   pkg_versionzPackageManager.pkg_version   s"     $--==%%r   c                     | j                   rK| j                  s?| j                   }| j                  |d| j                        }|j	                         | _        | j                  S )z
        Get a list of files known by the package manager

        :returns: All files known by the package manager
        :rtype: ``list``
           rE   )files_commandr	   r'   r   
splitlines)r   rL   r	   s      r   	all_fileszPackageManager.all_files   sP     djj$$CMM#s4;;MGE))+DJzzr   c                     | j                   sy	 | j                    d| }| j                  |d| j                        }|j                         xs dS # t        $ r Y yw xY w)zGiven a path, return the package that owns that path.

        :param path:    The filepath to check for package ownership
        :type path:     ``str``

        :returns:       The package name or 'unknown'
        :rtype:         ``str``
        unknown    rE   )query_path_commandr'   r   rR   r9   )r   pathrL   r6   s       r   pkg_by_pathzPackageManager.pkg_by_path   sh     &&	,,-Qtf5C--Qt{{-CC>>#0y0 		s   AA 	AAc                    | j                   sy| j                  }t        dt        ||            }|syd}|D ]4  }|D ]-  t	        fd| j
                  D              r"|r|dz  }|z  }/ 6 | j                   dz   |z   S )a  build_verify_command(self, packages) -> str
            Generate a command to verify the list of packages given
            in ``packages`` using the native package manager's
            verification tool.

            The command to be executed is returned as a string that
            may be passed to a command execution routine (for e.g.
            ``sos_get_command_output()``.

            :param packages: a string, or a list of strings giving
                             package names to be verified.
            :returns: a string containing an executable command
                      that will perform verification of the given
                      packages.
            :rtype: str or ``NoneType``
        Nr!   c              3   &   K   | ]  }|v  
 y wr    ).0fr   s     r   	<genexpr>z6PackageManager.build_verify_command.<locals>.<genexpr>  s     @qG|@s   rV   )verify_commandr7   r*   mapanyverify_filter)r   r   by_regexverify_listverify_packagespackage_listr   s         @r   build_verify_commandz#PackageManager.build_verify_command   s    " "" ..T3x#:; ' 	+L' +@T-?-?@@"#s*O7*+	+ ""S(?::r   NN)rD   FNFN)r   )r   
__module____qualname____doc__rK   ra   rd   rQ   rX   r   r	   r   propertyr   r   r'   r.   r7   r:   rA   r   rN   rS   rZ   ri   r]   r   r   r   r      s    < MNMMFE!  
 O O BF)-'R
:@""2$';r   r   c                   F     e Zd ZdZd fd	Zd Zd Zd Zd Z fdZ	 xZ
S )	MultiPackageManagera  
    This class is used to leverage multiple individual package managers as a
    single entity on systems that support multiple concurrent package managers.

    Policies that use this approach will need to specify a primary package
    manager, and at least one fallback manager. When queries are sent to this
    manager, the primary child manager is checked first. If there is a valid,
    not None, response (e.g. a given package is installed) then that response
    is used. However, if the response is empty or None, the fallback managers
    are then queried in the order they were passed to MultiPackageManager
    during initialization.

    :param primary: The primary package manager to rely on
    :type primary:  A subclass of `PackageManager`

    :param fallbacks: A list of package managers to use if the primary does not
                      provide a response
    :type fallbacks: ``list`` of `PackageManager` subclasses
    c                 
   t         |   ||       t        |t              st	        d|j
                         t        |t              st	        d      |D ]*  }t        |t              rt	        d|j
                           |||      | _        |D cg c]  } |||       c}| _	        | j                  st	        d      | j                  g| _
        | j                  j                  | j                         y c c}w )N)r   r
   z=Primary package manager must be PackageManager subclass, not z%Fallbacks must be specified in a listz?Fallback package managers must be PackageManager subclass, not z1Must define at least one fallback package manager)superr   
issubclassr   r9   r   
isinstancelistprimary	fallbacks	_managersextend)r   rv   rw   r   r
   pmr   s         r   r   zMultiPackageManager.__init__2  s   K@'>2%%&( 
 )T*CDD 	Bb.1%%'\\N4 	 f+FAJ
;=Bf+6
 ~~C  ,,dnn-
s   D c                     t         r<   r=   r?   s     r   rA   z#MultiPackageManager._parse_pkg_listR  rB   r   c                     | j                   s:| j                  D ]+  }| j                   j                  |j                                - | j                   S r   )r	   rx   ry   rS   )r   rz   s     r   rS   zMultiPackageManager.all_filesc  s>    zznn 2

!!",,.12zzr   c                 .   | j                   i | _         | j                   j                  | j                  j                         | j                  D ]D  }|j                  }|j                         D ]#  }|| j                   vs||   | j                   |<   % F y r   )r   updaterv   r   rw   r+   )r   rz   _pkgsr6   s       r   r   z&MultiPackageManager._generate_pkg_listi  s~    >>!DNdll334.. 	5BKKEzz| 5dnn,*/*DNN3'5	5r   c                       fd}|S )aJ  
        This wrapper method is used to provide implicit iteration through the
        primary and any defined fallback managers that are set for a given
        instance of MultiPackageManager.

        Important note: we pass the _name_ of the method to run here as a
        string, and not any actual method as we rely on iteratively looking up
        the actual method in each package manager.

        :param method: The name of the method we're wrapping for the purpose of
                       iterating through defined package managers
        :type method:  ``str``
        c                  f    d }j                   D ]  }|r|dk(  st        |      } || i |}  |S )NrU   )rx   getattr)argskwargsr&   rz   _wrapped_funcmethodr   s        r   pkg_funcz1MultiPackageManager._pm_wrapper.<locals>.pkg_func  sG    Cnn 9cY.$+B$7M'88C9 Jr   r]   )r   r   r   s   `` r   _pm_wrapperzMultiPackageManager._pm_wrappert  s    	 r   c                     |dv rt         |   |      S t         |   |      }t        |d      r| j                  |      S |S )N)r   r   rS   __call__)rr   __getattribute__hasattrr   )r   itemattrr   s      r   r   z$MultiPackageManager.__getattribute__  sM     EE7+D11w'-4$##D))r   rj   )r   rk   rl   rm   r   rA   rS   r   r   r   __classcell__)r   s   @r   rp   rp     s,    (.@""	5. r   rp   )r0   r)   sos.utilitiesr   r   rp   r]   r   r   <module>r      s+    
  0I; I;Xy. yr   