Context Navigation

snmp.py @ 3190

Revision 3190, 20.2 kB (checked in by jerome, 17 years ago)
Added the 'snmperrormask' directive.
Property svn:eol-style set to `native` Property svn:keywords set to `Auth Date Rev Id`

Rev	Line
[2205]	1	# PyKota
	2	# -- coding: ISO-8859-15 --
	3	#
	4	# PyKota - Print Quotas for CUPS and LPRng
	5	#
[3133]	6	# (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com>
[2205]	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
[2302]	19	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
[2205]	20	#
	21	# $Id$
	22	#
	23	#
	24
[3025]	25	"""This module is used to extract printer's internal page counter
	26	and status informations using SNMP queries.
	27
	28	The values extracted are defined at least in RFC3805 and RFC2970.
	29	"""
	30
[2205]	31
	32	import sys
	33	import os
	34	import time
[2319]	35	import select
[3161]	36	import socket
[2205]	37
	38	try :
[2877]	39	from pysnmp.entity.rfc3413.oneliner import cmdgen
	40	except ImportError :
	41	hasV4 = False
	42	try :
	43	from pysnmp.asn1.encoding.ber.error import TypeMismatchError
	44	from pysnmp.mapping.udp.error import SnmpOverUdpError
	45	from pysnmp.mapping.udp.role import Manager
	46	from pysnmp.proto.api import alpha
	47	except ImportError :
	48	raise RuntimeError, "The pysnmp module is not available. Download it from http://pysnmp.sf.net/"
	49	else :
	50	hasV4 = True
	51
[3175]	52	from pykota import constants
	53
[2877]	54	#
	55	# Documentation taken from RFC 3805 (Printer MIB v2) and RFC 2790 (Host Resource MIB)
	56	#
	57	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
	58	hrPrinterStatusOID = "1.3.6.1.2.1.25.3.5.1.1.1" # SNMPv2-SMI::mib-2.25.3.5.1.1.1
	59	printerStatusValues = { 1 : 'other',
	60	2 : 'unknown',
	61	3 : 'idle',
	62	4 : 'printing',
	63	5 : 'warmup',
	64	}
	65	hrDeviceStatusOID = "1.3.6.1.2.1.25.3.2.1.5.1" # SNMPv2-SMI::mib-2.25.3.2.1.5.1
	66	deviceStatusValues = { 1 : 'unknown',
	67	2 : 'running',
	68	3 : 'warning',
	69	4 : 'testing',
	70	5 : 'down',
	71	}
	72	hrPrinterDetectedErrorStateOID = "1.3.6.1.2.1.25.3.5.1.2.1" # SNMPv2-SMI::mib-2.25.3.5.1.2.1
