Products.ZenModel.DataRoot

66 implements(IDataRoot) 67 68 meta_type = portal_type = 'DataRoot' 69 70 manage_main = OrderedFolder.manage_main 71 72 manage_options = OrderedFolder.manage_options 73 74 #setTitle = DTMLFile('dtml/setTitle',globals()) 75 76 _rq = True 77 uuid = None 78 availableVersion = None 79 lastVersionCheck = 0 80 lastVersionCheckAttempt = 0 81 versionCheckOptIn = True 82 reportMetricsOptIn = True 83 acceptedTerms = True 84 instanceIdentifier = 'Zenoss' 85 smtpHost = 'localhost' 86 pageCommand = '$ZENHOME/bin/zensnpp localhost 444 $RECIPIENT' 87 smtpPort = 25 88 smtpUser = '' 89 smtpPass = '' 90 smtpUseTLS = 0 91 emailFrom = '' 92 iconMap = {} 93 geomapapikey = '' 94 geocache = '' 95 version = "" 96 97 _properties=( 98 {'id':'title', 'type': 'string', 'mode':'w'}, 99 {'id':'prodStateDashboardThresh','type':'int','mode':'w'}, 100 {'id':'prodStateConversions','type':'lines','mode':'w'}, 101 {'id':'priorityConversions','type':'lines','mode':'w'}, 102 {'id':'priorityDashboardThresh','type':'int','mode':'w'}, 103 {'id':'statusConversions','type':'lines','mode':'w'}, 104 {'id':'interfaceStateConversions','type':'lines','mode':'w'}, 105 {'id':'administrativeRoles','type':'lines','mode':'w'}, 106 {'id':'uuid', 'type': 'string', 'mode':'w'}, 107 {'id':'availableVersion', 'type': 'string', 'mode':'w'}, 108 {'id':'lastVersionCheck', 'type': 'long', 'mode':'w'}, 109 {'id':'lastVersionCheckAttempt', 'type': 'long', 'mode':'w'}, 110 {'id':'versionCheckOptIn', 'type': 'boolean', 'mode':'w'}, 111 {'id':'reportMetricsOptIn', 'type': 'boolean', 'mode':'w'}, 112 {'id':'instanceIdentifier', 'type': 'string', 'mode':'w'}, 113 {'id':'smtpHost', 'type': 'string', 'mode':'w'}, 114 {'id':'smtpPort', 'type': 'int', 'mode':'w'}, 115 {'id':'pageCommand', 'type': 'string', 'mode':'w'}, 116 {'id':'smtpUser', 'type': 'string', 'mode':'w'}, 117 {'id':'smtpPass', 'type': 'string', 'mode':'w'}, 118 {'id':'smtpUseTLS', 'type': 'int', 'mode':'w'}, 119 {'id':'emailFrom', 'type': 'string', 'mode':'w'}, 120 {'id':'geomapapikey', 'type': 'string', 'mode':'w'}, 121 {'id':'geocache', 'type': 'string', 'mode':'w'}, 122 ) 123 124 _relations = ( 125 ('userCommands', ToManyCont(ToOne, 'Products.ZenModel.UserCommand', 'commandable')), 126 # packs is depracated. Has been moved to dmd.ZenPackManager.packs 127 # Should be removed post Zenoss 2.2 128 # TODO 129 ('packs', ToManyCont(ToOne, 'Products.ZenModel.ZenPack', 'root')), 130 ('zenMenus', ToManyCont( 131 ToOne, 'Products.ZenModel.ZenMenu', 'menuable')), 132 ) 133 134 # Screen action bindings (and tab definitions) 135 factory_type_information = ( 136 { 137 'id' : 'DataRoot', 138 'meta_type' : 'DataRoot', 139 'description' : """Arbitrary device grouping class""", 140 'icon' : 'DataRoot_icon.gif', 141 'product' : 'ZenModel', 142 'factory' : 'manage_addStatusMonitorconf', 143 'immediate_view' : 'Dashboard', 144 'actions' : 145 ( 146 { 'id' : 'settings' 147 , 'name' : 'Settings' 148 , 'action' : 'editSettings' 149 , 'permissions' : ( "Manage DMD", ) 150 }, 151 { 'id' : 'manage' 152 , 'name' : 'Commands' 153 , 'action' : 'dataRootManage' 154 , 'permissions' : ('Manage DMD',) 155 }, 156 { 'id' : 'users' 157 , 'name' : 'Users' 158 , 'action' : 'ZenUsers/manageUserFolder' 159 , 'permissions' : ( 'Manage DMD', ) 160 }, 161 { 'id' : 'packs' 162 , 'name' : 'ZenPacks' 163 , 'action' : 'ZenPackManager/viewZenPacks' 164 , 'permissions' : ( "Manage DMD", ) 165 }, 166 { 'id' : 'jobs' 167 , 'name' : 'Jobs' 168 , 'action' : 'joblist' 169 , 'permissions' : ( "Manage DMD", ) 170 }, 171 { 'id' : 'portlets' 172 , 'name' : 'Portlets' 173 , 'action' : 'editPortletPerms' 174 , 'permissions' : ( "Manage DMD", ) 175 }, 176 { 'id' : 'daemons' 177 , 'name' : 'Daemons' 178 , 'action' : '../About/zenossInfo' 179 , 'permissions' : ( "Manage DMD", ) 180 }, 181 { 'id' : 'versions' 182 , 'name' : 'Versions' 183 , 'action' : '../About/zenossVersions' 184 , 'permissions' : ( "Manage DMD", ) 185 }, 186 { 'id' : 'backups' 187 , 'name' : 'Backups' 188 , 'action' : 'backupInfo' 189 , 'permissions' : ( "Manage DMD", ) 190 }, 191 ) 192 }, 193 ) 194 195 security = ClassSecurityInfo() 196 197 # production state threshold at which devices show on dashboard 198 prodStateDashboardThresh = 1000 199 200 # priority threshold at which devices show on dashboard 201 priorityDashboardThresh = 2 202 203 prodStateConversions = [ 204 'Production:1000', 205 'Pre-Production:500', 206 'Test:400', 207 'Maintenance:300', 208 'Decommissioned:-1', 209 ] 210 211 priorityConversions = [ 212 'Highest:5', 213 'High:4', 214 'Normal:3', 215 'Low:2', 216 'Lowest:1', 217 'Trivial:0', 218 ] 219 220 statusConversions = [ 221 'Up:0', 222 'None:-1', 223 'No DNS:-2', 224 ] 225 226 interfaceStateConversions = [ 227 'up:1', 228 'down:2', 229 'testing:3', 230 'unknown:4', 231 'dormant:5', 232 'notPresent:6', 233 'lowerLayerDown:7', 234 ] 235 236 administrativeRoles = ( 237 "Administrator", 238 "Analyst", 239 "Engineer", 240 "Tester", 241 ) 242 243 defaultDateRange = 129600 244 performanceDateRanges = [ 245 ('Hourly',129600,), 246 ('Daily',864000,), 247 ('Weekly',3628800,), 248 ('Monthly',41472000,), 249 ('Yearly',62208000,) 250 ] 251 252 253 # when calculating the primary path this will be its root 254 zPrimaryBasePath = ("", "zport") 255 256

