Context Navigation

cupspykota @ 2165

Revision 2165, 35.7 kB (checked in by jerome, 19 years ago)
Avoids launching non-executable backends during device enumeration
Property svn:eol-style set to `native` Property svn:executable set to ``* Property svn:keywords set to `Author Date Id Revision`

Rev	Line
[1177]	1	#! /usr/bin/env python
	2	# -- coding: ISO-8859-15 --
	3
	4	# CUPSPyKota accounting backend
	5	#
	6	# PyKota - Print Quotas for CUPS and LPRng
	7	#
[2028]	8	# (c) 2003, 2004, 2005 Jerome Alet <alet@librelogiciel.com>
[1177]	9	# This program is free software; you can redistribute it and/or modify
	10	# it under the terms of the GNU General Public License as published by
	11	# the Free Software Foundation; either version 2 of the License, or
	12	# (at your option) any later version.
	13	#
	14	# This program is distributed in the hope that it will be useful,
	15	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	# GNU General Public License for more details.
	18	#
	19	# You should have received a copy of the GNU General Public License
	20	# along with this program; if not, write to the Free Software
	21	# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
	22	#
	23	# $Id$
	24	#
[2066]	25	#
[1177]	26
	27	import sys
	28	import os
[2164]	29	import errno
	30	import tempfile
[1182]	31	import popen2
[1178]	32	import cStringIO
	33	import shlex
[1182]	34	import select
	35	import signal
[1291]	36	import time
[1177]	37
[1546]	38	from pykota.tool import PyKotaFilterOrBackend, PyKotaToolError, crashed
[1177]	39	from pykota.config import PyKotaConfigError
	40	from pykota.storage import PyKotaStorageError
[1196]	41	from pykota.accounter import PyKotaAccounterError
[1901]	42	from pykota.ipp import IPPMessage, PyKotaIPPError
[1271]	43
[1478]	44	class PyKotaPopen4(popen2.Popen4) :
[1182]	45	"""Our own class to execute real backends.
	46
	47	Their first argument is different from their path so using
	48	native popen2.Popen3 would not be feasible.
	49	"""
[1478]	50	def __init__(self, cmd, bufsize=-1, arg0=None) :
[1182]	51	self.arg0 = arg0
[1478]	52	popen2.Popen4.__init__(self, cmd, bufsize)
[1182]	53
	54	def _run_child(self, cmd):
[1704]	55	try :
	56	MAXFD = os.sysconf("SC_OPEN_MAX")
	57	except (AttributeError, ValueError) :
	58	MAXFD = 256
	59	for i in range(3, MAXFD) :
[1182]	60	try:
	61	os.close(i)
	62	except OSError:
	63	pass
	64	try:
	65	os.execvpe(cmd[0], [self.arg0 or cmd[0]] + cmd[1:], os.environ)
	66	finally:
	67	os._exit(1)
	68
[1271]	69	class PyKotaBackend(PyKotaFilterOrBackend) :
	70	"""A class for the pykota backend."""
	71	def acceptJob(self) :
	72	"""Returns the appropriate exit code to tell CUPS all is OK."""
	73	return 0
	74
	75	def removeJob(self) :
	76	"""Returns the appropriate exit code to let CUPS think all is OK.
[1177]	77
[1271]	78	Returning 0 (success) prevents CUPS from stopping the print queue.
	79	"""
	80	return 0
[1222]	81
[2060]	82	def genBanner(self, bannerfileorcommand) :
	83	"""Reads a banner or generates one through an external command.
	84
	85	Returns the banner's content in a format which MUST be accepted
	86	by the printer.
	87	"""
	88	if bannerfileorcommand :
	89	banner = "" # no banner by default
	90	if os.access(bannerfileorcommand, os.X_OK) or not os.path.isfile(bannerfileorcommand) :
	91	self.logdebug("Launching %s to generate a banner." % bannerfileorcommand)
	92	child = popen2.Popen3(bannerfileorcommand, capturestderr=1)
	93	banner = child.fromchild.read()
	94	child.tochild.close()
	95	child.childerr.close()
	96	child.fromchild.close()
	97	status = child.wait()
	98	if os.WIFEXITED(status) :
	99	status = os.WEXITSTATUS(status)
	100	self.printInfo(_("Banner generator %s exit code is %s") % (bannerfileorcommand, str(status)))
	101	else :
	102	self.logdebug("Using %s as the banner." % bannerfileorcommand)
	103	try :
	104	fh = open(bannerfileorcommand, 'r')
	105	except IOError, msg :
	106	self.printInfo("Impossible to open %s : %s" % (bannerfileorcommand, msg), "error")
	107	else :
	108	banner = fh.read()
	109	fh.close()
	110	if banner :
	111	return cStringIO.StringIO(banner)
	112
	113	def startingBanner(self, printername) :
	114	"""Retrieves a starting banner for current printer and returns its content."""
	115	self.logdebug("Retrieving starting banner...")
	116	return self.genBanner(self.config.getStartingBanner(printername))
	117
	118	def endingBanner(self, printername) :
	119	"""Retrieves an ending banner for current printer and returns its content."""
	120	self.logdebug("Retrieving ending banner...")
	121	return self.genBanner(self.config.getEndingBanner(printername))
	122
