root / tea4cups / trunk / tea4cups @ 608

Revision 608, 39.9 kB (checked in by jerome, 19 years ago)

TEASTATUS wasn't available with "serialize: yes"

  • 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        signal.signal(signal.SIGTERM, signal.SIG_IGN)
229        signal.signal(signal.SIGPIPE, signal.SIG_IGN)
230        self.MyName = "Tea4CUPS"
231        self.myname = "tea4cups"
232        self.pid = os.getpid()
233        confdir = os.environ.get("CUPS_SERVERROOT", ".") 
234        self.conffile = os.path.join(confdir, "%s.conf" % self.myname)
235        if os.path.isfile(self.conffile) :
236            self.config = ConfigParser.ConfigParser()
237            self.config.read([self.conffile])
238            self.debug = self.isTrue(self.getGlobalOption("debug", ignore=1))
239        else :   
240            self.config = FakeConfig()
241            self.debug = 1      # no config, so force debug mode !
242           
243    def logInfo(self, message, level="info") :       
244        """Logs a message to CUPS' error_log file."""
245        sys.stderr.write("%s: %s v%s (PID %i) : %s\n" % (level.upper(), self.MyName, version, os.getpid(), message))
246        sys.stderr.flush()
247       
248    def logDebug(self, message) :   
249        """Logs something to debug output if debug is enabled."""
250        if self.debug :
251            self.logInfo(message, level="debug")
252       
253    def isTrue(self, option) :       
254        """Returns 1 if option is set to true, else 0."""
255        if (option is not None) and (option.upper().strip() in ['Y', 'YES', '1', 'ON', 'T', 'TRUE']) :
256            return 1
257        else :   
258            return 0
259                       
260    def getGlobalOption(self, option, ignore=0) :   
261        """Returns an option from the global section, or raises a ConfigError if ignore is not set, else returns None."""
262        try :
263            return self.config.get("global", option, raw=1)
264        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
265            if not ignore :
266                raise ConfigError, "Option %s not found in section global of %s" % (option, self.conffile)
267               
268    def getPrintQueueOption(self, printqueuename, option, ignore=0) :   
269        """Returns an option from the printer section, or the global section, or raises a ConfigError."""
270        globaloption = self.getGlobalOption(option, ignore=1)
271        try :
272            return self.config.get(printqueuename, option, raw=1)
273        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
274            if globaloption is not None :
275                return globaloption
276            elif not ignore :
277                raise ConfigError, "Option %s not found in section [%s] of %s" % (option, printqueuename, self.conffile)
278               
279    def enumBranches(self, printqueuename, branchtype="tee") :
280        """Returns the list of branchtypes branches for a particular section's."""
281        branchbasename = "%s_" % branchtype.lower()
282        try :
283            globalbranches = [ (k, v) for (k, v) in self.config.items("global") if k.startswith(branchbasename) ]
284        except ConfigParser.NoSectionError, msg :   
285            raise ConfigError, "Invalid configuration file : %s" % msg
286        try :
287            sectionbranches = [ (k, v) for (k, v) in self.config.items(printqueuename) if k.startswith(branchbasename) ]
288        except ConfigParser.NoSectionError, msg :   
289            self.logInfo("No section for print queue %s : %s" % (printqueuename, msg))
290            sectionbranches = []
291        branches = {}
292        for (k, v) in globalbranches :
293            value = v.strip()
294            if value :
295                branches[k] = value
296        for (k, v) in sectionbranches :   
297            value = v.strip()
298            if value :
299                branches[k] = value # overwrite any global option or set a new value
300            else :   
301                del branches[k] # empty value disables a global option
302        return branches
303       
304    def discoverOtherBackends(self) :   
305        """Discovers the other CUPS backends.
306       
307           Executes each existing backend in turn in device enumeration mode.
308           Returns the list of available backends.
309        """
310        # Unfortunately this method can't output any debug information
311        # to stdout or stderr, else CUPS considers that the device is
312        # not available.
313        available = []
314        (directory, myname) = os.path.split(sys.argv[0])
315        if not directory :
316            directory = "./"
317        tmpdir = tempfile.gettempdir()
318        lockfilename = os.path.join(tmpdir, "%s..LCK" % myname)
319        if os.path.exists(lockfilename) :
320            lockfile = open(lockfilename, "r")
321            pid = int(lockfile.read())
322            lockfile.close()
323            try :
324                # see if the pid contained in the lock file is still running
325                os.kill(pid, 0)
326            except OSError, e :   
327                if e.errno != errno.EPERM :
328                    # process doesn't exist anymore
329                    os.remove(lockfilename)
330           
331        if not os.path.exists(lockfilename) :
332            lockfile = open(lockfilename, "w")
333            lockfile.write("%i" % self.pid)
334            lockfile.close()
335            allbackends = [ os.path.join(directory, b) \
336                                for b in os.listdir(directory) 
337                                    if os.access(os.path.join(directory, b), os.X_OK) \
338                                        and (b != myname)] 
339            for backend in allbackends :                           
340                answer = os.popen(backend, "r")
341                try :
342                    devices = [line.strip() for line in answer.readlines()]
343                except :   
344                    devices = []
345                status = answer.close()
346                if status is None :
347                    for d in devices :
348                        # each line is of the form :
349                        # 'xxxx xxxx "xxxx xxx" "xxxx xxx"'
350                        # so we have to decompose it carefully
351                        fdevice = cStringIO.StringIO(d)
352                        tokenizer = shlex.shlex(fdevice)
353                        tokenizer.wordchars = tokenizer.wordchars + \
354                                                        r".:,?!~/\_$*-+={}[]()#"
355                        arguments = []
356                        while 1 :
357                            token = tokenizer.get_token()
358                            if token :
359                                arguments.append(token)
360                            else :
361                                break
362                        fdevice.close()
363                        try :
364                            (devicetype, device, name, fullname) = arguments
365                        except ValueError :   
366                            pass    # ignore this 'bizarre' device
367                        else :   
368                            if name.startswith('"') and name.endswith('"') :
369                                name = name[1:-1]
370                            if fullname.startswith('"') and fullname.endswith('"') :
371                                fullname = fullname[1:-1]
372                            available.append('%s %s:%s "%s+%s" "%s managed %s"' \
373                                                 % (devicetype, self.myname, device, self.MyName, name, self.MyName, fullname))
374            os.remove(lockfilename)
375        available.append('direct %s:// "%s+Nothing" "%s managed Virtual Printer"' \
376                             % (self.myname, self.MyName, self.MyName))
377        return available
378                       
379    def initBackend(self) :   
380        """Initializes the backend's attributes."""
381        # check that the DEVICE_URI environment variable's value is
382        # prefixed with self.myname otherwise don't touch it.
383        # If this is the case, we have to remove the prefix from
384        # the environment before launching the real backend
385        muststartwith = "%s:" % self.myname
386        device_uri = os.environ.get("DEVICE_URI", "")
387        if device_uri.startswith(muststartwith) :
388            fulldevice_uri = device_uri[:]
389            device_uri = fulldevice_uri[len(muststartwith):]
390            for i in range(2) :
391                if device_uri.startswith("/") : 
392                    device_uri = device_uri[1:]
393        try :
394            (backend, destination) = device_uri.split(":", 1) 
395        except ValueError :   
396            if not device_uri :
397                self.logDebug("Not attached to an existing print queue.")
398                backend = ""
399            else :   
400                raise TeeError, "Invalid DEVICE_URI : %s\n" % device_uri
401       
402        self.JobId = sys.argv[1].strip()
403        self.UserName = sys.argv[2].strip()
404        self.Title = sys.argv[3].strip()
405        self.Copies = int(sys.argv[4].strip())
406        self.Options = sys.argv[5].strip()
407        if len(sys.argv) == 7 :
408            self.InputFile = sys.argv[6] # read job's datas from file
409        else :   
410            self.InputFile = None        # read job's datas from stdin
411           
412        self.RealBackend = backend
413        self.DeviceURI = device_uri
414        self.PrinterName = os.environ.get("PRINTER", "")
415        self.Directory = self.getPrintQueueOption(self.PrinterName, "directory")
416        self.DataFile = os.path.join(self.Directory, "%s-%s-%s-%s" % (self.myname, self.PrinterName, self.UserName, self.JobId))
417        self.ClientHost = self.extractJobOriginatingHostName()
418           
419    def getCupsConfigDirectives(self, directives=[]) :
420        """Retrieves some CUPS directives from its configuration file.
421       
422           Returns a mapping with lowercased directives as keys and
423           their setting as values.
424        """
425        dirvalues = {} 
426        cupsroot = os.environ.get("CUPS_SERVERROOT", "/etc/cups")
427        cupsdconf = os.path.join(cupsroot, "cupsd.conf")
428        try :
429            conffile = open(cupsdconf, "r")
430        except IOError :   
431            raise TeeError, "Unable to open %s" % cupsdconf
432        else :   
433            for line in conffile.readlines() :
434                linecopy = line.strip().lower()
435                for di in [d.lower() for d in directives] :
436                    if linecopy.startswith("%s " % di) :
437                        try :
438                            val = line.split()[1]
439                        except :   
440                            pass # ignore errors, we take the last value in any case.
441                        else :   
442                            dirvalues[di] = val
443            conffile.close()           
444        return dirvalues       
445           
446    def extractJobOriginatingHostName(self) :       
447        """Extracts the client's hostname or IP address from the CUPS message file for current job."""
448        cupsdconf = self.getCupsConfigDirectives(["RequestRoot"])
449        requestroot = cupsdconf.get("requestroot", "/var/spool/cups")
450        if (len(self.JobId) < 5) and self.JobId.isdigit() :
451            ippmessagefile = "c%05i" % int(self.JobId)
452        else :   
453            ippmessagefile = "c%s" % self.JobId
454        ippmessagefile = os.path.join(requestroot, ippmessagefile)
455        ippmessage = {}
456        try :
457            ippdatafile = open(ippmessagefile)
458        except :   
459            self.logInfo("Unable to open IPP message file %s" % ippmessagefile, "warn")
460        else :   
461            self.logDebug("Parsing of IPP message file %s begins." % ippmessagefile)
462            try :
463                ippmessage = IPPMessage(ippdatafile.read())
464            except IPPError, msg :   
465                self.logInfo("Error while parsing %s : %s" % (ippmessagefile, msg), "warn")
466            else :   
467                self.logDebug("Parsing of IPP message file %s ends." % ippmessagefile)
468            ippdatafile.close()
469        return ippmessage.get("job-originating-host-name")   
470               
471    def exportAttributes(self) :   
472        """Exports our backend's attributes to the environment."""
473        os.environ["DEVICE_URI"] = self.DeviceURI       # WARNING !
474        os.environ["TEAPRINTERNAME"] = self.PrinterName
475        os.environ["TEADIRECTORY"] = self.Directory
476        os.environ["TEADATAFILE"] = self.DataFile
477        os.environ["TEAJOBSIZE"] = str(self.JobSize)
478        os.environ["TEAMD5SUM"] = self.JobMD5Sum
479        os.environ["TEACLIENTHOST"] = self.ClientHost or ""
480        os.environ["TEAJOBID"] = self.JobId
481        os.environ["TEAUSERNAME"] = self.UserName
482        os.environ["TEATITLE"] = self.Title
483        os.environ["TEACOPIES"] = str(self.Copies)
484        os.environ["TEAOPTIONS"] = self.Options
485        os.environ["TEAINPUTFILE"] = self.InputFile or ""
486       
487    def saveDatasAndCheckSum(self) :
488        """Saves the input datas into a static file."""
489        self.logDebug("Duplicating data stream into %s" % self.DataFile)
490        mustclose = 0
491        if self.InputFile is not None :
492            infile = open(self.InputFile, "rb")
493            mustclose = 1
494        else :   
495            infile = sys.stdin
496        CHUNK = 64*1024         # read 64 Kb at a time
497        dummy = 0
498        sizeread = 0
499        checksum = md5.new()
500        outfile = open(self.DataFile, "wb")   
501        while 1 :
502            data = infile.read(CHUNK) 
503            if not data :
504                break
505            sizeread += len(data)   
506            outfile.write(data)
507            checksum.update(data)   
508            if not (dummy % 32) : # Only display every 2 Mb
509                self.logDebug("%s bytes saved..." % sizeread)
510            dummy += 1   
511        outfile.close()
512        if mustclose :   
513            infile.close()
514        self.JobSize = sizeread   
515        self.JobMD5Sum = checksum.hexdigest()
516        self.logDebug("Job %s is %s bytes long." % (self.JobId, self.JobSize))
517        self.logDebug("Job %s MD5 sum is %s" % (self.JobId, self.JobMD5Sum))
518
519    def cleanUp(self) :
520        """Cleans up the place."""
521        if not self.isTrue(self.getPrintQueueOption(self.PrinterName, "keepfiles", ignore=1)) :
522            os.remove(self.DataFile)
523           
524    def sigtermHandler(self, signum, frame) :
525        """Sets an attribute whenever SIGTERM is received."""
526        self.gotSigTerm = 1
527        self.logInfo("SIGTERM received for Job %s." % self.JobId)
528       
529    def runBranches(self) :         
530        """Launches each hook or tee defined for the current print queue."""
531        exitcode = 0
532        self.isCancelled = 0    # did a prehook cancel the print job ?
533        self.gotSigTerm = 0
534        signal.signal(signal.SIGTERM, self.sigtermHandler)
535        serialize = self.isTrue(self.getPrintQueueOption(self.PrinterName, "serialize", ignore=1))
536        for branchtype in ["prehook", "tee", "posthook"] :
537            branches = self.enumBranches(self.PrinterName, branchtype)
538            status = self.runCommands(branchtype, branches, serialize)
539            if status :
540                exitcode = status
541            if (branchtype == "prehook") and self.isCancelled :
542                break # We don't want to execute tees or posthooks in this case
543        signal.signal(signal.SIGTERM, signal.SIG_IGN)
544        if not exitcode :
545            self.logInfo("OK")
546        else :   
547            self.logInfo("An error occured, please check CUPS' error_log file.")
548        return exitcode
549       
550    def runCommands(self, btype, branches, serialize) :   
551        """Runs the commands for a particular branch type."""
552        exitcode = 0 
553        btype = btype.lower()
554        btypetitle = btype.title()
555        branchlist = branches.keys()   
556        branchlist.sort()
557        if serialize :
558            self.logDebug("Begin serialized %ss" % btypetitle)
559            if (btype == "tee") and self.RealBackend :
560                self.logDebug("Launching original backend %s for printer %s" % (self.RealBackend, self.PrinterName))
561                retcode = self.runOriginalBackend()
562                if os.WIFEXITED(retcode) :
563                    retcode = os.WEXITSTATUS(retcode)
564                os.environ["TEASTATUS"] = str(retcode)
565                exitcode = retcode
566            for branch in branchlist :
567                command = branches[branch]
568                if self.gotSigTerm :
569                    break
570                self.logDebug("Launching %s : %s" % (branch, command))
571                retcode = os.system(command)
572                self.logDebug("Exit code for %s %s on printer %s is %s" % (btype, branch, self.PrinterName, retcode))
573                if os.WIFEXITED(retcode) :
574                    retcode = os.WEXITSTATUS(retcode)
575                if retcode :   
576                    if (btype == "prehook") and (retcode == 255) : # -1
577                        self.logInfo("Job %s cancelled by prehook %s" % (self.JobId, branch))
578                        self.isCancelled = 1
579                    else :   
580                        self.logInfo("%s %s on printer %s didn't exit successfully." % (btypetitle, branch, self.PrinterName), "error")
581                        exitcode = 1
582            self.logDebug("End serialized %ss" % btypetitle)
583        else :       
584            self.logDebug("Begin forked %ss" % btypetitle)
585            pids = {}
586            if (btype == "tee") and self.RealBackend :
587                branches["Original backend"] = None     # Fakes a tee to launch one more child
588                branchlist = ["Original backend"] + branchlist
589            for branch in branchlist :
590                command = branches[branch]
591                if self.gotSigTerm :
592                    break
593                pid = os.fork()
594                if pid :
595                    pids[branch] = pid
596                else :   
597                    if branch == "Original backend" :
598                        self.logDebug("Launching original backend %s for printer %s" % (self.RealBackend, self.PrinterName))
599                        sys.exit(self.runOriginalBackend())
600                    else :
601                        self.logDebug("Launching %s : %s" % (branch, command))
602                        retcode = os.system(command)
603                        if os.WIFEXITED(retcode) :
604                            retcode = os.WEXITSTATUS(retcode)
605                        else :   
606                            retcode = -1
607                        sys.exit(retcode)
608            for (branch, pid) in pids.items() :
609                (childpid, retcode) = os.waitpid(pid, 0)
610                self.logDebug("Exit code for %s %s (PID %s) on printer %s is %s" % (btype, branch, childpid, self.PrinterName, retcode))
611                if os.WIFEXITED(retcode) :
612                    retcode = os.WEXITSTATUS(retcode)
613                if retcode :   
614                    if (btype == "prehook") and (retcode == 255) : # -1
615                        self.logInfo("Job %s cancelled by prehook %s" % (self.JobId, branch))
616                        self.isCancelled = 1
617                    else :   
618                        self.logInfo("%s %s (PID %s) on printer %s didn't exit successfully." % (btypetitle, branch, childpid, self.PrinterName), "error")
619                        exitcode = 1
620                if branch == "Original backend" :   
621                    os.environ["TEASTATUS"] = str(retcode)
622            self.logDebug("End forked %ss" % btypetitle)
623        return exitcode
624       
625    def unregisterFileNo(self, pollobj, fileno) :               
626        """Removes a file handle from the polling object."""
627        try :
628            pollobj.unregister(fileno)
629        except KeyError :   
630            self.logInfo("File number %s unregistered twice from polling object, ignored." % fileno, "warn")
631        except :   
632            self.logDebug("Error while unregistering file number %s from polling object." % fileno)
633        else :   
634            self.logDebug("File number %s unregistered from polling object." % fileno)
635           
636    def formatFileEvent(self, fd, mask) :       
637        """Formats file debug info."""
638        maskval = []
639        if mask & select.POLLIN :
640            maskval.append("POLLIN")
641        if mask & select.POLLOUT :
642            maskval.append("POLLOUT")
643        if mask & select.POLLPRI :
644            maskval.append("POLLPRI")
645        if mask & select.POLLERR :
646            maskval.append("POLLERR")
647        if mask & select.POLLHUP :
648            maskval.append("POLLHUP")
649        if mask & select.POLLNVAL :
650            maskval.append("POLLNVAL")
651        return "%s (%s)" % (fd, " | ".join(maskval))
652       
653    def runOriginalBackend(self) :   
654        """Launches the original backend."""
655        originalbackend = os.path.join(os.path.split(sys.argv[0])[0], self.RealBackend)
656        arguments = sys.argv
657        self.logDebug("Starting original backend %s with args %s" % (originalbackend, " ".join(['"%s"' % a for a in ([os.environ["DEVICE_URI"]] + arguments[1:])])))
658        subprocess = Popen4ForCUPS([originalbackend] + arguments[1:], bufsize=0, arg0=os.environ["DEVICE_URI"])
659       
660        # Save file descriptors, we will need them later.
661        stderrfno = sys.stderr.fileno()
662        fromcfno = subprocess.fromchild.fileno()
663        tocfno = subprocess.tochild.fileno()
664       
665        # We will have to be careful when dealing with I/O
666        # So we use a poll object to know when to read or write
667        pollster = select.poll()
668        pollster.register(fromcfno, select.POLLIN | select.POLLPRI)
669        pollster.register(stderrfno, select.POLLOUT)
670        pollster.register(tocfno, select.POLLOUT)
671       
672        # Initialize our buffers
673        indata = ""
674        outdata = ""
675        endinput = endoutput = 0
676        inputclosed = outputclosed = 0
677        totaltochild = totalfromcups = 0
678        totalfromchild = totaltocups = 0
679       
680        if self.InputFile is None :
681           # this is not a real file, we read the job's data
682            # from our temporary file which is a copy of stdin
683            inf = open(self.DataFile, "rb")
684            infno = inf.fileno()
685            pollster.register(infno, select.POLLIN | select.POLLPRI)
686        else :   
687            # job's data is in a file, no need to pass the data
688            # to the original backend
689            self.logDebug("Job's data is in %s" % self.InputFile)
690            infno = None
691            endinput = 1
692       
693        self.logDebug("Entering streams polling loop...")
694        MEGABYTE = 1024*1024
695        killed = 0
696        status = -1
697        while (status == -1) and (not killed) and not (inputclosed and outputclosed) :
698            # First check if original backend is still alive
699            status = subprocess.poll()
700           
701            # Now if we got SIGTERM, we have
702            # to kill -TERM the original backend
703            if self.gotSigTerm and not killed :
704                try :
705                    os.kill(subprocess.pid, signal.SIGTERM)
706                except OSError, msg : # ignore but logs if process was already killed.
707                    self.logDebug("Error while sending signal to pid %s : %s" % (subprocess.pid, msg))
708                else :   
709                    self.logInfo(_("SIGTERM was sent to original backend %s (PID %s)") % (originalbackend, subprocess.pid))
710                    killed = 1
711           
712            # In any case, deal with any remaining I/O
713            try :
714                availablefds = pollster.poll(5000)
715            except select.error, msg :   
716                self.logDebug("Interrupted poll : %s" % msg)
717                availablefds = []
718            if not availablefds :
719                self.logDebug("Nothing to do, sleeping a bit...")
720                time.sleep(0.01) # give some time to the system
721            else :
722                for (fd, mask) in availablefds :
723                    try :
724                        if mask & select.POLLOUT :
725                            # We can write
726                            if fd == tocfno :
727                                if indata :
728                                    try :
729                                        nbwritten = os.write(fd, indata)   
730                                    except (OSError, IOError), msg :   
731                                        self.logDebug("Error while writing to original backend's stdin %s : %s" % (fd, msg))
732                                    else :   
733                                        if len(indata) != nbwritten :
734                                            self.logDebug("Short write to original backend's input !")
735                                        totaltochild += nbwritten   
736                                        self.logDebug("%s bytes sent to original backend so far..." % totaltochild)
737                                        indata = indata[nbwritten:]
738                                else :       
739                                    self.logDebug("No data to send to original backend yet, sleeping a bit...")
740                                    time.sleep(0.01)
741                                   
742                                if endinput :   
743                                    self.unregisterFileNo(pollster, tocfno)       
744                                    self.logDebug("Closing original backend's stdin.")
745                                    os.close(tocfno)
746                                    inputclosed = 1
747                            elif fd == stderrfno :
748                                if outdata :
749                                    try :
750                                        nbwritten = os.write(fd, outdata)
751                                    except (OSError, IOError), msg :   
752                                        self.logDebug("Error while writing to CUPS back channel (stderr) %s : %s" % (fd, msg))
753                                    else :
754                                        if len(outdata) != nbwritten :
755                                            self.logDebug("Short write to stderr (CUPS) !")
756                                        totaltocups += nbwritten   
757                                        self.logDebug("%s bytes sent back to CUPS so far..." % totaltocups)
758                                        outdata = outdata[nbwritten:]
759                                else :       
760                                    # self.logDebug("No data to send back to CUPS yet, sleeping a bit...") # Uncommenting this fills your logs
761                                    time.sleep(0.01) # Give some time to the system, stderr is ALWAYS writeable it seems.
762                                   
763                                if endoutput :   
764                                    self.unregisterFileNo(pollster, stderrfno)       
765                                    outputclosed = 1
766                            else :   
767                                self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
768                                time.sleep(0.01)
769                               
770                        if mask & (select.POLLIN | select.POLLPRI) :     
771                            # We have something to read
772                            try :
773                                data = os.read(fd, MEGABYTE)
774                            except (IOError, OSError), msg :   
775                                self.logDebug("Error while reading file %s : %s" % (fd, msg))
776                            else :
777                                if fd == infno :
778                                    if not data :    # If yes, then no more input data
779                                        self.unregisterFileNo(pollster, infno)
780                                        self.logDebug("Input data ends.")
781                                        endinput = 1 # this happens with real files.
782                                    else :   
783                                        indata += data
784                                        totalfromcups += len(data)
785                                        self.logDebug("%s bytes read from CUPS so far..." % totalfromcups)
786                                elif fd == fromcfno :
787                                    if not data :
788                                        self.logDebug("No back channel data to read from original backend yet, sleeping a bit...")
789                                        time.sleep(0.01)
790                                    else :
791                                        outdata += data
792                                        totalfromchild += len(data)
793                                        self.logDebug("%s bytes read from original backend so far..." % totalfromchild)
794                                else :   
795                                    self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
796                                    time.sleep(0.01)
797                                   
798                        if mask & (select.POLLHUP | select.POLLERR) :
799                            # Treat POLLERR as an EOF.
800                            # Some standard I/O stream has no more datas
801                            self.unregisterFileNo(pollster, fd)
802                            if fd == infno :
803                                # Here we are in the case where the input file is stdin.
804                                # which has no more data to be read.
805                                self.logDebug("Input data ends.")
806                                endinput = 1
807                            elif fd == fromcfno :   
808                                # We are no more interested in this file descriptor       
809                                self.logDebug("Closing original backend's stdout+stderr.")
810                                os.close(fromcfno)
811                                endoutput = 1
812                            else :   
813                                self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask))
814                                time.sleep(0.01)
815                               
816                        if mask & select.POLLNVAL :       
817                            self.logDebug("File %s was closed. Unregistering from polling object." % fd)
818                            self.unregisterFileNo(pollster, fd)
819                    except IOError, msg :           
820                        self.logDebug("Got an IOError : %s" % msg) # we got signalled during an I/O
821               
822        # We must close the original backend's input stream
823        if killed and not inputclosed :
824            self.logDebug("Forcing close of original backend's stdin.")
825            os.close(tocfno)
826       
827        self.logDebug("Exiting streams polling loop...")
828       
829        self.logDebug("input data's final length : %s" % len(indata))
830        self.logDebug("back-channel data's final length : %s" % len(outdata))
831       
832        self.logDebug("Total bytes read from CUPS (job's datas) : %s" % totalfromcups)
833        self.logDebug("Total bytes sent to original backend (job's datas) : %s" % totaltochild)
834       
835        self.logDebug("Total bytes read from original backend (back-channel datas) : %s" % totalfromchild)
836        self.logDebug("Total bytes sent back to CUPS (back-channel datas) : %s" % totaltocups)
837       
838        # Check exit code of original CUPS backend.   
839        if status == -1 :
840            # we exited the loop before the original backend exited
841            # now we have to wait for it to finish and get its status
842            self.logDebug("Waiting for original backend to exit...")
843            try :
844                status = subprocess.wait()
845            except OSError : # already dead : TODO : detect when abnormal
846                status = 0
847        if os.WIFEXITED(status) :
848            return os.WEXITSTATUS(status)
849        elif not killed :   
850            self.logInfo("CUPS backend %s died abnormally." % originalbackend, "error")
851            return -1
852        else :   
853            return 1
854       
855if __name__ == "__main__" :   
856    # This is a CUPS backend, we should act and die like a CUPS backend
857    wrapper = CupsBackend()
858    if len(sys.argv) == 1 :
859        print "\n".join(wrapper.discoverOtherBackends())
860        sys.exit(0)               
861    elif len(sys.argv) not in (6, 7) :   
862        sys.stderr.write("ERROR: %s job-id user title copies options [file]\n"\
863                              % sys.argv[0])
864        sys.exit(1)
865    else :   
866        try :
867            wrapper.initBackend()
868            wrapper.saveDatasAndCheckSum()
869            wrapper.exportAttributes()
870            retcode = wrapper.runBranches()
871            wrapper.cleanUp()
872        except SystemExit, e :   
873            retcode = e.code
874        except :   
875            import traceback
876            lines = []
877            for line in traceback.format_exception(*sys.exc_info()) :
878                lines.extend([l for l in line.split("\n") if l])
879            msg = "ERROR: ".join(["%s (PID %s) : %s\n" % (wrapper.MyName, wrapper.pid, l) for l in (["ERROR: Tea4CUPS v%s" % version] + lines)])
880            sys.stderr.write(msg)
881            sys.stderr.flush()
882            retcode = 1
883        sys.exit(retcode)
Note: See TracBrowser for help on using the browser.