Products.ZenModel.IpNetwork

72 """IpNetwork object""" 73 74 isInTree = True 75 76 buildLinks = True 77 78 # Organizer configuration 79 dmdRootName = "Networks" 80 81 # Index name for IP addresses 82 default_catalog = 'ipSearch' 83 84 portal_type = meta_type = 'IpNetwork' 85 86 _properties = ( 87 {'id':'netmask', 'type':'int', 'mode':'w'}, 88 {'id':'description', 'type':'text', 'mode':'w'}, 89 ) 90 91 _relations = DeviceOrganizer._relations + ( 92 ("ipaddresses", ToManyCont(ToOne, "Products.ZenModel.IpAddress", "network")), 93 ("clientroutes", ToMany(ToOne,"Products.ZenModel.IpRouteEntry","target")), 94 ("location", ToOne(ToMany, "Products.ZenModel.Location", "networks")), 95 ) 96 97 # Screen action bindings (and tab definitions) 98 factory_type_information = ( 99 { 100 'id' : 'IpNetwork', 101 'meta_type' : 'IpNetwork', 102 'description' : """Arbitrary device grouping class""", 103 'icon' : 'IpNetwork_icon.gif', 104 'product' : 'ZenModel', 105 'factory' : 'manage_addIpNetwork', 106 'immediate_view' : 'viewNetworkOverview', 107 'actions' : 108 ( 109 { 'id' : 'overview' 110 , 'name' : 'Overview' 111 , 'action' : 'viewNetworkOverview' 112 , 'permissions' : ( 113 permissions.view, ) 114 }, 115 { 'id' : 'zProperties' 116 , 'name' : 'Configuration Properties' 117 , 'action' : 'zPropertyEdit' 118 , 'permissions' : ("Manage DMD",) 119 }, 120 { 'id' : 'viewHistory' 121 , 'name' : 'Modifications' 122 , 'action' : 'viewHistory' 123 , 'permissions' : (ZEN_VIEW_MODIFICATIONS,) 124 }, 125 ) 126 }, 127 ) 128 129 security = ClassSecurityInfo() 130 131

132 - def __init__(self, id, netmask=24, description=''):

133 if id.find("/") > -1: id, netmask = id.split("/",1) 134 DeviceOrganizer.__init__(self, id, description) 135 if id != "Networks": 136 checkip(id) 137 self.netmask = maskToBits(netmask) 138 self.description = description

139 140 security.declareProtected('Change Network', 'manage_addIpNetwork')

141 - def manage_addIpNetwork(self, newPath, REQUEST=None):

142 """ 143 From the GUI, create a new subnet (if necessary) 144 """ 145 net = self.createNet(newPath) 146 if REQUEST is not None: 147 REQUEST['RESPONSE'].redirect(net.absolute_url())

148

149 - def checkValidId(self, id, prep_id = False):

150 """Checks a valid id 151 """ 152 if id.find("/") > -1: id, netmask = id.split("/",1) 153 return super(IpNetwork, self).checkValidId(id, prep_id)

154 155

156 - def getNetworkRoot(self):

157 """This is a hook method do not remove!""" 158 return self.dmd.getDmdRoot("Networks")

159 160

161 - def createNet(self, netip, netmask=24):

