root / pykota / trunk / pykota / accounters / snmp.py @ 2305

Revision 2305, 10.0 kB (checked in by jerome, 19 years ago)

Fixed internal SNMP accounter according to Jamuel's findings.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Auth Date Rev Id
Line 
1# PyKota
2# -*- coding: ISO-8859-15 -*-
3#
4# PyKota - Print Quotas for CUPS and LPRng
5#
6# (c) 2003, 2004, 2005 Jerome Alet <alet@librelogiciel.com>
7# This program is free software; you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation; either version 2 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program; if not, write to the Free Software
19# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20#
21# $Id$
22#
23#
24
25ITERATIONDELAY = 1.5   # 1.5 Second
26STABILIZATIONDELAY = 3 # We must read three times the same value to consider it to be stable
27
28import sys
29import os
30import time
31
32try :
33    from pysnmp.asn1.encoding.ber.error import TypeMismatchError
34    from pysnmp.mapping.udp.error import SnmpOverUdpError
35    from pysnmp.mapping.udp.role import Manager
36    from pysnmp.proto.api import alpha
37except ImportError :
38    class Handler :
39        def __init__(self, parent, printerhostname) :
40            """Just there to raise an exception."""
41            raise RuntimeError, "The pysnmp module is not available. Download it from http://pysnmp.sf.net/"
42else :   
43    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
44    hrPrinterStatusOID = ".1.3.6.1.2.1.25.3.5.1.1.1" # SNMPv2-SMI::mib-2.25.3.5.1.1.1
45    printerStatusValues = { 1 : 'other',
46                            2 : 'unknown',
47                            3 : 'idle',
48                            4 : 'printing',
49                            5 : 'warmup',
50                          }
51    hrDeviceStatusOID = ".1.3.6.1.2.1.25.3.2.1.5.1" # SNMPv2-SMI::mib-2.25.3.2.1.5.1
52    deviceStatusValues = { 1 : 'unknown',
53                           2 : 'running',
54                           3 : 'warning',
55                           4 : 'testing',
56                           5 : 'down',
57                         } 
58    hrPrinterDetectedErrorStateOID = ".1.3.6.1.2.1.25.3.5.1.2.1" # SNMPv2-SMI::mib-2.25.3.5.1.2.1
59    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
60                         
61    #                     
62    # Documentation taken from RFC 3805 (Printer MIB v2) and RFC 2790 (Host Resource MIB)
63    #
64    class Handler :
65        """A class for SNMP print accounting."""
66        def __init__(self, parent, printerhostname) :
67            self.parent = parent
68            self.printerHostname = printerhostname
69            self.printerInternalPageCounter = None
70            self.printerStatus = None
71            self.deviceStatus = None
72           
73        def retrieveSNMPValues(self) :   
74            """Retrieves a printer's internal page counter and status via SNMP."""
75            ver = alpha.protoVersions[alpha.protoVersionId1]
76            req = ver.Message()
77            req.apiAlphaSetCommunity('public')
78            req.apiAlphaSetPdu(ver.GetRequestPdu())
79            req.apiAlphaGetPdu().apiAlphaSetVarBindList((pageCounterOID, ver.Null()), \
80                                                        (hrPrinterStatusOID, ver.Null()), \
81                                                        (hrDeviceStatusOID, ver.Null()))
82            tsp = Manager()
83            try :
84                tsp.sendAndReceive(req.berEncode(), (self.printerHostname, 161), (self.handleAnswer, req))
85            except SnmpOverUdpError, msg :   
86                self.parent.filter.printInfo(_("Network error while doing SNMP queries on printer %s : %s") % (self.printerHostname, msg), "warn")
87            tsp.close()
88   
89        def handleAnswer(self, wholeMsg, notusedhere, req):
90            """Decodes and handles the SNMP answer."""
91            self.parent.filter.logdebug("SNMP message : '%s'" % repr(wholeMsg))
92            ver = alpha.protoVersions[alpha.protoVersionId1]
93            rsp = ver.Message()
94            try :
95                rsp.berDecode(wholeMsg)
96            except TypeMismatchError, msg :   
97                self.parent.filter.printInfo(_("SNMP message decoding error for printer %s : %s") % (self.printerHostname, msg), "warn")
98            else :
99                if req.apiAlphaMatch(rsp):
100                    errorStatus = rsp.apiAlphaGetPdu().apiAlphaGetErrorStatus()
101                    if errorStatus:
102                        self.parent.filter.printInfo(_("Problem encountered while doing SNMP queries on printer %s : %s") % (self.printerHostname, errorStatus), "warn")
103                    else:
104                        self.values = []
105                        for varBind in rsp.apiAlphaGetPdu().apiAlphaGetVarBindList():
106                            self.values.append(varBind.apiAlphaGetOidVal()[1].rawAsn1Value)
107                        try :   
108                            # keep maximum value seen for printer's internal page counter
109                            self.printerInternalPageCounter = max(self.printerInternalPageCounter, self.values[0])
110                            self.printerStatus = self.values[1]
111                            self.deviceStatus = self.values[2]
112                            self.parent.filter.logdebug("SNMP answer is decoded : PageCounter : %s  PrinterStatus : %s  DeviceStatus : %s" % tuple(self.values))
113                        except IndexError :   
114                            self.parent.filter.logdebug("SNMP answer is incomplete : %s" % str(self.values))
115                            pass
116                        else :   
117                            return 1
118                       
119        def waitPrinting(self) :
120            """Waits for printer status being 'printing'."""
121            firstvalue = None
122            while 1:
123                self.retrieveSNMPValues()
124                statusAsString = printerStatusValues.get(self.printerStatus)
125                if statusAsString in ('printing', 'warmup') :
126                    break
127                if self.printerInternalPageCounter is not None :   
128                    if firstvalue is None :
129                        # first time we retrieved a page counter, save it
130                        firstvalue = self.printerInternalPageCounter
131                    else :     
132                        # second time (or later)
133                        if firstvalue < self.printerInternalPageCounter :
134                            # Here we have a printer which lies :
135                            # it says it is not printing or warming up
136                            # BUT the page counter increases !!!
137                            # So we can probably quit being sure it is printing.
138                            self.parent.filter.printInfo("Printer %s is lying to us !!!" % self.parent.filter.printername, "warn")
139                            break
140                self.parent.filter.logdebug(_("Waiting for printer %s to be printing...") % self.parent.filter.printername)   
141                time.sleep(ITERATIONDELAY)
142           
143        def waitIdle(self) :
144            """Waits for printer status being 'idle'."""
145            idle_num = idle_flag = 0
146            while 1 :
147                self.retrieveSNMPValues()
148                pstatusAsString = printerStatusValues.get(self.printerStatus)
149                dstatusAsString = deviceStatusValues.get(self.deviceStatus)
150                idle_flag = 0
151                if (pstatusAsString == 'idle') or \
152                   ((pstatusAsString == 'other') and \
153                    (dstatusAsString == 'running')) :
154                    idle_flag = 1       # Standby / Powersave is considered idle
155                if idle_flag :   
156                    idle_num += 1
157                    if idle_num >= STABILIZATIONDELAY :
158                        # printer status is stable, we can exit
159                        break
160                else :   
161                    idle_num = 0
162                self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.printername)   
163                time.sleep(ITERATIONDELAY)
164               
165        def retrieveInternalPageCounter(self) :
166            """Returns the page counter from the printer via internal SNMP handling."""
167            try :
168                if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
169                   (os.environ.get("PYKOTAACTION") != "DENY") and \
170                   (os.environ.get("PYKOTAPHASE") == "AFTER") and \
171                   self.parent.filter.jobSizeBytes :
172                    self.waitPrinting()
173                self.waitIdle()   
174            except :   
175                if self.printerInternalPageCounter is None :
176                    raise
177                else :   
178                    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")
179            return self.printerInternalPageCounter
180           
181if __name__ == "__main__" :           
182    if len(sys.argv) != 2 :   
183        sys.stderr.write("Usage :  python  %s  printer_ip_address\n" % sys.argv[0])
184    else :   
185        def _(msg) :
186            return msg
187           
188        class fakeFilter :
189            def __init__(self) :
190                self.printername = "FakePrintQueue"
191                self.jobSizeBytes = 1
192               
193            def printInfo(self, msg, level="info") :
194                sys.stderr.write("%s : %s\n" % (level.upper(), msg))
195                sys.stderr.flush()
196               
197            def logdebug(self, msg) :   
198                self.printInfo(msg, "debug")
199               
200        class fakeAccounter :       
201            def __init__(self) :
202                self.filter = fakeFilter()
203                self.protocolHandler = Handler(self, sys.argv[1])
204           
205        acc = fakeAccounter()           
206        print "Internal page counter's value is : %s" % acc.protocolHandler.retrieveInternalPageCounter()
Note: See TracBrowser for help on using the browser.