Changeset 2877

Timestamp:

05/03/06 19:19:53 (19 years ago)

Author:

jerome

Message:

Added support for pysnmp v4.x in addition to v3.4.x

Location:

pykota/trunk

Files:

• bin/pkturnkey (modified) (1 diff)
• NEWS (modified) (1 diff)
• pykota/accounters/snmp.py (modified) (3 diffs)
• pykota/version.py (modified) (1 diff)
• README (modified) (1 diff)

pykota/trunk/bin/pkturnkey

@@ -221 +221 @@
     def supportsSNMP(self, hostname, community) :
         """Returns 1 if the printer accepts SNMP queries, else 0."""
+        pageCounterOID = "1.3.6.1.2.1.43.10.2.1.4.1.1"  # SNMPv2-SMI::mib-2.43.10.2.1.4.1.1
         try :
-            from pysnmp.asn1.encoding.ber.error import TypeMismatchError
-            from pysnmp.mapping.udp.role import Manager
-            from pysnmp.proto.api import alpha
+            from pysnmp.entity.rfc3413.oneliner import cmdgen
         except ImportError :    
-            sys.stderr.write("pysnmp doesn't seem to be installed. SNMP checks will be ignored !\n")
-            return 0
-            
-        pageCounterOID = ".1.3.6.1.2.1.43.10.2.1.4.1.1"  # SNMPv2-SMI::mib-2.43.10.2.1.4.1.1
-        def retrieveSNMPValues(hostname, community) :    
-            """Retrieves a printer's internal page counter and status via SNMP."""
-            ver = alpha.protoVersions[alpha.protoVersionId1]
-            req = ver.Message()
-            req.apiAlphaSetCommunity(community)
-            req.apiAlphaSetPdu(ver.GetRequestPdu())
-            req.apiAlphaGetPdu().apiAlphaSetVarBindList((pageCounterOID, ver.Null()))
-            tsp = Manager()
+            hasV4 = False
             try :
-                tsp.sendAndReceive(req.berEncode(), \
-                                   (hostname, 161), \
-                                   (handleAnswer, req))
-            except :    
-                raise "No SNMP !"
-            tsp.close()
-        
-        def handleAnswer(wholemsg, notusedhere, req):
-            """Decodes and handles the SNMP answer."""
-            ver = alpha.protoVersions[alpha.protoVersionId1]
-            rsp = ver.Message()
-            try :
-                rsp.berDecode(wholemsg)
-            except TypeMismatchError, msg :    
-                raise "No SNMP !"
-            else :
-                if req.apiAlphaMatch(rsp):
-                    errorStatus = rsp.apiAlphaGetPdu().apiAlphaGetErrorStatus()
-                    if errorStatus:
-                        raise "No SNMP !"
-                    else:
-                        self.values = []
-                        for varBind in rsp.apiAlphaGetPdu().apiAlphaGetVarBindList():
-                            self.values.append(varBind.apiAlphaGetOidVal()[1].rawAsn1Value)
-                        try :    
-                            pagecounter = self.values[0]
-                        except :
+                from pysnmp.asn1.encoding.ber.error import TypeMismatchError
+                from pysnmp.mapping.udp.role import Manager
+                from pysnmp.proto.api import alpha
+            except ImportError :    
+                sys.stderr.write("pysnmp doesn't seem to be installed. SNMP checks will be ignored !\n")
+                return 0
+        else :        
+            hasV4 = True
+            
+        if hasV4 :    
+            def retrieveSNMPValues(hostname, community) :
+                """Retrieves a printer's internal page counter and status via SNMP."""
+                errorIndication, errorStatus, errorIndex, varBinds = \
+                     cmdgen.CommandGenerator().getCmd(cmdgen.CommunityData("pykota", community, 0), \
+                                                      cmdgen.UdpTransportTarget((hostname, 161)), \
+                                                      tuple([int(i) for i in pageCounterOID.split('.')]))
+                if errorIndication :                                                  
+                    raise "No SNMP !"
+                elif errorStatus :    
+                    raise "No SNMP !"
+                else :                                 
+                    self.SNMPOK = True
+        else :
+            def retrieveSNMPValues(hostname, community) :    
+                """Retrieves a printer's internal page counter and status via SNMP."""
+                ver = alpha.protoVersions[alpha.protoVersionId1]
+                req = ver.Message()
+                req.apiAlphaSetCommunity(community)
+                req.apiAlphaSetPdu(ver.GetRequestPdu())
+                req.apiAlphaGetPdu().apiAlphaSetVarBindList((pageCounterOID, ver.Null()))
+                tsp = Manager()
+                try :
+                    tsp.sendAndReceive(req.berEncode(), \
+                                       (hostname, 161), \
+                                       (handleAnswer, req))
+                except :    
+                    raise "No SNMP !"
+                tsp.close()
+            
+            def handleAnswer(wholemsg, notusedhere, req):
+                """Decodes and handles the SNMP answer."""
+                ver = alpha.protoVersions[alpha.protoVersionId1]
+                rsp = ver.Message()
+                try :
+                    rsp.berDecode(wholemsg)
+                except TypeMismatchError, msg :    
+                    raise "No SNMP !"
+                else :
+                    if req.apiAlphaMatch(rsp):
+                        errorStatus = rsp.apiAlphaGetPdu().apiAlphaGetErrorStatus()
+                        if errorStatus:
                             raise "No SNMP !"