162 """ 163 Return and create if necessary network. netip is in the form 164 1.1.1.0/24 or with netmask passed as parameter. Subnetworks created 165 based on the zParameter zDefaulNetworkTree. 166 Called by IpNetwork.createIp and IpRouteEntry.setTarget 167 If the netmask is invalid, then a netmask of 24 is assumed. 168 169 @param netip: network IP address start 170 @type netip: string 171 @param netmask: network mask 172 @type netmask: integer 173 @todo: investigate IPv6 issues 174 """ 175 if netip.find("/") > -1: netip, netmask = netip.split("/",1) 176 try: 177 netmask = int(netmask) 178 except (TypeError, ValueError): 179 netmask = 24 180 if netmask < 0 or netmask >= 64: 181 netmask = 24 182 183 #hook method do not remove! 184 netroot = self.getNetworkRoot() 185 netobj = netroot.getNet(netip) 186 if netmask == 0: 187 raise ValueError("netip '%s' without netmask" % netip) 188 if netobj and netobj.netmask >= netmask: # Network already exists. 189 return netobj 190 191 netip = getnetstr(netip,netmask) 192 netTree = getattr(self, 'zDefaultNetworkTree', defaultNetworkTree) 193 netTree = map(int, netTree) 194 if netobj: 195 # strip irrelevant values from netTree if we're not starting at /0 196 netTree = [ m for m in netTree if m > netobj.netmask ] 197 else: 198 # start at /Networks if no containing network was found 199 netobj = netroot 200 201 for treemask in netTree: 202 if treemask >= netmask: 203 netobjParent = netobj 204 netobj = netobj.addSubNetwork(netip, netmask) 205 self.rebalance(netobjParent, netobj) 206 break 207 else: 208 supnetip = getnetstr(netip, treemask) 209 netobjParent = netobj 210 netobj = netobj.addSubNetwork(supnetip, treemask) 211 self.rebalance(netobjParent, netobj) 212 213 return netobj

214 215

216 - def rebalance(self, netobjParent, netobj):

217 """ 218 Look for children of the netobj at this level and move them to the 219 right spot. 220 """ 221 moveList = [] 222 for subnetOrIp in netobjParent.children(): 223 if subnetOrIp == netobj: 224 continue 225 if netobj.hasIp(subnetOrIp.id): 226 moveList.append(subnetOrIp.id) 227 if moveList: 228 netobjPath = netobj.getOrganizerName()[1:] 229 netobjParent.moveOrganizer(netobjPath, moveList)

230

231 - def findNet(self, netip, netmask=0):

232 """ 233 Find and return the subnet of this IpNetwork that matches the requested 234 netip and netmask. 235 """ 236 if netip.find("/") >= 0: 237 netip, netmask = netip.split("/", 1) 238 netmask = int(netmask) 239 for subnet in [self] + self.getSubNetworks(): 240 if netmask == 0 and subnet.id == netip: 241 return subnet 242 if subnet.id == netip and subnet.netmask == netmask: 243 return subnet 244 return None

245 246

247 - def getNet(self, ip):

248 """Return the net starting form the Networks root for ip. 249 """ 250 return self._getNet(ip)

251 252

253 - def _getNet(self, ip):

254 """Recurse down the network tree to find the net of ip. 255 """ 256 257 # If we can find the IP in the catalog, use it. This is fast. 258 brains = self.ipSearch(id=ip) 259 path = self.getPrimaryUrlPath() 260 for brain in brains: 261 bp = brain.getPath() 262 if bp.startswith(path): 263 return self.unrestrictedTraverse('/'.join(bp.split('/')[:-2])) 264 265 # Otherwise we have to traverse the entire network hierarchy. 266 for net in self.children(): 267 if net.hasIp(ip): 268 if len(net.children()): 269 subnet = net._getNet(ip) 270 if subnet: 271 return subnet 272 else: 273 return net 274 else: 275 return net

276 277

278 - def createIp(self, ip, netmask=24):

279 """Return an ip and create if nessesary in a hierarchy of 280 subnetworks based on the zParameter zDefaulNetworkTree. 281 """ 282 ipobj = self.findIp(ip) 283 if ipobj: return ipobj 284 netobj = self.createNet(ip, netmask) 285 ipobj = netobj.addIpAddress(ip,netmask) 286 return ipobj

287 288

289 - def freeIps(self):

290 """Number of free Ips left in this network. 291 """ 292 freeips = int(math.pow(2,32-self.netmask)-(self.countIpAddresses())) 293 if self.netmask >= 31: 294 return freeips 295 return freeips - 2

296 297

298 - def hasIp(self, ip):

299 """Does network have (contain) this ip. 300 """ 301 start = numbip(self.id) 302 end = start + math.pow(2,32-self.netmask) 303 return start <= numbip(ip) < end

