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

Revision 3145, 18.9 kB (checked in by jerome, 17 years ago)

Added something TODO.

  • 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, 2006, 2007 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
25"""This module is used to extract printer's internal page counter
26and status informations using SNMP queries.
27
28The values extracted are defined at least in RFC3805 and RFC2970.
29"""
30
31ITERATIONDELAY = 4      # time to sleep between two loops
32STABILIZATIONDELAY = 5  # number of consecutive times the idle status must be seen before we consider it to be stable
33NOPRINTINGMAXDELAY = 60 # The printer must begin to print within 60 seconds by default.
34
35import sys
36import os
37import time
38import select
39
40try :
41    from pysnmp.entity.rfc3413.oneliner import cmdgen
42except ImportError :   
43    hasV4 = False
44    try :
45        from pysnmp.asn1.encoding.ber.error import TypeMismatchError
46        from pysnmp.mapping.udp.error import SnmpOverUdpError
47        from pysnmp.mapping.udp.role import Manager
48        from pysnmp.proto.api import alpha
49    except ImportError :
50        raise RuntimeError, "The pysnmp module is not available. Download it from http://pysnmp.sf.net/"
51else :
52    hasV4 = True
53
54#                     
55# Documentation taken from RFC 3805 (Printer MIB v2) and RFC 2790 (Host Resource MIB)
56#
57pageCounterOID = "1.3.6.1.2.1.43.10.2.1.4.1.1"  # SNMPv2-SMI::mib-2.43.10.2.1.4.1.1
58hrPrinterStatusOID = "1.3.6.1.2.1.25.3.5.1.1.1" # SNMPv2-SMI::mib-2.25.3.5.1.1.1
59printerStatusValues = { 1 : 'other',
60                        2 : 'unknown',
61                        3 : 'idle',
62                        4 : 'printing',
63                        5 : 'warmup',
64                      }
65hrDeviceStatusOID = "1.3.6.1.2.1.25.3.2.1.5.1" # SNMPv2-SMI::mib-2.25.3.2.1.5.1
66deviceStatusValues = { 1 : 'unknown',
67                       2 : 'running',
68                       3 : 'warning',
69                       4 : 'testing',
70                       5 : 'down',
71                     } 
72hrPrinterDetectedErrorStateOID = "1.3.6.1.2.1.25.3.5.1.2.1" # SNMPv2-SMI::mib-2.25.3.5.1.2.1
73printerDetectedErrorStateValues = [ { 128 : 'Low Paper',
74                                       64 : 'No Paper',
75                                       32 : 'Low Toner',
76                                       16 : 'No Toner',
77                                        8 : 'Door Open',
78                                        4 : 'Jammed',
79                                        2 : 'Offline',
80                                        1 : 'Service Requested',
81                                    },
82                                    { 128 : 'Input Tray Missing',
83                                       64 : 'Output Tray Missing',
84                                       32 : 'Marker Supply Missing',
85                                       16 : 'Output Near Full',
86                                        8 : 'Output Full',
87                                        4 : 'Input Tray Empty',
88                                        2 : 'Overdue Preventive Maintainance',
89                                        1 : 'Not Assigned in RFC3805',
90                                    },
91                                  ] 
92                                 
93# TODO : make the following list configurable at runtime, possibly per printer.                                 
94errorConditions = [ 'No Paper',
95                    # 'No Toner',
96                    'Door Open',
97                    'Jammed',
98                    'Offline',
99                    'Service Requested',
100                    'Input Tray Missing',
101                    'Output Tray Missing',
102                    # 'Marker Supply Missing',
103                    'Output Full',
104                    'Input Tray Empty',
105                  ]
106# WARNING : some printers don't support this one :                 
107prtConsoleDisplayBufferTextOID = "1.3.6.1.2.1.43.16.5.1.2.1.1" # SNMPv2-SMI::mib-2.43.16.5.1.2.1.1
108class BaseHandler :
109    """A class for SNMP print accounting."""
110    def __init__(self, parent, printerhostname) :
111        self.parent = parent
112        self.printerHostname = printerhostname
113        try :
114            self.community = self.parent.arguments.split(":")[1].strip()
115        except IndexError :   
116            self.community = "public"
117        self.port = 161
118        self.initValues()
119       
120    def initValues(self) :   
121        """Initializes SNMP values."""
122        self.printerInternalPageCounter = None
123        self.printerStatus = None
124        self.deviceStatus = None
125        self.printerDetectedErrorState = None
126        self.timebefore = time.time()   # resets timer also in case of error
127       
128    def retrieveSNMPValues(self) :   
129        """Retrieves a printer's internal page counter and status via SNMP."""
130        raise RuntimeError, "You have to overload this method."
131       
132    def extractErrorStates(self, value) :   
133        """Returns a list of textual error states from a binary value."""
134        states = []
135        for i in range(min(len(value), len(printerDetectedErrorStateValues))) :
136            byte = ord(value[i])
137            bytedescription = printerDetectedErrorStateValues[i]
138            for (k, v) in bytedescription.items() :
139                if byte & k :
140                    states.append(v)
141        return states           
142       
143    def checkIfError(self, errorstates) :   
144        """Checks if any error state is fatal or not."""
145        if errorstates is None :
146            return True
147        else :
148            for err in errorstates :
149                if err in errorConditions :
150                    return True
151            return False   
152       
153    def waitPrinting(self) :
154        """Waits for printer status being 'printing'."""
155        try :
156            noprintingmaxdelay = int(self.parent.filter.config.getNoPrintingMaxDelay(self.parent.filter.PrinterName))
157        except (TypeError, AttributeError) : # NB : AttributeError in testing mode because I'm lazy !
158            noprintingmaxdelay = NOPRINTINGMAXDELAY
159            self.parent.filter.logdebug("No max delay defined for printer %s, using %i seconds." % (self.parent.filter.PrinterName, noprintingmaxdelay))
160        if not noprintingmaxdelay :
161            self.parent.filter.logdebug("Will wait indefinitely until printer %s is in 'printing' state." % self.parent.filter.PrinterName)
162        else :   
163            self.parent.filter.logdebug("Will wait until printer %s is in 'printing' state or %i seconds have elapsed." % (self.parent.filter.PrinterName, noprintingmaxdelay))
164        previousValue = self.parent.getLastPageCounter()
165        firstvalue = None
166        while 1:
167            self.retrieveSNMPValues()
168            statusAsString = printerStatusValues.get(self.printerStatus)
169            if statusAsString in ('printing', 'warmup') :
170                break
171            if self.printerInternalPageCounter is not None :   
172                if firstvalue is None :
173                    # first time we retrieved a page counter, save it
174                    firstvalue = self.printerInternalPageCounter
175                else :     
176                    # second time (or later)
177                    if firstvalue < self.printerInternalPageCounter :
178                        # Here we have a printer which lies :
179                        # it says it is not printing or warming up
180                        # BUT the page counter increases !!!
181                        # So we can probably quit being sure it is printing.
182                        self.parent.filter.printInfo("Printer %s is lying to us !!!" % self.parent.filter.PrinterName, "warn")
183                        break
184                    elif noprintingmaxdelay \
185                         and ((time.time() - self.timebefore) > noprintingmaxdelay) \
186                         and not self.checkIfError(self.printerDetectedErrorState) :
187                        # More than X seconds without the printer being in 'printing' mode
188                        # We can safely assume this won't change if printer is now 'idle'
189                        pstatusAsString = printerStatusValues.get(self.printerStatus)
190                        dstatusAsString = deviceStatusValues.get(self.deviceStatus)
191                        if (pstatusAsString == 'idle') or \
192                            ((pstatusAsString == 'other') and \
193                             (dstatusAsString == 'running')) :
194                            if self.printerInternalPageCounter == previousValue :
195                                # Here the job won't be printed, because probably
196                                # the printer rejected it for some reason.
197                                self.parent.filter.printInfo("Printer %s probably won't print this job !!!" % self.parent.filter.PrinterName, "warn")
198                            else :     
199                                # Here the job has already been entirely printed, and
200                                # the printer has already passed from 'idle' to 'printing' to 'idle' again.
201                                self.parent.filter.printInfo("Printer %s has probably already printed this job !!!" % self.parent.filter.PrinterName, "warn")
202                            break
203            self.parent.filter.logdebug(_("Waiting for printer %s to be printing...") % self.parent.filter.PrinterName)   
204            time.sleep(ITERATIONDELAY)
205       
206    def waitIdle(self) :
207        """Waits for printer status being 'idle'."""
208        idle_num = idle_flag = 0
209        while 1 :
210            self.retrieveSNMPValues()
211            pstatusAsString = printerStatusValues.get(self.printerStatus)
212            dstatusAsString = deviceStatusValues.get(self.deviceStatus)
213            idle_flag = 0
214            if (not self.checkIfError(self.printerDetectedErrorState)) \
215               and ((pstatusAsString == 'idle') or \
216                         ((pstatusAsString == 'other') and \
217                          (dstatusAsString == 'running'))) :
218                idle_flag = 1       # Standby / Powersave is considered idle
219            if idle_flag :   
220                idle_num += 1
221                if idle_num >= STABILIZATIONDELAY :
222                    # printer status is stable, we can exit
223                    break
224            else :   
225                idle_num = 0
226            self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.PrinterName)   
227            time.sleep(ITERATIONDELAY)
228           
229    def retrieveInternalPageCounter(self) :
230        """Returns the page counter from the printer via internal SNMP handling."""
231        try :
232            if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
233               (os.environ.get("PYKOTAACTION") == "ALLOW") and \
234               (os.environ.get("PYKOTAPHASE") == "AFTER") and \
235               self.parent.filter.JobSizeBytes :
236                self.waitPrinting()
237            self.waitIdle()   
238        except :   
239            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")
240            raise
241        return self.printerInternalPageCounter
242           
243if hasV4 :           
244    class Handler(BaseHandler) :
245        """A class for pysnmp v4.x"""
246        def retrieveSNMPValues(self) :
247            """Retrieves a printer's internal page counter and status via SNMP."""
248            errorIndication, errorStatus, errorIndex, varBinds = \
249                 cmdgen.CommandGenerator().getCmd(cmdgen.CommunityData("pykota", self.community, 0), \
250                                                  cmdgen.UdpTransportTarget((self.printerHostname, self.port)), \
251                                                  tuple([int(i) for i in pageCounterOID.split('.')]), \
252                                                  tuple([int(i) for i in hrPrinterStatusOID.split('.')]), \
253                                                  tuple([int(i) for i in hrDeviceStatusOID.split('.')]), \
254                                                  tuple([int(i) for i in hrPrinterDetectedErrorStateOID.split('.')]))
255            if errorIndication :                                                 
256                self.parent.filter.printInfo("SNMP Error : %s" % errorIndication, "error")
257                self.initValues()
258            elif errorStatus :   
259                self.parent.filter.printInfo("SNMP Error : %s at %s" % (errorStatus.prettyPrint(), \
260                                                                        varBinds[int(errorIndex)-1]), \
261                                             "error")
262                self.initValues()
263            else :                                 
264                self.printerInternalPageCounter = max(self.printerInternalPageCounter, int(varBinds[0][1].prettyPrint()))
265                self.printerStatus = int(varBinds[1][1].prettyPrint())
266                self.deviceStatus = int(varBinds[2][1].prettyPrint())
267                self.printerDetectedErrorState = self.extractErrorStates(str(varBinds[3][1]))
268                self.parent.filter.logdebug("SNMP answer decoded : PageCounter : %s  PrinterStatus : '%s'  DeviceStatus : '%s'  PrinterErrorState : '%s'" \
269                     % (self.printerInternalPageCounter, \
270                        printerStatusValues.get(self.printerStatus), \
271                        deviceStatusValues.get(self.deviceStatus), \
272                        self.printerDetectedErrorState))
273else :
274    class Handler(BaseHandler) :
275        """A class for pysnmp v3.4.x"""
276        def retrieveSNMPValues(self) :   
277            """Retrieves a printer's internal page counter and status via SNMP."""
278            ver = alpha.protoVersions[alpha.protoVersionId1]
279            req = ver.Message()
280            req.apiAlphaSetCommunity(self.community)
281            req.apiAlphaSetPdu(ver.GetRequestPdu())
282            req.apiAlphaGetPdu().apiAlphaSetVarBindList((pageCounterOID, ver.Null()), \
283                                                        (hrPrinterStatusOID, ver.Null()), \
284                                                        (hrDeviceStatusOID, ver.Null()), \
285                                                        (hrPrinterDetectedErrorStateOID, ver.Null()))
286            tsp = Manager()
287            try :
288                tsp.sendAndReceive(req.berEncode(), \
289                                   (self.printerHostname, self.port), \
290                                   (self.handleAnswer, req))
291            except (SnmpOverUdpError, select.error), msg :   
292                self.parent.filter.printInfo(_("Network error while doing SNMP queries on printer %s : %s") % (self.printerHostname, msg), "warn")
293                self.initValues()
294            tsp.close()
295       
296        def handleAnswer(self, wholeMsg, notusedhere, req):
297            """Decodes and handles the SNMP answer."""
298            ver = alpha.protoVersions[alpha.protoVersionId1]
299            rsp = ver.Message()
300            try :
301                rsp.berDecode(wholeMsg)
302            except TypeMismatchError, msg :   
303                self.parent.filter.printInfo(_("SNMP message decoding error for printer %s : %s") % (self.printerHostname, msg), "warn")
304                self.initValues()
305            else :
306                if req.apiAlphaMatch(rsp):
307                    errorStatus = rsp.apiAlphaGetPdu().apiAlphaGetErrorStatus()
308                    if errorStatus:
309                        self.parent.filter.printInfo(_("Problem encountered while doing SNMP queries on printer %s : %s") % (self.printerHostname, errorStatus), "warn")
310                    else:
311                        self.values = []
312                        for varBind in rsp.apiAlphaGetPdu().apiAlphaGetVarBindList():
313                            self.values.append(varBind.apiAlphaGetOidVal()[1].rawAsn1Value)
314                        try :   
315                            # keep maximum value seen for printer's internal page counter
316                            self.printerInternalPageCounter = max(self.printerInternalPageCounter, self.values[0])
317                            self.printerStatus = self.values[1]
318                            self.deviceStatus = self.values[2]
319                            self.printerDetectedErrorState = self.extractErrorStates(self.values[3])
320                            self.parent.filter.logdebug("SNMP answer decoded : PageCounter : %s  PrinterStatus : '%s'  DeviceStatus : '%s'  PrinterErrorState : '%s'" \
321                                 % (self.printerInternalPageCounter, \
322                                    printerStatusValues.get(self.printerStatus), \
323                                    deviceStatusValues.get(self.deviceStatus), \
324                                    self.printerDetectedErrorState))
325                        except IndexError :   
326                            self.parent.filter.logdebug("SNMP answer is incomplete : %s" % str(self.values))
327                            pass
328                        else :   
329                            return 1
330                   
331def main(hostname) :
332    """Tries SNMP accounting for a printer host."""
333    class fakeFilter :
334        """Fakes a filter for testing purposes."""
335        def __init__(self) :
336            """Initializes the fake filter."""
337            self.PrinterName = "FakePrintQueue"
338            self.JobSizeBytes = 1
339           
340        def printInfo(self, msg, level="info") :
341            """Prints informational message."""
342            sys.stderr.write("%s : %s\n" % (level.upper(), msg))
343            sys.stderr.flush()
344           
345        def logdebug(self, msg) :   
346            """Prints debug message."""
347            self.printInfo(msg, "debug")
348           
349    class fakeAccounter :       
350        """Fakes an accounter for testing purposes."""
351        def __init__(self) :
352            """Initializes fake accounter."""
353            self.arguments = "snmp:public"
354            self.filter = fakeFilter()
355            self.protocolHandler = Handler(self, hostname)
356           
357        def getLastPageCounter(self) :   
358            """Fakes the return of a page counter."""
359            return 0
360       
361    acc = fakeAccounter()           
362    return acc.protocolHandler.retrieveInternalPageCounter()
363       
364if __name__ == "__main__" :           
365    if len(sys.argv) != 2 :   
366        sys.stderr.write("Usage :  python  %s  printer_ip_address\n" % sys.argv[0])
367    else :   
368        def _(msg) :
369            return msg
370           
371        pagecounter = main(sys.argv[1])
372        print "Internal page counter's value is : %s" % pagecounter
Note: See TracBrowser for help on using the browser.