257 - def __init__(self, id, title=None):

258 ZenModelRM.__init__(self, id, title) 259 from ZVersion import VERSION 260 self.version = "Zenoss " + VERSION

261

262 - def index_html(self):

263 """ 264 Override to force redirection to quickstart. 265 """ 266 if not self._rq: 267 return self.unrestrictedTraverse('quickstart')() 268 return self()

269

270 - def getEventCount(self, **kwargs):

271 """Return the current event list for this managed entity. 272 """ 273 return self.ZenEventManager.getEventCount(**kwargs)

274 275 security.declareProtected(ZEN_COMMON, 'getEventClassNames')

276 - def getEventClassNames(self):

277 """ 278 Get a list of all event class names within the permission scope. 279 """ 280 return self.Events.getOrganizerNames()

281 282

283 - def getDmdRoots(self):

284 return filter(lambda o: o.isInTree, self.objectValues())

285 286

287 - def exportXmlHook(self,ofile, ignorerels):

288 map(lambda x: x.exportXml(ofile, ignorerels), self.getDmdRoots())

289 290 291 security.declareProtected(ZEN_COMMON, 'getProdStateConversions')

292 - def getProdStateConversions(self):

293 """getProdStateConversions() -> return a list of tuples 294 for prodstat select edit box""" 295 return self.getConversions(self.prodStateConversions)