[1901]	123	def getCupsConfigDirectives(self, directives=[]) :
[1902]	124	"""Retrieves some CUPS directives from its configuration file.
	125
	126	Returns a mapping with lowercased directives as keys and
	127	their setting as values.
	128	"""
[1901]	129	dirvalues = {}
[1502]	130	cupsroot = os.environ.get("CUPS_SERVERROOT", "/etc/cups")
	131	cupsdconf = os.path.join(cupsroot, "cupsd.conf")
	132	try :
	133	conffile = open(cupsdconf, "r")
	134	except IOError :
[1503]	135	self.logdebug("Unable to open %s" % cupsdconf)
[1502]	136	else :
	137	for line in conffile.readlines() :
	138	linecopy = line.strip().lower()
[1901]	139	for di in [d.lower() for d in directives] :
	140	if linecopy.startswith("%s " % di) :
	141	try :
	142	val = line.split()[1]
	143	except :
	144	pass # ignore errors, we take the last value in any case.
	145	else :
	146	dirvalues[di] = val
[1502]	147	conffile.close()
[1901]	148	return dirvalues
[1502]	149
[1901]	150	def getJobOriginatingHostnameFromPageLog(self, cupsconfig, printername, username, jobid) :
[1502]	151	"""Retrieves the job-originating-hostname from the CUPS page_log file if possible."""
[1901]	152	pagelogpath = cupsconfig.get("pagelog", "/var/log/cups/page_log")
	153	self.logdebug("Trying to extract job-originating-host-name from %s" % pagelogpath)
[1502]	154	try :
	155	pagelog = open(pagelogpath, "r")
	156	except IOError :
[1503]	157	self.logdebug("Unable to open %s" % pagelogpath)
[1502]	158	return # no page log or can't read it, originating hostname unknown yet
	159	else :
	160	# TODO : read backward so we could take first value seen
	161	# TODO : here we read forward so we must take the last value seen
[1819]	162	prefix = ("%s %s %s " % (printername, username, jobid)).lower()
[1502]	163	matchingline = None
	164	while 1 :
	165	line = pagelog.readline()
	166	if not line :
	167	break
	168	else :
	169	line = line.strip()
[1530]	170	if line.lower().startswith(prefix) :
[1502]	171	matchingline = line # no break, because we read forward
	172	pagelog.close()
	173	if matchingline is None :
[1606]	174	self.logdebug("No matching line found in %s" % pagelogpath)
[1901]	175	return # correct line not found, job-originating-host-name unknown
[1502]	176	else :
	177	return matchingline.split()[-1]
	178
[1271]	179	def doWork(self, policy, printer, user, userpquota) :
	180	"""Most of the work is done here."""
	181	# Two different values possible for policy here :
	182	# ALLOW means : Either printer, user or user print quota doesn't exist,
	183	# but the job should be allowed anyway.
	184	# OK means : Both printer, user and user print quota exist, job should
	185	# be allowed if current user is allowed to print on this printer
	186	if policy == "OK" :
[1372]	187	# exports user information with initial values
	188	self.exportUserInfo(userpquota)
	189
[1901]	190	# tries to extract job-originating-host-name and other information
	191	cupsdconf = self.getCupsConfigDirectives(["PageLog", "RequestRoot"])
	192	requestroot = cupsdconf.get("requestroot", "/var/spool/cups")
	193	if (len(self.jobid) < 5) and self.jobid.isdigit() :
	194	ippmessagefile = "c%05i" % int(self.jobid)
	195	else :
	196	ippmessagefile = "c%s" % self.jobid
	197	ippmessagefile = os.path.join(requestroot, ippmessagefile)
	198	ippmessage = {}
