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 | |
---|
25 | import sys |
---|
26 | import os |
---|
27 | import popen2 |
---|
28 | import errno |
---|
29 | import md5 |
---|
30 | import cStringIO |
---|
31 | import shlex |
---|
32 | import tempfile |
---|
33 | import ConfigParser |
---|
34 | import select |
---|
35 | import signal |
---|
36 | import time |
---|
37 | from struct import unpack |
---|
38 | |
---|
39 | version = "1.00" |
---|
40 | |
---|
41 | class 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 | |
---|
50 | class ConfigError(TeeError) : |
---|
51 | """Configuration related exceptions.""" |
---|
52 | pass |
---|
53 | |
---|
54 | class IPPError(TeeError) : |
---|
55 | """IPP related exceptions.""" |
---|
56 | pass |
---|
57 | |
---|
58 | class 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 |
---|
84 | OPERATION_ATTRIBUTES_TAG = 0x01 |
---|
85 | JOB_ATTRIBUTES_TAG = 0x02 |
---|
86 | END_OF_ATTRIBUTES_TAG = 0x03 |
---|
87 | PRINTER_ATTRIBUTES_TAG = 0x04 |
---|
88 | UNSUPPORTED_ATTRIBUTES_TAG = 0x05 |
---|
89 | |
---|
90 | class 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 | |
---|
218 | class 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 | |
---|
224 | class 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 enumTeeBranches(self, printqueuename) : |
---|
281 | """Returns the list of branches for a particular section's Tee.""" |
---|
282 | try : |
---|
283 | globalbranches = [ (k, v) for (k, v) in self.config.items("global") if k.startswith("tee_") ] |
---|
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("tee_") ] |
---|
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 | return available |
---|
376 | |
---|
377 | def initBackend(self) : |
---|
378 | """Initializes the backend's attributes.""" |
---|
379 | # check that the DEVICE_URI environment variable's value is |
---|
380 | # prefixed with self.myname otherwise don't touch it. |
---|
381 | # If this is the case, we have to remove the prefix from |
---|
382 | # the environment before launching the real backend |
---|
383 | muststartwith = "%s:" % self.myname |
---|
384 | device_uri = os.environ.get("DEVICE_URI", "") |
---|
385 | if device_uri.startswith(muststartwith) : |
---|
386 | fulldevice_uri = device_uri[:] |
---|
387 | device_uri = fulldevice_uri[len(muststartwith):] |
---|
388 | for i in range(2) : |
---|
389 | if device_uri.startswith("/") : |
---|
390 | device_uri = device_uri[1:] |
---|
391 | try : |
---|
392 | (backend, destination) = device_uri.split(":", 1) |
---|
393 | except ValueError : |
---|
394 | if not device_uri : |
---|
395 | self.logInfo("Not attached to an existing print queue.") |
---|
396 | backend = "" |
---|
397 | else : |
---|
398 | raise TeeError, "Invalid DEVICE_URI : %s\n" % device_uri |
---|
399 | |
---|
400 | self.JobId = sys.argv[1].strip() |
---|
401 | self.UserName = sys.argv[2].strip() |
---|
402 | self.Title = sys.argv[3].strip() |
---|
403 | self.Copies = int(sys.argv[4].strip()) |
---|
404 | self.Options = sys.argv[5].strip() |
---|
405 | if len(sys.argv) == 7 : |
---|
406 | self.InputFile = sys.argv[6] # read job's datas from file |
---|
407 | else : |
---|
408 | self.InputFile = None # read job's datas from stdin |
---|
409 | |
---|
410 | self.RealBackend = backend |
---|
411 | self.DeviceURI = device_uri |
---|
412 | self.PrinterName = os.environ.get("PRINTER", "") |
---|
413 | self.Directory = self.getPrintQueueOption(self.PrinterName, "directory") |
---|
414 | self.DataFile = os.path.join(self.Directory, "%s-%s-%s-%s" % (self.myname, self.PrinterName, self.UserName, self.JobId)) |
---|
415 | self.ClientHost = self.extractJobOriginatingHostName() |
---|
416 | |
---|
417 | def getCupsConfigDirectives(self, directives=[]) : |
---|
418 | """Retrieves some CUPS directives from its configuration file. |
---|
419 | |
---|
420 | Returns a mapping with lowercased directives as keys and |
---|
421 | their setting as values. |
---|
422 | """ |
---|
423 | dirvalues = {} |
---|
424 | cupsroot = os.environ.get("CUPS_SERVERROOT", "/etc/cups") |
---|
425 | cupsdconf = os.path.join(cupsroot, "cupsd.conf") |
---|
426 | try : |
---|
427 | conffile = open(cupsdconf, "r") |
---|
428 | except IOError : |
---|
429 | raise TeeError, "Unable to open %s" % cupsdconf |
---|
430 | else : |
---|
431 | for line in conffile.readlines() : |
---|
432 | linecopy = line.strip().lower() |
---|
433 | for di in [d.lower() for d in directives] : |
---|
434 | if linecopy.startswith("%s " % di) : |
---|
435 | try : |
---|
436 | val = line.split()[1] |
---|
437 | except : |
---|
438 | pass # ignore errors, we take the last value in any case. |
---|
439 | else : |
---|
440 | dirvalues[di] = val |
---|
441 | conffile.close() |
---|
442 | return dirvalues |
---|
443 | |
---|
444 | def extractJobOriginatingHostName(self) : |
---|
445 | """Extracts the client's hostname or IP address from the CUPS message file for current job.""" |
---|
446 | cupsdconf = self.getCupsConfigDirectives(["RequestRoot"]) |
---|
447 | requestroot = cupsdconf.get("requestroot", "/var/spool/cups") |
---|
448 | if (len(self.JobId) < 5) and self.JobId.isdigit() : |
---|
449 | ippmessagefile = "c%05i" % int(self.JobId) |
---|
450 | else : |
---|
451 | ippmessagefile = "c%s" % self.JobId |
---|
452 | ippmessagefile = os.path.join(requestroot, ippmessagefile) |
---|
453 | ippmessage = {} |
---|
454 | try : |
---|
455 | ippdatafile = open(ippmessagefile) |
---|
456 | except : |
---|
457 | self.logInfo("Unable to open IPP message file %s" % ippmessagefile, "warn") |
---|
458 | else : |
---|
459 | self.logDebug("Parsing of IPP message file %s begins." % ippmessagefile) |
---|
460 | try : |
---|
461 | ippmessage = IPPMessage(ippdatafile.read()) |
---|
462 | except IPPError, msg : |
---|
463 | self.logInfo("Error while parsing %s : %s" % (ippmessagefile, msg), "warn") |
---|
464 | else : |
---|
465 | self.logDebug("Parsing of IPP message file %s ends." % ippmessagefile) |
---|
466 | ippdatafile.close() |
---|
467 | return ippmessage.get("job-originating-host-name") |
---|
468 | |
---|
469 | def exportAttributes(self) : |
---|
470 | """Exports our backend's attributes to the environment.""" |
---|
471 | os.environ["DEVICE_URI"] = self.DeviceURI # WARNING ! |
---|
472 | os.environ["TEAPRINTERNAME"] = self.PrinterName |
---|
473 | os.environ["TEADIRECTORY"] = self.Directory |
---|
474 | os.environ["TEADATAFILE"] = self.DataFile |
---|
475 | os.environ["TEAJOBSIZE"] = str(self.JobSize) |
---|
476 | os.environ["TEAMD5SUM"] = self.JobMD5Sum |
---|
477 | os.environ["TEACLIENTHOST"] = self.ClientHost or "" |
---|
478 | os.environ["TEAJOBID"] = self.JobId |
---|
479 | os.environ["TEAUSERNAME"] = self.UserName |
---|
480 | os.environ["TEATITLE"] = self.Title |
---|
481 | os.environ["TEACOPIES"] = str(self.Copies) |
---|
482 | os.environ["TEAOPTIONS"] = self.Options |
---|
483 | os.environ["TEAINPUTFILE"] = self.InputFile or "" |
---|
484 | |
---|
485 | def saveDatasAndCheckSum(self) : |
---|
486 | """Saves the input datas into a static file.""" |
---|
487 | self.logDebug("Duplicating data stream into %s" % self.DataFile) |
---|
488 | mustclose = 0 |
---|
489 | if self.InputFile is not None : |
---|
490 | infile = open(self.InputFile, "rb") |
---|
491 | mustclose = 1 |
---|
492 | else : |
---|
493 | infile = sys.stdin |
---|
494 | CHUNK = 64*1024 # read 64 Kb at a time |
---|
495 | dummy = 0 |
---|
496 | sizeread = 0 |
---|
497 | checksum = md5.new() |
---|
498 | outfile = open(self.DataFile, "wb") |
---|
499 | while 1 : |
---|
500 | data = infile.read(CHUNK) |
---|
501 | if not data : |
---|
502 | break |
---|
503 | sizeread += len(data) |
---|
504 | outfile.write(data) |
---|
505 | checksum.update(data) |
---|
506 | if not (dummy % 32) : # Only display every 2 Mb |
---|
507 | self.logDebug("%s bytes saved..." % sizeread) |
---|
508 | dummy += 1 |
---|
509 | outfile.close() |
---|
510 | if mustclose : |
---|
511 | infile.close() |
---|
512 | self.JobSize = sizeread |
---|
513 | self.JobMD5Sum = checksum.hexdigest() |
---|
514 | self.logDebug("Job %s is %s bytes long." % (self.JobId, self.JobSize)) |
---|
515 | self.logDebug("Job %s MD5 sum is %s" % (self.JobId, self.JobMD5Sum)) |
---|
516 | |
---|
517 | def cleanUp(self) : |
---|
518 | """Cleans up the place.""" |
---|
519 | if not self.isTrue(self.getPrintQueueOption(self.PrinterName, "keepfiles", ignore=1)) : |
---|
520 | os.remove(self.DataFile) |
---|
521 | |
---|
522 | def sigtermHandler(self, signum, frame) : |
---|
523 | """Sets an attribute whenever SIGTERM is received.""" |
---|
524 | self.gotSigTerm = 1 |
---|
525 | self.logInfo("SIGTERM received for Job %s." % self.JobId) |
---|
526 | |
---|
527 | def runBranches(self) : |
---|
528 | """Launches each tee defined for the current print queue.""" |
---|
529 | exitcode = 0 |
---|
530 | signal.signal(signal.SIGTERM, self.sigtermHandler) |
---|
531 | branches = self.enumTeeBranches(self.PrinterName) |
---|
532 | if self.isTrue(self.getPrintQueueOption(self.PrinterName, "serialize", ignore=1)) : |
---|
533 | self.logDebug("Serialized Tees") |
---|
534 | if self.RealBackend : |
---|
535 | self.logDebug("Launching original backend %s for printer %s" % (self.RealBackend, self.PrinterName)) |
---|
536 | exitcode = self.runOriginalBackend() |
---|
537 | for (branch, command) in branches.items() : |
---|
538 | if self.gotSigTerm : |
---|
539 | break |
---|
540 | self.logDebug("Launching %s : %s" % (branch, command)) |
---|
541 | retcode = os.system(command) |
---|
542 | self.logDebug("Exit code for tee %s on printer %s is %s" % (branch, self.PrinterName, retcode)) |
---|
543 | if os.WIFEXITED(retcode) : |
---|
544 | retcode = os.WEXITSTATUS(retcode) |
---|
545 | if retcode : |
---|
546 | self.logInfo("Tee %s on printer %s didn't exit successfully." % (branch, self.PrinterName), "error") |
---|
547 | exitcode = 1 |
---|
548 | else : |
---|
549 | self.logDebug("Forked Tees") |
---|
550 | pids = {} |
---|
551 | if self.RealBackend : |
---|
552 | branches["Original backend"] = None # Fakes a tee to launch one more child |
---|
553 | for (branch, command) in branches.items() : |
---|
554 | if self.gotSigTerm : |
---|
555 | break |
---|
556 | pid = os.fork() |
---|
557 | if pid : |
---|
558 | pids[branch] = pid |
---|
559 | else : |
---|
560 | if branch == "Original backend" : |
---|
561 | self.logDebug("Launching original backend %s for printer %s" % (self.RealBackend, self.PrinterName)) |
---|
562 | sys.exit(self.runOriginalBackend()) |
---|
563 | else : |
---|
564 | self.logDebug("Launching %s : %s" % (branch, command)) |
---|
565 | retcode = os.system(command) |
---|
566 | if os.WIFEXITED(retcode) : |
---|
567 | retcode = os.WEXITSTATUS(retcode) |
---|
568 | else : |
---|
569 | retcode = -1 |
---|
570 | sys.exit(retcode) |
---|
571 | for (branch, pid) in pids.items() : |
---|
572 | (childpid, retcode) = os.waitpid(pid, 0) |
---|
573 | self.logDebug("Exit code for tee %s (PID %s) on printer %s is %s" % (branch, childpid, self.PrinterName, retcode)) |
---|
574 | if os.WIFEXITED(retcode) : |
---|
575 | retcode = os.WEXITSTATUS(retcode) |
---|
576 | if retcode : |
---|
577 | self.logInfo("Tee %s (PID %s) on printer %s didn't exit successfully." % (branch, childpid, self.PrinterName), "error") |
---|
578 | exitcode = 1 |
---|
579 | signal.signal(signal.SIGTERM, signal.SIG_IGN) |
---|
580 | return exitcode |
---|
581 | |
---|
582 | def unregisterFileNo(self, pollobj, fileno) : |
---|
583 | """Removes a file handle from the polling object.""" |
---|
584 | try : |
---|
585 | pollobj.unregister(fileno) |
---|
586 | except KeyError : |
---|
587 | self.logInfo("File number %s unregistered twice from polling object, ignored." % fileno, "warn") |
---|
588 | except : |
---|
589 | self.logDebug("Error while unregistering file number %s from polling object." % fileno) |
---|
590 | else : |
---|
591 | self.logDebug("File number %s unregistered from polling object." % fileno) |
---|
592 | |
---|
593 | def formatFileEvent(self, fd, mask) : |
---|
594 | """Formats file debug info.""" |
---|
595 | maskval = [] |
---|
596 | if mask & select.POLLIN : |
---|
597 | maskval.append("POLLIN") |
---|
598 | if mask & select.POLLOUT : |
---|
599 | maskval.append("POLLOUT") |
---|
600 | if mask & select.POLLPRI : |
---|
601 | maskval.append("POLLPRI") |
---|
602 | if mask & select.POLLERR : |
---|
603 | maskval.append("POLLERR") |
---|
604 | if mask & select.POLLHUP : |
---|
605 | maskval.append("POLLHUP") |
---|
606 | if mask & select.POLLNVAL : |
---|
607 | maskval.append("POLLNVAL") |
---|
608 | return "%s (%s)" % (fd, " | ".join(maskval)) |
---|
609 | |
---|
610 | def runOriginalBackend(self) : |
---|
611 | """Launches the original backend.""" |
---|
612 | originalbackend = os.path.join(os.path.split(sys.argv[0])[0], self.RealBackend) |
---|
613 | arguments = sys.argv |
---|
614 | self.logDebug("Starting original backend %s with args %s" % (originalbackend, " ".join(['"%s"' % a for a in ([os.environ["DEVICE_URI"]] + arguments[1:])]))) |
---|
615 | subprocess = Popen4ForCUPS([originalbackend] + arguments[1:], bufsize=0, arg0=os.environ["DEVICE_URI"]) |
---|
616 | |
---|
617 | # Save file descriptors, we will need them later. |
---|
618 | stderrfno = sys.stderr.fileno() |
---|
619 | fromcfno = subprocess.fromchild.fileno() |
---|
620 | tocfno = subprocess.tochild.fileno() |
---|
621 | |
---|
622 | # We will have to be careful when dealing with I/O |
---|
623 | # So we use a poll object to know when to read or write |
---|
624 | pollster = select.poll() |
---|
625 | pollster.register(fromcfno, select.POLLIN | select.POLLPRI) |
---|
626 | pollster.register(stderrfno, select.POLLOUT) |
---|
627 | pollster.register(tocfno, select.POLLOUT) |
---|
628 | |
---|
629 | # Initialize our buffers |
---|
630 | indata = "" |
---|
631 | outdata = "" |
---|
632 | endinput = endoutput = 0 |
---|
633 | inputclosed = outputclosed = 0 |
---|
634 | totaltochild = totalfromcups = 0 |
---|
635 | totalfromchild = totaltocups = 0 |
---|
636 | |
---|
637 | if self.InputFile is None : |
---|
638 | # this is not a real file, we read the job's data |
---|
639 | # from our temporary file which is a copy of stdin |
---|
640 | inf = open(self.DataFile, "rb") |
---|
641 | infno = inf.fileno() |
---|
642 | pollster.register(infno, select.POLLIN | select.POLLPRI) |
---|
643 | else : |
---|
644 | # job's data is in a file, no need to pass the data |
---|
645 | # to the original backend |
---|
646 | self.logDebug("Job's data is in %s" % self.InputFile) |
---|
647 | infno = None |
---|
648 | endinput = 1 |
---|
649 | |
---|
650 | self.logDebug("Entering streams polling loop...") |
---|
651 | MEGABYTE = 1024*1024 |
---|
652 | killed = 0 |
---|
653 | status = -1 |
---|
654 | while (status == -1) and (not killed) and not (inputclosed and outputclosed) : |
---|
655 | # First check if original backend is still alive |
---|
656 | status = subprocess.poll() |
---|
657 | |
---|
658 | # Now if we got SIGTERM, we have |
---|
659 | # to kill -TERM the original backend |
---|
660 | if self.gotSigTerm and not killed : |
---|
661 | try : |
---|
662 | os.kill(subprocess.pid, signal.SIGTERM) |
---|
663 | except OSError, msg : # ignore but logs if process was already killed. |
---|
664 | self.logDebug("Error while sending signal to pid %s : %s" % (subprocess.pid, msg)) |
---|
665 | else : |
---|
666 | self.logInfo(_("SIGTERM was sent to original backend %s (PID %s)") % (originalbackend, subprocess.pid)) |
---|
667 | killed = 1 |
---|
668 | |
---|
669 | # In any case, deal with any remaining I/O |
---|
670 | try : |
---|
671 | availablefds = pollster.poll(5000) |
---|
672 | except select.error, msg : |
---|
673 | self.logDebug("Interrupted poll : %s" % msg) |
---|
674 | availablefds = [] |
---|
675 | if not availablefds : |
---|
676 | self.logDebug("Nothing to do, sleeping a bit...") |
---|
677 | time.sleep(0.01) # give some time to the system |
---|
678 | else : |
---|
679 | for (fd, mask) in availablefds : |
---|
680 | try : |
---|
681 | if mask & select.POLLOUT : |
---|
682 | # We can write |
---|
683 | if fd == tocfno : |
---|
684 | if indata : |
---|
685 | try : |
---|
686 | nbwritten = os.write(fd, indata) |
---|
687 | except (OSError, IOError), msg : |
---|
688 | self.logDebug("Error while writing to original backend's stdin %s : %s" % (fd, msg)) |
---|
689 | else : |
---|
690 | if len(indata) != nbwritten : |
---|
691 | self.logDebug("Short write to original backend's input !") |
---|
692 | totaltochild += nbwritten |
---|
693 | self.logDebug("%s bytes sent to original backend so far..." % totaltochild) |
---|
694 | indata = indata[nbwritten:] |
---|
695 | else : |
---|
696 | self.logDebug("No data to send to original backend yet, sleeping a bit...") |
---|
697 | time.sleep(0.01) |
---|
698 | |
---|
699 | if endinput : |
---|
700 | self.unregisterFileNo(pollster, tocfno) |
---|
701 | self.logDebug("Closing original backend's stdin.") |
---|
702 | os.close(tocfno) |
---|
703 | inputclosed = 1 |
---|
704 | elif fd == stderrfno : |
---|
705 | if outdata : |
---|
706 | try : |
---|
707 | nbwritten = os.write(fd, outdata) |
---|
708 | except (OSError, IOError), msg : |
---|
709 | self.logDebug("Error while writing to CUPS back channel (stderr) %s : %s" % (fd, msg)) |
---|
710 | else : |
---|
711 | if len(outdata) != nbwritten : |
---|
712 | self.logDebug("Short write to stderr (CUPS) !") |
---|
713 | totaltocups += nbwritten |
---|
714 | self.logDebug("%s bytes sent back to CUPS so far..." % totaltocups) |
---|
715 | outdata = outdata[nbwritten:] |
---|
716 | else : |
---|
717 | # self.logDebug("No data to send back to CUPS yet, sleeping a bit...") # Uncommenting this fills your logs |
---|
718 | time.sleep(0.01) # Give some time to the system, stderr is ALWAYS writeable it seems. |
---|
719 | |
---|
720 | if endoutput : |
---|
721 | self.unregisterFileNo(pollster, stderrfno) |
---|
722 | outputclosed = 1 |
---|
723 | else : |
---|
724 | self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask)) |
---|
725 | time.sleep(0.01) |
---|
726 | |
---|
727 | if mask & (select.POLLIN | select.POLLPRI) : |
---|
728 | # We have something to read |
---|
729 | try : |
---|
730 | data = os.read(fd, MEGABYTE) |
---|
731 | except (IOError, OSError), msg : |
---|
732 | self.logDebug("Error while reading file %s : %s" % (fd, msg)) |
---|
733 | else : |
---|
734 | if fd == infno : |
---|
735 | if not data : # If yes, then no more input data |
---|
736 | self.unregisterFileNo(pollster, infno) |
---|
737 | self.logDebug("Input data ends.") |
---|
738 | endinput = 1 # this happens with real files. |
---|
739 | else : |
---|
740 | indata += data |
---|
741 | totalfromcups += len(data) |
---|
742 | self.logDebug("%s bytes read from CUPS so far..." % totalfromcups) |
---|
743 | elif fd == fromcfno : |
---|
744 | if not data : |
---|
745 | self.logDebug("No back channel data to read from original backend yet, sleeping a bit...") |
---|
746 | time.sleep(0.01) |
---|
747 | else : |
---|
748 | outdata += data |
---|
749 | totalfromchild += len(data) |
---|
750 | self.logDebug("%s bytes read from original backend so far..." % totalfromchild) |
---|
751 | else : |
---|
752 | self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask)) |
---|
753 | time.sleep(0.01) |
---|
754 | |
---|
755 | if mask & (select.POLLHUP | select.POLLERR) : |
---|
756 | # Treat POLLERR as an EOF. |
---|
757 | # Some standard I/O stream has no more datas |
---|
758 | self.unregisterFileNo(pollster, fd) |
---|
759 | if fd == infno : |
---|
760 | # Here we are in the case where the input file is stdin. |
---|
761 | # which has no more data to be read. |
---|
762 | self.logDebug("Input data ends.") |
---|
763 | endinput = 1 |
---|
764 | elif fd == fromcfno : |
---|
765 | # We are no more interested in this file descriptor |
---|
766 | self.logDebug("Closing original backend's stdout+stderr.") |
---|
767 | os.close(fromcfno) |
---|
768 | endoutput = 1 |
---|
769 | else : |
---|
770 | self.logDebug("Unexpected : %s - Sleeping a bit..." % self.formatFileEvent(fd, mask)) |
---|
771 | time.sleep(0.01) |
---|
772 | |
---|
773 | if mask & select.POLLNVAL : |
---|
774 | self.logDebug("File %s was closed. Unregistering from polling object." % fd) |
---|
775 | self.unregisterFileNo(pollster, fd) |
---|
776 | except IOError, msg : |
---|
777 | self.logDebug("Got an IOError : %s" % msg) # we got signalled during an I/O |
---|
778 | |
---|
779 | # We must close the original backend's input stream |
---|
780 | if killed and not inputclosed : |
---|
781 | self.logDebug("Forcing close of original backend's stdin.") |
---|
782 | os.close(tocfno) |
---|
783 | |
---|
784 | self.logDebug("Exiting streams polling loop...") |
---|
785 | |
---|
786 | self.logDebug("input data's final length : %s" % len(indata)) |
---|
787 | self.logDebug("back-channel data's final length : %s" % len(outdata)) |
---|
788 | |
---|
789 | self.logDebug("Total bytes read from CUPS (job's datas) : %s" % totalfromcups) |
---|
790 | self.logDebug("Total bytes sent to original backend (job's datas) : %s" % totaltochild) |
---|
791 | |
---|
792 | self.logDebug("Total bytes read from original backend (back-channel datas) : %s" % totalfromchild) |
---|
793 | self.logDebug("Total bytes sent back to CUPS (back-channel datas) : %s" % totaltocups) |
---|
794 | |
---|
795 | # Check exit code of original CUPS backend. |
---|
796 | if status == -1 : |
---|
797 | # we exited the loop before the original backend exited |
---|
798 | # now we have to wait for it to finish and get its status |
---|
799 | self.logDebug("Waiting for original backend to exit...") |
---|
800 | try : |
---|
801 | status = subprocess.wait() |
---|
802 | except OSError : # already dead : TODO : detect when abnormal |
---|
803 | status = 0 |
---|
804 | if os.WIFEXITED(status) : |
---|
805 | return os.WEXITSTATUS(status) |
---|
806 | elif not killed : |
---|
807 | self.logInfo("CUPS backend %s died abnormally." % originalbackend, "error") |
---|
808 | return -1 |
---|
809 | else : |
---|
810 | return 1 |
---|
811 | |
---|
812 | if __name__ == "__main__" : |
---|
813 | # This is a CUPS backend, we should act and die like a CUPS backend |
---|
814 | wrapper = CupsBackend() |
---|
815 | if len(sys.argv) == 1 : |
---|
816 | print "\n".join(wrapper.discoverOtherBackends()) |
---|
817 | sys.exit(0) |
---|
818 | elif len(sys.argv) not in (6, 7) : |
---|
819 | sys.stderr.write("ERROR: %s job-id user title copies options [file]\n"\ |
---|
820 | % sys.argv[0]) |
---|
821 | sys.exit(1) |
---|
822 | else : |
---|
823 | try : |
---|
824 | wrapper.initBackend() |
---|
825 | wrapper.saveDatasAndCheckSum() |
---|
826 | wrapper.exportAttributes() |
---|
827 | retcode = wrapper.runBranches() |
---|
828 | wrapper.cleanUp() |
---|
829 | except SystemExit, e : |
---|
830 | retcode = e.code |
---|
831 | except : |
---|
832 | import traceback |
---|
833 | lines = [] |
---|
834 | for line in traceback.format_exception(*sys.exc_info()) : |
---|
835 | lines.extend([l for l in line.split("\n") if l]) |
---|
836 | msg = "ERROR: ".join(["%s (PID %s) : %s\n" % (wrapper.MyName, wrapper.pid, l) for l in (["ERROR: Tea4CUPS v%s" % version] + lines)]) |
---|
837 | sys.stderr.write(msg) |
---|
838 | sys.stderr.flush() |
---|
839 | retcode = 1 |
---|
840 | sys.exit(retcode) |
---|