Current File : //proc/self/root/lib/python2.7/site-packages/sos/plugins/__init__.pyo
�
u��ec @� se d Z d d l m Z d d l m Z m Z m Z 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 m Z d d l Z d d l Z d d l Z d d l Z d d l m Z m Z d d l m Z y e Wn e k
r� e Z n Xd � Z d � Z d
� Z d � Z d � Z d
� Z e j d e j! � Z" d Z# d e$ f d � � YZ% d e$ f d � � YZ& d e$ f d � � YZ' d e$ f d � � YZ( d e( f d � � YZ) d e( f d � � YZ* d e( f d � � YZ+ d e$ f d � � YZ, d e$ f d! � � YZ- d" e$ f d# � � YZ. d$ e$ f d% � � YZ/ d& e$ f d' � � YZ0 e1 d( � Z2 d S() s; This exports methods available for use by plugins for sos i����( t with_statement( t sos_get_command_outputt
import_modulet grept fileobjt tailt
is_executableN( t time( t zipt filter( t datetimec C� sD t | t j � s@ | j d � r. | d 7} n t j | � } n | S( Ns \t ( t
isinstancet sixt text_typet endswitht u( t s( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _to_u& s
c C� sN y5 t | � �# } t j | | j � t j � SWd QXWn t k
rI g SXd S( s= Return a list of all non overlapping matches in the string(s)N( R t ret findallt readt MULTILINEt AttributeError( t regext fnamet f( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
regex_findall1 s
&
c C� sY t j d d | � } t j d d | � } t j d d | � j d � } | d | !} | S( Ns ^/(usr/|)(bin|sbin)/t s [^\w\-\.\/]+t _t /t .s ._-i ( R t subt strip( t commandt name_maxt mangledname( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _mangle_command: s
c � s t � f d � | D� � S( Nc 3� s | ] } | � k Vq d S( N( ( t .0t p( t path( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>C s ( t any( R( t path_list( ( R( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _path_in_path_listB s c C� sf t j d f t j d f t j d f t j d f g } x) | D]! } | d | j � r= | d Sq= Wd S( s� return a string indicating the type of special node represented by
the stat buffer st (block, character, fifo, socket).
s block devices character devices
named pipet socketi i N( t statt S_ISBLKt S_ISCHRt S_ISFIFOt S_ISSOCKt st_mode( t stt _typest t( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_node_typeF s
c C� s
| j d � S( s� Check if a file appears to be compressed
Return True if the file specified by path appears to be compressed,
or False otherwise by testing the file name extension against a
list of known file compression extentions.
s .gzs .xzs .bzs .bz2( s .gzs .xzs .bzs .bz2( R ( R( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _file_is_compressedU s s -*BEGIN.*?-*ENDs
-----SCRUBBEDt SoSPredicatec B� s� e Z d Z d Z e Z g Z g Z g Z g Z
g Z e d d d � Z d � Z
d � Z d � Z d � Z d � Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d � Z e g g g g g i d � Z RS( s� A class to implement collection predicates.
A predicate gates the collection of data by an sos plugin. For any
`add_cmd_output()`, `add_copy_spec()` or `add_journal()` call, the
passed predicate will be evaulated and collection will proceed if
the result is `True`, and not otherwise.
Predicates may be used to control conditional data collection
without the need for explicit conditional blocks in plugins.
R c C� s� d } d | j } | j } | r? g | D] } | | ^ q) n | } | d d j | � 7} | j } | r� g | D] } | | ^ qr n | } | d d j | � 7} | j }
| r� g |
D] } | | ^ q� n |
}
| d d j |
� 7} g | j D]4 } d | d | | d | d | | d f ^ q� }
| d
d j |
� 7} | j } | rug | D] } | | ^ q_n | } | d d j | � 7} | | | S( sx Return a string representation of this SoSPredicate with
optional prefix, suffix and value quoting.
s "%s"s dry_run=%s, s kmods=[%s], t ,s services=[%s], s packages=[%s], s { %s: %s, %s: %s }t cmdt outputs cmdoutputs=[%s], s arches=[%s]( t dry_runt kmodst joint servicest packagest cmd_outputst arch( t selft quotet prefixt suffixt quotest pstrR= t kR? R t pkgsR' t cmdoutputt
cmdoutputst archest a( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt __str� s$
) ) )A )c C� s
| j � S( s� Return a string representation of this SoSPredicate.
"dry_run=False, kmods=[], services=[], cmdoutputs=[]"
( t _SoSPredicate__str( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt __str__� s c C� s | j d t d d d d � S( s� Return a machine readable string representation of this
SoSPredicate.
"SoSPredicate(dry_run=False, kmods=[], services=[], cmdoutputs=[])"
RD RE s
SoSPredicate(RF t )( RP t True( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt __repr__� s c C� sG | d k r t | � S| d k r, t | � S| d k rC t | � Sd S( s� Helper to simplify checking the state of the predicate's evaluations
against the setting of the required state of that evaluation
R) t allt noneN( R) RU ( RC t itemst required( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _check_required_state� s
c C� sH | j | } | d k r0 | j | j | � n | j | j | � d S( s� Helper to direct failed predicates to provide the proper messaging
based on the required check type
:param test: The type of check we're doing, e.g. kmods, arch
:param item: The string of what failed
RV N( RX t _failedt appendt
_forbidden( RC t testt itemt _req( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _failed_or_forbidden� s
c C� s� | j s | j j d � r t Sg } xI | j D]> } | j j | � } | j | � | s0 | j d | � q0 q0 W| j | | j d � S( Nt allow_system_changesR= ( R= t _ownert
get_optionRS t is_module_loadedR[ R` RY RX ( RC t _kmodst kmodt res( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _eval_kmods� s
c C� sv | j s
t Sg } xI | j D]> } | j j | � } | j | � | s | j d | � q q W| j | | j d � S( NR? ( R? RS Rb t is_service_runningR[ R` RY RX ( RC t _svcst svcRg ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _eval_services� s
c C� sv | j s
t Sg } xI | j D]> } | j j | � } | j | � | s | j d | � q q W| j | | j d � S( NR@ ( R@ RS Rb t is_installedR[ R` RY RX ( RC t _pkgst pkgRg ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _eval_packages� s
c C� ss d | k s d | k r t St | d � } | d d k r@ t Sx, | d j � D] } | d | k rQ t SqQ Wt S( s* Does 'cmd' output contain string 'output'?R: R; t statusi ( t FalseR t
splitlinesRS ( RC t
cmd_outputt resultt line( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _eval_cmd_output� s c C� s� | j s
t Sg } xX | j D]M } | j | � } | j | � | s | j d d | d | d f � q q W| j | | j d � S( NRA s %s: %sR: R; ( RA RS Rw R[ R` RY RX ( RC t _cmdsR: Rg ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _eval_cmd_outputs s
c C� s� | j s
t S| j j j � } d d j | j � } | j d d k rv t j | | � rr | j d j
| � t St St j | | � r� t S| j d j
| � t S( Ns (?:%s)t |RB RV t architecture(
RB RS Rb t policyt get_archR> RX R t matchR\ R[ Rr RZ ( RC t _archR ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_eval_arch s c C� so d } d } x\ | j j � D]K \ } } | s4 q n t | � } | | | d j d � | D� � f 7} q W| S( s\ Return a string informing user what caused the predicate to fail
evaluation
R s required %s missing: %s.s , c s� s | ] } | Vq d S( N( ( R& t v( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>, s ( RZ RW t setR> ( RC t msgt _substrt keyt val( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _report_failed" s +c C� so d } d } x\ | j j � D]K \ } } | s4 q n t | � } | | | d j d � | D� � f 7} q W| S( sx Return a string informing the user that a forbidden condition exists
which caused the predicate to fail
R s forbidden %s '%s' found.s , c s� s | ] } | Vq d S( N( ( R& R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>9 s ( R\ RW R� R> ( RC R� R� R� R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _report_forbidden/ s +c C� s+ | j � | j � g } d j | � j � S( s} Used by `Plugin()` to obtain the error string based on if the reason
was a failed check or a forbidden check
R ( R� R� R> t lstrip( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt report_failure< s c C� sx t | j | j | j | j | j | j g � s4 t S| j � ow | j � ow | j
� ow | j � ow | j � ow | j S( s# Predicate evaluation hook.
(
R) R= R? R@ RA RB R< RS Rh Rl Rp Ry R� ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt __nonzero__C s c C� s
| j � S( N( R� ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt __bool__Q s c � s4 | � _ t | � � _ t | � � _ t | � � _ t | � � _ t | t � s` | g } n | � _ | � j j d j B� _ i d d 6d d 6d d 6d d 6d d 6� _
� j
j � � f d � � j � D� � i g d 6g d 6g d 6g d 6g d 6� _
i g d 6g d 6g d 6g d 6g d 6� _ d
S( s. Initialise a new SoSPredicate object.
t cmdlineoptsR) R= R? R@ RA RB c � s6 i | ], \ } } � | � j | k r | | � q S( ( RX ( R& RI R� ( RX RC ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys
<dictcomp>f s R{ N( Rb t listR= R? R@ RB R RA t commonsR< RX t updateRW RZ R\ ( RC t ownerR< R= R? R@ RA RB RX ( ( RX RC s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt __init__V s&
N( t __name__t
__module__t __doc__t NoneRb Rr R< R= R? R@ RA RB RP RQ RT RY R` Rh Rl Rp Rw Ry R� R� R� R� R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR8 c s4
"
t
SoSCommandc B� s e Z d Z d � Z d � Z RS( s� A class to represent a command to be collected.
A SoSCommand() object is instantiated for each command handed to an
_add_cmd_output() call, so that we no longer need to pass around a very
long tuple to handle the parameters.
Any option supported by _add_cmd_output() is passed to the SoSCommand
object and converted to an attribute. SoSCommand.__dict__ is then passed to
_get_command_output_now() for each command to be collected.
c K� s | j j | � d S( N( t __dict__R� ( RC t kwargs( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s c C� s& d j d � t | j j � � D� � S( sI Return a human readable string representation of this SoSCommand
s , c s� s% | ] \ } } d | | f Vq d S( s %s=%rN( ( R& t paramR� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>� s ( R> t sortedR� RW ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRQ � s ( R� R� R� R� RQ ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� t s
t Pluginc B� s7 e Z d Z dZ Z e Z d Z d[ Z d\ Z d] Z
d^ Z d_ Z dZ Z
dZ Z d` Z d Z d Z d Z e Z dZ Z dZ Z da d d d e f g Z d
� Z e d � � Z d � Z e d
� � Z d � Z d � Z d � Z d � Z! d � Z" d � Z# d � Z$ d � Z% d � Z& d � Z' d � Z( d � Z) d � Z* d � Z+ d � Z, d � Z- d � Z. d � Z/ e dZ d � Z0 e dZ d! � Z1 e e e d" � Z2 d# d$ � Z3 d% � Z4 d# d& � Z5 d' � Z6 d( � Z7 d) � Z8 d* � Z9 d+ � Z: d, � Z; d- � Z< d. � Z= dZ d/ � Z> d0 � Z? d1 � Z@ d2 � ZA d3 d4 � ZB d5 dZ d6 � ZC d7 � ZD dZ dZ e dZ d8 � ZE d9 � ZF dZ dZ e e e dZ dZ e dZ dZ dZ e e d: �
ZG dZ e d; � ZH d< � ZI d= � ZJ dZ d> � ZK d? � ZL dZ d@ � ZM dZ e e e e dZ dZ e dZ dZ e e dA � ZN dZ e e e e dZ dZ e dZ dZ dZ dB � ZO e e e dZ dZ e dZ e dC � ZP dD � ZQ dE � ZR dF � ZS dG � ZT dZ dZ dZ dZ dZ e dZ e dZ dZ dZ dZ dH � ZU e dI � ZV dJ � ZW dK � ZX dL � ZY dM � ZZ dN � Z[ dO � Z\ dP � Z] dQ � Z^ dR � Z_ dS � Z` dT � Za dU � Zb dV � Zc dW � Zd dX � Ze dY � Zf RS(b sA This is the base class for sosreport plugins. Plugins should subclass
this and set the class variables where applicable.
plugin_name is a string returned by plugin.name(). If this is set to None
(the default) class\_.__name__.tolower() will be returned. Be sure to set
this if you are defining multiple plugins that do the same thing on
different platforms.
requires_root is a boolean that specifies whether or not sosreport should
execute this plugin as a super user.
version is a string representing the version of the plugin. This can be
useful for post-collection tooling.
packages (files) is an iterable of the names of packages (the paths
of files) to check for before running this plugin. If any of these packages
or files is found on the system, the default implementation of
check_enabled will return True.
profiles is an iterable of profile names that this plugin belongs to.
Whenever any of the profiles is selected on the command line the plugin
will be enabled (subject to normal check_enabled tests).
t unversionedR i, t timeouts Timeout in seconds for plugint fasti����t postprocs, Enable post-processing collected plugin datac C� s[ t | d t � s g | _ n g | _ g | _ t � | _ g | _ d | _ g | _ g | _
| | _ g | _ t � | _
g | _ g | _ | d | _ | d | _ d | j k r� | j d n t j d � | _ | j j | j � xV | j D]K } | j j | d � | j
j i | d d 6| d
d 6| d d
6� q� W| j t | � � d S( Nt option_listR t sysrootR| t soslogt sosi i t desci t speedi t enabled( t getattrRr R� t copied_filest executed_commandsR� t _env_varst alertst custom_textt opt_namest opt_parmsR� t forbidden_pathst
copy_pathst copy_stringst collect_cmdsR� R| t loggingt getLoggerR� t extendt _default_plug_optsR[ t
set_predicateR8 ( RC R� t opt( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s0
"c C� s� d } y� | j d � } t | j d � � } | d k rB | } nL | d k ri | d k ri t | � } n% | d k r� | d k r� | } n d SWn t k
r� | j SX| d k r� | d k r� | S| j S( s� Returns either the default plugin timeout value, the value as
provided on the commandline via -k plugin.timeout=value, or the value
of the global --plugin-timeout option.
t plugin_timeoutR� i����N( R� Rc t intt
ValueErrorR� ( RC t _timeoutt opt_timeoutt own_timeout( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s
c C� s | j S( sV
Checks to see if the plugin has hit its timeout.
This is set when the sos.collect_plugin() method hits a timeout and
terminates the thread. From there, a Popen() call can still continue to
run, and we need to manually terminate it. Thus, check_timeout() should
only be called in sos_get_command_output().
Since sos_get_command_output() is not plugin aware, this method is
handed to that call to use as a polling method, to avoid passing the
entire plugin object.
Returns True if timeout has been hit, else False.
( t _timeout_hit( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
check_timeout� s c C� s | j r | j S| j j � S( s^ Returns the plugin's name as a string. This should return a
lowercase string.
( t plugin_nameR� t lower( t cls( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt name s c C� s d | j � | f S( Ns [plugin:%s] %s( R� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _format_msg s c C� s | j j | j | � � d S( N( R� t errorR� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_log_error s c C� s | j j | j | � � d S( N( R� t warningR� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _log_warn s c C� s | j j | j | � � d S( N( R� t infoR� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _log_info s c C� s | j j | j | � � d S( N( R� t debugR� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_log_debug s c C� s6 | d t j k r | d } n t j j | j | � S( Ni i ( t ost sepR( R> R� ( RC R( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt join_sysroot s
c C� s7 | j � s | S| j | j � r3 | t | j � S| S( N( t use_sysroott
startswithR� t len( RC R( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
strip_sysroot% s
c C� s | j t j j t j � k S( N( R� R� R( t abspathR� ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� , s c C� s1 | j | j j � g } t j j | � | j k S( N( R� t archivet get_tmp_dirR� R( t commonprefix( RC t paths( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt tmp_in_sysroot/ s c C� s | j j | � d k S( s' Is the package $package_name installed?N( R| t pkg_by_nameR� ( RC t package_name( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRm 3 s c C� s | j j j | � S( s+ Does the service $name exist on the system?( R| t init_systemt
is_service( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� 7 s c C� s | j j j | � S( s Is the service $name enabled?( R| R� t
is_enabled( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt is_service_enabled; s c C� s | j j j | � S( s Is the service $name disabled?( R| R� t is_disabled( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt is_service_disabled? s c C� s | j j j | � S( s' Is the service $name currently running?( R| R� t
is_running( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRi C s c C� s | j j j | � d S( s, Return the reported status for service $nameRq ( R| R� t get_service_status( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� G s c C� s | j j j | � S( s$ Get all service names matching regex( R| R� t get_service_names( RC R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� K s c C� s
| | _ d S( s< Set or clear the default predicate for this plugin.
N( t predicate( RC t pred( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� O s c C� s
| | _ d S( s� Set or clear the default predicate for command collection
for this plugin. If set, this predecate takes precedence
over the `Plugin` default predicate for command and journal
data collection.
N( t
cmd_predicate( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt set_cmd_predicateT s c C� s3 | d k r | S| r, | j d k r, | j S| j S( sq Get the current default `Plugin` or command predicate. If the
`cmd` argument is `True`, the current command predicate is
returned if set, otherwise the default `Plugin` predicate
will be returned (which may be `None`).
If no default predicate is set and a `pred` value is passed
it will be returned.
N( R� R� R� ( RC R: R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
get_predicate\ s
c C� s2 | j d | d | � } | d k r. t | � St S( s1 Test the current predicate and return its value.
:param cmd: ``True`` if the predicate is gating a command or
``False`` otherwise.
:param pred: An optional predicate to override the current
``Plugin`` or command predicate.
R: R� N( R� R� t boolRr ( RC R: R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt test_predicatek s
c C� s: d | | j � f } | r) | d 7} n | j | � d S( s Log that a command was skipped due to predicate evaluation.
Emit a warning message indicating that a command was skipped due
to predicate evaluation. If ``kmods`` or ``services`` are ``True``
then the list of expected kernel modules or services will be
included in the log message. If ``allow_changes`` is ``True`` a
message indicating that the missing data can be collected by using
the "--allow-system-changes" command line option will be included.
s skipped command '%s': %ss3 Use '--allow-system-changes' to enable collection.N( R� R� ( RC R� R: R= R? t changesR� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt log_skipped_cmdx s
R c C� sM | j s
d S| j d | � | r4 d t | f n t } | j | t | � S( sh Remove certificate and key output archived by sosreport. cmd
is the command name from which output is collected (i.e. exlcuding
parameters). Any matching instances are replaced with: '-----SCRUBBED'
and this function does not take a regexp or substituting string.
This function returns the number of replacements made.
i s1 Scrubbing certs and keys for commands matching %ss %s %s( R� R� t
_cert_replacet do_cmd_output_subt
_certmatch( RC R: R� t replace( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt do_cmd_private_sub� s c
C� s� d | d } t | d � r& | j n | } | j d | | | f � | j sS d Sd } y� x� | j D]� } | d d k r� qf n | d d k r� | j d | d � qf n t j | d
| � rf t j j | j
d | d � } | j d | � | j j | � } t
j | | | j � � \ }
} | rF| j j |
| � qFqf qf WWn: t k
r�} d
} | j | | d | f � d } n X| S( s_ Apply a regexp substitution to command output archived by sosreport.
cmd is the command name from which output is collected (i.e. excluding
parameters). The regexp can be a string or a compiled re object. The
substitution string, subst, is a string that replaces each occurrence
of regexp in each file collected from cmd. Internally 'cmd' is treated
as a glob with a leading and trailing '*' and each matching file from
the current module's command list is subjected to the replacement.
This function returns the number of replacements made.
t *t patterns4 substituting '%s' for '%s' in commands matching '%s'i t filet binaryt yess6 Cannot apply regex substitution to binary output: '%s't exeR: t cmddirs applying substitution to '%s's- regex substitution failed for '%s' with: '%s'N( t hasattrR� R� R� R� R� t fnmatchR� R( R> R� R� t open_fileR t subnR t
add_stringt ExceptionR� (
RC R: t regexpt substt globstrR� t replacementst calledR( t readableRu t eR� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s8 !
c C� s� | j d | � t j | � j } | r9 d t | f n t } g | j D] } | | d � rI | ^ qI } x7 | D]/ } | d } | s� qr n | j | t | � qr Wd S( s� Scrub certificate/key/etc information from files collected by sos.
Files matching the provided pathregex are searched for content that
resembles certificate, ssh keys, or similar information. Any matches
are replaced with "-----SCRUBBED $desc" where `desc` is a description
of the specific type of content being replaced, e.g.
"-----SCRUBBED RSA PRIVATE KEY" so that support representatives can
at least be informed of what type of content it was originally.
Positional arguments:
:param pathregex: A string or regex of a filename to match against
:param desc: A description of the replaced content
s. Scrubbing certs and keys for paths matching %ss %s %st srcpatht dstpathN( R� R t compileR~ R� R� t do_file_subR� ( RC t pathregexR� R~ R� R t file_listt iR( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt do_file_private_sub� s ,
c C� sW y� | j | � } t | d � r* | j n | } | j d | � | j d | | | f � | se d S| j j | � } | j � } t | t j � s� | j
d d � } n t j | | | � \ } } | r� | j j
| | � n d } Wnh t t f k
rR}
|
j t j k r,d } | j | | � n d } | j | | |
f � d } n X| S( sg Apply a regexp substitution to a file archived by sosreport.
srcpath is the path in the archive where the file can be found. regexp
can be a regexp string or a compiled re object. subst is a string to
replace each occurance of regexp in the content of srcpath.
This function returns the number of replacements made.
R� s substituting scrpath '%s's" substituting '%s' for '%s' in '%s'i t utf8t ignores- file '%s' not collected, substitution skippeds- regex substitution failed for '%s' with: '%s'( t _get_dest_for_srcpathR� R� R� R� R� R R R
t string_typest decodeR R� R t OSErrort IOErrort errnot ENOENTR� ( RC R R R R( R� R t contentRu R R R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR � s0
c C� s� t | d � s! t j | � } n | j } g | j D] } | | d � r4 | ^ q4 } x% | D] } | j | d | | � q] Wd S( sz Apply a regexp substituation to a set of files archived by
sos. The set of files to be substituted is generated by matching
collected file pathnames against pathexp which may be a regular
expression string or compiled re object. The portion of the file
to be replaced is specified via regexp and the replacement string
is passed in subst.R~ R N( R� R R R~ R� R ( RC t pathexpR R R~ R R R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt do_path_regex_sub s ,
c C� s
t | | � S( N( R ( RC R R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt do_regex_find_all s c C� s t j | � } t j j t j j | � | � } t j j | � } t j j | � r� t j j t j j | � � } t j j | d | �} | j � r� | t
t j t j � } n | j
d | | f � n | } | j
d | | t j j | � f � | j | � } | j j | | � t j j | � rB| j
d | � d S| j j i | d 6| d 6d d 6| d 6� y t j | � Wn7 t k
r�} | j d
k r�| j
d | � d Sn X| j
d | | f � | | k r�| j | � n | j
d
| � d S( Nt starts& made link target '%s' relative as '%s's0 copying link '%s' pointing to '%s' with isdir=%ss% link '%s' is a directory, skipping...R R
R� t symlinkt pointstoi( s; link '%s' is part of a file system loop, skipping target...s# normalized link target '%s' as '%s's. link '%s' points to itself, skipping target...( R� t readlinkR( R> t dirnamet normpatht isabst realpatht relpathR� R� R� t pardirR� t isdirR� R� t add_linkR� R[ R- R R t
_do_copy_path( RC R t linkdestt destt absdestt realdirt reldestR
R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_copy_symlink sF ! c C� s� yW xP t j | � D]? } | j d | | f � t j j | | � } | j | � q WWn� t k
r� } | j t j k s� t j r� d } | j
d | | f � d S| j t j k r� d } | j d | | f � d S� n Xd S( Ns! recursively adding '%s' from '%s's Permission denieds _copy_dir: '%s' %ss) Too many levels of symbolic links copyings _copy_dir: %s '%s'(
R� t listdirR� R( R> R* R R t EPERMt EACCESR� t ELOOPR� ( RC R R� R( R R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _copy_dirR s c C� sN | j � r | j | � } n x) | j D] } | | d k r( | d Sq( Wd S( NR R
( R� R� R� R� ( RC R t copied( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR d s c C� s t | | j � S( N( R+ R� ( RC R( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _is_forbidden_pathl s c C� sS t j | j � } t j | j � } | j } | j j | | t j | | � � d S( N( R� t majort st_rdevt minorR2 R� t add_nodet makedev( RC R( R3 t dev_majt dev_mint mode( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_copy_nodeo s c C� s� | j r
d S| j | � r1 | j d | � d S| s@ | } n | j � r^ | j | � } n y t j | � } Wn) t t f k
r� | j d | � d SXt
j | j � r� | j
| � d St
j | j � rt j | t j � rt j | � s
| j j | � d S| j | � d St
j | j � p<t
j | j � svt | � } | j d | | f � | j | | � d S| j d | | f � | j d @s�| j j d | � n | j j | | � | j j i | d 6| d 6d
d 6� d S( s� Copy file or directory to the destination tree. If a directory, then
everything below it is recursively copied. A list of copied files are
saved for use later in preparing a report.
Ns skipping forbidden path '%s'R s failed to stat '%s's creating %s node at archive:'%s's! copying path '%s' to archive:'%s'i$ R R
t noR ( R� R7 R� R� R� R� t lstatR R R� R- t S_ISLNKR2 R0 t S_ISDIRt accesst R_OKR1 R� t add_dirR5 t S_ISREGR6 R@ R t add_fileR� R[ ( RC R R, R3 t ntype( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR* v sJ
'
$
c C� s� t | t j � r | g } n | j � rO g | D] } | j | � ^ q1 } n xI | D]A } | j d | � x' t j | � D] } | j j | � q} WqV Wd S( sn Specify a path, or list of paths, to not copy, even if it's
part of a copy_specs[] entry.
s adding forbidden path '%s'N( R R
R R� R� R� t globR� R[ ( RC t forbiddenR t forbidR( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_forbidden_path� s %
c C� s | j | j f S( s% return a list of all options selected( R� R� ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt get_all_options� s c C� s� x� t | j | j � D]i \ } } | | k r t | d � } | t | � k rq | t d � k rq | | � } n | | d <t Sq Wt S( sm Set the named option to value. Ensure the original type
of the option value is preserved.
R� N( R R� R� t typeR� RS Rr ( RC t
optionnamet valueR� t parmst defaulttype( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
set_option� s " $
i c C� sy d } | | k r& t | j d | � SxL t | j | j � D]5 \ } } | | k r< | d } | d
k rq | Sq< q< W| S( sH Returns the first value that matches 'optionname' in parameters
passed in via the command line or set via set_option or via the
global_plugin_options dictionary, in that order.
optionaname may be iterable, in which case the first option that
matches any of the option names is returned.
t all_logsRa t log_sizeR� t sincet verifyR� R� ( s all_logss allow_system_changess log_sizes plugin_timeouts sinceRY N( R� R� R R� R� R� ( RC RQ t defaultt global_optionsR� RS R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRc � s
"
R9 c C� sg | j | � } y? g | j | � D] } | j � ^ q" } t t d | � � SWn t k
rb | SXd S( sT Will try to return the option as a list separated by the
delimiter.
N( Rc t splitR! R� R R� R ( RC RQ t delimiterRZ t optionR� t opt_list( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt get_option_as_list� s (
c C� s | j j | � d S( N( R� R� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _add_copy_paths� s c � s� d � | j d � r' | j d � � n t j d � � t j d | j d � � � | j d | � s� | j d | | j d | � f � d S| d k r� | j d � } n | j d � r� d } n | r� | d 9} n | s� t St | t
j � r� | g } n x�| D]�} | ot | � s t S| j
� r=| j | � } n | j | � } t | � d k rdqn d � � � � � � � f d
� � � s�� r�t t � f d � | � � } n | j d � d t � d } t } x�| D]�}
|
| j k r
| j d |
� q�n | j |
� r0| j d |
� q�n | rM| j d |
� q�n y t j |
� } Wn% t k
r�| j d |
� q�n X| | t j 7} | r�| | k r�t } | r�t |
� r�| j d |
� |
} | d t j k r| j t j � } n | j t j j d � d }
| j t |
| � |
� t j j! d t j j" |
� � } t j j# | d | j$ � |
� } | j% j& | |
� q�| j d |
� q�| j' |
g � q�WqWd S( s- Add a file or glob but limit it to sizelimit megabytes. Collect
files with mtime not older than maxage hours.
If fname is a single file the file will be tailed to meet sizelimit.
If the first file in a glob is too large it will be tailed to meet
the sizelimit.
RX s" .*((\.(zip|gz|bz2|xz))|[-.][\d]+)$s ^%s/*t etcR� s, skipped copy spec '%s' due to predicate (%s)NRW RV i i c S� s- y t j j | � SWn t k
r( d SXd S( Ni ( R� R( t getmtimeR ( R( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRc / s
c � sz � j | � d k s* � j | � d k r. t St j � | � � } � rU | � k sr � rv t � | � d k rv t St S( sp When --since is passed, or maxage is coming from the
plugin, we need to filter out older files i N( t searchR� RS R
t
fromtimestampR Rr ( R( t filetime( t configfile_patternRc t logarchive_patternt maxageRX ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt time_filter5 s c � s
� | � S( N( ( R ( Rj ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt <lambda>D s R� t reverses skipping redundant file '%s's skipping forbidden path '%s's skipping '%s' over size limits failed to stat '%s's) collecting tail of '%s' due to size limitR s .tailedR t sos_stringsi (( R� Rc R R R� R� R� R� Rr R R
R R� R� t _expand_copy_specR� R t sortRS R� R� R7 R� R- R t ST_SIZER7 R� R� R� R( t add_string_as_fileR R& R" R> R� R� R) Ra ( RC t copyspecst sizelimitRi t tailitR� t copyspect filest current_sizet
limit_reachedt _filet filestatt file_namet strfilet rel_patht link_path( ( Rg Rc Rh Ri RX Rj s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
add_copy_spec� s�
!
!c K� s� d | k r | j d � n d } t | � } | j d | j � � | j d t d | � r� | j j | � | j d | j
� n: | j | | j
d t | j
� d t | j � d | j �d S( s? Internal helper to add a single command to the collection list.R� s packed command: R: s added cmd output '%s'R= R? R� N( t popR� R� R� RQ R� RS R� R[ R� R: R� R� R= R? R� ( RC R� R� t soscmd( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _add_cmd_outputt s ! !c C� s� t | t j � r | g } n t | � d k rL | s< | rL | j d � n |
d k rj | j d � }
n | d k r� | j d t � } n xl | D]d } | j d | d | d | d | d | d | d
| d | d | d
|
d | d | d |
d | � q� Wd S( s: Run a program or a list of programs and collect the outputi s. ambiguous filename or symlink for command listRW R: t suggest_filenamet root_symlinkR� t stderrt chroott runatt envR� Rs R� t subdirR� t
foregroundN(
R R
R R� R� R� Rc R� RS R� ( RC t cmdsR� R� R� R� R� R� R� R� Rs R� R� R� R� R: ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_cmd_output� s
c C� s_ t j j | j j � d | j � � } | rE t j j | | � } n | r[ t j | � n | S( s[ Return a path into which this module should store collected
command output
t sos_commands( R� R( R> R� R� R� t makedirs( RC R� t maket cmd_output_path( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt get_cmd_output_path� s c G� s
t | | � S( s� Returns lines matched in fnames, where fnames can either be
pathnames to files to grep through or open file objects to grep through
line by line.
( R ( RC R t fnames( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt file_grep� s c C� s | j j � } t | | � S( N( R� R# R% ( RC R� R# ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR% � s c
C� sX | j � } | r0 | d | j d � d 7} n t j j | j d | � } | j | � } t j j t j j | j j � | | � � rEd } | j j
� } x� t rAd | } | } | t | � t | � k r� | | t | � t | � } n | | } t j j t j j | j j � | | � � s4| } Pn | d 7} q� Wn t j j | | � S( s@ The internal function to build up a filename based on a command.s /%sR i R� i s .%d(
R� R\ R� R( R> R� R% t existsR� R� R# RS R� (
RC R� R� t
plugin_dirt outdirt outfnt incR# RF t newfn( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _make_command_filename� s*
!
c C� sU t | t � s | g } n x3 | D]+ } | j j | | j � | j � g � q" Wd S( s Add an environment variable to the list of to-be-collected env vars.
Accepts either a single variable name or a list of names. Any value
given will be added as provided to the method, as well as an upper-
and lower- cased version.
N( R R� R� R� t upperR� ( RC R� R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_env_var� s
c C� s� | r | j � d n d } t | t j � sC | j d d � } n | j d t d | � s� | j d | | j d | � f � d S| j j
| | f � | j d | | f � d S(
s6 Add a string to the archive as a file named `filename`i R R R R: R� s, skipped string ...'%s' due to predicate (%s)Ns added string ...'%s' as '%s'( Rs R R
R R R� Rr R� R� R� R[ R� ( RC R t filenameR� t summary( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRq � s c C� s� | j r
d S| s) | j d j d k r5 | j } n d } t � } t | d | d | d | d | d | d | d
|
d | j d |
� } | d
d k r� | j d | | f � n | d
d k s� | d
d k r�| r[| d k r[| j d j d k r[| j d | j
� d | f � t | d | d t d | d | d | d
|
d | j �} q[n | j d | � | d
d k r�| Sn | j d | j
� d t � | | f � | r�| j
| | � } n | j
| | � } | t | j d � d } | r| j j | d | � n | j j | d | � | rI| j j | | � n | j j i | d 6| d 6| rod n d d 6� | r�t j j | j j � | � n d | d <| S(! s- Execute a command and save the output to a file for inclusion in the
report.
Positional Arguments:
:param cmd: The command to run
Keyword Arguments:
:param suggest_filename: Filename to use when writing to the
archive
:param root_symlink: Create a symlink in the archive root
:param timeout: Time in seconds to allow a cmd to run
:param stderr: Write stderr to stdout?
:param chroot: Perform chroot before running cmd?
:param runat: Run the command from this location,
overriding chroot
:param env: Dict of env vars to set for the cmd
:param binary: Is the output in binary?
:param sizelimit: Maximum size in MB of output to save
:param subdir: Subdir in plugin directory to save to
:param changes: Does this cmd potentially make a change
on the system?
:returns: dict containing status, output, and filename in the
archive for the executed cmd
NR� t alwaysR� R� R� t chdirR� R� Rs t pollerR� Rq i| s command '%s' timed out after %dsi~ i R s5 command '%s' not found in %s - re-trying in host rooti s% could not run '%s': command not founds+ collected output of '%s' in %s (changes=%s)R� i R; R: R� R� RA R R� ( i~ i ( R� R� R� R� R� R R R� R� R� R\ Rr R� R� R� R� t
add_binaryR R) R� R[ R� R( R> t get_archive_path( RC R: R� R� R� R� R� R� R� R� Rs R� R� R� t rootR Ru R� t outfn_strip( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _collect_cmd_output� sR "$
c
C� s� | j d t d | � sZ | j d | | j d t d | � f � i d d 6d d 6d d 6S| j | d | d | d
| d | d | d
| d | d | d |
d | �
S( s] Execute a command and save the output to a file for inclusion in the
report.
R: R� s- skipped cmd output '%s' due to predicate (%s)Rq R R; R� R� R� R� R� R� R� R� R� Rs R� N( R� RS R� R� R� R� (
RC R: R� R� R� R� R� R� R� R� Rs R� R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt collect_cmd_outputM s c
C� s� | j d t d | � s* i d d 6d d 6S| sF | j d j d k rR | j }
n d }
t | d | d |
d
| d | d | d
| �S( s Execute a command right now and return the output and status, but
do not save the output within the archive.
Use this method in a plugin's setup() if command output is needed to
build subsequent commands added to a report via add_cmd_output().
R: R� Rq R R; R� R� R� R� R� R� R� R� N( R� RS R� R� R� R� R ( RC R: R� R� R� R� R� R� R� R� R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt exec_cmdd s c C� s | | j j k S( s? Return whether specified module as module_name is loaded or not( R| t kernel_mods( RC t module_name( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRd | s c C� s | j j | � d S( sp Add an alert to the collection of alerts for this plugin. These
will be displayed in the report
N( R� R[ ( RC t alertstring( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_alert� s c C� s | j | 7_ d S( sv Append text to the custom text that is included in the report. This
is freeform and can include html.
N( R� ( RC t text( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_custom_text� s c K� sv t | t j � r | g } n | j j j } | sD | j d � d Sx+ | D]# } | j d d | | f | � qK Wd S( sH Collect service status information based on the InitSystem used.
:param services: A string, or list of strings, specifying the services
to collect
:param kwargs Optional arguments to pass to _add_cmd_output
(timeout, predicate, suggest_filename,..)
sF Cannot add service output, policy does not define an InitSystem to useNR: s %s %s( R R
R R| R� t query_cmdR� R� ( RC R? R� t queryt service( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_service_status� s
c
C� s� d }
d } d } d } d } d } d } d } d } d
} | j d � } | p] | j d � } | su t | | � n d
} t | t j � r� | g } n | r� x | D] } |
| | 7}
q� Wn | r� |
| | 7}
n |
r� |
| 7}
n | r� |
d 7}
n | r?| d k rd } n | d k r.d } n |
| | 7}
n | rV|
| | 7}
n | rm|
| | 7}
n | r�|
| | 7}
n | r�|
| | 7}
n | j d |
� | j d |
d | d | d | � d S( s7 Collect journald logs from one of more units.
:param units: A string, or list of strings specifying the
systemd units for which journal entries will be
collected.
:param boot: A string selecting a boot index using the
journalctl syntax. The special values 'this' and
'last' are also accepted.
:param since: A string representation of the start time for
journal messages.
:param until: A string representation of the end time for
journal messages.
:param lines: The maximum number of lines to be collected.
:param allfields: A bool. Include all journal fields
regardless of size or non-printable
characters.
:param output: A journalctl output control string, for
example "verbose".
:param timeout: An optional timeout in seconds.
:param identifier: An optional message identifier.
:param catalog: Bool. If True, augment lines with descriptions
from the system catalog.
:param sizelimit: Limit to the size of output returned in MB.
Defaults to the value of --log-size.
s journalctl --no-pager s
--unit %ss
--boot %ss
--since '%s's --until %ss --lines %ss --output %ss --identifier %ss
--catalogid RV RW i s --allt thisR t lasts -1s collecting journal: %sR: R� Rs R� N( Rc t maxR R
R R� R� ( RC t unitst bootRX t untilt linest allfieldsR; R� t
identifiert catalogRs R� t journal_cmdt unit_optt boot_optt since_optt until_optt lines_optt
output_optt identifier_optt catalog_optt journal_sizeRV RW t unit( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_journal� sR $
c C� sw d } | r | d 7} n t | t j � r7 | g } n x9 | D]1 } | j d | � | j d d | | f � q> Wd S( sG Collect udevadm info output for a given device
:param device: A string or list of strings of device names or sysfs
paths. E.G. either '/sys/class/scsi_host/host0' or
'/dev/sda' is valid.
:param attrs: If True, run udevadm with the --attribute-walk option.
s udevadm infos -as collecting udev info for: %sR: s %s %sN( R R
R R� R� ( RC t devicet attrst udev_cmdt dev( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
add_udev_info� s
c C� s
t j | � S( N( RK ( RC Ru ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyRn s c C� s6 x/ | j D]$ } | j d | � | j | � q
Wd S( Ns collecting path '%s'( R� R� R* ( RC R( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _collect_copy_specs s c C� sS xL | j D]A } | j d | j � � | j d | j � | j | j � q
Wd S( Ns unpacked command: s collecting output of '%s'( R� R� RQ R� R: R� R� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
_collect_cmds s c C� s� x� | j D]� \ } } | j r# d Sd } | ri | j � d } t | t j � si | j d d � } qi n | j d | | f � y/ | j j | t
j j d | j
� | � � Wq
t k
r� } | j d | | f � q
Xq
Wd S( NR i R R s! collecting string ...'%s' as '%s'Rm s could not add string '%s': %s( R� R� Rs R R
R R R� R� R R� R( R> R� R R� ( RC t stringR{ R R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt _collect_strings s$ c C� sU t � } | j � | j � | j � | j � t � | f } | j d | � d S( s Collect the data for a plugin.s collected plugin '%s' in %sN( R R� R� R� R� R� ( RC R t fields( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt collect1 s
c C� s[ yB t | d � r( | j r( | j j � St | j | � j j � SWn t k
rV d SXd S( s9 This function will return the description for the pluginR� s <no description available>N( R� R� R! t supert __class__R ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt get_description: s
c
C� s[ t | j | j | j | j | j | j g � r0t | j t j � rW | j g | _ n t | j t j � r~ | j g | _ n t | j t j � r� | j g | _ n t | j t j � r� | j g | _ n t | j t j � r� | j g | _ n t | t
� rg t | � _ x� | j
� D]� } g | j D] } | i | d 6^ q.} g | j D] } | i | d 6^ qU} g | j D] } | i | d 6^ q|} g | j D] } | i | d 6^ q�} | j | | | | � r t | � j j | � q q Wt t | � j � d k S| j | j | j | j | j � St | t
� rW| j
� t | � _ n t S( s� This method will be used to verify that a plugin should execute
given the condition of the underlying environment.
The default implementation will return True if none of class.files,
class.packages, nor class.commands is specified. If any of these is
specified the plugin will check for the existence of any of the
corresponding paths, packages or commands and return True if any
are present.
For SCLPlugin subclasses, it will check whether the plugin can be run
for any of installed SCLs. If so, it will store names of these SCLs
on the plugin class in addition to returning True.
For plugins with more complex enablement checks this method may be
overridden.
t scl_namei ( R) Rv R@ t commandsR� R? t
architecturesR R
R t SCLPluginRP t
_scls_matchedt _get_sclst _check_plugin_triggersR[ R� RS (
RC t sclR Rv R' R@ t cR� R R? ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
check_enabledC s@ ''''
c � s� t d � | D� � s� t � f d � | D� � s� t d � | D� � s� t � f d � � j D� � s� t � f d � | D� � o� � j � S( Nc s� s! | ] } t j j | � Vq d S( N( R� R( R� ( R& R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>� s c 3� s | ] } � j | � Vq d S( N( Rm ( R& Ro ( RC ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>� s c s� s | ] } t | � Vq d S( N( R ( R& R: ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>� s c 3� s | ] } � j | � Vq d S( N( Rd ( R& t mod( RC ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>� s c 3� s | ] } � j | � Vq d S( N( R� ( R& Rk ( RC ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pys <genexpr>� s ( R) R� t check_is_architecture( RC Rv R@ R� R? ( ( RC s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s c C� sB | j d k r t Sd d j | j � } t j | | j j � � S( s� Checks whether or not the system is running on an architecture that
the plugin allows. If not architecture is set, assume plugin can run
on all arches.
s (?:%s)Rz N( R� R� RS R> R R~ R| R} ( RC R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s c C� s t S( sw This decides whether a plugin should be automatically loaded or
only if manually specified in the command line.( RS ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt default_enabled� s c C� s7 x0 | j D]% } | j | � r
| j | � q
q
Wd S( s� Based on the class attrs defined for plugin enablement, add a
standardized set of collections before we call the plugin's own setup()
method.
N( R? R� R� ( RC R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_default_collections� s c C� s | j t | j � � d S( s� Collect the list of files declared by the plugin. This method
may be overridden to add further copy_specs, forbidden_paths, and
external programs if required.
N( R R� Rv ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt setup� s c C� s� t | d � s | j r_ t | d � rX | j rX g | j D] } | d ^ q< | _ q_ d Sn | j j } | j | j � } | r� | j | � n d S( Nt verify_packagesR@ t $( R� R� R@ R| t package_managert build_verify_commandR� ( RC R' t pmt
verify_cmd( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt setup_verify� s & c C� s d S( sL Perform any postprocessing. To be replaced by a plugin if required.
N( ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s c C� s� t } d } yZ t j | � } xD | D]< } t | d � } | j � j � } | | k r% t } q% q% WWn t k
r| } t SX| S( sa Checks if a named process is found in /proc/[0-9]*/cmdline.
Returns either True or False.s /proc/[0-9]*/cmdlinet r( Rr RK t openR R! RS R ( RC t processRq t
cmd_line_globt cmd_line_pathsR( R t cmd_lineR ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt check_process_by_name� s
c C� s� g } d } t j | � } x~ | D]v } yW t | d � �B } | j � j � } | | k rx | j | j d � d � n Wd QXWq" t k
r� } q" q" Xq" W| S( sl Returns PIDs of all processes with process name.
If the process doesn't exist, returns an empty lists /proc/[0-9]*/cmdlineR� R i N( RK R� R R! R[ R\ R ( RC R� t pidsR� R� R( R R� R ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt get_process_pids� s
' N( ( ( ( ( ( ( s timeouts Timeout in seconds for pluginR� i����(g R� R� R� R� R� RS t
requires_roott versionR@ Rv R� R� R? R� R� t profilesR� R� t cmd_timeoutRr R� R� R� R� R� t propertyR� R� t classmethodR� R� R� R� R� R� R� R� R� R� Rm R� R� R� Ri R� R� R� R� R� R� R� R� R� R R R R R0 R5 R R7 R@ R* RN RO RU Rc R` Ra R R� R� R� R� R% R� R� Rq R� R� R� Rd R� R� R� R� R� Rn R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s� "
, % ; < u
^ W =
t RedHatPluginc B� s e Z d Z RS( s/ Tagging class for Red Hat's Linux distributions( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s R� c B� sS e Z d Z e d � � Z d � Z d � Z d � Z d � Z d � Z d � Z
RS( s� Superclass for plugins operating on Software Collections (SCLs).
Subclasses of this plugin class can specify class.files and class.packages
using "%(scl_name)s" interpolation. The plugin invoking mechanism will try
to match these against all found SCLs on the system. SCLs that do match
class.files or class.packages are then accessible via self.scls_matched
when the plugin is invoked.
Additionally, this plugin class provides "add_cmd_output_scl" (run
a command in context of given SCL), and "add_copy_spec_scl" and
"add_copy_spec_limit_scl" (copy package from file system of given SCL).
For example, you can implement a plugin that will list all global npm
packages in every SCL that contains "npm" package:
class SCLNpmPlugin(Plugin, SCLPlugin):
packages = ("%(scl_name)s-npm",)
def setup(self):
for scl in self.scls_matched:
self.add_cmd_output_scl(scl, "npm ls -g --json")
c C� s4 t t | � d � s' g t | � _ n t | � j S( NR� ( R� RP R� ( RC ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt scls_matched� s c C� s3 t d � d } g | j � D] } | j � ^ q S( Ns scl -lR; ( R Rs R! ( RC R; R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s c C� s� | j j � } y& t d | d � j � j d � } Wn* t k
ra } | j d | | f � n Xt j d } x- | j d � D] } d | | | | f } q Wd | | | f } | S( sC wrapping command in "scl enable" call and adds proper PATH
s /etc/scl/prefixes/%sR� s
s* Failed to find prefix for SCL %s, using %st PATHt :s
%s/%s%s:%ss scl enable %s "PATH=%s %s"(
R| t get_default_scl_prefixR� R t rstripR R� R� t environR\ ( RC R� R: RE R R( R' t scl_cmd( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt convert_cmd_scl s
c K� sb t | t j � r | g } n g } x' | D] } | j | j | | � � q+ W| j | | � d S( sp Same as add_cmd_output, except that it wraps command in
"scl enable" call and sets proper PATH.
N( R R
R R[ R R� ( RC R� R� R� t scl_cmdsR: ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_cmd_output_scl s
c C� s\ | j j � } xF d d g D]8 } t j d | � } | j d | | | f | � } q W| S( NRb t vars ^/%s/s
/%s/%s/%s/( R| R R R R ( RC R� Ru t
scl_prefixt rootdirR' ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt convert_copyspec_scl' s
c C� s_ t | t j � r | g } n g } x' | D] } | j | j | | � � q+ W| j | � d S( s` Same as add_copy_spec, except that it prepends path to SCL root
to "copyspecs".
N( R R
R R[ R
R ( RC R� Rr t
scl_copyspecsRu ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_copy_spec_scl/ s
c K� s | j | j | | � | � d S( se Same as add_copy_spec_limit, except that it prepends path to SCL
root to "copyspec".
N( t add_copy_spec_limitR
( RC R� Ru R� ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt add_copy_spec_limit_scl: s ( R� R� R� R� R� R� R R R
R R ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR� � s t PowerKVMPluginc B� s e Z d Z RS( s$ Tagging class for IBM PowerKVM Linux( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR D s t
ZKVMPluginc B� s e Z d Z RS( s Tagging class for IBM ZKVM Linux( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR I s t UbuntuPluginc B� s e Z d Z RS( s Tagging class for Ubuntu Linux( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR N s t DebianPluginc B� s e Z d Z RS( s Tagging class for Debian Linux( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR S s t
SuSEPluginc B� s e Z d Z RS( s* Tagging class for SuSE Linux distributions( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR X s t IndependentPluginc B� s e Z d Z RS( s6 Tagging class for plugins that can run on any platform( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR ] s t ExperimentalPluginc B� s e Z d Z RS( s= Tagging class that indicates that this plugin is experimental( R� R� R� ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyR b s c C� s) d | } | s t f } n t | | � S( s� Import name as a module and return a list of all classes defined in that
module. superclasses should be a tuple of valid superclasses to import,
this defaults to (Plugin,).
s sos.plugins.%s( R� R ( R� t superclassest
plugin_fqname( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt
import_pluging s
(3 R� t
__future__R t
sos.utilitiesR R R R R R R� RK R R- R R� R� R R
t six.movesR R R
t FileNotFoundErrort NameErrorR R R R% R+ R6 R7 R t DOTALLR� R� t objectR8 R� R� R� R� R R R R R R R R� R ( ( ( s8 /usr/lib/python2.7/site-packages/sos/plugins/__init__.pyt <module> sX .
� � � � � � Wc
Mini Shell