root / tea4cups / trunk / tea4cups @ 601

Revision 601, 39.8 kB (checked in by jerome, 19 years ago)

Added the possibility for prehooks to cancel print jobs

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Rev
Line 
1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3
4# Tea4CUPS : Tee for CUPS
5#
6# (c) 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
20#
21# $Id$
22#
23#
24
25import sys
26import os
27import popen2
28import errno
29import md5
30import cStringIO
31import shlex
32import tempfile
33import ConfigParser
34import select
35import signal
36import time
37from struct import unpack
38
39version = "2.00"
40
41class TeeError(Exception):
42    """Base exception for Tea4CUPS related stuff."""
43    def __init__(self, message = ""):
44        self.message = message
45        Exception.__init__(self, message)
46    def __repr__(self):
47        return self.message
48    __str__ = __repr__
49   
50class ConfigError(TeeError) :   
51    """Configuration related exceptions."""
52    pass 
53   
54class IPPError(TeeError) :   
55    """IPP related exceptions."""
56    pass 
57   
58class Popen4ForCUPS(popen2.Popen4) :
59    """Our own class to execute real backends.
60   
61       Their first argument is different from their path so using
62       native popen2.Popen3 would not be feasible.
63    """
64    def __init__(self, cmd, bufsize=-1, arg0=None) :
65        self.arg0 = arg0
66        popen2.Popen4.__init__(self, cmd, bufsize)
67       
68    def _run_child(self, cmd):
69        try :
70            MAXFD = os.sysconf("SC_OPEN_MAX")
71        except (AttributeError, ValueError) :   
72            MAXFD = 256
73        for i in range(3, MAXFD) : 
74            try:
75                os.close(i)
76            except OSError:
77                pass
78        try:
79            os.execvpe(cmd[0], [self.arg0 or cmd[0]] + cmd[1:], os.environ)
80        finally:
81            os._exit(1)
82   
83# Some IPP constants   
84OPERATION_ATTRIBUTES_TAG = 0x01
85JOB_ATTRIBUTES_TAG = 0x02
86END_OF_ATTRIBUTES_TAG = 0x03
87PRINTER_ATTRIBUTES_TAG = 0x04
88UNSUPPORTED_ATTRIBUTES_TAG = 0x05
89
90class IPPMessage :
91    """A class for IPP message files."""
92    def __init__(self, data) :
93        """Initializes an IPP Message object."""
94        self.data = data
95        self._attributes = {}
96        self.curname = None
97        self.tags = [ None ] * 256      # by default all tags reserved
98       
99        # Delimiter tags
100        self.tags[0x01] = "operation-attributes-tag"
101        self.tags[0x02] = "job-attributes-tag"
102        self.tags[0x03] = "end-of-attributes-tag"
103        self.tags[0x04] = "printer-attributes-tag"
104        self.tags[0x05] = "unsupported-attributes-tag"
105       
106        # out of band values
107        self.tags[0x10] = "unsupported"
108        self.tags[0x11] = "reserved-for-future-default"
109        self.tags[0x12] = "unknown"
110        self.tags[0x13] = "no-value"
111       
112        # integer values
113        self.tags[0x20] = "generic-integer"
114        self.tags[0x21] = "integer"
115        self.tags[0x22] = "boolean"
116        self.tags[0x23] = "enum"
117       
118        # octetString
119        self.tags[0x30] = "octetString-with-an-unspecified-format"
120        self.tags[0x31] = "dateTime"
121        self.tags[0x32] = "resolution"
122        self.tags[0x33] = "rangeOfInteger"
123        self.tags[0x34] = "reserved-for-collection"
124        self.tags[0x35] = "textWithLanguage"
125        self.tags[0x36] = "nameWithLanguage"
126       
127        # character strings
128        self.tags[0x20] = "generic-character-string"
129        self.tags[0x41] = "textWithoutLanguage"
130        self.tags[0x42] = "nameWithoutLanguage"
131        # self.tags[0x43] = "reserved"
132        self.tags[0x44] = "keyword"
133        self.tags[0x45] = "uri"
134        self.tags[0x46] = "uriScheme"
135        self.tags[0x47] = "charset"
136        self.tags[0x48] = "naturalLanguage"
137        self.tags[0x49] = "mimeMediaType"
138       
139        # now parses the IPP message
140        self.parse()
141       
142    def __getattr__(self, attrname) :   
143        """Allows self.attributes to return the attributes names."""
144        if attrname == "attributes" :
145            keys = self._attributes.keys()
146            keys.sort()
147            return keys
148        raise AttributeError, attrname
149           
150    def __getitem__(self, ippattrname) :   
151        """Fakes a dictionnary d['key'] notation."""
152        value = self._attributes.get(ippattrname)
153        if value is not None :
154            if len(value) == 1 :
155                value = value[0]
156        return value       
157    get = __getitem__   
158       
159    def parseTag(self) :   
160        """Extracts information from an IPP tag."""
161        pos = self.position
162        valuetag = self.tags[ord(self.data[pos])]
163        # print valuetag.get("name")
164        pos += 1
165        posend = pos2 = pos + 2
166        namelength = unpack(">H", self.data[pos:pos2])[0]
167        if not namelength :
168            name = self.curname
169        else :   
170            posend += namelength
171            self.curname = name = self.data[pos2:posend]
172        pos2 = posend + 2
173        valuelength = unpack(">H", self.data[posend:pos2])[0]
174        posend = pos2 + valuelength
175        value = self.data[pos2:posend]
176        oldval = self._attributes.setdefault(name, [])
177        oldval.append(value)
178        return posend - self.position
179       
180    def operation_attributes_tag(self) : 
181        """Indicates that the parser enters into an operation-attributes-tag group."""
182        return self.parseTag()
183       
184    def job_attributes_tag(self) : 
185        """Indicates that the parser enters into an operation-attributes-tag group."""
186        return self.parseTag()
187       
188    def printer_attributes_tag(self) : 
189        """Indicates that the parser enters into an operation-attributes-tag group."""
190        return self.parseTag()
191       
192    def parse(self) :
193        """Parses an IPP Message.
194       
195           NB : Only a subset of RFC2910 is implemented.
196           We are only interested in textual informations for now anyway.
197        """
198        self.version = "%s.%s" % (ord(self.data[0]), ord(self.data[1]))
199        self.operation_id = "0x%04x" % unpack(">H", self.data[2:4])[0]
200        self.request_id = "0x%08x" % unpack(">I", self.data[4:8])[0]
201        self.position = 8
202        try :
203            tag = ord(self.data[self.position])
204            while tag != END_OF_ATTRIBUTES_TAG :
205                self.position += 1
206                name = self.tags[tag]
207                if name is not None :
208                    func = getattr(self, name.replace("-", "_"), None)
209                    if func is not None :
210                        self.position += func()
211                        if ord(self.data[self.position]) > UNSUPPORTED_ATTRIBUTES_TAG :
212                            self.position -= 1
213                            continue
214                tag = ord(self.data[self.position])
215        except IndexError :
216            raise IPPError, "Unexpected end of IPP message."
217           
218class FakeConfig :   
219    """Fakes a configuration file parser."""
220    def get(self, section, option, raw=0) :
221        """Fakes the retrieval of a global option."""
222        raise ConfigError, "Invalid configuration file : no option %s in section [%s]" % (option, section)
223       
224class CupsBackend :
225    """Base class for tools with no database access."""
226    def __init__(self) :
227        """Initializes the CUPS backend wrapper."""
228        self.gotSigTerm = 0
229        signal.signal(signal.SIGTERM, signal.SIG_IGN)
230        signal.signal(signal.SIGPIPE, signal.SIG_IGN)
231        self.MyName = "Tea4CUPS"
232        self.myname = "tea4cups"
233        self.pid = os.getpid()
234        confdir = os.environ.get("CUPS_SERVERROOT", ".") 
235        self.conffile = os.path.join(confdir, "%s.conf" % self.myname)
236        if os.path.isfile(self.conffile) :
237            self.config = ConfigParser.ConfigParser()
238            self.config.read([self.conffile])
239            self.debug = self.isTrue(self.getGlobalOption("debug", ignore=1))
240        else :   
241            self.config = FakeConfig()
242            self.debug = 1      # no config, so force debug mode !
243           
244    def logInfo(self, message, level="info") :       
245        """Logs a message to CUPS' error_log file."""
246        sys.stderr.write("%s: %s v%s (PID %i) : %s\n" % (level.upper(), self.MyName, version, os.getpid(), message))
247        sys.stderr.flush()
248       
249    def logDebug(self, message) :   
250        """Logs something to debug output if debug is enabled."""
251        if self.debug :
252            self.logInfo(message, level="debug")
253       
254    def isTrue(self, option) :       
255        """Returns 1 if option is set to true, else 0."""
256        if (option is not None) and (option.upper().strip() in ['Y', 'YES', '1', 'ON', 'T', 'TRUE']) :
257            return 1
258        else :   
259            return 0
260                       
261    def getGlobalOption(self, option, ignore=0) :   
262        """Returns an option from the global section, or raises a ConfigError if ignore is not set, else returns None."""
263        try :
264            return self.config.get("global", option, raw=1)
265        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
266            if not ignore :
267                raise ConfigError, "Option %s not found in section global of %s" % (option, self.conffile)
268               
269    def getPrintQueueOption(self, printqueuename, option, ignore=0) :   
270        """Returns an option from the printer section, or the global section, or raises a ConfigError."""
271        globaloption = self.getGlobalOption(option, ignore=1)
272        try :
273            return self.config.get(printqueuename, option, raw=1)
274        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
275            if globaloption is not None :
276                return globaloption
277            elif not ignore :
278                raise ConfigError, "Option %s not found in section [%s] of %s" % (option, printqueuename, self.conffile)
279               
280    def enumBranches(self, printqueuename, branchtype="tee") :
281        """Returns the list of branchtypes branches for a particular section's."""
282        branchbasename = "%s_" % branchtype.lower()
283        try :
284            globalbranches = [ (k, v) for (k, v) in self.config.items("global") if k.startswith(branchbasename) ]
285        except ConfigParser.NoSectionError, msg :   
286            raise ConfigError, "Invalid configuration file : %s" % msg
287        try :
288            sectionbranches = [ (k, v) for (k, v) in self.config.items(printqueuename) if k.startswith(branchbasename) ]
289        except ConfigParser.NoSectionError, msg :   
290            self.logInfo("No section for print queue %s : %s" % (printqueuename, msg))
291            sectionbranches = []
292        branches = {}
293        for (k, v) in globalbranches :
294            value = v.strip()
295            if value :
296                branches[k] = value
297        for (k, v) in sectionbranches :   
298            value = v.strip()
299            if value :
300                branches[k] = value # overwrite any global option or set a new value
301            else :   
302                del branches[k] # empty value disables a global option
303        return branches
304       
305    def discoverOtherBackends(self) :   
306        """Discovers the other CUPS backends.
307       
308           Executes each existing backend in turn in device enumeration mode.
309           Returns the list of available backends.
310        """
311        # Unfortunately this method can't output any debug information
312        # to stdout or stderr, else CUPS considers that the device is
313        # not available.
314        available = []
315        (directory, myname) = os.path.split(sys.argv[0])
316        if not directory :
317            directory = "./"
318        tmpdir = tempfile.gettempdir()
319        lockfilename = os.path.join(tmpdir, "%s..LCK" % myname)
320        if os.path.exists(lockfilename) :
321            lockfile = open(lockfilename, "r")
322            pid = int(lockfile.read())
323            lockfile.close()
324            try :
325                # see if the pid contained in the lock file is still running
326                os.kill(pid, 0)
327            except OSError, e :   
328                if e.errno != errno.EPERM :
329                    # process doesn't exist anymore
330                    os.remove(lockfilename)
331           
332        if not os.path.exists(lockfilename) :
333            lockfile = open(lockfilename, "w")
334            lockfile.write("%i" % self.pid)
335            lockfile.close()
336            allbackends = [ os.path.join(directory, b) \
337                                for b in os.listdir(directory) 
338                                    if os.access(os.path.join(directory, b), os.X_OK) \
339                                        and (b != myname)] 
340            for backend in allbackends :                           
341                answer = os.popen(backend, "r")
342                try :
343                    devices = [line.strip() for line in answer.readlines()]
344                except :   
345                    devices = []
346                status = answer.close()
347                if status is None :
348                    for d in devices :
349                        # each line is of the form :
350                        # 'xxxx xxxx "xxxx xxx" "xxxx xxx"'
351                        # so we have to decompose it carefully
352                        fdevice = cStringIO.StringIO(d)
353                        tokenizer = shlex.shlex(fdevice)
354                        tokenizer.wordchars = tokenizer.wordchars + \
355                                                        r".:,?!~/\_$*-+={}[]()#"
356                        arguments = []
357                        while 1 :
358                            token = tokenizer.get_token()
359                            if token :
360                                arguments.append(token)
361                            else :
362                                break
363                        fdevice.close()
364                        try :
365                            (devicetype, device, name, fullname) = arguments
366                        except ValueError :   
367                            pass    # ignore this 'bizarre' device
368                        else :   
369                            if name.startswith('"') and name.endswith('"') :
370                                name = name[1:-1]
371                            if fullname.startswith('"') and fullname.endswith('"') :
372                                fullname = fullname[1:-1]
373                            available.append('%s %s:%s "%s+%s" "%s managed %s"' \
374                                                 % (devicetype, self.myname, device, self.MyName, name, self.MyName, fullname))
375            os.remove(lockfilename)
376        available.append('direct %s:// "%s+Nothing" "%s managed Virtual Printer"' \
377                             % (self.myname, self.MyName, self.MyName))
378        return available
379                       
380    def initBackend(self) :   
381        """Initializes the backend's attributes."""
382        # check that the DEVICE_URI environment variable's value is
383        # prefixed with self.myname otherwise don't touch it.
384        # If this is the case, we have to remove the prefix from
385        # the environment before launching the real backend
386        muststartwith = "%s:" % self.myname
387        device_uri = os.environ.get("DEVICE_URI", "")
388        if device_uri.startswith(muststartwith) :
389            fulldevice_uri = device_uri[:]
390            device_uri = fulldevice_uri[len(muststartwith):]
391            for i in range(2) :
392                if device_uri.startswith("/") : 
393                    device_uri = device_uri[1:]
394        try :
395            (backend, destination) = device_uri.split(":", 1) 
396        except ValueError :   
397            if not device_uri :
398                self.logDebug("Not attached to an existing print queue.")
399                backend = ""
400            else :   
401                raise TeeError, "Invalid DEVICE_URI : %s\n" % device_uri
402       
403        self.JobId = sys.argv[1].strip()
404        self.UserName = sys.argv[2].strip()
405        self.Title = sys.argv[3].strip()
406        self.Copies = int(sys.argv[4].strip())
407        self.Options = sys.argv[5].strip()
408        if len(sys.argv) == 7 :
409            self.InputFile = sys.argv[6] # read job's datas from file
410        else :   
411            self.InputFile = None        # read job's datas from stdin
412           
413        self.RealBackend = backend
414        self.DeviceURI = device_uri
415        self.PrinterName = os.environ.get("PRINTER", "")
416        self.Directory = self.getPrintQueueOption(self.PrinterName, "directory")
417        self.DataFile = os.path.join(self.Directory, "%s-%s-%s-%s" % (self.myname, self.PrinterName, self.UserName, self.JobId))
418        self.ClientHost = self.extractJobOriginatingHostName()
419           
420    def getCupsConfigDirectives(self, directives=[]) :
421        """Retrieves some CUPS directives from its configuration file.
422       
423           Returns a mapping with lowercased directives as keys and
424           their setting as values.
425        """
426        dirvalues = {} 
427        cupsroot = os.environ.get("CUPS_SERVERROOT", "/etc/cups")
428        cupsdconf = os.path.join(cupsroot, "cupsd.conf")
429        try :
430            conffile = open(cupsdconf, "r")
431        except IOError :   
432            raise TeeError, "Unable to open %s" % cupsdconf
433        else :   
434            for line in conffile.readlines() :
435                linecopy = line.strip().lower()
436                for di in [d.lower() for d in directives] :
437                    if linecopy.startswith("%s " % di) :
438                        try :
439                            val = line.split()[1]
440                        except :   
441                            pass # ignore errors, we take the last value in any case.
442                        else :   
443                            dirvalues[di] = val
444            conffile.close()           
445        return dirvalues       
446           
447    def extractJobOriginatingHostName(self) :       
448        """Extracts the client's hostname or IP address from the CUPS message file for current job."""
449        cupsdconf = self.getCupsConfigDirectives(["RequestRoot"])
450        requestroot = cupsdconf.get("requestroot", "/var/spool/cups")
451        if (len(self.JobId) < 5) and self.JobId.isdigit() :
452            ippmessagefile = "c%05i" % int(self.JobId)
453        else :   
454            ippmessagefile = "c%s" % self.JobId
455        ippmessagefile = os.path.join(requestroot, ippmessagefile)
456        ippmessage = {}
457        try :
458            ippdatafile = open(ippmessagefile)
459        except :   
460            self.logInfo("Unable to open IPP message file %s" % ippmessagefile, "warn")
461        else :   
462            self.logDebug("Parsing of IPP message file %s begins." % ippmessagefile)
463            try :
464                ippmessage = IPPMessage(ippdatafile.read())
465            except IPPError, msg :   
466                self.logInfo("Error while parsing %s : %s" % (ippmessagefile, msg), "warn")
467            else :   
468                self.logDebug("Parsing of IPP message file %s ends." % ippmessagefile)
469            ippdatafile.close()
470        return ippmessage.get("job-originating-host-name")   
471               
472    def exportAttributes(self) :   
473        """Exports our backend's attributes to the environment."""
474        os.environ["DEVICE_URI"] = self.DeviceURI       # WARNING !
475        os.environ["TEAPRINTERNAME"] = self.PrinterName
476        os.environ["TEADIRECTORY"] = self.Directory
477        os.environ["TEADATAFILE"] = self.DataFile
478        os.environ["TEAJOBSIZE"] = str(self.JobSize)
479        os.environ["TEAMD5SUM"] = self.JobMD5Sum
480        os.environ["TEACLIENTHOST"] = self.ClientHost or ""
481        os.environ["TEAJOBID"] = self.JobId
482        os.environ["TEAUSERNAME"] = self.UserName
483        os.environ["TEATITLE"] = self.Title
484        os.environ["TEACOPIES"] = str(self.Copies)
485        os.environ["TEAOPTIONS"] = self.Options
486        os.environ["TEAINPUTFILE"] = self.InputFile or ""
487       
488    def saveDatasAndCheckSum(self) :
489        """Saves the input datas into a static file."""
490        self.logDebug("Duplicating data stream into %s" % self.DataFile)
491        mustclose = 0
492        if self.InputFile is not None :
493            infile = open(self.InputFile, "rb")
494            mustclose = 1
495        else :   
496            infile = sys.stdin
497        CHUNK = 64*1024         # read 64 Kb at a time
498        dummy = 0
499        sizeread = 0
500        checksum = md5.new()
501        outfile = open(self.DataFile, "wb")   
502        while 1 :
503            data = infile.read(CHUNK) 
504            if not data :
505                break
506            sizeread += len(data)   
507            outfile.write(data)
508            checksum.update(data)   
509            if not (dummy % 32) : # Only display every 2 Mb
510                self.logDebug("%s bytes saved..." % sizeread)
511            dummy += 1   
512        outfile.close()
513        if mustclose :   
514            infile.close()
515        self.JobSize = sizeread   
516        self.JobMD5Sum = checksum.hexdigest()
517        self.logDebug("Job %s is %s bytes long." % (self.JobId, self.JobSize))
518        self.logDebug("Job %s MD5 sum is %s" % (self.JobId, self.JobMD5Sum))
519
520    def cleanUp(self) :
521        """Cleans up the place."""
522        if not self.isTrue(self.getPrintQueueOption(self.PrinterName, "keepfiles", ignore=1)) :
523            os.remove(self.DataFile)
524           
525    def sigtermHandler(self, signum, frame) :
526        """Sets an attribute whenever SIGTERM is received."""
527        self.gotSigTerm = 1
528        self.logInfo("SIGTERM received for Job %s." % self.JobId)
529       
530    def runBranches(self) :         
531        """Launches each hook or tee defined for the current print queue."""
532        exitcode = 0
533        signal.signal(signal.SIGTERM, self.sigtermHandler)
534        serialize = self.isTrue(self.getPrintQueueOption(self.PrinterName, "serialize", ignore=1))
535        for branchtype in ["prehook", "tee", "posthook"] :
536            branches = self.enumBranches(self.PrinterName, branchtype)
537            status = self.runCommands(branchtype, branches, serialize)
538            if status :
539                exitcode = status
540            if (branchtype == "prehook") and (os.environ.get("TEASTATUS", "") == "CANCELLED") :
541                break # We don't want to execute tees or posthooks in this case
542        signal.signal(signal.SIGTERM, signal.SIG_IGN)
543        if not exitcode :
544            self.logInfo("OK")
545        else :   
546            self.logInfo("An error occured, please check CUPS' error_log file.")
547        return exitcode
548       
549    def runCommands(self, btype, branches, serialize) :   
550        """Runs the commands for a particular branch type."""
551        exitcode = 0 
552        btype = btype.lower()
553        btypetitle = btype.title()
554        branchlist = branches.keys()   
555        branchlist.sort()
556        if serialize :
557            self.logDebug("Begin serialized %ss" % btypetitle)
558            if (btype == "tee") and self.RealBackend :
559                self.logDebug("Launching original backend %s for printer %s" % (self.RealBackend, self.PrinterName))
560                exitcode = self.runOriginalBackend()
561            for branch in branchlist :
562                command = branches[branch]
563                if self.gotSigTerm :
564                    break
565                self.logDebug("Launching %s : %s" % (branch, command))
566                retcode = os.system(command)
567                self.logDebug("Exit code for %s %s on printer %s is %s" % (btype, branch, self.PrinterName, retcode))
568                if os.WIFEXITED(retcode) :
569                    retcode = os.WEXITSTATUS(retcode)
570                if retcode :   
571                    if (btype == "prehook") and (retcode == 255) : # -1
572                        self.logInfo("Job %s cancelled by prehook %s" % (self.JobId, branch))
573                        os.environ["TEASTATUS"] = "CANCELLED" # and don't touch exitcode
574                    else :   
575                        self.logInfo("%s %s on printer %s didn't exit successfully." % (btypetitle, branch, self.PrinterName), "error")
576                        exitcode = 1
577            self.logDebug("End serialized %ss" % btypetitle)
578        else :       
579            self.logDebug("Begin forked %ss" % btypetitle)
580            pids = {}
581            if (btype == "tee") and self.RealBackend :
582                branches["Original backend"] = None     # Fakes a tee to launch one more child
583                branchlist = ["Original backend"] + branchlist
584            for branch in branchlist :
585                command = branches[branch]
586                if self.gotSigTerm :
587                    break
588                pid = os.fork()
589                if pid :
590                    pids[branch] = pid
591                else :   
592                    if branch == "Original backend" :
593                        self.logDebug("Launching original backend %s for printer %s" % (self.RealBackend, self.PrinterName))
594                        sys.exit(self.runOriginalBackend())
595                    else :
596                        self.logDebug("Launching %s : %s" % (branch, command))
597                        retcode = os.system(command)
598                        if os.WIFEXITED(retcode) :
599                            retcode = os.WEXITSTATUS(retcode)
600                        else :   
601                            retcode = -1
602                        sys.exit(retcode)
603            for (branch, pid) in pids.items() :
604                (childpid, retcode) = os.waitpid(pid, 0)
605                self.logDebug("Exit code for %s %s (PID %s) on printer %s is %s" % (btype, branch, childpid, self.PrinterName, retcode))
606                if os.WIFEXITED(retcode) :
607                    retcode = os.WEXITSTATUS(retcode)
608                if retcode :   
609                    if (btype == "prehook") and (retcode == 255) : # -1
610                        self.logInfo("Job %s cancelled by prehook %s" % (self.JobId, branch))
611                        os.environ["TEASTATUS"] = "CANCELLED" # and don't touch exitcode
612                    else :   
613                        self.logInfo("%s %s (PID %s) on printer %s didn't exit successfully." % (btypetitle, branch, childpid, self.PrinterName), "error")
614                        exitcode = 1
615                if branch == "Original backend" :   
616                    os.environ["TEASTATUS"] = str(retcode)
617            self.logDebug("End forked %ss" % btypetitle)
618        return exitcode
619       
620    def unregisterFileNo(self, pollobj, fileno) :               
621        """Removes a file handle from the polling object."""
622        try :
623            pollobj.unregister(fileno)
624        except KeyError :   
625            self.logInfo("File number %s unregistered twice from polling object, ignored." % fileno, "warn")
626        except :   
627            self.logDebug("Error while unregistering file number %s from polling object." % fileno)
628        else :   
629            self.logDebug("File number %s unregistered from polling object." % fileno)
630           
631    def formatFileEvent(self, fd, mask) :       
632        """Formats file debug info."""
633        maskval = []
634        if mask & select.POLLIN :
635            maskval.append("POLLIN")
636        if mask & select.POLLOUT :
637            maskval.append("POLLOUT")
638        if mask & select.POLLPRI :
639            maskval.append("POLLPRI")
640        if mask & select.POLLERR :
641            maskval.append("POLLERR")
642        if mask & select.POLLHUP :
643            maskval.append("POLLHUP")
644        if mask & select.POLLNVAL :
645            maskval.append("POLLNVAL")
646        return "%s (%s)" % (fd, " | ".join(maskval))
647       
648    def runOriginalBackend(self) :   
649        """Launches the original backend."""
650        originalbackend = os.path.join(os.path.split(sys.argv[0])[0], self.RealBackend)
651        arguments = sys.argv
652        self.logDebug("Starting original backend %s with args %s" % (originalbackend, " ".join(['"%s"' % a for a in ([os.environ["DEVICE_URI"]] + arguments[1:])])))
653        subprocess = Popen4ForCUPS([originalbackend] + arguments[1:], bufsize=0, arg0=os.environ["DEVICE_URI"])
654       
655        # Save file descriptors, we will need them later.
656        stderrfno = sys.stderr.fileno()
657        fromcfno = subprocess.fromchild.fileno()
658        tocfno = subprocess.tochild.fileno()
659       
660        # We will have to be careful when dealing with I/O
661        # So we use a poll object to know when to read or write
662        pollster = select.poll()
663        pollster.register(fromcfno, select.POLLIN | select.POLLPRI)
664        pollster.register(stderrfno, select.POLLOUT)
665        pollster.register(tocfno, select.POLLOUT)
666       
667        # Initialize our buffers
668        indata = ""
669        outdata = ""
670        endinput = endoutput = 0
671        inputclosed = outputclosed = 0
672        totaltochild = totalfromcups = 0
673        totalfromchild = totaltocups = 0
674       
675        if self.InputFile is None :
676           # this is not a real file, we read the job's data
677            # from our temporary file which is a copy of stdin
678            inf = open(self.DataFile, "rb")
679            infno = inf.fileno()
680            pollster.register(infno, select.POLLIN | select.POLLPRI)
681        else :   
682            # job's data is in a file, no need to pass the data
683            # to the original backend
684            self.logDebug("Job's data is in %s" % self.InputFile)
685            infno = None
686            endinput = 1
687       
688        self.logDebug("Entering streams polling loop...")
689        MEGABYTE = 1024*1024
690        killed = 0
691        status = -1
692        while (status == -1) and (not killed) and not (inputclosed and outputclosed) :
693            # First check if original backend is still alive
694            status = subprocess.poll()
695           
696            # Now if we got SIGTERM, we have
697            # to kill -TERM the original backend
698            if self.gotSigTerm and not killed :
699                try :
700                    os.kill(subprocess.pid, signal.SIGTERM)
701                except OSError, msg : # ignore but logs if process was already killed.
702                    self.logDebug("Error while sending signal to pid %s : %s" % (subprocess.pid, msg))
703                else :   
704                    self.logInfo(_("SIGTERM was sent to original backend %s (PID %s)") % (originalbackend, subprocess.pid))
705                    killed = 1
706           
707            # In any case, deal with any remaining I/O
708            try :
709                availablefds = pollster.poll(5000)
710            except select.error, msg :   
711                self.logDebug("Interrupted poll : %s" % msg)
712                availablefds = []
713            if not availablefds :
714                self.logDebug("Nothing to do, sleeping a bit...")
715                time.sleep(0.01) # give some time to the system
716            else :
717                for (fd, mask) in availablefds :
718                    try :
719                        if mask & select.POLLOUT :
720                            # We can write
721                            if fd == tocfno :
722                                if indata :
723                                    try :
724                                        nbwritten = os.write(fd, indata)   
725                                    except (OSError, IOError), msg :   
726                                        self.logDebug("Error while writing to original backend's stdin %s : %s" % (fd, msg))
727                                    else :   
728                                        if len(indata) != nbwritten :
729                                            self.logDebug("Short write to original backend's input !")
730                                        totaltochild += nbwritten   
731                                        self.logDebug("%s bytes sent to original backend so far..." % totaltochild)
732                                        indata = indata[nbwritten:]
733                                else :       
734                                    self.logDebug("No data to send to original backend yet, sleeping a bit...")
735                                    time.sleep(0.01)
736                                   
737                                if endinput :   
738                                    self.unregisterFileNo(pollster, tocfno)       
739                                    self.logDebug("Closing original backend's stdin.")
740                                    os.close(tocfno)
741                                    inputclosed = 1
742                            elif fd == stderrfno :
743                                if outdata :
744                                    try :
745                                        nbwritten = os.write(fd, outdata)
746                                    except (OSError, IOError), msg :   
747                                        self.logDebug("Error while writing to CUPS back channel (stderr) %s : %s" % (fd, msg))
748                                    else :
749                                        if len(outdata) != nbwritten :
750                                            self.logDebug("Short write to stderr (CUPS) !")
751                                        totaltocups += nbwritten   
752                                        self.logDebug("%s bytes sent back to CUPS so far..." % totaltocups)
753                                        outdata = outdata[nbwritten:]
754                                else :       
755                                    # self.logDebug("No data to send back to CUPS yet, sleeping a bit...") # Uncommenting this fills your logs
756                                    time.sleep(0.01) # Give some time to the system, stderr is ALWAYS writeable it seems.
757                                   
758                                if endoutput :   
759                                    self.unregisterFileNo(pollster, stderrfno)       
760                                    outputclosed = 1
761                            else :   
762                                self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
763                                time.sleep(0.01)
764                               
765                        if mask & (select.POLLIN | select.POLLPRI) :     
766                            # We have something to read
767                            try :
768                                data = os.read(fd, MEGABYTE)
769                            except (IOError, OSError), msg :   
770                                self.logDebug("Error while reading file %s : %s" % (fd, msg))
771                            else :
772                                if fd == infno :
773                                    if not data :    # If yes, then no more input data
774                                        self.unregisterFileNo(pollster, infno)
775                                        self.logDebug("Input data ends.")
776                                        endinput = 1 # this happens with real files.
777                                    else :   
778                                        indata += data
779                                        totalfromcups += len(data)
780                                        self.logDebug("%s bytes read from CUPS so far..." % totalfromcups)
781                                elif fd == fromcfno :
782                                    if not data :
783                                        self.logDebug("No back channel data to read from original backend yet, sleeping a bit...")
784                                        time.sleep(0.01)
785                                    else :
786                                        outdata += data
787                                        totalfromchild += len(data)
788                                        self.logDebug("%s bytes read from original backend so far..." % totalfromchild)
789                                else :   
790                                    self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
791                                    time.sleep(0.01)
792                                   
793                        if mask & (select.POLLHUP | select.POLLERR) :
794                            # Treat POLLERR as an EOF.
795                            # Some standard I/O stream has no more datas
796                            self.unregisterFileNo(pollster, fd)
797                            if fd == infno :
798                                # Here we are in the case where the input file is stdin.
799                                # which has no more data to be read.
800                                self.logDebug("Input data ends.")
801                                endinput = 1
802                            elif fd == fromcfno :   
803                                # We are no more interested in this file descriptor       
804                                self.logDebug("Closing original backend's stdout+stderr.")
805                                os.close(fromcfno)
806                                endoutput = 1
807                            else :   
808                                self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
809                                time.sleep(0.01)
810                               
811                        if mask & select.POLLNVAL :       
812                            self.logDebug("File %s was closed. Unregistering from polling object." % fd)
813                            self.unregisterFileNo(pollster, fd)
814                    except IOError, msg :           
815                        self.logDebug("Got an IOError : %s" % msg) # we got signalled during an I/O
816               
817        # We must close the original backend's input stream
818        if killed and not inputclosed :
819            self.logDebug("Forcing close of original backend's stdin.")
820            os.close(tocfno)
821       
822        self.logDebug("Exiting streams polling loop...")
823       
824        self.logDebug("input data's final length : %s" % len(indata))
825        self.logDebug("back-channel data's final length : %s" % len(outdata))
826       
827        self.logDebug("Total bytes read from CUPS (job's datas) : %s" % totalfromcups)
828        self.logDebug("Total bytes sent to original backend (job's datas) : %s" % totaltochild)
829       
830        self.logDebug("Total bytes read from original backend (back-channel datas) : %s" % totalfromchild)
831        self.logDebug("Total bytes sent back to CUPS (back-channel datas) : %s" % totaltocups)
832       
833        # Check exit code of original CUPS backend.   
834        if status == -1 :
835            # we exited the loop before the original backend exited
836            # now we have to wait for it to finish and get its status
837            self.logDebug("Waiting for original backend to exit...")
838            try :
839                status = subprocess.wait()
840            except OSError : # already dead : TODO : detect when abnormal
841                status = 0
842        if os.WIFEXITED(status) :
843            return os.WEXITSTATUS(status)
844        elif not killed :   
845            self.logInfo("CUPS backend %s died abnormally." % originalbackend, "error")
846            return -1
847        else :   
848            return 1
849       
850if __name__ == "__main__" :   
851    # This is a CUPS backend, we should act and die like a CUPS backend
852    wrapper = CupsBackend()
853    if len(sys.argv) == 1 :
854        print "\n".join(wrapper.discoverOtherBackends())
855        sys.exit(0)               
856    elif len(sys.argv) not in (6, 7) :   
857        sys.stderr.write("ERROR: %s job-id user title copies options [file]\n"\
858                              % sys.argv[0])
859        sys.exit(1)
860    else :   
861        try :
862            wrapper.initBackend()
863            wrapper.saveDatasAndCheckSum()
864            wrapper.exportAttributes()
865            retcode = wrapper.runBranches()
866            wrapper.cleanUp()
867        except SystemExit, e :   
868            retcode = e.code
869        except :   
870            import traceback
871            lines = []
872            for line in traceback.format_exception(*sys.exc_info()) :
873                lines.extend([l for l in line.split("\n") if l])
874            msg = "ERROR: ".join(["%s (PID %s) : %s\n" % (wrapper.MyName, wrapper.pid, l) for l in (["ERROR: Tea4CUPS v%s" % version] + lines)])
875            sys.stderr.write(msg)
876            sys.stderr.flush()
877            retcode = 1
878        sys.exit(retcode)
Note: See TracBrowser for help on using the browser.