296 297 298 security.declareProtected(ZEN_COMMON, 'convertProdState')

299 - def convertProdState(self, prodState):

300 '''convert a numeric production state to a 301 textual representation using the prodStateConversions 302 map''' 303 return self.convertAttribute(prodState, self.prodStateConversions)

304 305 306 security.declareProtected(ZEN_COMMON, 'getStatusConversions')

307 - def getStatusConversions(self):

308 """get text strings for status field""" 309 return self.getConversions(self.statusConversions)

310 311 312 security.declareProtected(ZEN_COMMON, 'convertStatus')

313 - def convertStatus(self, status):

314 """get text strings for status field""" 315 return self.convertAttribute(status, self.statusConversions)

316 317 security.declareProtected(ZEN_COMMON, 'getPriorityConversions')

318 - def getPriorityConversions(self):

319 return self.getConversions(self.priorityConversions)

320 321 security.declareProtected(ZEN_COMMON, 'convertPriority')

322 - def convertPriority(self, priority):

323 return self.convertAttribute(priority, self.priorityConversions)

324 325 security.declareProtected(ZEN_COMMON, 'getInterfaceStateConversions')

326 - def getInterfaceStateConversions(self):

327 """get text strings for interface status""" 328 if hasattr(self, 'interfaceStateConversions'): 329 return self.getConversions(self.interfaceStateConversions)

330 331 332 security.declareProtected(ZEN_COMMON, 'convertAttribute')

333 - def convertAttribute(self, numbValue, conversions):

334 '''convert a numeric production state to a 335 textual representation using the prodStateConversions 336 map''' 337 numbValue = int(numbValue) 338 for line in conversions: 339 line = line.rstrip() 340 (name, number) = line.split(':') 341 if int(number) == numbValue: 342 return name 343 return numbValue

344 345 security.declareProtected(ZEN_COMMON, 'convertStatusToDot')

346 - def convertStatusToDot(self, status):

347 colors = ['green', 'yellow', 'orange', 'red'] 348 try: 349 return colors[status] 350 except IndexError: 351 return 'grey'

352 353 security.declareProtected(ZEN_COMMON, 'getConversions')

354 - def getConversions(self, attribute):

355 """get the text list of itmes that convert to ints""" 356 convs = [] 357 for item in attribute: 358 tup = item.split(':') 359 try: 360 tup[1] = int(tup[1]) 361 except (IndexError, ValueError): 362 continue 363 convs.append(tup) 364 return convs

365 366 security.declarePublic('filterObjectsRegex')

367 - def filterObjectsRegex(self, filter, objects, 368 filteratt='id', negatefilter=0):

369 """filter a list of objects based on a regex""" 370 filter = re.compile(filter).search 371 filteredObjects = [] 372 for obj in objects: 373 value = getattr(obj, filteratt, None) 374 if callable(value): 375 value = value() 376 fvalue = filter(value) 377 if (fvalue and not negatefilter) or (not fvalue and negatefilter): 378 filteredObjects.append(obj) 379 return filteredObjects

380 381 382 security.declareProtected('View', 'myUserGroups')

383 - def myUserGroups(self):

384 user = self.REQUEST.get('AUTHENTICATED_USER') 385 if hasattr(user, 'getGroups'): 386 return user.getGroups() 387 else: 388 return ()

389 390 391 security.declareProtected('View', 'getAllUserGroups')

392 - def getAllUserGroups(self):

393 return self.acl_users.getGroups()

394 395 396 security.declareProtected(ZEN_VIEW, 'zenoss_error_message')

397 - def zenoss_error_message(self,error_type,error_value, 398 error_traceback,error_message):

