root / pkpgcounter / trunk / pkpgpdls / pcl345.py @ 285

Revision 285, 23.0 kB (checked in by jerome, 18 years ago)

Improved PCL3/4/5 parser in corner cases

  • 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
27
28import pdlparser
29import pjl
30
31class Parser(pdlparser.PDLParser) :
32    """A parser for PCL3, PCL4, PCL5 documents."""
33    mediasizes = {  # ESC&l####A
34                    0 : "Default",
35                    1 : "Executive",
36                    2 : "Letter",
37                    3 : "Legal",
38                    6 : "Ledger", 
39                    25 : "A5",
40                    26 : "A4",
41                    27 : "A3",
42                    45 : "JB5",
43                    46 : "JB4",
44                    71 : "HagakiPostcard",
45                    72 : "OufukuHagakiPostcard",
46                    80 : "MonarchEnvelope",
47                    81 : "COM10Envelope",
48                    90 : "DLEnvelope",
49                    91 : "C5Envelope",
50                    100 : "B5Envelope",
51                    101 : "Custom",
52                 }   
53                 
54    mediasources = { # ESC&l####H
55                     0 : "Default",
56                     1 : "Main",
57                     2 : "Manual",
58                     3 : "ManualEnvelope",
59                     4 : "Alternate",
60                     5 : "OptionalLarge",
61                     6 : "EnvelopeFeeder",
62                     7 : "Auto",
63                     8 : "Tray1",
64                   }
65                   
66    orientations = { # ESC&l####O
67                     0 : "Portrait",
68                     1 : "Landscape",
69                     2 : "ReversePortrait",
70                     3 : "ReverseLandscape",
71                   }
72                   
73    mediatypes = { # ESC&l####M
74                     0 : "Plain",
75                     1 : "Bond",
76                     2 : "Special",
77                     3 : "Glossy",
78                     4 : "Transparent",
79                   }
80       
81    def isValid(self) :   
82        """Returns 1 if data is PCL, else 0."""
83        if self.firstblock.startswith("\033E\033") or \
84           (self.firstblock.startswith("\033*rbC") and (not self.lastblock[-3:] == "\f\033@")) or \
85           self.firstblock.startswith("\033%8\033") or \
86           (self.firstblock.find("\033%-12345X") != -1) :
87            self.logdebug("DEBUG: Input file is in the PCL3/4/5 format.")
88            return 1
89        else :   
90            return 0
91       
92    def setPageDict(self, pages, number, attribute, value) :
93        """Initializes a page dictionnary."""
94        dic = pages.setdefault(number, { "copies" : 1, "mediasource" : "Main", "mediasize" : "Default", "mediatype" : "Plain", "orientation" : "Portrait", "escaped" : ""})
95        dic[attribute] = value
96       
97    def getJobSize(self) :     
98        """Count pages in a PCL5 document.
99         
100           Should also work for PCL3 and PCL4 documents.
101           
102           Algorithm from pclcount
103           (c) 2003, by Eduardo Gielamo Oliveira & Rodolfo Broco Manin
104           published under the terms of the GNU General Public Licence v2.
105         
106           Backported from C to Python by Jerome Alet, then enhanced
107           with more PCL tags detected. I think all the necessary PCL tags
108           are recognized to correctly handle PCL5 files wrt their number
109           of pages. The documentation used for this was :
110         
111           HP PCL/PJL Reference Set
112           PCL5 Printer Language Technical Quick Reference Guide
113           http://h20000.www2.hp.com/bc/docs/support/SupportManual/bpl13205/bpl13205.pdf
114        """
115        infileno = self.infile.fileno()
116        minfile = mmap.mmap(infileno, os.fstat(infileno)[6], prot=mmap.PROT_READ, flags=mmap.MAP_SHARED)
117        tagsends = { "&n" : "W", 
118                     "&b" : "W", 
119                     "*i" : "W", 
120                     "*l" : "W", 
121                     "*m" : "W", 
122                     "*v" : "W", 
123                     "*c" : "W", 
124                     "(f" : "W", 
125                     "(s" : "W", 
126                     ")s" : "W", 
127                     "&p" : "X", 
128                     # "&l" : "XHAOM",  # treated specially
129                     "&a" : "G", # TODO : 0 means next side, 1 front side, 2 back side
130                     "*g" : "W",
131                     "*r" : "sbABC",
132                     "*t" : "R",
133                     # "*b" : "VW", # treated specially because it occurs very often
134                   } 
135        pagecount = resets = ejects = backsides = startgfx = endgfx = 0
136        starb = ampl = ispcl3 = escstart = 0
137        mediasourcecount = mediasizecount = orientationcount = mediatypecount = 0
138        tag = None
139        endmark = chr(0x1b) + chr(0x0c) + chr(0x00) 
140        asciilimit = chr(0x80)
141        pages = {}
142        pos = 0
143        try :
144            while 1 :
145                char = minfile[pos] ; pos += 1
146                if char == "\014" :   
147                    pagecount += 1
148                elif char == "\033" :   
149                    starb = ampl = 0
150                    if minfile[pos : pos+8] == r"%-12345X" :
151                        endpos = pos + 9
152                        quotes = 0
153                        while (minfile[endpos] not in endmark) and \
154                              ((minfile[endpos] < asciilimit) or (quotes % 2)) :
155                            if minfile[endpos] == '"' :
156                                quotes += 1
157                            endpos += 1
158                        self.setPageDict(pages, pagecount, "escaped", minfile[pos : endpos])
159                        pos += (endpos - pos)
160                    else :
161                        #
162                        #     <ESC>*b###y#m###v###w... -> PCL3 raster graphics
163                        #     <ESC>*b###W -> Start of a raster data row/block
164                        #     <ESC>*b###V -> Start of a raster data plane
165                        #     <ESC>*c###W -> Start of a user defined pattern
166                        #     <ESC>*i###W -> Start of a viewing illuminant block
167                        #     <ESC>*l###W -> Start of a color lookup table
168                        #     <ESC>*m###W -> Start of a download dither matrix block
169                        #     <ESC>*v###W -> Start of a configure image data block
170                        #     <ESC>*r1A -> Start Gfx
171                        #     <ESC>(s###W -> Start of a characters description block
172                        #     <ESC>)s###W -> Start of a fonts description block
173                        #     <ESC>(f###W -> Start of a symbol set block
174                        #     <ESC>&b###W -> Start of configuration data block
175                        #     <ESC>&l###X -> Number of copies for current page
176                        #     <ESC>&n###W -> Starts an alphanumeric string ID block
177                        #     <ESC>&p###X -> Start of a non printable characters block
178                        #     <ESC>&a2G -> Back side when duplex mode as generated by rastertohp
179                        #     <ESC>*g###W -> Needed for planes in PCL3 output
180                        #     <ESC>&l###H (or only 0 ?) -> Eject if NumPlanes > 1, as generated by rastertohp. Also defines mediasource
181                        #     <ESC>&l###A -> mediasize
182                        #     <ESC>&l###O -> orientation
183                        #     <ESC>&l###M -> mediatype
184                        #     <ESC>*t###R -> gfx resolution
185                        #
186                        tagstart = minfile[pos] ; pos += 1
187                        if tagstart in "E9=YZ" : # one byte PCL tag
188                            if tagstart == "E" :
189                                resets += 1
190                            continue             # skip to next tag
191                        tag = tagstart + minfile[pos] ; pos += 1
192                        if tag == "*b" : 
193                            starb = 1
194                            tagend = "VW"
195                        elif tag == "&l" :   
196                            ampl = 1
197                            tagend = "XHAOM"
198                        else :   
199                            try :
200                                tagend = tagsends[tag]
201                            except KeyError :   
202                                continue # Unsupported PCL tag
203                        # Now read the numeric argument
204                        size = 0
205                        while 1 :
206                            char = minfile[pos] ; pos += 1
207                            if not char.isdigit() :
208                                break
209                            size = (size * 10) + int(char)   
210                        if char in tagend :   
211                            if tag == "&l" :
212                                if char == "X" : 
213                                    self.setPageDict(pages, pagecount, "copies", size)
214                                elif char == "H" :
215                                    self.setPageDict(pages, pagecount, "mediasource", self.mediasources.get(size, str(size)))
216                                    mediasourcecount += 1
217                                    ejects += 1 
218                                elif char == "A" :
219                                    self.setPageDict(pages, pagecount, "mediasize", self.mediasizes.get(size, str(size)))
220                                    mediasizecount += 1
221                                elif char == "O" :
222                                    self.setPageDict(pages, pagecount, "orientation", self.orientations.get(size, str(size)))
223                                    orientationcount += 1
224                                elif char == "M" :
225                                    self.setPageDict(pages, pagecount, "mediatype", self.mediatypes.get(size, str(size)))
226                                    mediatypecount += 1
227                            elif tag == "*r" :
228                                # Special tests for PCL3
229                                if (char == "s") and size :
230                                    while 1 :
231                                        char = minfile[pos] ; pos += 1
232                                        if char == "A" :
233                                            break
234                                elif (char == "b") and (minfile[pos] == "C") and not size :
235                                    ispcl3 = 1 # Certainely a PCL3 file
236                                startgfx += (char == "A") and (minfile[pos - 2] in ("0", "1", "2", "3")) # Start Gfx
237                                endgfx += (not size) and (char in ("C", "B")) # End Gfx
238                            elif tag == "*t" :   
239                                escstart += 1
240                            elif (tag == "&a") and (size == 2) :
241                                backsides += 1      # Back side in duplex mode
242                            else :   
243                                # we just ignore the block.
244                                if tag == "&n" : 
245                                    # we have to take care of the operation id byte
246                                    # which is before the string itself
247                                    size += 1
248                                pos += size   
249                else :                           
250                    if starb :
251                        # special handling of PCL3 in which
252                        # *b introduces combined ESCape sequences
253                        size = 0
254                        while 1 :
255                            char = minfile[pos] ; pos += 1
256                            if not char.isdigit() :
257                                break
258                            size = (size * 10) + int(char)   
259                        if char in ("w", "v") :   
260                            ispcl3 = 1  # certainely a PCL3 document
261                            pos += size - 1
262                        elif char in ("y", "m") :   
263                            ispcl3 = 1  # certainely a PCL3 document
264                            pos -= 1    # fix position : we were ahead
265                    elif ampl :       
266                        # special handling of PCL3 in which
267                        # &l introduces combined ESCape sequences
268                        size = 0
269                        while 1 :
270                            char = minfile[pos] ; pos += 1
271                            if not char.isdigit() :
272                                break
273                            size = (size * 10) + int(char)   
274                        if char in ("a", "o", "h", "m") :   
275                            ispcl3 = 1  # certainely a PCL3 document
276                            pos -= 1    # fix position : we were ahead
277                            if char == "h" :
278                                self.setPageDict(pages, pagecount, "mediasource", self.mediasources.get(size, str(size)))
279                                mediasourcecount += 1
280                            elif char == "a" :
281                                self.setPageDict(pages, pagecount, "mediasize", self.mediasizes.get(size, str(size)))
282                                mediasizecount += 1
283                            elif char == "o" :
284                                self.setPageDict(pages, pagecount, "orientation", self.orientations.get(size, str(size)))
285                                orientationcount += 1
286                            elif char == "m" :
287                                self.setPageDict(pages, pagecount, "mediatype", self.mediatypes.get(size, str(size)))
288                                mediatypecount += 1
289        except IndexError : # EOF ?
290            minfile.close() # reached EOF
291                           
292        # if pagecount is still 0, we will use the number
293        # of resets instead of the number of form feed characters.
294        # but the number of resets is always at least 2 with a valid
295        # pcl file : one at the very start and one at the very end
296        # of the job's data. So we substract 2 from the number of
297        # resets. And since on our test data we needed to substract
298        # 1 more, we finally substract 3, and will test several
299        # PCL files with this. If resets < 2, then the file is
300        # probably not a valid PCL file, so we use 0
301       
302        if self.debug :
303            sys.stderr.write("pagecount : %s\n" % pagecount)
304            sys.stderr.write("resets : %s\n" % resets)
305            sys.stderr.write("ejects : %s\n" % ejects)
306            sys.stderr.write("backsides : %s\n" % backsides)
307            sys.stderr.write("startgfx : %s\n" % startgfx)
308            sys.stderr.write("endgfx : %s\n" % endgfx)
309            sys.stderr.write("mediasourcecount : %s\n" % mediasourcecount)
310            sys.stderr.write("mediasizecount : %s\n" % mediasizecount)
311            sys.stderr.write("orientationcount : %s\n" % orientationcount)
312            sys.stderr.write("mediatypecount : %s\n" % mediatypecount)
313            sys.stderr.write("escstart : %s\n" % escstart)
314       
315        if (orientationcount == (pagecount - 1)) and (resets == 1) :
316            if resets == ejects == startgfx == mediasourcecount == escstart == 1 :
317                self.logdebug("Rule #19")
318            else :   
319                self.logdebug("Rule #1")
320                pagecount -= 1
321        elif pagecount and (pagecount == orientationcount) :
322            self.logdebug("Rule #2")
323        elif resets == ejects == mediasourcecount == mediasizecount == escstart == 1 :
324            #if ((startgfx and endgfx) and (startgfx != endgfx)) or (startgfx == endgfx == 0) :
325            if (startgfx and endgfx) or (startgfx == endgfx == 0) :
326                self.logdebug("Rule #3")
327                pagecount = orientationcount
328            elif (endgfx and not startgfx) and (pagecount > orientationcount) :   
329                self.logdebug("Rule #4")
330                pagecount = orientationcount
331            else :     
332                self.logdebug("Rule #5")
333                pagecount += 1
334        elif (ejects == mediasourcecount == orientationcount) and (startgfx == endgfx) :     
335            if (resets == 2) and (orientationcount == (pagecount - 1)) and (orientationcount > 1) :
336                self.logdebug("Rule #6")
337                pagecount = orientationcount
338        elif pagecount == mediasourcecount == escstart : 
339            self.logdebug("Rule #7")
340        elif resets == startgfx == endgfx == mediasizecount == orientationcount == escstart == 1 :     
341            self.logdebug("Rule #8")
342        elif resets == startgfx == endgfx == (pagecount - 1) :   
343            self.logdebug("Rule #9")
344        elif (not startgfx) and (not endgfx) :
345            self.logdebug("Rule #10")
346        elif (resets == 2) and (startgfx == endgfx) and (mediasourcecount == 1) :
347            if orientationcount == (pagecount - 1) :
348                self.logdebug("Rule #11")
349                pagecount = orientationcount
350            elif not pagecount :   
351                self.logdebug("Rule #17")
352                pagecount = ejects
353        elif (resets == 1) and (startgfx == endgfx) and (mediasourcecount == 0) :
354            if (startgfx > 1) and (startgfx != (pagecount - 1)) :
355                self.logdebug("Rule #12")
356                pagecount -= 1
357            else :   
358                self.logdebug("Rule #18")
359        elif startgfx == endgfx :   
360            self.logdebug("Rule #13")
361            pagecount = startgfx
362        elif startgfx == (endgfx - 1) :   
363            self.logdebug("Rule #14")
364            pagecount = startgfx
365        elif (startgfx == 1) and not endgfx :   
366            self.logdebug("Rule #15")
367            pass
368        else :   
369            self.logdebug("Rule #16")
370            pagecount = abs(startgfx - endgfx)
371           
372        defaultpjlcopies = 1   
373        defaultduplexmode = "Simplex"
374        defaultpapersize = ""
375        oldpjlcopies = -1
376        oldduplexmode = ""
377        oldpapersize = ""
378        for pnum in range(pagecount) :
379            # if no number of copies defined, take the preceding one else the one set before any page else 1.
380            page = pages.get(pnum, pages.get(pnum - 1, pages.get(0, { "copies" : 1, "mediasource" : "Main", "mediasize" : "Default", "mediatype" : "Plain", "orientation" : "Portrait", "escaped" : ""})))
381            pjlstuff = page["escaped"]
382            if pjlstuff :
383                pjlparser = pjl.PJLParser(pjlstuff)
384                nbdefaultcopies = int(pjlparser.default_variables.get("COPIES", -1))
385                nbcopies = int(pjlparser.environment_variables.get("COPIES", -1))
386                nbdefaultqty = int(pjlparser.default_variables.get("QTY", -1))
387                nbqty = int(pjlparser.environment_variables.get("QTY", -1))
388                if nbdefaultcopies > -1 :
389                    defaultpjlcopies = nbdefaultcopies
390                if nbdefaultqty > -1 :
391                    defaultpjlcopies = nbdefaultqty
392                if nbcopies > -1 :
393                    pjlcopies = nbcopies
394                elif nbqty > -1 :
395                    pjlcopies = nbqty
396                else :
397                    if oldpjlcopies == -1 :   
398                        pjlcopies = defaultpjlcopies
399                    else :   
400                        pjlcopies = oldpjlcopies   
401                defaultdm = pjlparser.default_variables.get("DUPLEX", "")
402                if defaultdm :
403                    if defaultdm.upper() == "ON" :
404                        defaultduplexmode = "Duplex"
405                    else :   
406                        defaultduplexmode = "Simplex"
407                envdm = pjlparser.environment_variables.get("DUPLEX", "")
408                if envdm :
409                    if envdm.upper() == "ON" :
410                        duplexmode = "Duplex"
411                    else :   
412                        duplexmode = "Simplex"
413                else :       
414                    if not oldduplexmode :
415                        duplexmode = defaultduplexmode
416                    else :   
417                        duplexmode = oldduplexmode
418                defaultps = pjlparser.default_variables.get("PAPER", "")
419                if defaultps :
420                    defaultpapersize = defaultps
421                envps = pjlparser.environment_variables.get("PAPER", "")
422                if envps :
423                    papersize = envps
424                else :   
425                    if not oldpapersize :
426                        papersize = defaultpapersize
427                    else :   
428                        papersize = oldpapersize
429            else :       
430                if oldpjlcopies == -1 :
431                    pjlcopies = defaultpjlcopies
432                else :   
433                    pjlcopies = oldpjlcopies
434                if not oldduplexmode :
435                    duplexmode = defaultduplexmode
436                else :   
437                    duplexmode = oldduplexmode
438                if not oldpapersize :   
439                    papersize = defaultpapersize
440                else :   
441                    papersize = oldpapersize
442                duplexmode = oldduplexmode
443                papersize = oldpapersize or page["mediasize"]
444            if page["mediasize"] != "Default" :
445                papersize = page["mediasize"]
446            if not duplexmode :   
447                duplexmode = oldduplexmode or defaultduplexmode
448            oldpjlcopies = pjlcopies   
449            oldduplexmode = duplexmode
450            oldpapersize = papersize
451            copies = pjlcopies * page["copies"]       
452            pagecount += (copies - 1)
453            self.logdebug("%s*%s*%s*%s*%s*%s*BW" % (copies, \
454                                              page["mediatype"], \
455                                              papersize, \
456                                              page["orientation"], \
457                                              page["mediasource"], \
458                                              duplexmode))
459               
460        return pagecount
461       
462def test() :       
463    """Test function."""
464    if (len(sys.argv) < 2) or ((not sys.stdin.isatty()) and ("-" not in sys.argv[1:])) :
465        sys.argv.append("-")
466    totalsize = 0   
467    for arg in sys.argv[1:] :
468        if arg == "-" :
469            infile = sys.stdin
470            mustclose = 0
471        else :   
472            infile = open(arg, "rb")
473            mustclose = 1
474        try :
475            parser = Parser(infile, debug=1)
476            totalsize += parser.getJobSize()
477        except pdlparser.PDLParserError, msg :   
478            sys.stderr.write("ERROR: %s\n" % msg)
479            sys.stderr.flush()
480        if mustclose :   
481            infile.close()
482    print "%s" % totalsize
483   
484if __name__ == "__main__" :   
485    test()
Note: See TracBrowser for help on using the browser.