-                        else :    
-                            self.SNMPOK = 1
-                            return 1
+                        else:
+                            self.values = []
+                            for varBind in rsp.apiAlphaGetPdu().apiAlphaGetVarBindList():
+                                self.values.append(varBind.apiAlphaGetOidVal()[1].rawAsn1Value)
+                            try :    
+                                pagecounter = self.values[0]
+                            except :
+                                raise "No SNMP !"
+                            else :    
+                                self.SNMPOK = 1
+                                return 1
             
         self.SNMPOK = 0

pykota/trunk/NEWS

@@ -22 +22 @@
 PyKota NEWS :
        
+    - 1.25alpha2 (2006-05-03) :
+    
+        - Added support for PySNMP v4.x in addition to 3.4.x.
+        
     - 1.25alpha1 (2006-04-14) :
     

pykota/trunk/pykota/accounters/snmp.py

@@ -33 +33 @@
 
 try :
-    from pysnmp.asn1.encoding.ber.error import TypeMismatchError
-    from pysnmp.mapping.udp.error import SnmpOverUdpError
-    from pysnmp.mapping.udp.role import Manager
-    from pysnmp.proto.api import alpha
-except ImportError :
-    class Handler :
-        def __init__(self, parent, printerhostname) :
-            """Just there to raise an exception."""
-            raise RuntimeError, "The pysnmp module is not available. Download it from http://pysnmp.sf.net/"
-else :    
-    pageCounterOID = ".1.3.6.1.2.1.43.10.2.1.4.1.1"  # SNMPv2-SMI::mib-2.43.10.2.1.4.1.1
-    hrPrinterStatusOID = ".1.3.6.1.2.1.25.3.5.1.1.1" # SNMPv2-SMI::mib-2.25.3.5.1.1.1
-    printerStatusValues = { 1 : 'other',
-                            2 : 'unknown',
-                            3 : 'idle',
-                            4 : 'printing',
-                            5 : 'warmup',
-                          }
-    hrDeviceStatusOID = ".1.3.6.1.2.1.25.3.2.1.5.1" # SNMPv2-SMI::mib-2.25.3.2.1.5.1
-    deviceStatusValues = { 1 : 'unknown',
-                           2 : 'running',
-                           3 : 'warning',
-                           4 : 'testing',
-                           5 : 'down',
-                         }  
-    hrPrinterDetectedErrorStateOID = ".1.3.6.1.2.1.25.3.5.1.2.1" # SNMPv2-SMI::mib-2.25.3.5.1.2.1
-    prtConsoleDisplayBufferTextOID = ".1.3.6.1.2.1.43.16.5.1.2.1.1" # SNMPv2-SMI::mib-2.43.16.5.1.2.1.1
-                          
-    #                      
-    # Documentation taken from RFC 3805 (Printer MIB v2) and RFC 2790 (Host Resource MIB)
-    #
-    class Handler :
-        """A class for SNMP print accounting."""
-        def __init__(self, parent, printerhostname) :
-            self.parent = parent
-            self.printerHostname = printerhostname
-            try :
-                self.community = self.parent.arguments.split(":")[1].strip()
-            except IndexError :    
-                self.community = "public"
-            self.port = 161
-            self.printerInternalPageCounter = None
-            self.printerStatus = None
-            self.deviceStatus = None
-            
+    from pysnmp.entity.rfc3413.oneliner import cmdgen
+except ImportError :    
+    hasV4 = False
+    try :
+        from pysnmp.asn1.encoding.ber.error import TypeMismatchError
+        from pysnmp.mapping.udp.error import SnmpOverUdpError
+        from pysnmp.mapping.udp.role import Manager
+        from pysnmp.proto.api import alpha
+    except ImportError :
+        raise RuntimeError, "The pysnmp module is not available. Download it from http://pysnmp.sf.net/"
+else :
+    hasV4 = True
+
+#                      
+# Documentation taken from RFC 3805 (Printer MIB v2) and RFC 2790 (Host Resource MIB)
+#
+pageCounterOID = "1.3.6.1.2.1.43.10.2.1.4.1.1"  # SNMPv2-SMI::mib-2.43.10.2.1.4.1.1
+hrPrinterStatusOID = "1.3.6.1.2.1.25.3.5.1.1.1" # SNMPv2-SMI::mib-2.25.3.5.1.1.1
+printerStatusValues = { 1 : 'other',
+                        2 : 'unknown',
+                        3 : 'idle',
+                        4 : 'printing',
+                        5 : 'warmup',
+                      }
+hrDeviceStatusOID = "1.3.6.1.2.1.25.3.2.1.5.1" # SNMPv2-SMI::mib-2.25.3.2.1.5.1
+deviceStatusValues = { 1 : 'unknown',
+                       2 : 'running',
+                       3 : 'warning',
+                       4 : 'testing',
+                       5 : 'down',
+                     }  
+hrPrinterDetectedErrorStateOID = "1.3.6.1.2.1.25.3.5.1.2.1" # SNMPv2-SMI::mib-2.25.3.5.1.2.1
+prtConsoleDisplayBufferTextOID = "1.3.6.1.2.1.43.16.5.1.2.1.1" # SNMPv2-SMI::mib-2.43.16.5.1.2.1.1
+class BaseHandler :
+    """A class for SNMP print accounting."""
+    def __init__(self, parent, printerhostname) :
+        self.parent = parent
+        self.printerHostname = printerhostname
+        try :
+            self.community = self.parent.arguments.split(":")[1].strip()
+        except IndexError :    
+            self.community = "public"
+        self.port = 161
+        self.printerInternalPageCounter = None
+        self.printerStatus = None
+        self.deviceStatus = None
+        
+    def retrieveSNMPValues(self) :    
+        """Retrieves a printer's internal page counter and status via SNMP."""
+        raise RuntimeError, "You have to overload this method."
+        
+    def waitPrinting(self) :
+        """Waits for printer status being 'printing'."""
+        previousValue = self.parent.getLastPageCounter()
+        timebefore = time.time()
+        firstvalue = None
+        while 1:
+            self.retrieveSNMPValues()
+            statusAsString = printerStatusValues.get(self.printerStatus)
+            if statusAsString in ('printing', 'warmup') :
+                break
+            if self.printerInternalPageCounter is not None :    
+                if firstvalue is None :
+                    # first time we retrieved a page counter, save it
+                    firstvalue = self.printerInternalPageCounter
+                else :     
+                    # second time (or later)
+                    if firstvalue < self.printerInternalPageCounter :
+                        # Here we have a printer which lies :
+                        # it says it is not printing or warming up
+                        # BUT the page counter increases !!!
+                        # So we can probably quit being sure it is printing.
+                        self.parent.filter.printInfo("Printer %s is lying to us !!!" % self.parent.filter.PrinterName, "warn")
+                        break
+                    elif (time.time() - timebefore) > NOPRINTINGMAXDELAY :
+                        # More than X seconds without the printer being in 'printing' mode
+                        # We can safely assume this won't change if printer is now 'idle'
+                        pstatusAsString = printerStatusValues.get(self.printerStatus)
+                        dstatusAsString = deviceStatusValues.get(self.deviceStatus)
+                        if (pstatusAsString == 'idle') or \
+                            ((pstatusAsString == 'other') and \
+                             (dstatusAsString == 'running')) :
+                            if self.printerInternalPageCounter == previousValue :
+                                # Here the job won't be printed, because probably
+                                # the printer rejected it for some reason.
+                                self.parent.filter.printInfo("Printer %s probably won't print this job !!!" % self.parent.filter.PrinterName, "warn")
+                            else :     
+                                # Here the job has already been entirely printed, and
+                                # the printer has already passed from 'idle' to 'printing' to 'idle' again.
+                                self.parent.filter.printInfo("Printer %s has probably already printed this job !!!" % self.parent.filter.PrinterName, "warn")
+                            break
+            self.parent.filter.logdebug(_("Waiting for printer %s to be printing...") % self.parent.filter.PrinterName)    
+            time.sleep(ITERATIONDELAY)
+        
+    def waitIdle(self) :
+        """Waits for printer status being 'idle'."""
+        idle_num = idle_flag = 0
+        while 1 :
+            self.retrieveSNMPValues()
+            pstatusAsString = printerStatusValues.get(self.printerStatus)
+            dstatusAsString = deviceStatusValues.get(self.deviceStatus)
+            idle_flag = 0
+            if (pstatusAsString == 'idle') or \
+               ((pstatusAsString == 'other') and \
+                (dstatusAsString == 'running')) :
+                idle_flag = 1       # Standby / Powersave is considered idle
+            if idle_flag :    
+                idle_num += 1
+                if idle_num >= STABILIZATIONDELAY :
+                    # printer status is stable, we can exit
+                    break
+            else :    
+                idle_num = 0
+            self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.PrinterName)    
+            time.sleep(ITERATIONDELAY)
+            
+    def retrieveInternalPageCounter(self) :
+        """Returns the page counter from the printer via internal SNMP handling."""
+        try :
+            if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
+               (os.environ.get("PYKOTAACTION") == "ALLOW") and \
+               (os.environ.get("PYKOTAPHASE") == "AFTER") and \
+               self.parent.filter.JobSizeBytes :
+                self.waitPrinting()
+            self.waitIdle()    
+        except :    
+            self.parent.filter.printInfo(_("SNMP querying stage interrupted. Using latest value seen for internal page counter (%s) on printer %s.") % (self.printerInternalPageCounter, self.parent.filter.PrinterName), "warn")
+            raise
+        return self.printerInternalPageCounter
+            
+if hasV4 :            
+    class Handler(BaseHandler) :
+        """A class for pysnmp v4.x"""
+        def retrieveSNMPValues(self) :
+            """Retrieves a printer's internal page counter and status via SNMP."""
+            errorIndication, errorStatus, errorIndex, varBinds = \
+                 cmdgen.CommandGenerator().getCmd(cmdgen.CommunityData("pykota", self.community, 0), \
+                                                  cmdgen.UdpTransportTarget((self.printerHostname, self.port)), \
+                                                  tuple([int(i) for i in pageCounterOID.split('.')]), \
+                                                  tuple([int(i) for i in hrPrinterStatusOID.split('.')]), \
+                                                  tuple([int(i) for i in hrDeviceStatusOID.split('.')]))
+            if errorIndication :                                                  
+                self.parent.filter.printInfo("SNMP Error : %s" % errorIndication, "error")
+            elif errorStatus :    
+                self.parent.filter.printInfo("SNMP Error : %s at %s" % (errorStatus.prettyPrint(), \
+                                                                        varBinds[int(errorIndex)-1]), \
+                                             "error")
+            else :                                 
+                self.printerInternalPageCounter = max(self.printerInternalPageCounter, int(varBinds[0][1].prettyPrint()))
+                self.printerStatus = int(varBinds[1][1].prettyPrint())
+                self.deviceStatus = int(varBinds[2][1].prettyPrint())
+                self.parent.filter.logdebug("SNMP answer decoded : PageCounter : %s  PrinterStatus : '%s'  DeviceStatus : '%s'" \
+                     % (self.printerInternalPageCounter, \
+                        printerStatusValues.get(self.printerStatus), \
+                        deviceStatusValues.get(self.deviceStatus)))
+else :
+    class Handler(BaseHandler) :
+        """A class for pysnmp v3.4.x"""
         def retrieveSNMPValues(self) :    
             """Retrieves a printer's internal page counter and status via SNMP."""