399 """Return an error page that is more friendly then the standard stack 400 trace + feedback page for ConflictErrors and MySQL errors (we need to 401 add out of disk space errors). If one of these is not found we return 402 the old stacktrace page 403 """ 404 from ZODB.POSException import ConflictError 405 from Products.ZenEvents.Exceptions import MySQLConnectionError 406 from _mysql_exceptions import MySQLError 407 if isinstance(error_value, ConflictError): 408 return self.zenoss_conflict_error_message() 409 elif isinstance(error_value, MySQLConnectionError) \ 410 or isinstance(error_value, MySQLError): 411 return self.zenoss_mysql_error_message(error_value=error_value) 412 return self.zenoss_feedback_error_message(error_type=error_type, 413 error_value=error_value, 414 error_traceback=error_traceback)

415 416

417 - def reportError(self):

418 ''' send an email to the zenoss error email address 419 then send user to a thankyou page or an email error page. 420 ''' 421 if self.smtpHost: host = self.smtpHost 422 else: host = None 423 port = self.smtpPort and self.smtpPort or 25 424 usetls = self.smtpUseTLS 425 usr = self.smtpUser 426 pwd = self.smtpPass 427 428 mailSent = SiteError.sendErrorEmail( 429 self.REQUEST.errorType, 430 self.REQUEST.errorValue, 431 self.REQUEST.errorTrace, 432 self.REQUEST.errorUrl, 433 self.About.getZenossRevision(), 434 self.About.getZenossVersionShort(), 435 self.REQUEST.contactName, 436 self.REQUEST.contactEmail, 437 self.REQUEST.comments, 438 host, port, usetls, usr, pwd) 439 if not mailSent: 440 body = SiteError.createReport( 441 self.REQUEST.errorType, 442 self.REQUEST.errorValue, 443 self.REQUEST.errorTrace, 444 self.REQUEST.errorUrl, 445 self.About.getZenossRevision(), 446 self.About.getZenossVersionShort(), 447 True, 448 self.REQUEST.contactName, 449 self.REQUEST.contactEmail, 450 self.REQUEST.comments) 451 return self.errorEmailFailure(toAddress=SiteError.ERRORS_ADDRESS, 452 body=body) 453 return self.errorEmailThankYou()

454 455 456 #security.declareProtected('View', 'writeExportRows')

457 - def writeExportRows(self, fieldsAndLabels, objects, out=None):

458 '''Write out csv rows with the given objects and fields. 459 If out is not None then call out.write() with the result and return None 460 otherwise return the result. 461 Each item in fieldsAndLabels is either a string representing a 462 field/key/index (see getDataField) or it is a tuple of (field, label) 463 where label is the string to be used in the first row as label 464 for that column. 465 Objects can be either dicts, lists/tuples or other objects. Field 466 is interpreted as a key, index or attribute depending on what 467 object is. 468 Method names can be passed instead of attribute/key/indices as field. 469 In this case the method is called and the return value is used in 470 the export. 471 ''' 472 import csv 473 import StringIO 474 if out: 475 buffer = out 476 else: 477 buffer = StringIO.StringIO() 478 fields = [] 479 labels = [] 480 if not fieldsAndLabels: 481 fieldsAndLabels = [] 482 if not objects: 483 objects = [] 484 for p in fieldsAndLabels: 485 if isinstance(p, tuple): 486 fields.append(p[0]) 487 labels.append(p[1]) 488 else: 489 fields.append(p) 490 labels.append(p) 491 writer = csv.writer(buffer) 492 writer.writerow(labels) 493 def getDataField(thing, field): 494 if isinstance(thing, dict): 495 value = thing.get(field, '') 496 elif isinstance(thing, list) or isinstance(thing, tuple): 497 value = thing[int(field)] 498 else: 499 value = getattr(thing, field, '') 500 if isinstance(value, ZenModelBase): 501 value = value.id 502 elif callable(value): 503 value = value() 504 if value == None: 505 value = '' 506 return str(value)

507 for o in objects: 508 writer.writerow([getDataField(o,f) for f in fields]) 509 if out: 510 result = None 511 else: 512 result = buffer.getvalue() 513 return result

Source Code for Module Products.ZenModel.DataRoot