[2007]	199	self.regainPriv()
[1901]	200	try :
	201	ippdatafile = open(ippmessagefile)
	202	except :
	203	self.printInfo("Unable to open IPP message file %s" % ippmessagefile, "warn")
	204	else :
	205	self.logdebug("Parsing of IPP message file %s begins." % ippmessagefile)
[1902]	206	try :
	207	ippmessage = IPPMessage(ippdatafile.read())
	208	except PyKotaIPPError, msg :
	209	self.printInfo("Error while parsing %s : %s" % (ippmessagefile, msg), "warn")
	210	else :
	211	self.logdebug("Parsing of IPP message file %s ends." % ippmessagefile)
[1901]	212	ippdatafile.close()
[2007]	213	self.dropPriv()
[1901]	214	clienthost = ippmessage.get("job-originating-host-name") \
	215	or self.getJobOriginatingHostnameFromPageLog(cupsdconf, printer.Name, user.Name, self.jobid)
[1503]	216	self.logdebug("Client Hostname : %s" % (clienthost or "Unknown"))
[1517]	217	os.environ["PYKOTAJOBORIGINATINGHOSTNAME"] = str(clienthost or "")
[1502]	218
[1901]	219	# TODO : extract username (double check ?) and billing code too
	220
[1375]	221	# enters first phase
[1517]	222	os.environ["PYKOTAPHASE"] = "BEFORE"
[1375]	223
[2060]	224	# precomputes the job's price
	225	self.softwareJobPrice = userpquota.computeJobPrice(self.softwareJobSize)
[1517]	226	os.environ["PYKOTAPRECOMPUTEDJOBPRICE"] = str(self.softwareJobPrice)
[2060]	227	self.logdebug("Precomputed job's size is %s pages, price is %s units" % (self.softwareJobSize, self.softwareJobPrice))
[1519]	228
	229	if not self.jobSizeBytes :
[2066]	230	# if no data to pass to real backend, probably a filter
	231	# higher in the chain failed because of a misconfiguration.
	232	# we deny the job in this case (nothing to print anyway)
[1820]	233	self.printMoreInfo(user, printer, _("Job contains no data. Printing is denied."), "warn")
[1519]	234	action = "DENY"
[2066]	235	elif self.config.getDenyDuplicates(printer.Name) \
	236	and printer.LastJob.Exists \
	237	and (printer.LastJob.UserName == user.Name) \
	238	and (printer.LastJob.JobMD5Sum == self.checksum) :
	239	self.printMoreInfo(user, printer, _("Job is a duplicate. Printing is denied."), "warn")
	240	action = "DENY"
[1606]	241	else :
	242	# checks the user's quota
	243	action = self.warnUserPQuota(userpquota)
[1519]	244
[1372]	245	# exports some new environment variables
[1517]	246	os.environ["PYKOTAACTION"] = action
[1372]	247
	248	# launches the pre hook
	249	self.prehook(userpquota)
[1918]	250
	251	# saves the size of banners which have to be accounted for
	252	# this is needed in the case of software accounting
	253	bannersize = 0
[1372]	254
[1918]	255	# handle starting banner pages before accounting
	256	accountbanner = self.config.getAccountBanner(printer.Name)
	257	if accountbanner in ["ENDING", "NONE"] :
[2066]	258	if (action == 'DENY') and (userpquota.WarnCount >= self.config.getMaxDenyBanners(printer.Name)) :
[2054]	259	self.printInfo(_("Banner won't be printed : maximum number of deny banners reached."), "warn")
	260	else :
	261	if action == 'DENY' :
[2066]	262	self.logdebug("Incrementing the number of deny banners for user %s on printer %s" % (user.Name, printer.Name))
	263	userpquota.incDenyBannerCounter() # increments the warning counter
[2054]	264	self.exportUserInfo(userpquota)
	265	banner = self.startingBanner(printer.Name)
	266	if banner :
	267	self.logdebug("Printing starting banner before accounting begins.")
	268	self.handleData(banner)
[1918]	269
[1820]	270	self.printMoreInfo(user, printer, _("Job accounting begins."))
[1624]	271	self.accounter.beginJob(printer)
[1918]	272
	273	# handle starting banner pages during accounting
	274	if accountbanner in ["STARTING", "BOTH"] :
