K<]c @ s8 d Z d d k l Z d d k l Z l Z l Z l Z l Z d d k Z d d k
Z
d d k Z d d k Z d d k
l
Z
d d k Z d d k Z d Z d Z d 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 e d Z 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 tailN( t timec C sd yI t | i i } z) | ~ } t i | | i t i SWd QXWn t j
o g SXd S( s= Return a list of all non overlapping matches in the string(s)N( R t __exit__t __enter__t ret findallt readt MULTILINEt AttributeError( t regext fnamet _[1]t f( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
regex_findall s
#&c C sY t i d d | } t i d d | } t i d d | i 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.6/site-packages/sos/plugins/__init__.pyt _mangle_command) s
c s t f d | D S( Nc 3 s x | ] } | j Vq Wd S( N( ( t .0t p( t path( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pys 2 s ( t any( R t path_list( ( R s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _path_in_path_list1 s c C sh t i d f t i d f t i d f t i d f g } x+ | D]# } | d | i o | 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.6/site-packages/sos/plugins/__init__.pyt
_node_type5 s t Pluginc B s< e Z d Z d7 Z e Z d Z d8 Z d9 Z d7 Z
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 d7 d Z d Z d Z! d Z" d d Z# d d7 d Z$ d7 e d Z% d Z& d d7 d Z' d d7 d Z( d! Z) d7 d7 d d7 d" Z* d7 e d# Z+ d$ Z, d% Z- d& Z. d' Z/ d7 e0 d d7 d( Z1 d) Z2 d* Z3 d+ Z4 d, Z5 d- Z6 d. Z7 d/ Z8 d0 Z9 d1 Z: d2 Z; d3 Z< d4 Z= d5 Z> d6 Z? RS(; s@ 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 unversionedc C s t | d t p
g | _ n g | _ g | _ g | _ d | _ g | _ g | _ | | _ g | _
t | _ g | _
g | _ d | i j o | i d n
t i d | _ xV | i D]K } | i i | d | i i h | d d 6| d d 6| d
d 6 q Wd S( Nt option_listR t soslogt sosi i t desci t speedi t enabled( t getattrt FalseR0 t copied_filest executed_commandst alertst custom_textt opt_namest opt_parmst commonst forbidden_pathst sett
copy_pathst copy_stringst collect_cmdst loggingt getLoggerR1 t append( t selfR> t opt( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt __init__e s(
"c C s | i o | i S| i i S( s^ Returns the plugin's name as a string. This should return a
lowercase string.
( t plugin_namet __name__t lower( t class_( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt name~ s
c C s d | i | f S( Ns [plugin:%s] %s( RN ( RG t msg( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _format_msg s c C s | i i | i | d S( N( R1 t errorRP ( RG RO ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
_log_error s c C s | i i | i | d S( N( R1 t warningRP ( RG RO ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _log_warn s c C s | i i | i | d S( N( R1 t infoRP ( RG RO ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _log_info s c C s | i i | i | d S( N( R1 t debugRP ( RG RO ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
_log_debug s c C s | i d S( Nt policy( R> ( RG ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyRY s c C s | i i | d j S( s' Is the package $package_name installed?N( RY t pkg_by_namet None( RG t package_name( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt is_installed s c C sM d | d } | i d | | | f | i p d Sd } y x | i D] } | d d j o qJ n t i | d | o t i i | i d | d } | i d | | i i | } t
i | | | i \ } } | o | i i
| | qqJ qJ WWn< t j
o0 }
d } | i | | 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 *s4 substituting '%s' for '%s' in commands matching '%s'i t filet exet cmddirs applying substitution to '%s's- regex substitution failed for '%s' with: '%s'N( RX R9 R[ t fnmatcht osR t joinR> t archivet open_fileR t subnR t
add_stringt ExceptionRR ( RG t cmdt regexpt substt globstrt replacementst calledR t readablet resultt eRO ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt do_cmd_output_sub s0
# c
C s y | i | } | i d | | | f | p d S| i i | } t i | | | i \ } } | o | i i | | n d } Wn8 t j
o, } d } | i | | | 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.
s" substituting '%s' for '%s' in '%s'i s- regex substitution failed for '%s' with: '%s'(
t _get_dest_for_srcpathRX Re Rf R Rg R Rh Ri RR (
RG t srcpathRk Rl R Rp Rq Rn Rr RO ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt do_file_sub s !
c C s t | d p t i | } n | i } g } | i D]" } | | d o | | q: q: ~ } x% | D] } | i | d | | ql 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.t matchRu N( t hasattrR t compileRw R8 Rv ( RG t pathexpRk Rl Rw R R t file_listR_ ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt do_path_regex_sub s 9 c C s
t | | S( N( R ( RG R R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt do_regex_find_all s c C so t i | } t i i t i i | | } t i i | } t i i | o< t i i | t i i | } | i d | | f n | } | i d | | t i i | f | i
i | | t i i | o | i d | d S| i d | | f | | j o | i | n | i d | | i
i h | d 6| d 6d d 6| d
6 d S( Ns& made link target '%s' relative as '%s's0 copying link '%s' pointing to '%s' with isdir=%ss% link '%s' is a directory, skipping...s# normalized link target '%s' as '%s's. link '%s' points to itself, skipping target...Ru t dstpatht yest symlinkt pointsto( Rc t readlinkR Rd t dirnamet normpatht isabst relpathRX t isdirRe t add_linkt
_do_copy_pathR8 RF ( RG Ru t linkdestt destt absdestt reldest( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
_copy_symlink s0 !!
c C sW xP t i | D]? } | i d | | f | i t i i | | d d q Wd S( Ns! recursively adding '%s' from '%s'R ( Rc t listdirRX R R Rd R[ ( RG Ru t afile( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _copy_dir s
c C s2 x+ | i D] } | | d j o | d Sq
Wd S( NRu R~ ( R8 R[ ( RG Ru t copied( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyRt s
c C s t | | i S( N( R" R? ( RG R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _is_forbidden_path$ s c C sS t i | i } t i | i } | i } | i i | | t i | | d S( N( Rc t majort st_rdevt minorR) Re t add_nodet makedev( RG R R* t dev_majt dev_mint mode( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
_copy_node' s c C s | i | o | i d | d S| p
| } n y t i | } Wn+ t t f j
o | i d | d SXt i | i o | i
| d St i | i o | i | d St i
| i p t i | i p8 t | } | i d | | f | i | | d S| i d | | f | i d @p | i i d | n | i i | | | i i h | 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.
s skipping forbidden path '%s'R s failed to stat '%s'Ns creating %s node at archive:'%s's! copying path '%s' to archive:'%s'i$ Ru R~ t noR ( R RX Rc t lstatt OSErrort IOErrorRV R$ t S_ISLNKR) R t S_ISDIRR t S_ISREGR- R Re Rh t add_fileR8 RF ( RG Ru R R* t ntype( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR . s:
& c C s. x' t i | D] } | i i | q Wd S( sW Specify a path to not copy, even if it's part of a copy_specs[]
entry.
N( t globR? RF ( RG t
forbiddenPatht filespec( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt add_forbidden_path^ s c C s | i | i f S( s% return a list of all options selected( R< R= ( RG ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt get_all_optionsf s c C sJ xC t | i | i D]( \ } } | | j o | | d R R< R= R[ t gett iteritems( RG R t defaultt global_optionsR RN R t valt itemsR R ( ( R s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
get_options s
t ,c C sq | i | } yG g } | i | D] } | | i q& ~ } t t d | SWn t j
o | SXd S( sT Will try to return the option as a list separated by the
delimiter.
N( R t splitR t listt filterR[ Ri ( RG R t delimiterR t optionR RH t opt_list( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt get_option_as_list s 0c C s | o
t | p t St i | } | i t | d j o d Sd } t } | d 9} d } xT | D]L } | t i | t i 7} | o | | j o t } Pn | i | qm W| o | o | } | d t i
j o | i t i
} n | i t i
i
d d } | i t | | | t i
i d t i
i | }
t i
i |
d | i | } | i i | | n d S( s Add a file or glob but limit it to sizelimit megabytes. 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.
i Ni R s .tailedR t sos_stringsi ( t lenR7 R t sortR[ Rc R$ t ST_SIZER t
add_copy_spect sept lstript replaceR t add_string_as_fileR R R Rd RN Re R ( RG t copyspect sizelimitt tailitt filest current_sizet
limit_reachedt _filet file_namet strfilet rel_patht link_path( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt add_copy_spec_limit s6
!c C s t | t o
| g } n xd | D]\ } | o
t | p | i d t S| i | } | i i | | i d | q$ Wd S( sz Add a file specification (can be file, dir,or shell glob) to be
copied into the sosreport by this module.
s added null or empty copy specs added copyspec '%s'N( t
isinstancet
basestringR RT R7 t _expand_copy_specRA t updateRV ( RG t copyspecsR RA ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR s
i, c C s t | d | d | } | d d j o | i d | | f n | d d j p | d d j o | i d | n | S( Nt timeoutt runatt statusi| s command '%s' timed out after %dsi~ i s% could not run '%s': command not found( R RT RX ( RG t progR R Rq ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt get_command_output s "c C s | i | d | d | S( s[ Execute a command independantly of the output gathering part of
sosreport.
R R ( R ( RG R R R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
call_ext_prog s c C s | i | d d j S( s Execute a command independently of the output gathering part of
sosreport and check the return code. Return True for a return code of 0
and False otherwise.
R i ( R ( RG R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt check_ext_prog s c C s t | t o
| g } n t | d j o | p | o | i d n x[ | D]S } | | | | | f } d } | i | | | i i | | i d | qV Wd S( s: Run a program or a list of programs and collect the outputi s. ambiguous filename or symlink for command lists2 packed command tuple: ('%s', '%s', '%s', %s, '%s')s added cmd output '%s'N( R R R RT RX RC RF RV ( RG t cmdst suggest_filenamet root_symlinkR R Rj t cmdtt _logstr( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt add_cmd_output s
! c C sc t i i | i i d | i } | o t i i | | } n | o t i | n | S( s[ Return a path into which this module should store collected
command output
t sos_commands( Rc R Rd Re t get_tmp_dirRN t makedirs( RG RN t maket cmd_output_path( ( s8 /usr/lib/python2.6/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 ( RG Rk t fnames( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt file_grep s c C s | i i } t | | S( N( Re R R ( RG R` R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR
s c C s t i i | i d | i | i | } t i i | oQ d } xH t o< d | | f } t i i | p | } Pn | d 7} qJ Wn | S( s@ The internal function to build up a filename based on a command.Ra i s %s_%di ( Rc R Rd R> RN R t existsR ( RG R` t outfnt inct newfn( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _make_command_filename s c C sQ | i i | | f d | i d i d d } | i d | | f d S( s6 Add a string to the archive as a file named `filename`s ...i t utf8t ignores added string '%s' as '%s'N( RB RF t
splitlinest decodeRX ( RG t contentt filename( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR s c
C sM t } | i | d | d | } | d d j p | d d j o d S| i d | i d t | f | o | i | } n | i | } | t | i d d } | i i | d
| | o | i i
| | n | i i h | d 6| d 6 | i d
i
d | d | d d | t i i | i i | S( s] Execute a command and save the output to a file for inclusion in the
report.
R R R i~ i s collected output of '%s' in %si Ra i t outputR` R_ t xmlreportt cmdlinet exitcodet f_stdoutN( R R R[ RX R R R R> Re Rh R R9 RF t add_commandRc R Rd t get_archive_path(
RG R` R R R R t startRq R t outfn_strip( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt get_cmd_output_now& s$ "
c C s1 t t d | d d d j o d St Sd S( s? Return whether specified moudle as module_name is loaded or nott ^t s
/proc/modulesi N( R R R[ R ( RG t module_name( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt is_module_loadedG s $c C s | i i | d S( sp Add an alert to the collection of alerts for this plugin. These
will be displayed in the report
N( R: RF ( RG t alertstring( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt add_alertO s c C s | i | 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; ( RG t text( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt add_custom_textU s c C s
t i | S( N( R ( RG R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR [ s c C s6 x/ | i D]$ } | i d | | i | q
Wd S( Ns collecting path '%s'( RA RV R ( RG R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _collect_copy_specs^ s
c C s x t | i D]n } | d \ } } } } } | i d d | d | i d | | i | d | d | d | d | q Wd S( Ni s unpacked command tuple: s ('%s', '%s', '%s', %s, '%s')s collecting output of '%s'R R R R ( R RC RX RV R ( RG t progsR R R R R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _collect_cmd_outputc s c
C s x | i D] \ } } d } | | i d i d d 7} | i d | | f y/ | i i | t i i d | i | Wq
t
j
o } | i d | | f q
Xq
Wd S( Ns ...i R R s collecting string '%s' as '%s'R s could not add string '%s': %s( RB R R RV Re Rh Rc R Rd RN Ri RX ( RG t stringR R Rr ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt _collect_stringsm s
c C sU t } | i | i | i | i t | f } | i d | d S( s Collect the data for a plugin.s collected plugin '%s' in %sN( R R R R RN RX ( RG R t fields( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt collect| s
c C sT yE t | d o | i o | i i St | i | i i SWn d SXd S( s9 This function will return the description for the plugint __doc__s N( Rx R R t supert __class__( RG ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt get_description s c s i p
i o t i t o i g _ n t i t o i g _ n t d i D p t f d i D St 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 neither class.files or
class.packages is specified. If either are specified the plugin will
check for the existence of any of the supplied files or packages and
return True if any exist. It is encouraged to override this method if
this behavior isn't applicable.
c s s% x | ] } t i i | Vq Wd S( N( Rc R R ( R R ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pys s c 3 s" x | ] } i | Vq Wd S( N( R] ( R t pkg( RG ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pys s ( R t packagesR R R R ( RG ( ( RG s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
check_enabled 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.( R ( RG ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt default_enabled s c C s | i t | i 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 R ( RG ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt setup s c C s d S( sL Perform any postprocessing. To be replaced by a plugin if required.
N( ( RG ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt postproc s c C s d | i } | d | i d } t | i o} | d } xb | i D]W } | d d | d | d f } | d d
j o | d | d } n | d
} qL W| d } n t | i o | d } xx | i D]m } | d oJ t | d o9 d | i d d | d } | d | | d f } q | d | d } q W| d } n t | i o: | d } x | i D] } | d | } q|W| d } n | i d j o | d } | | i d } n | S( sm Present all information that was gathered in an html file that
allows browsing the results.
s
s
( RN R R8 R9 R> R: R; ( RG t htmlR Rj t cmd_rel_patht alert( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt report s@
N( ( ( (@ RK t
__module__R R[ RJ R t
requires_roott versionR R Re t profilesRI t classmethodRN RP RR RT RV RX RY R] Rs Rv R| R} R R Rt R R R R R R R R R R R R R R R R R R R R7 R R R R R R R R R R R! R" R# R$ R( ( ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR. D sz ' ) 0 ! $
t RedHatPluginc B s e Z d Z RS( sB Tagging class to indicate that this plugin works with CentOS Linux( RK R) R ( ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR. s t UbuntuPluginc B s e Z d Z RS( sB Tagging class to indicate that this plugin works with Ubuntu Linux( RK R) R ( ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR/ s t DebianPluginc B s e Z d Z RS( sB Tagging class to indicate that this plugin works with Debian Linux( RK R) R ( ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR0 s t IndependentPluginc B s e Z d Z RS( s@ Tagging class that indicates this plugin can run on any platform( RK R) R ( ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyR1 s c C s+ d | } | p
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 ( RN t superclassest
plugin_fqname( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt
import_plugin s
( R t
__future__R t
sos.utilitiesR R R R R Rc R R R$ R RD Rb R R R" R- t objectR. R. R/ R0 R1 R[ R4 ( ( ( s8 /usr/lib/python2.6/site-packages/sos/plugins/__init__.pyt s* (