@@ -95 +208 @@
                 self.parent.filter.printInfo(_("Network error while doing SNMP queries on printer %s : %s") % (self.printerHostname, msg), "warn")
             tsp.close()
-    
+        
         def handleAnswer(self, wholeMsg, notusedhere, req):
             """Decodes and handles the SNMP answer."""
@@ -128 +241 @@
                         else :    
                             return 1
-                        
-        def waitPrinting(self) :
-            """Waits for printer status being 'printing'."""
-            previousValue = self.parent.getLastPageCounter()
-            timebefore = time.time()
-            firstvalue = None
-            while 1:
-                self.retrieveSNMPValues()
-                statusAsString = printerStatusValues.get(self.printerStatus)
-                if statusAsString in ('printing', 'warmup') :
-                    break
-                if self.printerInternalPageCounter is not None :    
-                    if firstvalue is None :
-                        # first time we retrieved a page counter, save it
-                        firstvalue = self.printerInternalPageCounter
-                    else :     
-                        # second time (or later)
-                        if firstvalue < self.printerInternalPageCounter :
-                            # Here we have a printer which lies :
-                            # it says it is not printing or warming up
-                            # BUT the page counter increases !!!
-                            # So we can probably quit being sure it is printing.
-                            self.parent.filter.printInfo("Printer %s is lying to us !!!" % self.parent.filter.PrinterName, "warn")
-                            break
-                        elif (time.time() - timebefore) > NOPRINTINGMAXDELAY :
-                            # More than X seconds without the printer being in 'printing' mode
-                            # We can safely assume this won't change if printer is now 'idle'
-                            pstatusAsString = printerStatusValues.get(self.printerStatus)
-                            dstatusAsString = deviceStatusValues.get(self.deviceStatus)
-                            if (pstatusAsString == 'idle') or \
-                                ((pstatusAsString == 'other') and \
-                                 (dstatusAsString == 'running')) :
-                                if self.printerInternalPageCounter == previousValue :
-                                    # Here the job won't be printed, because probably
-                                    # the printer rejected it for some reason.
-                                    self.parent.filter.printInfo("Printer %s probably won't print this job !!!" % self.parent.filter.PrinterName, "warn")
-                                else :     
-                                    # Here the job has already been entirely printed, and
-                                    # the printer has already passed from 'idle' to 'printing' to 'idle' again.
-                                    self.parent.filter.printInfo("Printer %s has probably already printed this job !!!" % self.parent.filter.PrinterName, "warn")
-                                break
-                self.parent.filter.logdebug(_("Waiting for printer %s to be printing...") % self.parent.filter.PrinterName)    
-                time.sleep(ITERATIONDELAY)
-            
-        def waitIdle(self) :
-            """Waits for printer status being 'idle'."""
-            idle_num = idle_flag = 0
-            while 1 :
-                self.retrieveSNMPValues()
-                pstatusAsString = printerStatusValues.get(self.printerStatus)
-                dstatusAsString = deviceStatusValues.get(self.deviceStatus)
-                idle_flag = 0
-                if (pstatusAsString == 'idle') or \
-                   ((pstatusAsString == 'other') and \
-                    (dstatusAsString == 'running')) :
-                    idle_flag = 1       # Standby / Powersave is considered idle
-                if idle_flag :    
-                    idle_num += 1
-                    if idle_num >= STABILIZATIONDELAY :
-                        # printer status is stable, we can exit
-                        break
-                else :    
-                    idle_num = 0
-                self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.PrinterName)    
-                time.sleep(ITERATIONDELAY)
-                
-        def retrieveInternalPageCounter(self) :
-            """Returns the page counter from the printer via internal SNMP handling."""
-            try :
-                if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
-                   (os.environ.get("PYKOTAACTION") == "ALLOW") and \
-                   (os.environ.get("PYKOTAPHASE") == "AFTER") and \
-                   self.parent.filter.JobSizeBytes :
-                    self.waitPrinting()
-                self.waitIdle()    
-            except :    
-                self.parent.filter.printInfo(_("SNMP querying stage interrupted. Using latest value seen for internal page counter (%s) on printer %s.") % (self.printerInternalPageCounter, self.parent.filter.PrinterName), "warn")
-                raise
-            return self.printerInternalPageCounter
-            
+                    
 def main(hostname) :
     """Tries SNMP accounting for a printer host."""

pykota/trunk/pykota/version.py

@@ -22 +22 @@
 #
 
-__version__ = "1.25alpha1_unofficial"
+__version__ = "1.25alpha2_unofficial"
 
 __doc__ = "PyKota : a complete Printing Quota Solution for CUPS."

pykota/trunk/README

@@ -375 +375 @@
     - The Python-SNMP module to query printers for their page counter.
       (http://pysnmp.sourceforge.net). 
-      IMPORTANT : version 3.4.4 (or 3.4.3 or 3.4.2) is REQUIRED.
-      Versions 2.x or 4.x won't work for now.
+      IMPORTANT : version 3.4.2 or higher is REQUIRED.
+      Versions 2.x won't work. Versions 4.x now work (tested with v4.1.5a).
     - The Python-OSD module to use the graphical print quota reminder.
       (http://repose.cx/pyosd/)