[2066]	275	if (action == 'DENY') and (userpquota.WarnCount >= self.config.getMaxDenyBanners(printer.Name)) :
[2054]	276	self.printInfo(_("Banner won't be printed : maximum number of deny banners reached."), "warn")
	277	else :
	278	if action == 'DENY' :
[2066]	279	self.logdebug("Incrementing the number of deny banners for user %s on printer %s" % (user.Name, printer.Name))
	280	userpquota.incDenyBannerCounter() # increments the warning counter
[2054]	281	self.exportUserInfo(userpquota)
	282	banner = self.startingBanner(printer.Name)
	283	if banner :
	284	self.logdebug("Printing starting banner during accounting.")
	285	self.handleData(banner)
	286	if self.accounter.isSoftware :
	287	bannersize += 1 # TODO : fix this by passing the banner's content through PDLAnalyzer
[1280]	288	else :
	289	action = "ALLOW"
[1517]	290	os.environ["PYKOTAACTION"] = action
[1271]	291
	292	# pass the job's data to the real backend
[1280]	293	if action in ["ALLOW", "WARN"] :
[1291]	294	if self.gotSigTerm :
[1280]	295	retcode = self.removeJob()
	296	else :
	297	retcode = self.handleData()
	298	else :
[1271]	299	retcode = self.removeJob()
	300
	301	if policy == "OK" :
[1374]	302	# indicate phase change
[1517]	303	os.environ["PYKOTAPHASE"] = "AFTER"
[1374]	304
[1918]	305	# handle ending banner pages during accounting
	306	if accountbanner in ["ENDING", "BOTH"] :
[2066]	307	if (action == 'DENY') and (userpquota.WarnCount >= self.config.getMaxDenyBanners(printer.Name)) :
[2054]	308	self.printInfo(_("Banner won't be printed : maximum number of deny banners reached."), "warn")
	309	else :
	310	if action == 'DENY' :
[2066]	311	self.logdebug("Incrementing the number of deny banners for user %s on printer %s" % (user.Name, printer.Name))
	312	userpquota.incDenyBannerCounter() # increments the warning counter
[2054]	313	self.exportUserInfo(userpquota)
	314	banner = self.endingBanner(printer.Name)
	315	if banner :
	316	self.logdebug("Printing ending banner during accounting.")
	317	self.handleData(banner)
	318	if self.accounter.isSoftware :
	319	bannersize += 1 # TODO : fix this by passing the banner's content through PDLAnalyzer
[1918]	320
[1271]	321	# stops accounting.
[1624]	322	self.accounter.endJob(printer)
[1820]	323	self.printMoreInfo(user, printer, _("Job accounting ends."))
[1271]	324
	325	# retrieve the job size
[1321]	326	if action == "DENY" :
	327	jobsize = 0
[1820]	328	self.printMoreInfo(user, printer, _("Job size forced to 0 because printing is denied."))
[1321]	329	else :
[2066]	330	userpquota.resetDenyBannerCounter()
[2007]	331	jobsize = self.accounter.getJobSize(printer)
[1974]	332	if self.softwareJobSize and (jobsize != self.softwareJobSize) :
	333	self.printInfo(_("Beware : computed job size (%s) != precomputed job size (%s)") % (jobsize, self.softwareJobSize), "error")
[2062]	334	(limit, replacement) = self.config.getTrustJobSize(printer.Name)
	335	if limit is None :
	336	self.printInfo(_("The job size will be trusted anyway according to the 'trustjobsize' directive"), "warn")
	337	else :
	338	if jobsize <= limit :
	339	self.printInfo(_("The job size will be trusted because it is inferior to the 'trustjobsize' directive's limit %s") % limit, "warn")
	340	else :
	341	self.printInfo(_("The job size will be modified according to the 'trustjobsize' directive : %s") % replacement, "warn")
	342	if replacement == "PRECOMPUTED" :
	343	jobsize = self.softwareJobSize
	344	else :
	345	jobsize = replacement
[2007]	346	jobsize += bannersize
[1820]	347	self.printMoreInfo(user, printer, _("Job size : %i") % jobsize)
[1271]	348
	349	# update the quota for the current user on this printer