304 305

306 - def fullIpList(self):

307 """Return a list of all ips in this network. 308 """ 309 if (self.netmask == 32): return [self.id] 310 ipnumb = numbip(self.id) 311 maxip = math.pow(2,32-self.netmask) 312 start = int(ipnumb+1) 313 end = int(ipnumb+maxip-1) 314 return map(strip, range(start,end))

315 316

317 - def deleteUnusedIps(self):

318 """Delete ips that are unused in this network. 319 """ 320 for ip in self.ipaddresses(): 321 if ip.device(): continue 322 self.ipaddresses.removeRelation(ip)

323 324

325 - def defaultRouterIp(self):

326 """Return the ip of the default router for this network. 327 It is based on zDefaultRouterNumber which specifies the sequence 328 number that locates the router in this network. If: 329 zDefaultRouterNumber==1 for 10.2.1.0/24 -> 10.2.1.1 330 zDefaultRouterNumber==254 for 10.2.1.0/24 -> 10.2.1.254 331 zDefaultRouterNumber==1 for 10.2.2.128/25 -> 10.2.2.129 332 zDefaultRouterNumber==126 for 10.2.2.128/25 -> 10.2.2.254 333 """ 334 roffset = getattr(self, "zDefaultRouterNumber", 1) 335 return strip((numbip(self.id) + roffset))

336 337

338 - def getNetworkName(self):

339 """return the full network name of this network""" 340 return "%s/%d" % (self.id, self.netmask)

341 342 343 security.declareProtected('View', 'primarySortKey')

344 - def primarySortKey(self):

345 """ 346 Sort by the IP numeric 347 348 >>> net = dmd.Networks.addSubNetwork('1.2.3.0', 24) 349 >>> net.primarySortKey() 350 16909056L 351 """ 352 return numbip(self.id)

353 354 355 security.declareProtected('Change Network', 'addSubNetwork')

356 - def addSubNetwork(self, ip, netmask=24):

357 """Return and add if nessesary subnetwork to this network. 358 """ 359 netobj = self.getSubNetwork(ip) 360 if not netobj: 361 net = IpNetwork(ip, netmask) 362 self._setObject(ip, net) 363 return self.getSubNetwork(ip)

364 365 366 security.declareProtected('View', 'getSubNetwork')

367 - def getSubNetwork(self, ip):

368 """get an ip on this network""" 369 return self._getOb(ip, None)

370 371

372 - def getSubNetworks(self):

373 """Return all network objects below this one. 374 """ 375 nets = self.children() 376 for subgroup in self.children(): 377 nets.extend(subgroup.getSubNetworks()) 378 return nets

379 380 security.declareProtected('Change Network', 'addIpAddress')

381 - def addIpAddress(self, ip, netmask=24):

382 """add ip to this network and return it""" 383 ipobj = IpAddress(ip,netmask) 384 self.ipaddresses._setObject(ip, ipobj) 385 return self.getIpAddress(ip)

386 387 388 security.declareProtected('View', 'getIpAddress')

389 - def getIpAddress(self, ip):

390 """get an ip on this network""" 391 return self.ipaddresses._getOb(ip, None)

392 393 security.declareProtected('Change Network', 'manage_deleteIpAddresses')

394 - def manage_deleteIpAddresses(self, ipaddresses=(), REQUEST=None):

395 """Delete ipaddresses by id from this network. 396 """ 397 for ipaddress in ipaddresses: 398 ip = self.getIpAddress(ipaddress) 399 self.ipaddresses.removeRelation(ip) 400 if REQUEST: 401 return self.callZenScreen(REQUEST)

402 403 404 security.declareProtected('View', 'countIpAddresses')

405 - def countIpAddresses(self, inuse=False):

406 """get an ip on this network""" 407 if inuse: 408 # When there are a large number of IPs this code is too slow 409 # we either need to cache all /Status/Ping events before hand 410 # and then integrate them with the list of IPs 411 # or blow off the whole feature. For now we just set the 412 # default to not use this code. -EAD 413 count = len(filter(lambda x: x.getStatus() == 0,self.ipaddresses())) 414 else: 415 count = self.ipaddresses.countObjects() 416 for net in self.children(): 417 count += net.countIpAddresses(inuse) 418 return count

