root / pkpgcounter / trunk / pkpgpdls / pclxl.py @ 245

Revision 245, 20.9 kB (checked in by jerome, 19 years ago)

Improved PCLXL parser.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Auth Date Id Rev
Line 
1#! /usr/bin/env python
2# -*- coding: ISO-8859-15 -*-
3#
4# pkpgcounter : a generic Page Description Language parser
5#
6# (c) 2003, 2004, 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20#
21# $Id$
22#
23
24import sys
25import os
26import mmap
27from struct import unpack
28
29import pdlparser
30
31class Parser(pdlparser.PDLParser) :
32    """A parser for PCLXL (aka PCL6) documents."""
33    mediasizes = { 
34                    0 : "Letter",
35                    1 : "Legal",
36                    2 : "A4",
37                    3 : "Executive",
38                    4 : "Ledger",
39                    5 : "A3",
40                    6 : "COM10Envelope",
41                    7 : "MonarchEnvelope",
42                    8 : "C5Envelope",
43                    9 : "DLEnvelope",
44                    10 : "JB4",
45                    11 : "JB5",
46                    12 : "B5Envelope",
47                    14 : "JPostcard",
48                    15 : "JDoublePostcard",
49                    16 : "A5",
50                    17 : "A6",
51                    18 : "JB6",
52                 }   
53                 
54    mediasources = {             
55                     0 : "Default",
56                     1 : "Auto",
57                     2 : "Manual",
58                     3 : "MultiPurpose",
59                     4 : "UpperCassette",
60                     5 : "LowerCassette",
61                     6 : "EnvelopeTray",
62                     7 : "ThirdCassette",
63                   }
64                   
65    orientations = {               
66                     0 : "Portrait",
67                     1 : "Landscape",
68                     2 : "ReversePortrait",
69                     3 : "ReverseLandscape",
70                   }
71           
72    def isValid(self) :   
73        """Returns 1 if data is PCLXL aka PCL6, else 0."""
74        if ((self.firstblock[:128].find("\033%-12345X") != -1) and \
75             (self.firstblock.find(" HP-PCL XL;") != -1) and \
76             ((self.firstblock.find("LANGUAGE=PCLXL") != -1) or \
77              (self.firstblock.find("LANGUAGE = PCLXL") != -1))) :
78            if self.debug : 
79                sys.stderr.write("DEBUG: Input file is in the PCLXL (aka PCL6) format.\n")
80            return 1
81        else :   
82            return 0
83           
84    def beginPage(self) :
85        """Indicates the beginning of a new page, and extracts media information."""
86        self.pagecount += 1
87       
88        # Default values
89        mediatypelabel = "Plain"
90        mediasourcelabel = "Main"
91        mediasizelabel = "Default"
92        orientationlabel = "Portrait"
93       
94        # Now go upstream to decode media type, size, source, and orientation
95        # this saves time because we don't need a complete parser !
96        minfile = self.minfile
97        pos = self.pos - 2
98        while pos > 0 : # safety check : don't go back to far !
99            val = ord(minfile[pos])
100            if val in (0x44, 0x48, 0x41) : # if previous endPage or openDataSource or beginSession (first page)
101                break
102            if val == 0x26 :   
103                mediasource = ord(minfile[pos - 2])
104                mediasourcelabel = self.mediasources.get(mediasource, str(mediasource))
105                pos = pos - 4
106            elif val == 0x25 :
107                mediasize = ord(minfile[pos - 2])
108                mediasizelabel = self.mediasizes.get(mediasize, str(mediasize))
109                pos = pos - 4
110            elif val == 0x28 :   
111                orientation = ord(minfile[pos - 2])
112                orienationlabel = self.orientations.get(orientation, str(orientation))
113                pos = pos - 4
114            elif val == 0x27 :   
115                savepos = pos
116                pos = pos - 1
117                while pos > 0 : # safety check : don't go back to far !
118                    val = ord(minfile[pos])
119                    pos -= 1   
120                    if val == 0xc8 :
121                        break
122                mediatypelabel = minfile[pos:savepos] # TODO : INCORRECT, WE HAVE TO STRIP OUT THE UBYTE ARRAY'S LENGTH !!!
123            # else : TODO : CUSTOM MEDIA SIZE AND UNIT !
124            else :   
125                pos = pos - 2   # ignored
126        self.pages[self.pagecount] = { "copies" : 1, 
127                                       "orientation" : orientationlabel, 
128                                       "mediatype" : mediatypelabel, 
129                                       "mediasize" : mediasizelabel,
130                                       "mediasource" : mediasourcelabel,
131                                     } 
132        return 0
133       
134    def endPage(self) :   
135        """Indicates the end of a page."""
136        pos = self.pos
137        pos3 = pos - 3
138        minfile = self.minfile
139        if minfile[pos3:pos-1] == self.setNumberOfCopies :
140            # The EndPage operator may be preceded by a PageCopies attribute
141            # So set number of copies for current page.
142            # From what I read in PCLXL documentation, the number
143            # of copies is an unsigned 16 bits integer
144            self.pages[self.pagecount]["copies"] = unpack(self.endianness + "H", minfile[pos-5:pos3])[0]
145        return 0
146       
147    def setColorSpace(self) :   
148        """Changes the color space."""
149        if self.minfile[self.pos-4:self.pos-1] == self.RGBColorSpace :
150            self.iscolor = 1
151        return 0
152           
153    def array_8(self) :   
154        """Handles byte arrays."""
155        pos = self.pos
156        datatype = self.minfile[pos]
157        pos += 1
158        length = self.tags[ord(datatype)]
159        if callable(length) :
160            self.pos = pos
161            length = length()
162            pos = self.pos
163        posl = pos + length
164        self.pos = posl
165        if length == 1 :   
166            return unpack("B", self.minfile[pos:posl])[0]
167        elif length == 2 :   
168            return unpack(self.endianness + "H", self.minfile[pos:posl])[0]
169        elif length == 4 :   
170            return unpack(self.endianness + "I", self.minfile[pos:posl])[0]
171        else :   
172            raise pdlparser.PDLParserError, "Error on array size at %s" % self.pos
173       
174    def array_16(self) :   
175        """Handles byte arrays."""
176        pos = self.pos
177        datatype = self.minfile[pos]
178        pos += 1
179        length = self.tags[ord(datatype)]
180        if callable(length) :
181            self.pos = pos
182            length = length()
183            pos = self.pos
184        posl = pos + length
185        self.pos = posl
186        if length == 1 :   
187            return 2 * unpack("B", self.minfile[pos:posl])[0]
188        elif length == 2 :   
189            return 2 * unpack(self.endianness + "H", self.minfile[pos:posl])[0]
190        elif length == 4 :   
191            return 2 * unpack(self.endianness + "I", self.minfile[pos:posl])[0]
192        else :   
193            raise pdlparser.PDLParserError, "Error on array size at %s" % self.pos
194       
195    def array_32(self) :   
196        """Handles byte arrays."""
197        pos = self.pos
198        datatype = self.minfile[pos]
199        pos += 1
200        length = self.tags[ord(datatype)]
201        if callable(length) :
202            self.pos = pos
203            length = length()
204            pos = self.pos
205        posl = pos + length
206        self.pos = posl
207        if length == 1 :   
208            return 4 * unpack("B", self.minfile[pos:posl])[0]
209        elif length == 2 :   
210            return 4 * unpack(self.endianness + "H", self.minfile[pos:posl])[0]
211        elif length == 4 :   
212            return 4 * unpack(self.endianness + "I", self.minfile[pos:posl])[0]
213        else :   
214            raise pdlparser.PDLParserError, "Error on array size at %s" % self.pos
215       
216    def embeddedDataSmall(self) :
217        """Handle small amounts of data."""
218        pos = self.pos
219        length = ord(self.minfile[pos])
220        self.pos = pos + 1
221        return length
222       
223    def embeddedData(self) :
224        """Handle normal amounts of data."""
225        pos = self.pos
226        pos4 = pos + 4
227        self.pos = pos4
228        return unpack(self.endianness + "I", self.minfile[pos:pos4])[0]
229       
230    def littleEndian(self) :       
231        """Toggles to little endianness."""
232        self.endianness = "<" # little endian
233        return 0
234       
235    def bigEndian(self) :   
236        """Toggles to big endianness."""
237        self.endianness = ">" # big endian
238        return 0
239   
240    def reservedForFutureUse(self) :
241        """Outputs something when a reserved byte is encountered."""
242        if self.debug :
243            sys.stderr.write("Byte at %s is out of the PCLXL Protocol Class 2.0 Specification\n" % self.pos)
244        return 0   
245       
246    def escape(self) :   
247        """Handles the ESC code."""
248        pos = endpos = self.pos
249        if self.minfile[pos : pos+8] == r"%-12345X" :
250            endpos = pos + 9
251            endmark = chr(0x0c) + chr(0x00)
252            while self.minfile[endpos] not in endmark :
253                endpos += 1
254               
255            # Store this in a per page mapping.   
256            # NB : First time will be at page 0 (i.e. **before** page 1) !
257            stuff = self.escapedStuff.setdefault(self.pagecount, [])
258            stuff.append(self.minfile[pos : endpos])
259            if self.debug :
260                sys.stderr.write("Escaped datas : [%s]\n" % repr(self.minfile[pos : endpos]))
261        return endpos - pos
262       
263    def getJobSize(self) :
264        """Counts pages in a PCLXL (PCL6) document.
265       
266           Algorithm by Jerome Alet.
267           
268           The documentation used for this was :
269         
270           HP PCL XL Feature Reference
271           Protocol Class 2.0
272           http://www.hpdevelopersolutions.com/downloads/64/358/xl_ref20r22.pdf
273        """
274        self.iscolor = None
275        self.endianness = None
276        found = 0
277        while not found :
278            line = self.infile.readline()
279            if not line :
280                break
281            if line[1:12] == " HP-PCL XL;" :
282                found = 1
283                endian = ord(line[0])
284                if endian == 0x29 :
285                    self.littleEndian()
286                elif endian == 0x28 :   
287                    self.bigEndian()
288                # elif endian == 0x27 : # TODO : This is the ESC code : parse it for PJL statements !
289                #
290                else :   
291                    raise pdlparser.PDLParserError, "Unknown endianness marker 0x%02x at start !" % endian
292        if not found :
293            raise pdlparser.PDLParserError, "This file doesn't seem to be PCLXL (aka PCL6)"
294           
295        # Initialize table of tags
296        self.tags = [ 0 ] * 256   
297       
298        self.tags[0x1b] = self.escape # The escape code
299       
300        # GhostScript's sources tell us that HP printers
301        # only accept little endianness, but we can handle both.
302        self.tags[0x28] = self.bigEndian    # BigEndian
303        self.tags[0x29] = self.littleEndian # LittleEndian
304       
305        self.tags[0x43] = self.beginPage    # BeginPage
306        self.tags[0x44] = self.endPage      # EndPage
307        self.tags[0x45] = self.reservedForFutureUse # reserved
308        self.tags[0x46] = self.reservedForFutureUse # reserved
309       
310        self.tags[0x4a] = self.reservedForFutureUse # reserved
311        self.tags[0x4b] = self.reservedForFutureUse # reserved
312        self.tags[0x4c] = self.reservedForFutureUse # reserved
313        self.tags[0x4d] = self.reservedForFutureUse # reserved
314        self.tags[0x4e] = self.reservedForFutureUse # reserved
315       
316        self.tags[0x56] = self.reservedForFutureUse # TODO : documentation not clear about reserved status
317       
318        self.tags[0x57] = self.reservedForFutureUse # reserved
319        self.tags[0x58] = self.reservedForFutureUse # reserved
320        self.tags[0x59] = self.reservedForFutureUse # reserved
321        self.tags[0x5a] = self.reservedForFutureUse # reserved
322       
323        self.tags[0x6a] = self.setColorSpace    # to detect color/b&w mode
324       
325        self.tags[0x83] = self.reservedForFutureUse # reserved
326       
327        self.tags[0x87] = self.reservedForFutureUse # reserved
328        self.tags[0x88] = self.reservedForFutureUse # reserved
329        self.tags[0x89] = self.reservedForFutureUse # reserved
330        self.tags[0x8a] = self.reservedForFutureUse # reserved
331        self.tags[0x8b] = self.reservedForFutureUse # reserved
332        self.tags[0x8c] = self.reservedForFutureUse # reserved
333        self.tags[0x8d] = self.reservedForFutureUse # reserved
334        self.tags[0x8e] = self.reservedForFutureUse # reserved
335        self.tags[0x8f] = self.reservedForFutureUse # reserved
336        self.tags[0x90] = self.reservedForFutureUse # reserved
337       
338        self.tags[0x92] = self.reservedForFutureUse # reserved
339       
340        self.tags[0x94] = self.reservedForFutureUse # reserved
341       
342        self.tags[0x9a] = self.reservedForFutureUse # reserved
343        self.tags[0x9c] = self.reservedForFutureUse # reserved
344       
345        self.tags[0xa4] = self.reservedForFutureUse # reserved
346        self.tags[0xa5] = self.reservedForFutureUse # reserved
347        self.tags[0xa6] = self.reservedForFutureUse # reserved
348        self.tags[0xa7] = self.reservedForFutureUse # reserved
349       
350        self.tags[0xaa] = self.reservedForFutureUse # reserved
351        self.tags[0xab] = self.reservedForFutureUse # reserved
352        self.tags[0xac] = self.reservedForFutureUse # reserved
353        self.tags[0xad] = self.reservedForFutureUse # reserved
354        self.tags[0xae] = self.reservedForFutureUse # reserved
355        self.tags[0xaf] = self.reservedForFutureUse # reserved
356       
357        self.tags[0xb7] = self.reservedForFutureUse # reserved
358       
359        self.tags[0xba] = self.reservedForFutureUse # reserved
360        self.tags[0xbb] = self.reservedForFutureUse # reserved
361        self.tags[0xbc] = self.reservedForFutureUse # reserved
362        self.tags[0xbd] = self.reservedForFutureUse # reserved
363        self.tags[0xbe] = self.reservedForFutureUse # reserved
364        self.tags[0xbf] = self.reservedForFutureUse # reserved
365       
366        self.tags[0xc0] = 1 # ubyte
367        self.tags[0xc1] = 2 # uint16
368        self.tags[0xc2] = 4 # uint32
369        self.tags[0xc3] = 2 # sint16
370        self.tags[0xc4] = 4 # sint32
371        self.tags[0xc5] = 4 # real32
372       
373        self.tags[0xc6] = self.reservedForFutureUse # reserved
374        self.tags[0xc7] = self.reservedForFutureUse # reserved
375       
376        self.tags[0xc8] = self.array_8  # ubyte_array
377        self.tags[0xc9] = self.array_16 # uint16_array
378        self.tags[0xca] = self.array_32 # uint32_array
379        self.tags[0xcb] = self.array_16 # sint16_array
380        self.tags[0xcc] = self.array_32 # sint32_array
381        self.tags[0xcd] = self.array_32 # real32_array
382       
383        self.tags[0xce] = self.reservedForFutureUse # reserved
384        self.tags[0xcf] = self.reservedForFutureUse # reserved
385       
386        self.tags[0xd0] = 2 # ubyte_xy
387        self.tags[0xd1] = 4 # uint16_xy
388        self.tags[0xd2] = 8 # uint32_xy
389        self.tags[0xd3] = 4 # sint16_xy
390        self.tags[0xd4] = 8 # sint32_xy
391        self.tags[0xd5] = 8 # real32_xy
392        self.tags[0xd6] = self.reservedForFutureUse # reserved
393        self.tags[0xd7] = self.reservedForFutureUse # reserved
394        self.tags[0xd8] = self.reservedForFutureUse # reserved
395        self.tags[0xd9] = self.reservedForFutureUse # reserved
396        self.tags[0xda] = self.reservedForFutureUse # reserved
397        self.tags[0xdb] = self.reservedForFutureUse # reserved
398        self.tags[0xdc] = self.reservedForFutureUse # reserved
399        self.tags[0xdd] = self.reservedForFutureUse # reserved
400        self.tags[0xde] = self.reservedForFutureUse # reserved
401        self.tags[0xdf] = self.reservedForFutureUse # reserved
402       
403        self.tags[0xe0] = 4  # ubyte_box
404        self.tags[0xe1] = 8  # uint16_box
405        self.tags[0xe2] = 16 # uint32_box
406        self.tags[0xe3] = 8  # sint16_box
407        self.tags[0xe4] = 16 # sint32_box
408        self.tags[0xe5] = 16 # real32_box
409        self.tags[0xe6] = self.reservedForFutureUse # reserved
410        self.tags[0xe7] = self.reservedForFutureUse # reserved
411        self.tags[0xe8] = self.reservedForFutureUse # reserved
412        self.tags[0xe9] = self.reservedForFutureUse # reserved
413        self.tags[0xea] = self.reservedForFutureUse # reserved
414        self.tags[0xeb] = self.reservedForFutureUse # reserved
415        self.tags[0xec] = self.reservedForFutureUse # reserved
416        self.tags[0xed] = self.reservedForFutureUse # reserved
417        self.tags[0xee] = self.reservedForFutureUse # reserved
418        self.tags[0xef] = self.reservedForFutureUse # reserved
419       
420        self.tags[0xf0] = self.reservedForFutureUse # reserved
421        self.tags[0xf1] = self.reservedForFutureUse # reserved
422        self.tags[0xf2] = self.reservedForFutureUse # reserved
423        self.tags[0xf3] = self.reservedForFutureUse # reserved
424        self.tags[0xf4] = self.reservedForFutureUse # reserved
425        self.tags[0xf5] = self.reservedForFutureUse # reserved
426        self.tags[0xf6] = self.reservedForFutureUse # reserved
427        self.tags[0xf7] = self.reservedForFutureUse # reserved
428       
429        self.tags[0xf8] = 1 # attr_ubyte
430        self.tags[0xf9] = 2 # attr_uint16
431       
432        self.tags[0xfa] = self.embeddedData      # dataLength
433        self.tags[0xfb] = self.embeddedDataSmall # dataLengthByte
434       
435        self.tags[0xfc] = self.reservedForFutureUse # reserved
436        self.tags[0xfd] = self.reservedForFutureUse # reserved
437        self.tags[0xfe] = self.reservedForFutureUse # reserved
438        self.tags[0xff] = self.reservedForFutureUse # reserved
439           
440        # color spaces   
441        self.BWColorSpace = "".join([chr(0x00), chr(0xf8), chr(0x03)])
442        self.GrayColorSpace = "".join([chr(0x01), chr(0xf8), chr(0x03)])
443        self.RGBColorSpace = "".join([chr(0x02), chr(0xf8), chr(0x03)])
444       
445        # set number of copies
446        self.setNumberOfCopies = "".join([chr(0xf8), chr(0x31)]) 
447       
448        infileno = self.infile.fileno()
449        self.pages = {}
450        self.minfile = minfile = mmap.mmap(infileno, os.fstat(infileno)[6], prot=mmap.PROT_READ, flags=mmap.MAP_SHARED)
451        tags = self.tags
452        self.pagecount = 0
453        self.escapedStuff = {}
454        self.pos = pos = 0
455        try :
456            while 1 :
457                char = minfile[pos]
458                pos += 1
459                length = tags[ord(char)]
460                if not length :
461                    continue
462                if callable(length) :   
463                    self.pos = pos
464                    length = length()
465                    pos = self.pos
466                pos += length   
467        except IndexError : # EOF ?
468            self.minfile.close() # reached EOF
469           
470        # now handle number of copies for each page (may differ).
471        if self.iscolor :
472            colormode = "Color"
473        else :   
474            colormode = "Black"
475        for pnum in range(1, self.pagecount + 1) :
476            # if no number of copies defined, take 1, as explained
477            # in PCLXL documentation.
478            # NB : is number of copies is 0, the page won't be output
479            # but the formula below is still correct : we want
480            # to decrease the total number of pages in this case.
481            page = self.pages.get(pnum, 1)
482            copies = page["copies"]
483            self.pagecount += (copies - 1)
484            if self.debug :
485                sys.stderr.write("%s*%s*%s*%s*%s*%s\n" % (copies, 
486                                                          page["mediatype"], 
487                                                          page["mediasize"], 
488                                                          page["orientation"], 
489                                                          page["mediasource"], 
490                                                          colormode))
491        return self.pagecount
492       
493def test() :       
494    """Test function."""
495    if (len(sys.argv) < 2) or ((not sys.stdin.isatty()) and ("-" not in sys.argv[1:])) :
496        sys.argv.append("-")
497    totalsize = 0   
498    for arg in sys.argv[1:] :
499        if arg == "-" :
500            infile = sys.stdin
501            mustclose = 0
502        else :   
503            infile = open(arg, "rb")
504            mustclose = 1
505        try :
506            parser = Parser(infile, debug=1)
507            totalsize += parser.getJobSize()
508        except pdlparser.PDLParserError, msg :   
509            sys.stderr.write("ERROR: %s\n" % msg)
510            sys.stderr.flush()
511        if mustclose :   
512            infile.close()
513    print "%s" % totalsize
514   
515if __name__ == "__main__" :   
516    test()
Note: See TracBrowser for help on using the browser.