[1606]	350	self.printInfo(_("Updating user %s's quota on printer %s") % (user.Name, printer.Name))
[1285]	351	jobprice = userpquota.increasePagesUsage(jobsize)
[1271]	352
	353	# adds the current job to history
[2057]	354	printer.addJobToHistory(self.jobid, user, self.accounter.getLastPageCounter(), \
	355	action, jobsize, jobprice, self.preserveinputfile, \
	356	self.title, self.copies, self.options, clienthost, \
	357	self.jobSizeBytes, self.checksum)
[1820]	358	self.printMoreInfo(user, printer, _("Job added to history."))
[1271]	359
[1372]	360	# exports some new environment variables
[1517]	361	os.environ["PYKOTAJOBSIZE"] = str(jobsize)
	362	os.environ["PYKOTAJOBPRICE"] = str(jobprice)
[1372]	363
[1517]	364	# then re-export user information with new value
[1372]	365	self.exportUserInfo(userpquota)
	366
[1923]	367	# handle ending banner pages after accounting ends
	368	if accountbanner in ["STARTING", "NONE"] :
[2066]	369	if (action == 'DENY') and (userpquota.WarnCount >= self.config.getMaxDenyBanners(printer.Name)) :
[2054]	370	self.printInfo(_("Banner won't be printed : maximum number of deny banners reached."), "warn")
	371	else :
	372	if action == 'DENY' :
[2066]	373	self.logdebug("Incrementing the number of deny banners for user %s on printer %s" % (user.Name, printer.Name))
	374	userpquota.incDenyBannerCounter() # increments the warning counter
[2054]	375	self.exportUserInfo(userpquota)
	376	banner = self.endingBanner(printer.Name)
	377	if banner :
	378	self.logdebug("Printing ending banner after accounting ends.")
	379	self.handleData(banner)
	380
[1372]	381	# Launches the post hook
	382	self.posthook(userpquota)
	383
[1271]	384	return retcode
[1478]	385
[1458]	386	def unregisterFileNo(self, pollobj, fileno) :
	387	"""Removes a file handle from the polling object."""
	388	try :
	389	pollobj.unregister(fileno)
	390	except KeyError :
[1584]	391	self.printInfo(_("File number %s unregistered twice from polling object, ignored.") % fileno, "warn")
[1494]	392	except :
	393	self.logdebug("Error while unregistering file number %s from polling object." % fileno)
[1458]	394	else :
	395	self.logdebug("File number %s unregistered from polling object." % fileno)
	396
[1495]	397	def formatFileEvent(self, fd, mask) :
[1478]	398	"""Formats file debug info."""
[1495]	399	maskval = []
	400	if mask & select.POLLIN :
	401	maskval.append("POLLIN")
	402	if mask & select.POLLOUT :
	403	maskval.append("POLLOUT")
	404	if mask & select.POLLPRI :
	405	maskval.append("POLLPRI")
	406	if mask & select.POLLERR :
	407	maskval.append("POLLERR")
	408	if mask & select.POLLHUP :
	409	maskval.append("POLLHUP")
	410	if mask & select.POLLNVAL :
	411	maskval.append("POLLNVAL")
	412	return "%s (%s)" % (fd, " \| ".join(maskval))
[1478]	413
[1918]	414	def handleData(self, filehandle=None) :
[1271]	415	"""Pass the job's data to the real backend."""
[1222]	416	# Find the real backend pathname
[1271]	417	realbackend = os.path.join(os.path.split(sys.argv[0])[0], self.originalbackend)
[1222]	418
	419	# And launch it
[1923]	420	if filehandle is None :
	421	arguments = sys.argv
	422	else :
	423	# Here we absolutely WANT to remove any filename from the command line !
	424	arguments = [ "Fake this because we are printing a banner" ] + sys.argv[1:6]
[2006]	425
	426	self.regainPriv()
	427
[1924]	428	self.logdebug("Starting real backend %s with args %s" % (realbackend, " ".join(['"%s"' % a for a in ([os.environ["DEVICE_URI"]] + arguments[1:])])))
	429	subprocess = PyKotaPopen4([realbackend] + arguments[1:], bufsize=0, arg0=os.environ["DEVICE_URI"])
[1222]	430
	431	# Save file descriptors, we will need them later.
	432	stderrfno = sys.stderr.fileno()
	433	fromcfno = subprocess.fromchild.fileno()
[1494]	434	tocfno = subprocess.tochild.fileno()
[1222]	435
	436	# We will have to be careful when dealing with I/O
	437	# So we use a poll object to know when to read or write
	438	pollster = select.poll()
	439	pollster.register(fromcfno, select.POLLIN \| select.POLLPRI)
[1494]	440	pollster.register(stderrfno, select.POLLOUT)
	441	pollster.register(tocfno, select.POLLOUT)
[1222]	442
[1494]	443	# Initialize our buffers
	444	indata = ""
	445	outdata = ""
	446	endinput = endoutput = 0
	447	inputclosed = outputclosed = 0
[1897]	448	totaltochild = totalfromcups = 0
	449	totalfromchild = totaltocups = 0
[1494]	450
[1918]	451	if filehandle is None:
	452	if self.preserveinputfile is None :
	453	# this is not a real file, we read the job's data
	454	# from our temporary file which is a copy of stdin
	455	infno = self.jobdatastream.fileno()
	456	self.jobdatastream.seek(0)
	457	pollster.register(infno, select.POLLIN \| select.POLLPRI)
	458	else :
	459	# job's data is in a file, no need to pass the data
	460	# to the real backend
	461	self.logdebug("Job's data is in %s" % self.preserveinputfile)
	462	infno = None
	463	endinput = 1
	464	else:
	465	self.logdebug("Printing data passed from filehandle")
	466	indata = filehandle.read()
[1494]	467	infno = None
	468	endinput = 1
[1918]	469	filehandle.close()
[1494]	470
[1606]	471	self.logdebug("Entering streams polling loop...")
[1495]	472	MEGABYTE = 1024*1024
[1494]	473	killed = 0
	474	status = -1
[1495]	475	while (status == -1) and (not killed) and not (inputclosed and outputclosed) :
[1494]	476	# First check if original backend is still alive
	477	status = subprocess.poll()
	478
	479	# Now if we got SIGTERM, we have
	480	# to kill -TERM the original backend
	481	if self.gotSigTerm and not killed :
	482	try :
[1222]	483	os.kill(subprocess.pid, signal.SIGTERM)
[1495]	484	except OSError, msg : # ignore but logs if process was already killed.
[1514]	485	self.logdebug("Error while sending signal to pid %s : %s" % (subprocess.pid, msg))
[1495]	486	else :
[1606]	487	self.printInfo(_("SIGTERM was sent to real backend %s (pid: %s)") % (realbackend, subprocess.pid))
[1291]	488	killed = 1
[1494]	489
	490	# In any case, deal with any remaining I/O
[1498]	491	try :
	492	availablefds = pollster.poll(5000)
	493	except select.error, msg :
	494	self.logdebug("Interrupted poll : %s" % msg)
	495	availablefds = []
[1495]	496	if not availablefds :
[1606]	497	self.logdebug("Nothing to do, sleeping a bit...")
[1495]	498	time.sleep(0.01) # give some time to the system
	499	else :
	500	for (fd, mask) in availablefds :
	501	# self.logdebug(self.formatFileEvent(fd, mask))
	502	try :
	503	if mask & select.POLLOUT :
	504	# We can write
	505	if fd == tocfno :
	506	if indata :
	507	try :
[1897]	508	nbwritten = os.write(fd, indata)
[1515]	509	except (OSError, IOError), msg :
[1495]	510	self.logdebug("Error while writing to real backend's stdin %s : %s" % (fd, msg))
	511	else :
[1897]	512	if len(indata) != nbwritten :
	513	self.logdebug("Short write to real backend's input !")
	514	totaltochild += nbwritten
	515	self.logdebug("%s bytes sent to real backend so far..." % totaltochild)
	516	indata = indata[nbwritten:]
[1498]	517	else :
[1606]	518	self.logdebug("No data to send to real backend yet, sleeping a bit...")
[1498]	519	time.sleep(0.01)
	520
[1495]	521	if endinput :
	522	self.unregisterFileNo(pollster, tocfno)
[1606]	523	self.logdebug("Closing real backend's stdin.")
[1495]	524	os.close(tocfno)
	525	inputclosed = 1
	526	elif fd == stderrfno :
	527	if outdata :
	528	try :
[1897]	529	nbwritten = os.write(fd, outdata)
[1515]	530	except (OSError, IOError), msg :
[1495]	531	self.logdebug("Error while writing to CUPS back channel (stderr) %s : %s" % (fd, msg))
	532	else :
[1897]	533	if len(outdata) != nbwritten :
	534	self.logdebug("Short write to stderr (CUPS) !")
	535	totaltocups += nbwritten
	536	self.logdebug("%s bytes sent back to CUPS so far..." % totaltocups)
	537	outdata = outdata[nbwritten:]
[1498]	538	else :
	539	# self.logdebug("No data to send back to CUPS yet, sleeping a bit...") # Uncommenting this fills your logs
	540	time.sleep(0.01) # Give some time to the system, stderr is ALWAYS writeable it seems.
	541
[1495]	542	if endoutput :
	543	self.unregisterFileNo(pollster, stderrfno)
	544	outputclosed = 1
[1498]	545	else :
	546	self.logdebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
	547	time.sleep(0.01)
	548
[1495]	549	if mask & (select.POLLIN \| select.POLLPRI) :
	550	# We have something to read
	551	try :
	552	data = os.read(fd, MEGABYTE)
	553	except (IOError, OSError), msg :
	554	self.logdebug("Error while reading file %s : %s" % (fd, msg))
	555	else :
	556	if fd == infno :
	557	if not data : # If yes, then no more input data
	558	self.unregisterFileNo(pollster, infno)
[1606]	559	self.logdebug("Input data ends.")
[1495]	560	endinput = 1 # this happens with real files.
[1498]	561	else :
	562	indata += data
[1897]	563	totalfromcups += len(data)
	564	self.logdebug("%s bytes read from CUPS so far..." % totalfromcups)
[1495]	565	elif fd == fromcfno :
[1498]	566	if not data :
[1606]	567	self.logdebug("No back channel data to read from real backend yet, sleeping a bit...")
[1498]	568	time.sleep(0.01)
	569	else :
	570	outdata += data
[1897]	571	totalfromchild += len(data)
	572	self.logdebug("%s bytes read from real backend so far..." % totalfromchild)
[1498]	573	else :
	574	self.logdebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
	575	time.sleep(0.01)
	576
[1495]	577	if mask & (select.POLLHUP \| select.POLLERR) :
	578	# Treat POLLERR as an EOF.
	579	# Some standard I/O stream has no more datas
	580	self.unregisterFileNo(pollster, fd)
[1494]	581	if fd == infno :
[1495]	582	# Here we are in the case where the input file is stdin.
	583	# which has no more data to be read.
[1606]	584	self.logdebug("Input data ends.")
[1495]	585	endinput = 1
	586	elif fd == fromcfno :
	587	# We are no more interested in this file descriptor
[1606]	588	self.logdebug("Closing real backend's stdout+stderr.")
[1495]	589	os.close(fromcfno)
	590	endoutput = 1
[1498]	591	else :
	592	self.logdebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
	593	time.sleep(0.01)
[1495]	594
	595	if mask & select.POLLNVAL :
[1606]	596	self.logdebug("File %s was closed. Unregistering from polling object." % fd)
[1495]	597	self.unregisterFileNo(pollster, fd)
	598	except IOError, msg :
	599	self.logdebug("Got an IOError : %s" % msg) # we got signalled during an I/O
[1191]	600
[1494]	601	# We must close the real backend's input stream
	602	if killed and not inputclosed :
[1606]	603	self.logdebug("Forcing close of real backend's stdin.")
[1494]	604	os.close(tocfno)
	605
[1606]	606	self.logdebug("Exiting streams polling loop...")
[1492]	607
[1897]	608	self.logdebug("input data's final length : %s" % len(indata))
	609	self.logdebug("back-channel data's final length : %s" % len(outdata))
	610
	611	self.logdebug("Total bytes read from CUPS (job's datas) : %s" % totalfromcups)
	612	self.logdebug("Total bytes sent to real backend (job's datas) : %s" % totaltochild)
	613
	614	self.logdebug("Total bytes read from real backend (back-channel datas) : %s" % totalfromchild)
	615	self.logdebug("Total bytes sent back to CUPS (back-channel datas) : %s" % totaltocups)
	616
[1494]	617	# Check exit code of original CUPS backend.
	618	if status == -1 :
	619	# we exited the loop before the real backend exited
	620	# now we have to wait for it to finish and get its status
[1606]	621	self.logdebug("Waiting for real backend to exit...")
[1494]	622	try :
	623	status = subprocess.wait()