419 420 security.declareProtected('View', 'countDevices') 421 countDevices = countIpAddresses 422 423

424 - def getAllCounts(self, devrel=None):

425 """Count all devices within a device group and get the 426 ping and snmp counts as well""" 427 unused(devrel) 428 counts = [ 429 self.ipaddresses.countObjects(), 430 self._status("Ping", "ipaddresses"), 431 self._status("Snmp", "ipaddresses"), 432 ] 433 for group in self.children(): 434 sc = group.getAllCounts() 435 for i in range(3): counts[i] += sc[i] 436 return counts

437 438

439 - def pingStatus(self, devrel=None):

440 """aggregate ping status for all devices in this group and below""" 441 unused(devrel) 442 return DeviceOrganizer.pingStatus(self, "ipaddresses")

443 444

445 - def snmpStatus(self, devrel=None):

446 """aggregate snmp status for all devices in this group and below""" 447 unused(devrel) 448 return DeviceOrganizer.snmpStatus(self, "ipaddresses")

449 450

451 - def getSubDevices(self, filter=None):

452 """get all the devices under and instance of a DeviceGroup""" 453 return DeviceOrganizer.getSubDevices(self, filter, "ipaddresses")

454 455

456 - def findIp(self, ip):

457 """Find an ipAddress. 458 """ 459 searchCatalog = self.getDmdRoot("Networks").ipSearch 460 ret = searchCatalog(dict(id=ip)) 461 if not ret: return None 462 if len(ret) > 1: 463 raise IpAddressConflict( "IP address conflict for IP: %s" % ip ) 464 return ret[0].getObject()

465 466

467 - def buildZProperties(self):

468 nets = self.getDmdRoot("Networks") 469 if getattr(aq_base(nets), "zDefaultNetworkTree", False): 470 return 471 nets._setProperty("zDefaultNetworkTree", (24,32), type="lines") 472 nets._setProperty("zDrawMapLinks", True, type="boolean") 473 nets._setProperty("zAutoDiscover", True, type="boolean") 474 nets._setProperty("zPingFailThresh", 168, type="int") 475 nets._setProperty("zIcon", "/zport/dmd/img/icons/network.png") 476 nets._setProperty("zPreferSnmpNaming", False, type="boolean") 477 nets._setProperty("zSnmpStrictDiscovery", False, type="boolean")

478 479

480 - def reIndex(self):

481 """Go through all ips in this tree and reindex them.""" 482 zcat = self._getCatalog() 483 zcat.manage_catalogClear() 484 transaction.savepoint() 485 for net in self.getSubNetworks(): 486 for ip in net.ipaddresses(): 487 ip.index_object() 488 transaction.savepoint()

489 490

491 - def createCatalog(self):

492 """make the catalog for device searching""" 493 from Products.ZCatalog.ZCatalog import manage_addZCatalog 494 495 # XXX convert to ManagableIndex 496 manage_addZCatalog(self, self.default_catalog, 497 self.default_catalog) 498 zcat = self._getOb(self.default_catalog) 499 cat = zcat._catalog 500 cat.addIndex('id', makeCaseInsensitiveFieldIndex('id')) 501 zcat.addColumn('getPrimaryId')

502 503

504 - def discoverNetwork(self, REQUEST=None):

505 """ 506 """ 507 path = '/'.join(self.getPrimaryPath()[4:]) 508 return self.discoverDevices([path], REQUEST=REQUEST)

509

510 - def discoverDevices(self, organizerPaths=None, REQUEST = None):