[3025]	73	printerDetectedErrorStateValues = [ { 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	]
[3145]	92
[3190]	93	# The default error mask to use when checking error conditions.
	94	defaultErrorMask = 0x4fcc # [ 'No Paper',
	95	# 'Door Open',
	96	# 'Jammed',
	97	# 'Offline',
	98	# 'Service Requested',
	99	# 'Input Tray Missing',
	100	# 'Output Tray Missing',
	101	# 'Output Full',
	102	# 'Input Tray Empty',
	103	# ]
	104
[3039]	105	# WARNING : some printers don't support this one :
[2877]	106	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
	107	class BaseHandler :
	108	"""A class for SNMP print accounting."""
[3162]	109	def __init__(self, parent, printerhostname, skipinitialwait=False) :
[2877]	110	self.parent = parent
	111	self.printerHostname = printerhostname
[3162]	112	self.skipinitialwait = skipinitialwait
[2877]	113	try :
	114	self.community = self.parent.arguments.split(":")[1].strip()
	115	except IndexError :
	116	self.community = "public"
	117	self.port = 161
[3025]	118	self.initValues()
	119
	120	def initValues(self) :
	121	"""Initializes SNMP values."""
[2877]	122	self.printerInternalPageCounter = None
	123	self.printerStatus = None
	124	self.deviceStatus = None
[3025]	125	self.printerDetectedErrorState = None
	126	self.timebefore = time.time() # resets timer also in case of error
[2877]	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
[3025]	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."""
[3028]	145	if errorstates is None :
	146	return True
	147	else :
[3190]	148	try :
	149	errormask = self.parent.filter.config.getPrinterSNMPErrorMask(self.parent.filter.PrinterName)
	150	except AttributeError : # debug mode
	151	errormask = defaultErrorMask
	152	if errormask is None :
	153	errormask = defaultErrorMask
	154	errormaskbytes = [ chr((errormask & 0xff00) >> 8),
	155	chr((errormask & 0x00ff)),
	156	]
	157	errorConditions = self.extractErrorStates(errormaskbytes)
	158	self.parent.filter.logdebug("Error conditions for mask 0x%04x : %s" \
	159	% (errormask, errorConditions))
[3028]	160	for err in errorstates :
	161	if err in errorConditions :
[3190]	162	self.parent.filter.logdebug("Error condition '%s' encountered. PyKota will wait until this problem is fixed." % err)
[3028]	163	return True
[3190]	164	self.parent.filter.logdebug("No error condition matching mask 0x%04x" % errormask)
[3028]	165	return False
[3025]	166
[2877]	167	def waitPrinting(self) :
	168	"""Waits for printer status being 'printing'."""
[3180]	169	statusstabilizationdelay = constants.get(self.parent.filter, "StatusStabilizationDelay")
	170	noprintingmaxdelay = constants.get(self.parent.filter, "NoPrintingMaxDelay")
[3025]	171	if not noprintingmaxdelay :
	172	self.parent.filter.logdebug("Will wait indefinitely until printer %s is in 'printing' state." % self.parent.filter.PrinterName)
	173	else :
	174	self.parent.filter.logdebug("Will wait until printer %s is in 'printing' state or %i seconds have elapsed." % (self.parent.filter.PrinterName, noprintingmaxdelay))
[2877]	175	previousValue = self.parent.getLastPageCounter()
	176	firstvalue = None
	177	while 1:
	178	self.retrieveSNMPValues()
	179	statusAsString = printerStatusValues.get(self.printerStatus)
	180	if statusAsString in ('printing', 'warmup') :
	181	break
	182	if self.printerInternalPageCounter is not None :
	183	if firstvalue is None :
	184	# first time we retrieved a page counter, save it
	185	firstvalue = self.printerInternalPageCounter
	186	else :
	187	# second time (or later)
	188	if firstvalue < self.printerInternalPageCounter :
	189	# Here we have a printer which lies :
	190	# it says it is not printing or warming up
	191	# BUT the page counter increases !!!
	192	# So we can probably quit being sure it is printing.
	193	self.parent.filter.printInfo("Printer %s is lying to us !!!" % self.parent.filter.PrinterName, "warn")
	194	break
[3025]	195	elif noprintingmaxdelay \
	196	and ((time.time() - self.timebefore) > noprintingmaxdelay) \
	197	and not self.checkIfError(self.printerDetectedErrorState) :
[2877]	198	# More than X seconds without the printer being in 'printing' mode
	199	# We can safely assume this won't change if printer is now 'idle'
	200	pstatusAsString = printerStatusValues.get(self.printerStatus)
	201	dstatusAsString = deviceStatusValues.get(self.deviceStatus)
	202	if (pstatusAsString == 'idle') or \
	203	((pstatusAsString == 'other') and \
	204	(dstatusAsString == 'running')) :
	205	if self.printerInternalPageCounter == previousValue :
	206	# Here the job won't be printed, because probably
	207	# the printer rejected it for some reason.
	208	self.parent.filter.printInfo("Printer %s probably won't print this job !!!" % self.parent.filter.PrinterName, "warn")
	209	else :
	210	# Here the job has already been entirely printed, and
	211	# the printer has already passed from 'idle' to 'printing' to 'idle' again.
	212	self.parent.filter.printInfo("Printer %s has probably already printed this job !!!" % self.parent.filter.PrinterName, "warn")
	213	break
	214	self.parent.filter.logdebug(_("Waiting for printer %s to be printing...") % self.parent.filter.PrinterName)
[3180]	215	time.sleep(statusstabilizationdelay)
[2877]	216
	217	def waitIdle(self) :
	218	"""Waits for printer status being 'idle'."""
[3180]	219	statusstabilizationdelay = constants.get(self.parent.filter, "StatusStabilizationDelay")
	220	statusstabilizationloops = constants.get(self.parent.filter, "StatusStabilizationLoops")
[2877]	221	idle_num = idle_flag = 0
	222	while 1 :
	223	self.retrieveSNMPValues()
	224	pstatusAsString = printerStatusValues.get(self.printerStatus)
	225	dstatusAsString = deviceStatusValues.get(self.deviceStatus)
	226	idle_flag = 0
[3025]	227	if (not self.checkIfError(self.printerDetectedErrorState)) \
	228	and ((pstatusAsString == 'idle') or \
	229	((pstatusAsString == 'other') and \
	230	(dstatusAsString == 'running'))) :
[2877]	231	idle_flag = 1 # Standby / Powersave is considered idle
	232	if idle_flag :
[3163]	233	if (self.printerInternalPageCounter is not None) \
	234	and self.skipinitialwait \
	235	and (os.environ.get("PYKOTAPHASE") == "BEFORE") :
	236	self.parent.filter.logdebug("No need to wait for the printer to be idle, it is the case already.")
	237	return
[2877]	238	idle_num += 1
[3180]	239	if idle_num >= statusstabilizationloops :
[2877]	240	# printer status is stable, we can exit
	241	break
	242	else :
	243	idle_num = 0
	244	self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.PrinterName)
[3180]	245	time.sleep(statusstabilizationdelay)
[2205]	246
[2877]	247	def retrieveInternalPageCounter(self) :
	248	"""Returns the page counter from the printer via internal SNMP handling."""
	249	try :
	250	if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
	251	(os.environ.get("PYKOTAACTION") == "ALLOW") and \
	252	(os.environ.get("PYKOTAPHASE") == "AFTER") and \
	253	self.parent.filter.JobSizeBytes :
	254	self.waitPrinting()
	255	self.waitIdle()
	256	except :
	257	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")
	258	raise
	259	return self.printerInternalPageCounter
	260
	261	if hasV4 :
	262	class Handler(BaseHandler) :
	263	"""A class for pysnmp v4.x"""
	264	def retrieveSNMPValues(self) :
	265	"""Retrieves a printer's internal page counter and status via SNMP."""
[3160]	266	try :
	267	errorIndication, errorStatus, errorIndex, varBinds = \
[2877]	268	cmdgen.CommandGenerator().getCmd(cmdgen.CommunityData("pykota", self.community, 0), \
	269	cmdgen.UdpTransportTarget((self.printerHostname, self.port)), \
	270	tuple([int(i) for i in pageCounterOID.split('.')]), \
	271	tuple([int(i) for i in hrPrinterStatusOID.split('.')]), \
[3025]	272	tuple([int(i) for i in hrDeviceStatusOID.split('.')]), \
[3039]	273	tuple([int(i) for i in hrPrinterDetectedErrorStateOID.split('.')]))
[3161]	274	except socket.gaierror, msg :
	275	errorIndication = repr(msg)
[3160]	276	except :
	277	errorIndication = "Unknown SNMP/Network error. Check your wires."
[2877]	278	if errorIndication :
	279	self.parent.filter.printInfo("SNMP Error : %s" % errorIndication, "error")
[3025]	280	self.initValues()
[2877]	281	elif errorStatus :
	282	self.parent.filter.printInfo("SNMP Error : %s at %s" % (errorStatus.prettyPrint(), \
	283	varBinds[int(errorIndex)-1]), \
	284	"error")
[3027]	285	self.initValues()
[2877]	286	else :
	287	self.printerInternalPageCounter = max(self.printerInternalPageCounter, int(varBinds[0][1].prettyPrint()))
	288	self.printerStatus = int(varBinds[1][1].prettyPrint())
	289	self.deviceStatus = int(varBinds[2][1].prettyPrint())
[3025]	290	self.printerDetectedErrorState = self.extractErrorStates(str(varBinds[3][1]))
[3039]	291	self.parent.filter.logdebug("SNMP answer decoded : PageCounter : %s PrinterStatus : '%s' DeviceStatus : '%s' PrinterErrorState : '%s'" \
[2877]	292	% (self.printerInternalPageCounter, \
	293	printerStatusValues.get(self.printerStatus), \
[3025]	294	deviceStatusValues.get(self.deviceStatus), \
[3039]	295	self.printerDetectedErrorState))
[2877]	296	else :
	297	class Handler(BaseHandler) :
	298	"""A class for pysnmp v3.4.x"""
[2205]	299	def retrieveSNMPValues(self) :
	300	"""Retrieves a printer's internal page counter and status via SNMP."""
	301	ver = alpha.protoVersions[alpha.protoVersionId1]
	302	req = ver.Message()
[2423]	303	req.apiAlphaSetCommunity(self.community)
[2205]	304	req.apiAlphaSetPdu(ver.GetRequestPdu())
	305	req.apiAlphaGetPdu().apiAlphaSetVarBindList((pageCounterOID, ver.Null()), \
	306	(hrPrinterStatusOID, ver.Null()), \
[3025]	307	(hrDeviceStatusOID, ver.Null()), \
[3039]	308	(hrPrinterDetectedErrorStateOID, ver.Null()))
[2205]	309	tsp = Manager()
	310	try :
[2423]	311	tsp.sendAndReceive(req.berEncode(), \
	312	(self.printerHostname, self.port), \
	313	(self.handleAnswer, req))
[2319]	314	except (SnmpOverUdpError, select.error), msg :
[2205]	315	self.parent.filter.printInfo(_("Network error while doing SNMP queries on printer %s : %s") % (self.printerHostname, msg), "warn")
[3027]	316	self.initValues()
[2205]	317	tsp.close()
[2877]	318
[2205]	319	def handleAnswer(self, wholeMsg, notusedhere, req):
	320	"""Decodes and handles the SNMP answer."""
	321	ver = alpha.protoVersions[alpha.protoVersionId1]
	322	rsp = ver.Message()
	323	try :
	324	rsp.berDecode(wholeMsg)
	325	except TypeMismatchError, msg :
	326	self.parent.filter.printInfo(_("SNMP message decoding error for printer %s : %s") % (self.printerHostname, msg), "warn")
[3027]	327	self.initValues()
[2205]	328	else :
	329	if req.apiAlphaMatch(rsp):
	330	errorStatus = rsp.apiAlphaGetPdu().apiAlphaGetErrorStatus()
	331	if errorStatus:
	332	self.parent.filter.printInfo(_("Problem encountered while doing SNMP queries on printer %s : %s") % (self.printerHostname, errorStatus), "warn")
	333	else:
	334	self.values = []
	335	for varBind in rsp.apiAlphaGetPdu().apiAlphaGetVarBindList():
	336	self.values.append(varBind.apiAlphaGetOidVal()[1].rawAsn1Value)
	337	try :
	338	# keep maximum value seen for printer's internal page counter
	339	self.printerInternalPageCounter = max(self.printerInternalPageCounter, self.values[0])
[2305]	340	self.printerStatus = self.values[1]
	341	self.deviceStatus = self.values[2]
[3025]	342	self.printerDetectedErrorState = self.extractErrorStates(self.values[3])
[3039]	343	self.parent.filter.logdebug("SNMP answer decoded : PageCounter : %s PrinterStatus : '%s' DeviceStatus : '%s' PrinterErrorState : '%s'" \
[2615]	344	% (self.printerInternalPageCounter, \
[2617]	345	printerStatusValues.get(self.printerStatus), \
[3025]	346	deviceStatusValues.get(self.deviceStatus), \
[3039]	347	self.printerDetectedErrorState))
[2205]	348	except IndexError :
	349	self.parent.filter.logdebug("SNMP answer is incomplete : %s" % str(self.values))
	350	pass
	351	else :
	352	return 1
[2877]	353
[2506]	354	def main(hostname) :
	355	"""Tries SNMP accounting for a printer host."""
	356	class fakeFilter :
[2830]	357	"""Fakes a filter for testing purposes."""
[2506]	358	def __init__(self) :
[2830]	359	"""Initializes the fake filter."""
[2506]	360	self.PrinterName = "FakePrintQueue"
	361	self.JobSizeBytes = 1
	362
	363	def printInfo(self, msg, level="info") :
[2830]	364	"""Prints informational message."""
[2506]	365	sys.stderr.write("%s : %s\n" % (level.upper(), msg))
	366	sys.stderr.flush()
	367
	368	def logdebug(self, msg) :
[2830]	369	"""Prints debug message."""
[2506]	370	self.printInfo(msg, "debug")
	371
	372	class fakeAccounter :
[2830]	373	"""Fakes an accounter for testing purposes."""
[2506]	374	def __init__(self) :
[2830]	375	"""Initializes fake accounter."""
[2506]	376	self.arguments = "snmp:public"
	377	self.filter = fakeFilter()
	378	self.protocolHandler = Handler(self, hostname)
[2615]	379
	380	def getLastPageCounter(self) :
[2830]	381	"""Fakes the return of a page counter."""
[2615]	382	return 0
[2506]	383
	384	acc = fakeAccounter()
	385	return acc.protocolHandler.retrieveInternalPageCounter()
	386
[2205]	387	if __name__ == "__main__" :
	388	if len(sys.argv) != 2 :
	389	sys.stderr.write("Usage : python %s printer_ip_address\n" % sys.argv[0])
	390	else :
	391	def _(msg) :
	392	return msg
	393
[2506]	394	pagecounter = main(sys.argv[1])
	395	print "Internal page counter's value is : %s" % pagecounter

Note: See TracBrowser for help on using the browser.

Context Navigation

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

Download in other formats: