1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
|
## This exports methods available for use by plugins for sos
## Copyright (C) 2006 Steve Conklin <sconklin@redhat.com>
### This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
# pylint: disable-msg = R0902
# pylint: disable-msg = R0904
# pylint: disable-msg = W0702
# pylint: disable-msg = W0703
# pylint: disable-msg = R0201
# pylint: disable-msg = W0611
# pylint: disable-msg = W0613
from __future__ import with_statement
from sos.utilities import sosGetCommandOutput, import_module, grep, fileobj, tail
from sos import _sos as _
import inspect
import os
import sys
import string
import glob
import re
import traceback
import shutil
from stat import *
from time import time
from itertools import *
import logging
import urllib2
try:
import json
except ImportError:
import simplejson as json
def commonPrefix(l1, l2, common = None):
"""Returns a tuple like the following:
([common, elements, from l1, and l2], [[tails, from, l1], [tails, from, l2]])
>>> commonPrefix(['usr','share','foo'], ['usr','share','bar'])
(['usr','share'], [['foo'], ['bar']])
"""
if common is None:
common = []
if len(l1) < 1 or len(l2) < 1 or l1[0] != l2[0]:
return (common, [l1, l2])
return commonPrefix(l1[1:], l2[1:], common+[l1[0]])
def sosRelPath(path1, path2, sep=os.path.sep, pardir=os.path.pardir):
'''Return a relative path from path1 equivalent to path path2. In
particular: the empty string, if path1 == path2; path2, if path1 and path2
have no common prefix.
'''
try:
common, (u1, u2) = commonPrefix(path1.split(sep), path2.split(sep))
except AttributeError:
return path2
if not common:
return path2 # leave path absolute if nothing at all in common
return sep.join( [pardir]*len(u1) + u2 )
def regex_findall(regex, fname):
'''Return a list of all non overlapping matches in the string(s)'''
try:
with fileobj(fname) as f:
return re.findall(regex, f.read(), re.MULTILINE)
except AttributeError:
return []
def mangle_command(command):
# FIXME: this can be improved
mangledname = re.sub(r"^/(usr/|)(bin|sbin)/", "", command)
mangledname = re.sub(r"[^\w\-\.\/]+", "_", mangledname)
mangledname = re.sub(r"/", ".", mangledname).strip(" ._-")[0:64]
return mangledname
class PluginException(Exception):
pass
class Plugin(object):
""" 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 is an iterable of the names of packages to check for before
running this plugin. If any of these packages is found on the system, the
default implementation of checkenabled will return True.
files is an iterable of the paths of files to check for before running this
plugin. If any of these packages is found on the system, the default
implementation of checkenabled will return True.
"""
plugin_name = None
requires_root = True
version = 'unversioned'
packages = ()
files = ()
def __init__(self, commons):
if not getattr(self, "optionList", False):
self.optionList = []
self.copiedFiles = []
self.executedCommands = []
self.diagnose_msgs = []
self.alerts = []
self.customText = ""
self.optNames = []
self.optParms = []
self.cInfo = commons
self.forbiddenPaths = []
self.copyPaths = []
self.copyStrings = []
self.collectProgs = []
self.must_exit = False
self.soslog = logging.getLogger('sos')
self.proflog = logging.getLogger('sosprofile')
# get the option list into a dictionary
for opt in self.optionList:
self.optNames.append(opt[0])
self.optParms.append({'desc':opt[1], 'speed':opt[2], 'enabled':opt[3]})
@classmethod
def name(class_):
"""Returns the plugin's name as a string. This should return a
lowercase string.
"""
if class_.plugin_name:
return class_.plugin_name
return class_.__name__.lower()
def policy(self):
return self.cInfo["policy"]
def isInstalled(self, package_name):
'''Is the package $package_name installed?'''
return (self.policy().pkgByName(package_name) is not None)
def doRegexSub(self, srcpath, regexp, subst):
'''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.
'''
try:
path = self._get_dest_for_srcpath(srcpath)
if not path:
return 0
readable = self.archive.open_file(path)
result, replacements = re.subn(regexp, subst, readable.read())
if replacements:
self.archive.add_string(result, srcpath)
return replacements
else:
return 0
except Exception, e:
return 0
def doRegexFindAll(self, regex, fname):
return regex_findall(regex, fname)
def _path_in_path_list(self, path, path_list):
for p in path_list:
if p in path:
return True
return False
def copy_symlink(self, srcpath, sub=None):
link = os.readlink(srcpath)
if not os.path.isabs(link):
link = os.path.normpath(
os.path.join(
os.path.dirname(srcpath),
link)
)
if os.path.isdir(link):
self.soslog.debug("link %s is a directory, skipping..." % link)
return
dest = link
if sub:
old, new = sub
dest = srcpath.replace(old, new)
self.archive.add_file(link, dest=dest)
self.copiedFiles.append({
'srcpath':srcpath,
'dstpath':dest,
'symlink':"yes",
'pointsto':link})
def copy_dir(self, srcpath, sub=None):
for afile in os.listdir(srcpath):
self.doCopyFileOrDir(os.path.join(srcpath, afile), dest=None, sub=sub)
def _get_dest_for_srcpath(self, srcpath):
for copied in self.copiedFiles:
if srcpath == copied["srcpath"]:
return copied["dstpath"]
return None
# Methods for copying files and shelling out
def doCopyFileOrDir(self, srcpath, dest=None, sub=None):
# pylint: disable-msg = R0912
# pylint: disable-msg = R0915
'''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. sub can be used to rename
the destination of the file, sub should be a two-tuple of (old,new).
For example if you passed in ("etc","configurations") for use against
/etc/my_file.conf the file would end up at
/configurations/my_file.conf.
'''
if self.cInfo['cmdlineopts'].profiler:
start_time = time()
if self._path_in_path_list(srcpath, self.forbiddenPaths):
self.soslog.debug("%s is in the forbidden path list" % srcpath)
return ''
if not os.path.exists(srcpath):
self.soslog.debug("file or directory %s does not exist" % srcpath)
return
if not dest:
dest = srcpath
if sub:
old, new = sub
dest = srcpath.replace(old, new)
if os.path.islink(srcpath):
self.copy_symlink(srcpath, sub=sub)
return
else:
if os.path.isdir(srcpath):
self.copy_dir(srcpath, sub=sub)
return
# if we get here, it's definitely a regular file (not a symlink or dir)
self.soslog.debug("copying file %s to %s" % (srcpath,dest))
try:
self.archive.add_file(srcpath, dest)
self.copiedFiles.append({
'srcpath':srcpath,
'dstpath':dest,
'symlink':"no"})
if self.cInfo['cmdlineopts'].profiler:
time_passed = time() - start_time
self.proflog.debug("copied: %-75s time: %f" % (srcpath, time_passed))
except Exception, e:
self.soslog.error("Unable to copy %s to %s" % (srcpath, dest))
self.soslog.error(traceback.format_exc())
def addForbiddenPath(self, forbiddenPath):
"""Specify a path to not copy, even if it's part of a copyPaths[]
entry.
"""
# Glob case handling is such that a valid non-glob is a reduced glob
for filespec in glob.glob(forbiddenPath):
self.forbiddenPaths.append(filespec)
def getAllOptions(self):
"""return a list of all options selected"""
return (self.optNames, self.optParms)
def setOption(self, optionname, value):
'''set the named option to value.'''
for name, parms in izip(self.optNames, self.optParms):
if name == optionname:
parms['enabled'] = value
return True
else:
return False
def isOptionEnabled(self, optionname):
'''Deprecated, use getOption() instead'''
return self.getOption(optionname)
def getOption(self, optionname, default=0):
"""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.
"""
def _check(key):
if hasattr(optionname, "__iter__"):
return key in optionname
else:
return key == optionname
for name, parms in izip(self.optNames, self.optParms):
if _check(name):
val = parms['enabled']
if val != None:
return val
for key, value in self.cInfo.get('global_plugin_options', {}).iteritems():
if _check(key):
return value
return default
def getOptionAsList(self, optionname, delimiter=",", default=None):
'''Will try to return the option as a list separated by the
delimiter.
'''
option = self.getOption(optionname)
try:
opt_list = [opt.strip() for opt in option.split(delimiter)]
return filter(None, opt_list)
except Exception:
return default
def addCopySpecLimit(self, fname, sizelimit=None, sub=None):
"""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.
"""
if not (fname and len(fname)):
return False
files = glob.glob(fname)
files.sort()
cursize = 0
limit_reached = False
sizelimit *= 1024 * 1024 # in MB
flog = None
for flog in files:
cursize += os.stat(flog)[ST_SIZE]
if sizelimit and cursize > sizelimit:
limit_reached = True
break
self.addCopySpec(flog, sub)
if flog == files[0] and limit_reached:
flog_name = flog
if sub:
old, new = sub
flog_name = flog.replace(old, new)
self.addStringAsFile(tail(flog, sizelimit),
flog_name.replace(os.path.sep, ".") + ".tailed")
def addCopySpecs(self, copyspecs, sub=None):
for copyspec in copyspecs:
self.addCopySpec(copyspec, sub)
def addCopySpec(self, copyspec, sub=None):
"""Add a file specification (can be file, dir,or shell glob) to be
copied into the sosreport by this module.
"""
if not (copyspec and len(copyspec)):
# self.soslog.warning("invalid file path")
return False
# Glob case handling is such that a valid non-glob is a reduced glob
for filespec in glob.glob(copyspec):
if filespec not in self.copyPaths:
self.copyPaths.append((filespec, sub))
def callExtProg(self, prog, timeout=300):
"""Execute a command independantly of the output gathering part of
sosreport.
"""
# pylint: disable-msg = W0612
return sosGetCommandOutput(prog, timeout)
def checkExtprog(self, prog):
"""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.
"""
(status, output, runtime) = self.callExtProg(prog)
return (status == 0)
def collectExtOutput(self, exe, suggest_filename=None, root_symlink=None, timeout=300):
"""Run a program and collect the output"""
self.collectProgs.append( (exe, suggest_filename, root_symlink, timeout) )
def fileGrep(self, regexp, *fnames):
"""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.
"""
return grep(regexp, *fnames)
def mangleCommand(self, exe):
return mangle_command(exe)
def makeCommandFilename(self, exe):
"""The internal function to build up a filename based on a command."""
outfn = os.path.join(self.cInfo['cmddir'], self.name(), self.mangleCommand(exe))
# check for collisions
if os.path.exists(outfn):
inc = 2
while True:
newfn = "%s_%d" % (outfn, inc)
if not os.path.exists(newfn):
outfn = newfn
break
inc +=1
return outfn
def addStringAsFile(self, content, filename):
"""Add a string to the archive as a file named `filename`"""
self.copyStrings.append((content, filename))
def collectOutputNow(self, exe, suggest_filename=None, root_symlink=False, timeout=300):
"""Execute a command and save the output to a file for inclusion in the
report.
"""
if self.cInfo['cmdlineopts'].profiler:
start_time = time()
# pylint: disable-msg = W0612
status, shout, runtime = sosGetCommandOutput(exe, timeout=timeout)
if suggest_filename:
outfn = self.makeCommandFilename(suggest_filename)
else:
outfn = self.makeCommandFilename(exe)
if not (status == 127 or status == 32512): # if not command_not_found
outfn_strip = outfn[len(self.cInfo['cmddir'])+1:]
self.archive.add_string(shout, outfn)
if root_symlink:
self.archive.add_link(outfn, root_symlink)
else:
self.soslog.debug("could not run command: %s" % exe)
outfn = None
outfn_strip = None
# save info for later
self.executedCommands.append({'exe': exe, 'file':outfn_strip}) # save in our list
self.cInfo['xmlreport'].add_command(cmdline=exe,exitcode=status,f_stdout=outfn_strip,runtime=runtime)
if self.cInfo['cmdlineopts'].profiler:
time_passed = time() - start_time
self.proflog.debug("output: %-75s time: %f" % (exe, time_passed))
return outfn
# For adding warning messages regarding configuration sanity
def addDiagnose(self, alertstring):
"""Add a configuration sanity warning for this plugin. These will be
displayed on-screen before collection and in the report as well.
"""
self.diagnose_msgs.append(alertstring)
# For adding output
def addAlert(self, alertstring):
"""Add an alert to the collection of alerts for this plugin. These
will be displayed in the report
"""
self.alerts.append(alertstring)
def addCustomText(self, text):
"""Append text to the custom text that is included in the report. This
is freeform and can include html.
"""
self.customText += text
def copyStuff(self):
"""Collect the data for a plugin."""
for path, sub in self.copyPaths:
self.doCopyFileOrDir(path, sub=sub)
for string, file_name in self.copyStrings:
try:
self.archive.add_string(string,
os.path.join('sos_strings', self.name(), file_name))
except Exception, e:
self.soslog.debug("could not create %s, traceback follows: %s" % (file_name, e))
for progs in izip(self.collectProgs):
prog, suggest_filename, root_symlink, timeout = progs[0]
# self.soslog.debug("collecting output of '%s'" % prog)
try:
self.collectOutputNow(prog, suggest_filename, root_symlink, timeout)
except Exception, e:
self.soslog.debug("error collection output of '%s', traceback follows: %s" % (prog, e))
def exit_please(self):
""" This function tells the plugin that it should exit ASAP"""
self.must_exit = True
def get_description(self):
""" This function will return the description for the plugin"""
try:
return self.__doc__.strip()
except:
return "<no description available>"
def checkenabled(self):
"""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 applicabled.
"""
# some files or packages have been specified for this package
if self.files or self.packages:
if isinstance(self.files, basestring):
self.files = [self.files]
if isinstance(self.packages, basestring):
self.packages = [self.packages]
return (any(os.path.exists(fname) for fname in self.files) or
any(self.isInstalled(pkg) for pkg in self.packages))
return True
def defaultenabled(self):
"""This devices whether a plugin should be automatically loaded or
only if manually specified in the command line."""
return True
def diagnose(self):
"""This method must be overridden to check the sanity of the system's
configuration before the collection begins.
"""
pass
def setup(self):
"""This method must be overridden to add the copyPaths, forbiddenPaths,
and external programs to be collected at a minimum.
"""
pass
def analyze(self):
"""
perform any analysis. To be replaced by a plugin if desired
"""
pass
def postproc(self):
"""
perform any postprocessing. To be replaced by a plugin if desired
"""
pass
def report(self):
""" Present all information that was gathered in an html file that allows browsing
the results.
"""
# make this prettier
html = '<hr/><a name="%s"></a>\n' % self.name()
# Intro
html = html + "<h2> Plugin <em>" + self.name() + "</em></h2>\n"
# Files
if len(self.copiedFiles):
html = html + "<p>Files copied:<br><ul>\n"
for afile in self.copiedFiles:
html = html + '<li><a href="%s">%s</a>' % (afile['dstpath'], afile['srcpath'])
if (afile['symlink'] == "yes"):
html = html + " (symlink to %s)" % afile['pointsto']
html = html + '</li>\n'
html = html + "</ul></p>\n"
# Command Output
if len(self.executedCommands):
html = html + "<p>Commands Executed:<br><ul>\n"
# convert file name to relative path from our root
for cmd in self.executedCommands:
if cmd["file"] and len(cmd["file"]):
cmdOutRelPath = sosRelPath(self.cInfo['rptdir'], self.cInfo['cmddir'] + "/" + cmd['file'])
html = html + '<li><a href="%s">%s</a></li>\n' % (cmdOutRelPath, cmd['exe'])
else:
html = html + '<li>%s</li>\n' % (cmd['exe'])
html = html + "</ul></p>\n"
# Alerts
if len(self.alerts):
html = html + "<p>Alerts:<br><ul>\n"
for alert in self.alerts:
html = html + '<li>%s</li>\n' % alert
html = html + "</ul></p>\n"
# Custom Text
if (self.customText != ""):
html = html + "<p>Additional Information:<br>\n"
html = html + self.customText + "</p>\n"
return html
class RedHatPlugin(object):
"""Tagging class to indicate that this plugin works with Red Hat Linux"""
pass
class UbuntuPlugin(object):
"""Tagging class to indicate that this plugin works with Ubuntu Linux"""
pass
class DebianPlugin(object):
"""Tagging class to indicate that this plugin works with Debian Linux"""
pass
class IndependentPlugin(object):
"""Tagging class that indicates this plugin can run on any platform"""
pass
class AS7Mixin(object):
"""A mixin class that adds some helpful methods for AS7 related plugins"""
class Request(object):
def __init__(self, resource, operation="read-resource", parameters=None):
self.resource = resource
self.operation = operation
if parameters:
self.parameters = parameters
else:
self.parameters = {}
def url_parts(self):
"""Generator function to split a url into (key, value) tuples. The
url should contain an even number of pairs. In the case of / the
generator will immediately stop iteration.
"""
parts = self.resource.strip("/").split("/")
if parts == ['']:
raise StopIteration
while parts:
yield (parts.pop(0), parts.pop(0))
def get_jboss_home(self):
return self._get_opt('home', 'as7_home') or os.getenv("JBOSS_HOME", None)
def query(self, request_obj):
try:
return self.query_java(request_obj)
except Exception, e:
self.addAlert("JBOSS API call failed, falling back to HTTP: %s" % e)
return self.query_http(request_obj)
def _get_opt(self, first, second, default=None):
val = self.getOption(first)
if val:
return val
val = self.getOption(second)
if val:
return val
return default
def query_java(self, request_obj):
from org.jboss.dmr import ModelNode
controller_client = self.getOption('controller_client_proxy')
if not controller_client:
raise AttributeError("Controller Client is not available")
request = ModelNode()
request.get("operation").set(request_obj.operation)
for key, val in request_obj.url_parts():
request.get('address').add(key,val)
if request_obj.parameters:
for key, value in request_obj.parameters.iteritems():
request.get(key).set(value)
return controller_client.execute(request).toJSONString(True)
def query_http(self, request_obj, postdata=None):
host = self._get_opt('host', 'as7_host')
port = self._get_opt('port', 'as7_port')
username = self._get_opt('user', 'as7_user')
password = self._get_opt('pass', 'as7_pass')
uri = "http://%s:%s/management" % (host,port)
json_data = {'operation': request_obj.operation,
'address': []}
for key, val in request_obj.url_parts():
json_data['address'].append({key:val})
for key, val in request_obj.parameters.iteritems():
json_data[key] = val
postdata = json.dumps(json_data)
headers = {'Content-Type': 'application/json',
'Accept': 'application/json'}
opener = urllib2.build_opener()
if username and password:
passwd_manager = urllib2.HTTPPasswordMgrWithDefaultRealm()
passwd_manager.add_password(realm="ManagementRealm",
uri=uri,
user=username,
passwd=password)
digest_auth_handler = urllib2.HTTPDigestAuthHandler(passwd_manager)
basic_auth_handler = urllib2.HTTPBasicAuthHandler(passwd_manager)
opener.add_handler(digest_auth_handler)
opener.add_handler(basic_auth_handler)
req = urllib2.Request(uri, data=postdata, headers=headers)
try:
resp = opener.open(req)
return resp.read()
except Exception, e:
err_msg = "Could not query url: %s; error: %s" % (uri, e)
self.addAlert(err_msg)
return err_msg
def set_domain_info(self, parameters=None):
"""This function will add host controller and server instance name data
if it is present to the desired resource. This is to support
domain-mode operation in AS7.
"""
host_controller_name = self.getOption("as7_host_controller_name")
server_name = self.getOption("as7_server_name")
if host_controller_name and server_name:
if not parameters:
parameters = {}
parameters['host'] = host_controller_name
parameters['server'] = server_name
return parameters
def resource_to_file(self, resource=None, parameters=None, operation='read-resource', outfile=None):
parameters = self.set_domain_info(parameters)
r = self.Request(resource=resource,
parameters=parameters,
operation=operation)
self.addStringAsFile(self.query(r), filename=outfile)
def import_plugin(name, superclasses=None):
"""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,).
"""
try:
plugin_fqname = "sos.plugins.%s" % name
if not superclasses:
superclasses = (Plugin,)
return import_module(plugin_fqname, superclasses)
except ImportError, e:
return None
|