511 """ 512 Load a device into the database connecting its major relations 513 and collecting its configuration. 514 """ 515 xmlrpc = isXmlRpc(REQUEST) 516 517 if not organizerPaths: 518 if xmlrpc: return 1 519 return self.callZenScreen(REQUEST) 520 521 zDiscCommand = "empty" 522 523 from Products.ZenUtils.ZenTales import talesEval 524 525 orgroot = self.getNetworkRoot() 526 for organizerName in organizerPaths: 527 organizer = orgroot.getOrganizer(organizerName) 528 if organizer is None: 529 if xmlrpc: return 1 # XML-RPC error 530 log.error("Couldn't obtain a network entry for '%s' " 531 "-- does it exist?" % organizerName) 532 continue 533 534 zDiscCommand = getattr(organizer, "zZenDiscCommand", None) 535 if zDiscCommand: 536 cmd = talesEval('string:' + zDiscCommand, organizer).split(" ") 537 else: 538 cmd = ["zendisc", "run", "--net", organizer.getNetworkName()] 539 if getattr(organizer, "zSnmpStrictDiscovery", False): 540 cmd += ["--snmp-strict-discovery"] 541 if getattr(organizer, "zPreferSnmpNaming", False): 542 cmd += ["--prefer-snmp-naming"] 543 zd = binPath('zendisc') 544 zendiscCmd = [zd] + cmd[1:] 545 status = self.dmd.JobManager.addJob(ShellCommandJob, zendiscCmd) 546 547 log.info('Done') 548 549 if REQUEST and not xmlrpc: 550 REQUEST.RESPONSE.redirect('/zport/dmd/JobManager/joblist') 551 552 if xmlrpc: return 0

553 554

555 - def setupLog(self, response):

556 """setup logging package to send to browser""" 557 from logging import StreamHandler, Formatter 558 root = logging.getLogger() 559 self._v_handler = StreamHandler(response) 560 fmt = Formatter("""<tr class="tablevalues"> 561 <td>%(asctime)s</td><td>%(levelname)s</td> 562 <td>%(name)s</td><td>%(message)s</td></tr> 563 """, "%Y-%m-%d %H:%M:%S") 564 self._v_handler.setFormatter(fmt) 565 root.addHandler(self._v_handler) 566 root.setLevel(10)

567 568

569 - def clearLog(self):

570 alog = logging.getLogger() 571 if getattr(self, "_v_handler", False): 572 alog.removeHandler(self._v_handler)

573 574

575 - def loaderFooter(self, response):

576 """add navigation links to the end of the loader output""" 577 response.write("""<tr class="tableheader"><td colspan="4"> 578 Navigate to network <a href=%s>%s</a></td></tr>""" 579 % (self.absolute_url(), self.id)) 580 response.write("</table></body></html>")

581 582 security.declareProtected('View', 'getXMLEdges')

583 - def getXMLEdges(self, depth=1, filter='/', start=()):

584 """ Gets XML """ 585 if not start: start=self.id 586 edges = NetworkTree.get_edges(self, depth, 587 withIcons=True, filter=filter) 588 return edgesToXML(edges, start)

589

590 - def getIconPath(self):

591 """ gets icon """ 592 try: 593 return self.primaryAq().zIcon 594 except AttributeError: 595 return '/zport/dmd/img/icons/noicon.png'

596 597

598 - def urlLink(self, text=None, url=None, attrs={}):

599 """ 600 Return an anchor tag if the user has access to the remote object. 601 @param text: the text to place within the anchor tag or string. 602 Defaults to the id of this object. 603 @param url: url for the href. Default is getPrimaryUrlPath 604 @type attrs: dict 605 @param attrs: any other attributes to be place in the in the tag. 606 @return: An HTML link to this object 607 @rtype: string 608 """ 609 if not text: 610 text = "%s/%d" % (self.id, self.netmask) 611 if not self.checkRemotePerm("View", self): 612 return text 613 if not url: 614 url = self.getPrimaryUrlPath() 615 if len(attrs): 616 return '<a href="%s" %s>%s</a>' % (url, 617 ' '.join(['%s="%s"' % (x,y) for x,y in attrs.items()]), 618 text) 619 else: 620 return '<a href="%s">%s</a>' % (url, text)

Source Code for Module Products.ZenModel.IpNetwork