[2054]	624	except OSError : # already dead : TODO : detect when abnormal
[1494]	625	status = 0
[1222]	626	if os.WIFEXITED(status) :
	627	retcode = os.WEXITSTATUS(status)
[1291]	628	elif not killed :
[1606]	629	self.sendBackChannelData(_("CUPS backend %s died abnormally.") % realbackend, "error")
[1222]	630	retcode = -1
[1291]	631	else :
	632	retcode = self.removeJob()
[2006]	633
	634	self.dropPriv()
	635
[1271]	636	return retcode
[1222]	637
[1177]	638	if __name__ == "__main__" :
	639	# This is a CUPS backend, we should act and die like a CUPS backend
[1542]	640	retcode = 0
[1177]	641	if len(sys.argv) == 1 :
[1178]	642	(directory, myname) = os.path.split(sys.argv[0])
[2164]	643	tmpdir = tempfile.gettempdir()
	644	lockfilename = os.path.join(tmpdir, "%s..LCK" % myname)
	645	if os.path.exists(lockfilename) :
	646	# there's already a lockfile, see if still used
	647	lockfile = open(lockfilename, "r")
	648	pid = int(lockfile.read())
	649	lockfile.close()
[1178]	650	try :
[2164]	651	# see if the pid contained in the lock file is still running
	652	os.kill(pid, 0)
	653	except OSError, e :
	654	if e.errno != errno.EPERM :
	655	# process doesn't exist anymore, remove the lock
	656	os.remove(lockfilename)
	657
	658	if not os.path.exists(lockfilename) :
	659	lockfile = open(lockfilename, "w")
	660	lockfile.write("%i" % os.getpid())
	661	lockfile.close()
	662	# we will execute each existing backend in device enumeration mode
	663	# and generate their PyKota accounting counterpart
[2165]	664	allbackends = [ os.path.join(directory, b) \
	665	for b in os.listdir(directory)
	666	if os.access(os.path.join(directory, b), os.X_OK) \
	667	and (b != myname)]
	668	for backend in allbackends :
[2164]	669	answer = os.popen(backend, "r")
	670	try :
	671	devices = [line.strip() for line in answer.readlines()]
	672	except :
	673	devices = []
	674	status = answer.close()
	675	if status is None :
	676	for d in devices :
	677	# each line is of the form : 'xxxx xxxx "xxxx xxx" "xxxx xxx"'
	678	# so we have to decompose it carefully
	679	fdevice = cStringIO.StringIO("%s" % d)
	680	tokenizer = shlex.shlex(fdevice)
	681	tokenizer.wordchars = tokenizer.wordchars + r".:,?!~/\_$*-+={}[]()#"
	682	arguments = []
	683	while 1 :
	684	token = tokenizer.get_token()
	685	if token :
	686	arguments.append(token)
	687	else :
	688	break
	689	fdevice.close()
	690	try :
	691	(devicetype, device, name, fullname) = arguments
	692	except ValueError :
	693	pass # ignore this 'bizarre' device
	694	else :
	695	if name.startswith('"') and name.endswith('"') :
	696	name = name[1:-1]
	697	if fullname.startswith('"') and fullname.endswith('"') :
	698	fullname = fullname[1:-1]
	699	print '%s cupspykota:%s "PyKota+%s" "PyKota managed %s"' % (devicetype, device, name, fullname)
	700	os.remove(lockfilename)
[1542]	701	retcode = 0
[1177]	702	elif len(sys.argv) not in (6, 7) :
	703	sys.stderr.write("ERROR: %s job-id user title copies options [file]\n" % sys.argv[0])
	704	retcode = 1
	705	else :
	706	try :
[1542]	707	try :
	708	# Initializes the backend
	709	kotabackend = PyKotaBackend()
	710	except SystemExit :
	711	retcode = -1
	712	except :
	713	crashed("cupspykota backend initialization failed")
	714	retcode = 1
	715	else :
	716	retcode = kotabackend.mainWork()
	717	kotabackend.storage.close()
	718	kotabackend.closeJobDataStream()
[1513]	719	except :
[1517]	720	try :
	721	kotabackend.crashed("cupspykota backend failed")
	722	except :
[1542]	723	crashed("cupspykota backend failed")
	724	retcode = 1
[1177]	725
	726	sys.exit(retcode)

Note: See TracBrowser for help on using the browser.

Context Navigation

root / pykota / trunk / bin / cupspykota @ 2165

Download in other formats: