root / pkipplib / trunk / pkipplib / pkipplib.py @ 42

Revision 42, 31.1 kB (checked in by jerome, 15 years ago)

Now works again with http/ipp quries over the network, but still not
over unix domain sockets.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
Line 
1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3#
4# pkipplib : IPP and CUPS support for Python
5#
6# (c) 2003, 2004, 2005, 2006, 2007 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 3 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, see <http://www.gnu.org/licenses/>.
19#
20# $Id$
21#
22#
23
24import sys
25import os
26import urllib2
27import socket
28from struct import pack, unpack
29
30IPP_VERSION = "1.1"     # default version number
31
32IPP_PORT = 631
33
34IPP_MAX_NAME = 256
35IPP_MAX_VALUES = 8
36
37IPP_TAG_ZERO = 0x00
38IPP_TAG_OPERATION = 0x01
39IPP_TAG_JOB = 0x02
40IPP_TAG_END = 0x03
41IPP_TAG_PRINTER = 0x04
42IPP_TAG_UNSUPPORTED_GROUP = 0x05
43IPP_TAG_SUBSCRIPTION = 0x06
44IPP_TAG_EVENT_NOTIFICATION = 0x07
45IPP_TAG_UNSUPPORTED_VALUE = 0x10
46IPP_TAG_DEFAULT = 0x11
47IPP_TAG_UNKNOWN = 0x12
48IPP_TAG_NOVALUE = 0x13
49IPP_TAG_NOTSETTABLE = 0x15
50IPP_TAG_DELETEATTR = 0x16
51IPP_TAG_ADMINDEFINE = 0x17
52IPP_TAG_INTEGER = 0x21
53IPP_TAG_BOOLEAN = 0x22
54IPP_TAG_ENUM = 0x23
55IPP_TAG_STRING = 0x30
56IPP_TAG_DATE = 0x31
57IPP_TAG_RESOLUTION = 0x32
58IPP_TAG_RANGE = 0x33
59IPP_TAG_BEGIN_COLLECTION = 0x34
60IPP_TAG_TEXTLANG = 0x35
61IPP_TAG_NAMELANG = 0x36
62IPP_TAG_END_COLLECTION = 0x37
63IPP_TAG_TEXT = 0x41
64IPP_TAG_NAME = 0x42
65IPP_TAG_KEYWORD = 0x44
66IPP_TAG_URI = 0x45
67IPP_TAG_URISCHEME = 0x46
68IPP_TAG_CHARSET = 0x47
69IPP_TAG_LANGUAGE = 0x48
70IPP_TAG_MIMETYPE = 0x49
71IPP_TAG_MEMBERNAME = 0x4a
72IPP_TAG_MASK = 0x7fffffff
73IPP_TAG_COPY = -0x7fffffff-1
74
75IPP_RES_PER_INCH = 3
76IPP_RES_PER_CM = 4
77
78IPP_FINISHINGS_NONE = 3
79IPP_FINISHINGS_STAPLE = 4
80IPP_FINISHINGS_PUNCH = 5
81IPP_FINISHINGS_COVER = 6
82IPP_FINISHINGS_BIND = 7
83IPP_FINISHINGS_SADDLE_STITCH = 8
84IPP_FINISHINGS_EDGE_STITCH = 9
85IPP_FINISHINGS_FOLD = 10
86IPP_FINISHINGS_TRIM = 11
87IPP_FINISHINGS_BALE = 12
88IPP_FINISHINGS_BOOKLET_MAKER = 13
89IPP_FINISHINGS_JOB_OFFSET = 14
90IPP_FINISHINGS_STAPLE_TOP_LEFT = 20
91IPP_FINISHINGS_STAPLE_BOTTOM_LEFT = 21
92IPP_FINISHINGS_STAPLE_TOP_RIGHT = 22
93IPP_FINISHINGS_STAPLE_BOTTOM_RIGHT = 23
94IPP_FINISHINGS_EDGE_STITCH_LEFT = 24
95IPP_FINISHINGS_EDGE_STITCH_TOP = 25
96IPP_FINISHINGS_EDGE_STITCH_RIGHT = 26
97IPP_FINISHINGS_EDGE_STITCH_BOTTOM = 27
98IPP_FINISHINGS_STAPLE_DUAL_LEFT = 28
99IPP_FINISHINGS_STAPLE_DUAL_TOP = 29
100IPP_FINISHINGS_STAPLE_DUAL_RIGHT = 30
101IPP_FINISHINGS_STAPLE_DUAL_BOTTOM = 31
102IPP_FINISHINGS_BIND_LEFT = 50
103IPP_FINISHINGS_BIND_TOP = 51
104IPP_FINISHINGS_BIND_RIGHT = 52
105IPP_FINISHINGS_BIND_BOTTO = 53
106
107IPP_PORTRAIT = 3
108IPP_LANDSCAPE = 4
109IPP_REVERSE_LANDSCAPE = 5
110IPP_REVERSE_PORTRAIT = 6
111
112IPP_QUALITY_DRAFT = 3
113IPP_QUALITY_NORMAL = 4
114IPP_QUALITY_HIGH = 5
115
116IPP_JOB_PENDING = 3
117IPP_JOB_HELD = 4
118IPP_JOB_PROCESSING = 5
119IPP_JOB_STOPPED = 6
120IPP_JOB_CANCELLED = 7
121IPP_JOB_ABORTED = 8
122IPP_JOB_COMPLETE = 9
123
124IPP_PRINTER_IDLE = 3
125IPP_PRINTER_PROCESSING = 4
126IPP_PRINTER_STOPPED = 5
127
128IPP_ERROR = -1
129IPP_IDLE = 0
130IPP_HEADER = 1
131IPP_ATTRIBUTE = 2
132IPP_DATA = 3
133
134IPP_PRINT_JOB = 0x0002
135IPP_PRINT_URI = 0x0003
136IPP_VALIDATE_JOB = 0x0004
137IPP_CREATE_JOB = 0x0005
138IPP_SEND_DOCUMENT = 0x0006
139IPP_SEND_URI = 0x0007
140IPP_CANCEL_JOB = 0x0008
141IPP_GET_JOB_ATTRIBUTES = 0x0009
142IPP_GET_JOBS = 0x000a
143IPP_GET_PRINTER_ATTRIBUTES = 0x000b
144IPP_HOLD_JOB = 0x000c
145IPP_RELEASE_JOB = 0x000d
146IPP_RESTART_JOB = 0x000e
147IPP_PAUSE_PRINTER = 0x0010
148IPP_RESUME_PRINTER = 0x0011
149IPP_PURGE_JOBS = 0x0012
150IPP_SET_PRINTER_ATTRIBUTES = 0x0013
151IPP_SET_JOB_ATTRIBUTES = 0x0014
152IPP_GET_PRINTER_SUPPORTED_VALUES = 0x0015
153IPP_CREATE_PRINTER_SUBSCRIPTION = 0x0016
154IPP_CREATE_JOB_SUBSCRIPTION = 0x0017
155IPP_GET_SUBSCRIPTION_ATTRIBUTES = 0x0018
156IPP_GET_SUBSCRIPTIONS = 0x0019
157IPP_RENEW_SUBSCRIPTION = 0x001a
158IPP_CANCEL_SUBSCRIPTION = 0x001b
159IPP_GET_NOTIFICATIONS = 0x001c
160IPP_SEND_NOTIFICATIONS = 0x001d
161IPP_GET_PRINT_SUPPORT_FILES = 0x0021
162IPP_ENABLE_PRINTER = 0x0022
163IPP_DISABLE_PRINTER = 0x0023
164IPP_PAUSE_PRINTER_AFTER_CURRENT_JOB = 0x0024
165IPP_HOLD_NEW_JOBS = 0x0025
166IPP_RELEASE_HELD_NEW_JOBS = 0x0026
167IPP_DEACTIVATE_PRINTER = 0x0027
168IPP_ACTIVATE_PRINTER = 0x0028
169IPP_RESTART_PRINTER = 0x0029
170IPP_SHUTDOWN_PRINTER = 0x002a
171IPP_STARTUP_PRINTER = 0x002b
172IPP_REPROCESS_JOB = 0x002c
173IPP_CANCEL_CURRENT_JOB = 0x002d
174IPP_SUSPEND_CURRENT_JOB = 0x002e
175IPP_RESUME_JOB = 0x002f
176IPP_PROMOTE_JOB = 0x0030
177IPP_SCHEDULE_JOB_AFTER = 0x0031
178IPP_PRIVATE = 0x4000
179CUPS_GET_DEFAULT = 0x4001
180CUPS_GET_PRINTERS = 0x4002
181CUPS_ADD_PRINTER = 0x4003
182CUPS_DELETE_PRINTER = 0x4004
183CUPS_GET_CLASSES = 0x4005
184CUPS_ADD_CLASS = 0x4006
185CUPS_DELETE_CLASS = 0x4007
186CUPS_ACCEPT_JOBS = 0x4008
187CUPS_REJECT_JOBS = 0x4009
188CUPS_SET_DEFAULT = 0x400a
189CUPS_GET_DEVICES = 0x400b
190CUPS_GET_PPDS = 0x400c
191CUPS_MOVE_JOB = 0x400d
192CUPS_AUTHENTICATE_JOB = 0x400e
193CUPS_GET_PPD = 0x400f
194CUPS_GET_DOCUMENT = 0x4027
195
196IPP_OK = 0x0000
197IPP_OK_SUBST = 0x0001
198IPP_OK_CONFLICT = 0x0002
199IPP_OK_IGNORED_SUBSCRIPTIONS = 0x0003
200IPP_OK_IGNORED_NOTIFICATIONS = 0x0004
201IPP_OK_TOO_MANY_EVENTS = 0x0005
202IPP_OK_BUT_CANCEL_SUBSCRIPTION = 0x0006
203IPP_REDIRECTION_OTHER_SITE = 0x0300
204IPP_BAD_REQUEST = 0x0400
205IPP_FORBIDDEN = 0x0401
206IPP_NOT_AUTHENTICATED = 0x0402
207IPP_NOT_AUTHORIZED = 0x0403
208IPP_NOT_POSSIBLE = 0x0404
209IPP_TIMEOUT = 0x0405
210IPP_NOT_FOUND = 0x0406
211IPP_GONE = 0x0407
212IPP_REQUEST_ENTITY = 0x0408
213IPP_REQUEST_VALUE = 0x0409
214IPP_DOCUMENT_FORMAT = 0x040a
215IPP_ATTRIBUTES = 0x040b
216IPP_URI_SCHEME = 0x040c
217IPP_CHARSET = 0x040d
218IPP_CONFLICT = 0x040e
219IPP_COMPRESSION_NOT_SUPPORTED = 0x040f
220IPP_COMPRESSION_ERROR = 0x0410
221IPP_DOCUMENT_FORMAT_ERROR = 0x0411
222IPP_DOCUMENT_ACCESS_ERROR = 0x0412
223IPP_ATTRIBUTES_NOT_SETTABLE = 0x0413
224IPP_IGNORED_ALL_SUBSCRIPTIONS = 0x0414
225IPP_TOO_MANY_SUBSCRIPTIONS = 0x0415
226IPP_IGNORED_ALL_NOTIFICATIONS = 0x0416
227IPP_PRINT_SUPPORT_FILE_NOT_FOUND = 0x0417
228
229IPP_INTERNAL_ERROR = 0x0500
230IPP_OPERATION_NOT_SUPPORTED = 0x0501
231IPP_SERVICE_UNAVAILABLE = 0x0502
232IPP_VERSION_NOT_SUPPORTED = 0x0503
233IPP_DEVICE_ERROR = 0x0504
234IPP_TEMPORARY_ERROR = 0x0505
235IPP_NOT_ACCEPTING = 0x0506
236IPP_PRINTER_BUSY = 0x0507
237IPP_ERROR_JOB_CANCELLED = 0x0508
238IPP_MULTIPLE_JOBS_NOT_SUPPORTED = 0x0509
239IPP_PRINTER_IS_DEACTIVATED = 0x50a
240 
241CUPS_PRINTER_LOCAL = 0x0000
242CUPS_PRINTER_CLASS = 0x0001
243CUPS_PRINTER_REMOTE = 0x0002
244CUPS_PRINTER_BW = 0x0004
245CUPS_PRINTER_COLOR = 0x0008
246CUPS_PRINTER_DUPLEX = 0x0010
247CUPS_PRINTER_STAPLE = 0x0020
248CUPS_PRINTER_COPIES = 0x0040
249CUPS_PRINTER_COLLATE = 0x0080
250CUPS_PRINTER_PUNCH = 0x0100
251CUPS_PRINTER_COVER = 0x0200
252CUPS_PRINTER_BIND = 0x0400
253CUPS_PRINTER_SORT = 0x0800
254CUPS_PRINTER_SMALL = 0x1000
255CUPS_PRINTER_MEDIUM = 0x2000
256CUPS_PRINTER_LARGE = 0x4000
257CUPS_PRINTER_VARIABLE = 0x8000
258CUPS_PRINTER_IMPLICIT = 0x1000
259CUPS_PRINTER_DEFAULT = 0x2000
260CUPS_PRINTER_FAX = 0x4000
261CUPS_PRINTER_REJECTING = 0x8000
262CUPS_PRINTER_DELETE = 0x1000
263CUPS_PRINTER_NOT_SHARED = 0x2000
264CUPS_PRINTER_AUTHENTICATED = 0x4000
265CUPS_PRINTER_COMMANDS = 0x8000
266CUPS_PRINTER_OPTIONS = 0xe6ff
267 
268 
269class IPPError(Exception) :
270    """An exception for IPP related stuff."""
271    def __init__(self, message = ""):
272        self.message = message
273        Exception.__init__(self, message)
274    def __repr__(self):
275        return self.message
276    __str__ = __repr__
277
278class FakeAttribute :
279    """Fakes an IPPRequest attribute to simplify usage syntax."""
280    def __init__(self, request, name) :
281        """Initializes the fake attribute."""
282        self.request = request
283        self.name = name
284       
285    def __setitem__(self, key, value) :
286        """Appends the value to the real attribute."""
287        attributeslist = getattr(self.request, "_%s_attributes" % self.name)
288        for i in range(len(attributeslist)) :
289            attribute = attributeslist[i]
290            for j in range(len(attribute)) :
291                (attrname, attrvalue) = attribute[j]
292                if attrname == key :
293                    attribute[j][1].append(value)
294                    return
295            attribute.append((key, [value]))       
296           
297    def __getitem__(self, key) :
298        """Returns an attribute's value."""
299        answer = []
300        attributeslist = getattr(self.request, "_%s_attributes" % self.name)
301        for i in range(len(attributeslist)) :
302            attribute = attributeslist[i]
303            for j in range(len(attribute)) :
304                (attrname, attrvalue) = attribute[j]
305                if attrname == key :
306                    answer.extend(attrvalue)
307        if answer :
308            return answer
309        raise KeyError, key           
310   
311class IPPRequest :
312    """A class for IPP requests."""
313    attributes_types = ("operation", "job", "printer", "unsupported", \
314                                     "subscription", "event_notification")
315    def __init__(self, data="", version=IPP_VERSION, 
316                                operation_id=None, \
317                                request_id=None, \
318                                debug=False) :
319        """Initializes an IPP Message object.
320       
321           Parameters :
322           
323             data : the complete IPP Message's content.
324             debug : a boolean value to output debug info on stderr.
325        """
326        self.debug = debug
327        self._data = data
328        self.parsed = False
329       
330        # Initializes message
331        self.setVersion(version)               
332        self.setOperationId(operation_id)
333        self.setRequestId(request_id)
334        self.data = ""
335       
336        for attrtype in self.attributes_types :
337            setattr(self, "_%s_attributes" % attrtype, [[]])
338       
339        # Initialize tags   
340        self.tags = [ None ] * 256 # by default all tags reserved
341       
342        # Delimiter tags
343        self.tags[0x01] = "operation-attributes-tag"
344        self.tags[0x02] = "job-attributes-tag"
345        self.tags[0x03] = "end-of-attributes-tag"
346        self.tags[0x04] = "printer-attributes-tag"
347        self.tags[0x05] = "unsupported-attributes-tag"
348        self.tags[0x06] = "subscription-attributes-tag"
349        self.tags[0x07] = "event_notification-attributes-tag"
350       
351        # out of band values
352        self.tags[0x10] = "unsupported"
353        self.tags[0x11] = "reserved-for-future-default"
354        self.tags[0x12] = "unknown"
355        self.tags[0x13] = "no-value"
356        self.tags[0x15] = "not-settable"
357        self.tags[0x16] = "delete-attribute"
358        self.tags[0x17] = "admin-define"
359 
360        # integer values
361        self.tags[0x20] = "generic-integer"
362        self.tags[0x21] = "integer"
363        self.tags[0x22] = "boolean"
364        self.tags[0x23] = "enum"
365       
366        # octetString
367        self.tags[0x30] = "octetString-with-an-unspecified-format"
368        self.tags[0x31] = "dateTime"
369        self.tags[0x32] = "resolution"
370        self.tags[0x33] = "rangeOfInteger"
371        self.tags[0x34] = "begCollection" # TODO : find sample files for testing
372        self.tags[0x35] = "textWithLanguage"
373        self.tags[0x36] = "nameWithLanguage"
374        self.tags[0x37] = "endCollection"
375       
376        # character strings
377        self.tags[0x40] = "generic-character-string"
378        self.tags[0x41] = "textWithoutLanguage"
379        self.tags[0x42] = "nameWithoutLanguage"
380        self.tags[0x44] = "keyword"
381        self.tags[0x45] = "uri"
382        self.tags[0x46] = "uriScheme"
383        self.tags[0x47] = "charset"
384        self.tags[0x48] = "naturalLanguage"
385        self.tags[0x49] = "mimeMediaType"
386        self.tags[0x4a] = "memberAttrName"
387       
388        # Reverse mapping to generate IPP messages
389        self.tagvalues = {}
390        for i in range(len(self.tags)) :
391            value = self.tags[i]
392            if value is not None :
393                self.tagvalues[value] = i
394                                     
395    def __getattr__(self, name) :                                 
396        """Fakes attribute access."""
397        if name in self.attributes_types :
398            return FakeAttribute(self, name)
399        else :
400            raise AttributeError, name
401           
402    def __str__(self) :       
403        """Returns the parsed IPP message in a readable form."""
404        if not self.parsed :
405            return ""
406        mybuffer = []
407        mybuffer.append("IPP version : %s.%s" % self.version)
408        mybuffer.append("IPP operation Id : 0x%04x" % self.operation_id)
409        mybuffer.append("IPP request Id : 0x%08x" % self.request_id)
410        for attrtype in self.attributes_types :
411            for attribute in getattr(self, "_%s_attributes" % attrtype) :
412                if attribute :
413                    mybuffer.append("%s attributes :" % attrtype.title())
414                for (name, value) in attribute :
415                    mybuffer.append("  %s : %s" % (name, value))
416        if self.data :           
417            mybuffer.append("IPP datas : %s" % repr(self.data))
418        return "\n".join(mybuffer)
419       
420    def logDebug(self, msg) :   
421        """Prints a debug message."""
422        if self.debug :
423            sys.stderr.write("%s\n" % msg)
424            sys.stderr.flush()
425           
426    def setVersion(self, version) :
427        """Sets the request's operation id."""
428        if version is not None :
429            try :
430                self.version = [int(p) for p in version.split(".")]
431            except AttributeError :
432                if len(version) == 2 : # 2-tuple
433                    self.version = version
434                else :   
435                    try :
436                        self.version = [int(p) for p in str(float(version)).split(".")]
437                    except :
438                        self.version = [int(p) for p in IPP_VERSION.split(".")]
439       
440    def setOperationId(self, opid) :       
441        """Sets the request's operation id."""
442        self.operation_id = opid
443       
444    def setRequestId(self, reqid) :       
445        """Sets the request's request id."""
446        self.request_id = reqid
447       
448    def dump(self) :   
449        """Generates an IPP Message.
450       
451           Returns the message as a string of text.
452        """   
453        mybuffer = []
454        if None not in (self.version, self.operation_id) :
455            mybuffer.append(chr(self.version[0]) + chr(self.version[1]))
456            mybuffer.append(pack(">H", self.operation_id))
457            mybuffer.append(pack(">I", self.request_id or 1))
458            for attrtype in self.attributes_types :
459                for attribute in getattr(self, "_%s_attributes" % attrtype) :
460                    if attribute :
461                        mybuffer.append(chr(self.tagvalues["%s-attributes-tag" % attrtype]))
462                    for (attrname, value) in attribute :
463                        nameprinted = 0
464                        for (vtype, val) in value :
465                            mybuffer.append(chr(self.tagvalues[vtype]))
466                            if not nameprinted :
467                                mybuffer.append(pack(">H", len(attrname)))
468                                mybuffer.append(attrname)
469                                nameprinted = 1
470                            else :     
471                                mybuffer.append(pack(">H", 0))
472                            if vtype in ("integer", "enum") :
473                                mybuffer.append(pack(">H", 4))
474                                mybuffer.append(pack(">I", val))
475                            elif vtype == "boolean" :
476                                mybuffer.append(pack(">H", 1))
477                                mybuffer.append(chr(val))
478                            else :   
479                                mybuffer.append(pack(">H", len(val)))
480                                mybuffer.append(val)
481            mybuffer.append(chr(self.tagvalues["end-of-attributes-tag"]))
482        mybuffer.append(self.data)   
483        return "".join(mybuffer)
484           
485    def parse(self) :
486        """Parses an IPP Request.
487       
488           NB : Only a subset of RFC2910 is implemented.
489        """
490        self._curname = None
491        self._curattributes = None
492       
493        try :
494            self.setVersion((ord(self._data[0]), ord(self._data[1])))
495            self.setOperationId(unpack(">H", self._data[2:4])[0])
496            self.setRequestId(unpack(">I", self._data[4:8])[0])
497            self.position = 8
498            endofattributes = self.tagvalues["end-of-attributes-tag"]
499            maxdelimiter = self.tagvalues["event_notification-attributes-tag"]
500            nulloffset = lambda : 0
501            tag = ord(self._data[self.position])
502            while tag != endofattributes :
503                self.position += 1
504                name = self.tags[tag]
505                if name is not None :
506                    func = getattr(self, name.replace("-", "_"), nulloffset)
507                    self.position += func()
508                    if ord(self._data[self.position]) > maxdelimiter :
509                        self.position -= 1
510                        continue
511                oldtag = tag       
512                tag = ord(self._data[self.position])
513                if tag == oldtag :
514                    self._curattributes.append([])
515        except IndexError :
516            raise IPPError, "Unexpected end of IPP message."
517           
518        self.data = self._data[self.position+1:]           
519        self.parsed = True
520       
521    def parseTag(self) :   
522        """Extracts information from an IPP tag."""
523        pos = self.position
524        tagtype = self.tags[ord(self._data[pos])]
525        pos += 1
526        posend = pos2 = pos + 2
527        namelength = unpack(">H", self._data[pos:pos2])[0]
528        if not namelength :
529            name = self._curname
530        else :   
531            posend += namelength
532            self._curname = name = self._data[pos2:posend]
533        pos2 = posend + 2
534        valuelength = unpack(">H", self._data[posend:pos2])[0]
535        posend = pos2 + valuelength
536        value = self._data[pos2:posend]
537        if tagtype in ("integer", "enum") :
538            value = unpack(">I", value)[0]
539        elif tagtype == "boolean" :   
540            value = ord(value)
541        try :   
542            (oldname, oldval) = self._curattributes[-1][-1]
543            if oldname == name :
544                oldval.append((tagtype, value))
545            else :   
546                raise IndexError
547        except IndexError :   
548            self._curattributes[-1].append((name, [(tagtype, value)]))
549        self.logDebug("%s(%s) : %s" % (name, tagtype, value))
550        return posend - self.position
551       
552    def operation_attributes_tag(self) : 
553        """Indicates that the parser enters into an operation-attributes-tag group."""
554        self._curattributes = self._operation_attributes
555        return self.parseTag()
556       
557    def job_attributes_tag(self) : 
558        """Indicates that the parser enters into a job-attributes-tag group."""
559        self._curattributes = self._job_attributes
560        return self.parseTag()
561       
562    def printer_attributes_tag(self) : 
563        """Indicates that the parser enters into a printer-attributes-tag group."""
564        self._curattributes = self._printer_attributes
565        return self.parseTag()
566       
567    def unsupported_attributes_tag(self) : 
568        """Indicates that the parser enters into an unsupported-attributes-tag group."""
569        self._curattributes = self._unsupported_attributes
570        return self.parseTag()
571       
572    def subscription_attributes_tag(self) : 
573        """Indicates that the parser enters into a subscription-attributes-tag group."""
574        self._curattributes = self._subscription_attributes
575        return self.parseTag()
576       
577    def event_notification_attributes_tag(self) : 
578        """Indicates that the parser enters into an event-notification-attributes-tag group."""
579        self._curattributes = self._event_notification_attributes
580        return self.parseTag()
581       
582           
583class CUPS :
584    """A class for a CUPS instance."""
585    def __init__(self, url=None, username=None, password=None, charset="utf-8", language="en-us", debug=False) :
586        """Initializes the CUPS instance."""
587        if url is not None :
588            self.url = url.replace("ipp://", "http://")
589            if self.url.endswith("/") :
590                self.url = self.url[:-1]
591        else :       
592            self.url = self.getDefaultURL()
593        self.username = username
594        self.password = password
595        self.charset = charset
596        self.language = language
597        self.debug = debug
598        self.lastError = None
599        self.lastErrorMessage = None
600        self.requestId = None
601       
602    def getDefaultURL(self) :   
603        """Builds a default URL."""
604        # TODO : encryption methods.
605        server = os.environ.get("CUPS_SERVER") or "localhost"
606        port = os.environ.get("IPP_PORT") or 631
607        if server.startswith("/") :
608            # it seems it's a unix domain socket.
609            # we can't handle this right now, so we use the default instead.
610            # return "http://localhost:%s" % port
611            return "socket:%s" % server
612        else :   
613            return "http://%s:%s" % (server, port)
614           
615    def identifierToURI(self, service, ident) :
616        """Transforms an identifier into a particular URI depending on requested service."""
617        return "%s/%s/%s" % (self.url.replace("http://", "ipp://"),
618                             service,
619                             ident)
620       
621    def nextRequestId(self) :       
622        """Increments the current request id and returns the new value."""
623        try :
624            self.requestId += 1
625        except TypeError :   
626            self.requestId = 1
627        return self.requestId
628           
629    def newRequest(self, operationid=None) :
630        """Generates a new empty request."""
631        if operationid is not None :
632            req = IPPRequest(operation_id=operationid, \
633                             request_id=self.nextRequestId(), \
634                             debug=self.debug)
635            req.operation["attributes-charset"] = ("charset", self.charset)
636            req.operation["attributes-natural-language"] = ("naturalLanguage", self.language)
637            return req
638   
639    def doRequest(self, req, url=None) :
640        """Sends a request to the CUPS server.
641           returns a new IPPRequest object, containing the parsed answer.
642        """   
643        url = url or self.url
644        connection = urllib2.Request(url=url, \
645                             data=req.dump())
646        connection.add_header("Content-Type", "application/ipp")
647        if self.username :
648            pwmanager = urllib2.HTTPPasswordMgrWithDefaultRealm()
649            pwmanager.add_password(None, \
650                                   "%s%s" % (connection.get_host(), \
651                                             connection.get_selector()), \
652                                   self.username, \
653                                   self.password or "")
654            authhandler = urllib2.HTTPBasicAuthHandler(pwmanager)                       
655            opener = urllib2.build_opener(authhandler)
656            urllib2.install_opener(opener)
657        else : # TODO : also do this in the 'if' part     
658            if url.startswith("socket:") : 
659                class SocketHandler(urllib2.HTTPHandler) :
660                    """A class to handle IPP connections over an Unix domain socket."""
661                    def socket_open(self, req) :
662                        """Opens an Unix domain socket for IPP."""
663                        req.host = "localhost"
664                        req.geturl = lambda : req.get_full_url()[7:]
665                        req.info = lambda : "Unix domain socket %s" % req.geturl()
666                        req.get_selector = req.geturl
667                        s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
668                        s.connect(req.get_selector())
669                        s.settimeout(5.0)
670                        sys.stderr.write("Opened [%s]\n" % req.get_selector())
671                        return s.makefile(mode="r+b")
672                       
673                opener = urllib2.build_opener(SocketHandler()) 
674                urllib2.install_opener(opener)
675                sys.stderr.write("Opener installed\n")
676        self.lastError = None   
677        self.lastErrorMessage = None
678        try :   
679            response = urllib2.urlopen(connection)
680        except (urllib2.URLError, urllib2.HTTPError, socket.error), error :   
681            self.lastError = error
682            self.lastErrorMessage = str(error)
683            return None
684        else :   
685            bytes = []
686            try :
687                try :
688                    while True :
689                        try :
690                            byte = response.read(1)
691                        except AttributeError :   
692                            byte = response.recv(1)
693                        if not byte :
694                            break
695                        else :   
696                            bytes.append(byte)
697                except socket.error :
698                    sys.stderr.write("socket error\n")
699                    pass
700            finally :
701                datas = "".join(bytes)
702            if datas :
703                ippresponse = IPPRequest(datas)
704                ippresponse.parse()
705                return ippresponse
706            else :
707                return None
708   
709    def getPPD(self, queuename) :   
710        """Retrieves the PPD for a particular queuename."""
711        req = self.newRequest(IPP_GET_PRINTER_ATTRIBUTES)
712        req.operation["printer-uri"] = ("uri", self.identifierToURI("printers", queuename))
713        for attrib in ("printer-uri-supported", "printer-type", "member-uris") :
714            req.operation["requested-attributes"] = ("nameWithoutLanguage", attrib)
715        return self.doRequest(req)  # TODO : get the PPD from the actual print server
716       
717    def getDefault(self) :
718        """Retrieves CUPS' default printer."""
719        return self.doRequest(self.newRequest(CUPS_GET_DEFAULT))
720   
721    def getJobAttributes(self, jobid) :   
722        """Retrieves a print job's attributes."""
723        req = self.newRequest(IPP_GET_JOB_ATTRIBUTES)
724        req.operation["job-uri"] = ("uri", self.identifierToURI("jobs", jobid))
725        return self.doRequest(req)
726       
727    def getPrinters(self) :   
728        """Returns the list of print queues names."""
729        req = self.newRequest(CUPS_GET_PRINTERS)
730        req.operation["requested-attributes"] = ("keyword", "printer-name")
731        req.operation["printer-type"] = ("enum", 0)
732        req.operation["printer-type-mask"] = ("enum", CUPS_PRINTER_CLASS)
733        return [printer[1] for printer in self.doRequest(req).printer["printer-name"]]
734       
735    def getDevices(self) :   
736        """Returns a list of devices as (deviceclass, deviceinfo, devicemakeandmodel, deviceuri) tuples."""
737        answer = self.doRequest(self.newRequest(CUPS_GET_DEVICES))
738        return zip([d[1] for d in answer.printer["device-class"]], \
739                   [d[1] for d in answer.printer["device-info"]], \
740                   [d[1] for d in answer.printer["device-make-and-model"]], \
741                   [d[1] for d in answer.printer["device-uri"]])
742                   
743    def getPPDs(self) :   
744        """Returns a list of PPDs as (ppdnaturallanguage, ppdmake, ppdmakeandmodel, ppdname) tuples."""
745        answer = self.doRequest(self.newRequest(CUPS_GET_PPDS))
746        return zip([d[1] for d in answer.printer["ppd-natural-language"]], \
747                   [d[1] for d in answer.printer["ppd-make"]], \
748                   [d[1] for d in answer.printer["ppd-make-and-model"]], \
749                   [d[1] for d in answer.printer["ppd-name"]])
750                   
751    def createSubscription(self, uri, events=["all"],
752                                      userdata=None,
753                                      recipient=None,
754                                      pullmethod=None,
755                                      charset=None,
756                                      naturallanguage=None,
757                                      leaseduration=None,
758                                      timeinterval=None,
759                                      jobid=None) :
760        """Creates a job, printer or server subscription.
761         
762           uri : the subscription's uri, e.g. ipp://server
763           events : a list of events to subscribe to, e.g. ["printer-added", "printer-deleted"]
764           recipient : the notifier's uri
765           pullmethod : the pull method to use
766           charset : the charset to use when sending notifications
767           naturallanguage : the language to use when sending notifications
768           leaseduration : the duration of the lease in seconds
769           timeinterval : the interval of time during notifications
770           jobid : the optional job id in case of a job subscription
771        """   
772        if jobid is not None :
773            opid = IPP_CREATE_JOB_SUBSCRIPTION
774            uritype = "job-uri"
775        else :
776            opid = IPP_CREATE_PRINTER_SUBSCRIPTION
777            uritype = "printer-uri"
778        req = self.newRequest(opid)
779        req.operation[uritype] = ("uri", uri)
780        for event in events :
781            req.subscription["notify-events"] = ("keyword", event)
782        if userdata is not None :   
783            req.subscription["notify-user-data"] = ("octetString-with-an-unspecified-format", userdata)
784        if recipient is not None :   
785            req.subscription["notify-recipient"] = ("uri", recipient)
786        if pullmethod is not None :
787            req.subscription["notify-pull-method"] = ("keyword", pullmethod)
788        if charset is not None :
789            req.subscription["notify-charset"] = ("charset", charset)
790        if naturallanguage is not None :
791            req.subscription["notify-natural-language"] = ("naturalLanguage", naturallanguage)
792        if leaseduration is not None :
793            req.subscription["notify-lease-duration"] = ("integer", leaseduration)
794        if timeinterval is not None :
795            req.subscription["notify-time-interval"] = ("integer", timeinterval)
796        if jobid is not None :
797            req.subscription["notify-job-id"] = ("integer", jobid)
798        return self.doRequest(req)
799           
800    def cancelSubscription(self, uri, subscriptionid, jobid=None) :   
801        """Cancels a subscription.
802       
803           uri : the subscription's uri.
804           subscriptionid : the subscription's id.
805           jobid : the optional job's id.
806        """
807        req = self.newRequest(IPP_CANCEL_SUBSCRIPTION)
808        if jobid is not None :
809            uritype = "job-uri"
810        else :
811            uritype = "printer-uri"
812        req.operation[uritype] = ("uri", uri)
813        req.event_notification["notify-subscription-id"] = ("integer", subscriptionid)
814        return self.doRequest(req)
815       
816if __name__ == "__main__" :           
817    if (len(sys.argv) < 2) or (sys.argv[1] == "--debug") :
818        print "usage : python pkipplib.py /var/spool/cups/c00005 [--debug] (for example)\n"
819    else :   
820        infile = open(sys.argv[1], "rb")
821        filedata = infile.read()
822        infile.close()
823       
824        msg = IPPRequest(filedata, debug=(sys.argv[-1]=="--debug"))
825        msg.parse()
826        msg2 = IPPRequest(msg.dump())
827        msg2.parse()
828        filedata2 = msg2.dump()
829       
830        if filedata == filedata2 :
831            print "Test OK : parsing original and parsing the output of the dump produce the same dump !"
832            print str(msg)
833        else :   
834            print "Test Failed !"
835            print str(msg)
836            print
837            print str(msg2)
838       
Note: See TracBrowser for help on using the browser.