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

Revision 403, 24.2 kB (checked in by jerome, 18 years ago)

Renamed the new PCL3/4/5 parser in order to activate it.

  • 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# pkpgcounter : a generic Page Description Language parser
5#
6# (c) 2003, 2004, 2005, 2006 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
24"""This modules implements a page counter for PCL3/4/5 documents."""
25
26import sys
27import os
28import mmap
29from struct import unpack
30
31import pdlparser
32import pjl
33
34NUL = chr(0x00)
35FORMFEED = chr(0x0c)
36ESCAPE = chr(0x1b)
37ASCIILIMIT = chr(0x80)
38
39class Parser(pdlparser.PDLParser) :
40    """A parser for PCL3, PCL4, PCL5 documents."""
41    totiffcommand = 'pcl6 -sDEVICE=pdfwrite -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -sOutputFile=- - | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r%(dpi)i -sOutputFile="%(fname)s" -'
42    mediasizes = {  # ESC&l####A
43                    0 : "Default",
44                    1 : "Executive",
45                    2 : "Letter",
46                    3 : "Legal",
47                    6 : "Ledger", 
48                    25 : "A5",
49                    26 : "A4",
50                    27 : "A3",
51                    45 : "JB5",
52                    46 : "JB4",
53                    71 : "HagakiPostcard",
54                    72 : "OufukuHagakiPostcard",
55                    80 : "MonarchEnvelope",
56                    81 : "COM10Envelope",
57                    90 : "DLEnvelope",
58                    91 : "C5Envelope",
59                    100 : "B5Envelope",
60                    101 : "Custom",
61                 }   
62                 
63    mediasources = { # ESC&l####H
64                     0 : "Default",
65                     1 : "Main",
66                     2 : "Manual",
67                     3 : "ManualEnvelope",
68                     4 : "Alternate",
69                     5 : "OptionalLarge",
70                     6 : "EnvelopeFeeder",
71                     7 : "Auto",
72                     8 : "Tray1",
73                   }
74                   
75    orientations = { # ESC&l####O
76                     0 : "Portrait",
77                     1 : "Landscape",
78                     2 : "ReversePortrait",
79                     3 : "ReverseLandscape",
80                   }
81                   
82    mediatypes = { # ESC&l####M
83                     0 : "Plain",
84                     1 : "Bond",
85                     2 : "Special",
86                     3 : "Glossy",
87                     4 : "Transparent",
88                   }
89       
90    def isValid(self) :   
91        """Returns True if data is PCL3/4/5, else False."""
92        if self.firstblock.startswith("\033E\033") or \
93           (self.firstblock.startswith("\033*rbC") and (not self.lastblock[-3:] == "\f\033@")) or \
94           self.firstblock.startswith("\033%8\033") or \
95           (self.firstblock.find("\033%-12345X") != -1) or \
96           (self.firstblock.find("@PJL ENTER LANGUAGE=PCL\012\015\033") != -1) or \
97           (self.firstblock.startswith(chr(0xcd)+chr(0xca)) and self.firstblock.find("\033E\033")) :
98            self.logdebug("DEBUG: Input file is in the PCL3/4/5 format.")
99            return True
100        else :   
101            return False
102       
103    def setPageDict(self, attribute, value) :
104        """Initializes a page dictionnary."""
105        dic = self.pages.setdefault(self.pagecount, { "copies" : 1, "mediasource" : "Main", "mediasize" : "Default", "mediatype" : "Plain", "orientation" : "Portrait", "escaped" : "", "duplex": 0})
106        dic[attribute] = value
107       
108    def readByte(self) :   
109        """Reads a byte from the input stream."""
110        tag = ord(self.minfile[self.pos])
111        self.pos += 1
112        return tag
113       
114    def endPage(self) :   
115        """Handle the FF marker."""
116        #self.logdebug("FORMFEED %i at %08x" % (self.pagecount, self.pos-1))
117        if not self.hpgl2 :
118            # Increments page count only if we are not inside an HPGL2 block
119            self.pagecount += 1
120       
121    def escPercent(self) :   
122        """Handles the ESC% sequence."""
123        if self.minfile[self.pos : self.pos+7] == r"-12345X" :
124            #self.logdebug("Generic ESCAPE sequence at %08x" % self.pos)
125            self.pos += 7
126            buffer = []
127            quotes = 0
128            char = chr(self.readByte())
129            while ((char < ASCIILIMIT) or (quotes % 2)) and (char not in (FORMFEED, ESCAPE, NUL)) : 
130                buffer.append(char)
131                if char == '"' :
132                    quotes += 1
133                char = chr(self.readByte())
134            self.setPageDict("escaped", "".join(buffer))
135            #self.logdebug("ESCAPED : %s" % "".join(buffer))
136            self.pos -= 1   # Adjust position
137        else :   
138            while 1 :
139                (value, end) = self.getInteger()
140                if end == 'B' :
141                    self.enterHPGL2()
142                    while self.minfile[self.pos] != ESCAPE :
143                        self.pos += 1
144                    self.pos -= 1   
145                    return 
146                elif end == 'A' :   
147                    self.exitHPGL2()
148                    return
149                elif end is None :   
150                    return
151       
152    def enterHPGL2(self) :   
153        """Enters HPGL2 mode."""
154        #self.logdebug("ENTERHPGL2 %08x" % self.pos)
155        self.hpgl2 = True
156       
157    def exitHPGL2(self) :   
158        """Exits HPGL2 mode."""
159        #self.logdebug("EXITHPGL2 %08x" % self.pos)
160        self.hpgl2 = False
161       
162    def handleTag(self, tagtable) :   
163        """Handles tags."""
164        tagtable[self.readByte()]()
165       
166    def escape(self) :   
167        """Handles the ESC character."""
168        #self.logdebug("ESCAPE")
169        self.handleTag(self.esctags)
170       
171    def escAmp(self) :   
172        """Handles the ESC& sequence."""
173        #self.logdebug("AMP")
174        self.handleTag(self.escamptags)
175       
176    def escStar(self) :   
177        """Handles the ESC* sequence."""
178        #self.logdebug("STAR")
179        self.handleTag(self.escstartags)
180       
181    def escLeftPar(self) :   
182        """Handles the ESC( sequence."""
183        #self.logdebug("LEFTPAR")
184        self.handleTag(self.escleftpartags)
185       
186    def escRightPar(self) :   
187        """Handles the ESC( sequence."""
188        #self.logdebug("RIGHTPAR")
189        self.handleTag(self.escrightpartags)
190       
191    def escE(self) :   
192        """Handles the ESCE sequence."""
193        #self.logdebug("RESET")
194        self.resets += 1
195       
196    def escAmpl(self) :   
197        """Handles the ESC&l sequence."""
198        while 1 :
199            (value, end) = self.getInteger()
200            if value is None :
201                return
202            if end in ('h', 'H') :
203                mediasource = self.mediasources.get(value, str(value))
204                self.mediasourcesvalues.append(mediasource)
205                self.setPageDict("mediasource", mediasource)
206                #self.logdebug("MEDIASOURCE %s" % mediasource)
207            elif end in ('a', 'A') :
208                mediasize = self.mediasizes.get(value, str(value))
209                self.mediasizesvalues.append(mediasize)
210                self.setPageDict("mediasize", mediasize)
211                #self.logdebug("MEDIASIZE %s" % mediasize)
212            elif end in ('o', 'O') :
213                orientation = self.orientations.get(value, str(value))
214                self.orientationsvalues.append(orientation)
215                self.setPageDict("orientation", orientation)
216                #self.logdebug("ORIENTATION %s" % orientation)
217            elif end in ('m', 'M') :
218                mediatype = self.mediatypes.get(value, str(value))
219                self.mediatypesvalues.append(mediatype)
220                self.setPageDict("mediatype", mediatype)
221                #self.logdebug("MEDIATYPE %s" % mediatype)
222            elif end == 'X' :
223                self.copies.append(value)
224                self.setPageDict("copies", value)
225                #self.logdebug("COPIES %i" % value)
226               
227    def escAmpa(self) :   
228        """Handles the ESC&a sequence."""
229        while 1 :
230            (value, end) = self.getInteger()
231            if value is None :
232                return
233            if end == 'G' :   
234                #self.logdebug("BACKSIDES %i" % value)
235                self.backsides.append(value)
236                self.setPageDict("duplex", value)
237               
238    def escAmpb(self) :   
239        """Handles the ESC&b sequence."""
240        while 1 :
241            (value, end) = self.getInteger()
242            if value is None :
243                return
244            if end == 'W' :   
245                self.pos += value
246                #self.logdebug("SKIPTO %08x" % self.pos)
247               
248    def escAmpn(self) :   
249        """Handles the ESC&n sequence."""
250        while 1 :
251            (value, end) = self.getInteger()
252            if value is None :
253                return
254            if end == 'W' :   
255                self.pos += value
256                #self.logdebug("SKIPTO %08x" % self.pos)
257               
258    def escAmpp(self) :   
259        """Handles the ESC&p sequence."""
260        while 1 :
261            (value, end) = self.getInteger()
262            if value is None :
263                return
264            if end == 'X' :   
265                self.pos += value
266                #self.logdebug("SKIPTO %08x" % self.pos)
267               
268    def escAmpu(self) :   
269        """Handles the ESC&u sequence."""
270        while 1 :
271            (value, end) = self.getInteger()
272            if value is None :
273                return
274               
275    def escStarb(self) :   
276        """Handles the ESC*b sequence."""
277        while 1 :
278            (value, end) = self.getInteger()
279            if (end is None) and (value is None) :
280                return
281            if end in ('V', 'W', 'v', 'w') :   
282                self.pos += (value or 0)
283                #self.logdebug("SKIPTO %08x" % self.pos)
284               
285    def escStarcgilmv(self) :   
286        """Handles the ESC*c, ESC*g, ESC*i, ESC*l, ESC*m, ESC*v sequences."""
287        while 1 :
288            (value, end) = self.getInteger()
289            if value is None :
290                return
291            if end == 'W' :   
292                self.pos += value
293                #self.logdebug("SKIPTO %08x" % self.pos)
294               
295    def escStaro(self) :   
296        """Handles the ESC*o sequence."""
297        while 1 :
298            (value, end) = self.getInteger()
299            if value is None :
300                return
301               
302    def escStarp(self) :   
303        """Handles the ESC*p sequence."""
304        while 1 :
305            (value, end) = self.getInteger()
306            if value is None :
307                return
308               
309    def escStarr(self) :   
310        """Handles the ESC*r sequence."""
311        while 1 :
312            (value, end) = self.getInteger()
313            if value is None :
314                if end is None :
315                    return
316                elif end in ('B', 'C') :       
317                    #self.logdebug("EndGFX")
318                    if self.startgfx :
319                        self.endgfx.append(1)
320                    else :   
321                        #self.logdebug("EndGFX found before StartGFX, ignored.")
322                        pass
323            if end == 'A' and (0 <= value <= 3) :
324                #self.logdebug("StartGFX %i" % value)
325                self.startgfx.append(value)
326               
327    def escStart(self) :   
328        """Handles the ESC*t sequence."""
329        while 1 :
330            (value, end) = self.getInteger()
331            if value is None :
332                return
333       
334    def escRightorLeftParsf(self) :   
335        """Handles the ESC(s, ESC)s, ESC(f sequences."""
336        while 1 :
337            (value, end) = self.getInteger()
338            if value is None :
339                return
340            if end == 'W' :   
341                self.pos += value
342                #self.logdebug("SKIPTO %08x" % self.pos)
343               
344    def getInteger(self) :   
345        """Returns an integer value and the end character."""
346        sign = 1
347        value = None
348        while 1 :
349            char = chr(self.readByte())
350            if char in (NUL, ESCAPE, FORMFEED, ASCIILIMIT) :
351                self.pos -= 1 # Adjust position
352                return (None, None)
353            if char == '-' :
354                sign = -1
355            elif not char.isdigit() :
356                if value is not None :
357                    return (sign*value, char)
358                else :
359                    return (value, char)
360            else :   
361                value = ((value or 0) * 10) + int(char)   
362       
363    def skipByte(self) :   
364        """Skips a byte."""
365        #self.logdebug("SKIPBYTE %08x ===> %02x" % (self.pos, ord(self.minfile[self.pos])))
366        self.pos += 1
367       
368    def handleImageRunner(self) :   
369        """Handles Canon ImageRunner tags."""
370        tag = self.readByte()
371        if tag == ord(self.imagerunnermarker1[-1]) :
372            oldpos = self.pos-2
373            codop = self.minfile[self.pos:self.pos+2]
374            length = unpack(">H", minfile[pos+6:pos+8])[0]
375            self.pos += 18
376            if codop != self.imagerunnermarker2 :
377                self.pos += length
378            self.logdebug("IMAGERUNNERTAG SKIP %i AT %08x" % (self.pos-oldpos, self.pos))
379        else :
380            self.pos -= 1 # Adjust position
381               
382    def getJobSize(self) :     
383        """Count pages in a PCL5 document.
384         
385           Should also work for PCL3 and PCL4 documents.
386           
387           Algorithm from pclcount
388           (c) 2003, by Eduardo Gielamo Oliveira & Rodolfo Broco Manin
389           published under the terms of the GNU General Public Licence v2.
390         
391           Backported from C to Python by Jerome Alet, then enhanced
392           with more PCL tags detected. I think all the necessary PCL tags
393           are recognized to correctly handle PCL5 files wrt their number
394           of pages. The documentation used for this was :
395         
396           HP PCL/PJL Reference Set
397           PCL5 Printer Language Technical Quick Reference Guide
398           http://h20000.www2.hp.com/bc/docs/support/SupportManual/bpl13205/bpl13205.pdf
399        """
400        infileno = self.infile.fileno()
401        self.minfile = minfile = mmap.mmap(infileno, os.fstat(infileno)[6], prot=mmap.PROT_READ, flags=mmap.MAP_SHARED)
402        self.pages = {}
403        self.pagecount = 0
404        self.resets = 0
405        self.backsides = []
406        self.copies = []
407        self.mediasourcesvalues = []
408        self.mediasizesvalues = []
409        self.orientationsvalues = []
410        self.mediatypesvalues = []
411        self.startgfx = []
412        self.endgfx = []
413        self.hpgl2 = False
414        self.imagerunnermarker1 = chr(0xcd) + chr(0xca) # Markers for Canon ImageRunner printers
415        self.imagerunnermarker2 = chr(0x10) + chr(0x02)
416        self.isimagerunner = (minfile[:2] == self.imagerunnermarker1)
417       
418        tags = [ lambda : None] * 256
419        tags[ord(FORMFEED)] = self.endPage
420        tags[ord(ESCAPE)] = self.escape
421        tags[ord(ASCIILIMIT)] = self.skipByte
422        tags[ord(self.imagerunnermarker1[0])] = self.handleImageRunner
423       
424        self.esctags = [ lambda : None ] * 256
425        self.esctags[ord('%')] = self.escPercent
426        self.esctags[ord('*')] = self.escStar
427        self.esctags[ord('&')] = self.escAmp
428        self.esctags[ord('(')] = self.escLeftPar
429        self.esctags[ord(')')] = self.escRightPar
430        self.esctags[ord('E')] = self.escE
431       
432        self.escamptags = [lambda : None ] * 256
433        self.escamptags[ord('a')] = self.escAmpa
434        self.escamptags[ord('b')] = self.escAmpb
435        self.escamptags[ord('l')] = self.escAmpl
436        self.escamptags[ord('n')] = self.escAmpn
437        self.escamptags[ord('p')] = self.escAmpp
438        self.escamptags[ord('u')] = self.escAmpu
439       
440        self.escstartags = [ lambda : None ] * 256
441        self.escstartags[ord('b')] = self.escStarb
442        self.escstartags[ord('o')] = self.escStaro
443        self.escstartags[ord('p')] = self.escStarp
444        self.escstartags[ord('r')] = self.escStarr
445        self.escstartags[ord('t')] = self.escStart
446        self.escstartags[ord('c')] = self.escStarcgilmv
447        self.escstartags[ord('g')] = self.escStarcgilmv
448        self.escstartags[ord('i')] = self.escStarcgilmv
449        self.escstartags[ord('l')] = self.escStarcgilmv
450        self.escstartags[ord('m')] = self.escStarcgilmv
451        self.escstartags[ord('v')] = self.escStarcgilmv
452       
453        self.escleftpartags = [ lambda : None ] * 256
454        self.escleftpartags[ord('s')] = self.escRightorLeftParsf
455        self.escleftpartags[ord('f')] = self.escRightorLeftParsf
456       
457        self.escrightpartags = [ lambda : None ] * 256
458        self.escrightpartags[ord('s')] = self.escRightorLeftParsf
459       
460        self.pos = 0
461        try :
462            try :
463                while 1 :
464                    tags[self.readByte()]()
465            except IndexError : # EOF ?           
466                pass
467        finally :
468            self.minfile.close()
469       
470        self.logdebug("Pagecount : \t\t\t%i" % self.pagecount)
471        self.logdebug("Resets : \t\t\t%i" % self.resets)
472        self.logdebug("Copies : \t\t\t%s" % self.copies)
473        self.logdebug("NbCopiesMarks : \t\t%i" % len(self.copies))
474        self.logdebug("MediaTypes : \t\t\t%s" % self.mediatypesvalues)
475        self.logdebug("NbMediaTypes : \t\t\t%i" % len(self.mediatypesvalues))
476        self.logdebug("MediaSizes : \t\t\t%s" % self.mediasizesvalues)
477        self.logdebug("NbMediaSizes : \t\t\t%i" % len(self.mediasizesvalues))
478        self.logdebug("MediaSources : \t\t\t%s" % self.mediasourcesvalues)
479        nbmediasourcesdefault = len([m for m in self.mediasourcesvalues if m == 'Default'])
480        self.logdebug("MediaSourcesDefault : \t\t%i" % nbmediasourcesdefault)
481        self.logdebug("MediaSourcesNOTDefault : \t%i" % (len(self.mediasourcesvalues) - nbmediasourcesdefault))
482        self.logdebug("Orientations : \t\t\t%s" % self.orientationsvalues)
483        nborientations = len(self.orientationsvalues)
484        self.logdebug("NbOrientations : \t\t\t%i" % nborientations)
485        self.logdebug("StartGfx : \t\t\t%s" % len(self.startgfx))
486        self.logdebug("EndGfx : \t\t\t%s" % len(self.endgfx))
487        self.logdebug("BackSides : \t\t\t%s" % self.backsides)
488        self.logdebug("NbBackSides : \t\t\t%i" % len(self.backsides))
489        self.logdebug("IsImageRunner : \t\t\t%s" % self.isimagerunner)
490       
491        if self.isimagerunner :
492            self.pagecount += 1      # ImageRunner adjustment
493        elif len(self.startgfx) == len(self.endgfx) == 0 :
494            if self.resets % 2 :
495                if nborientations == self.pagecount + 1 :
496                    self.logdebug("Adjusting PageCount : +1")
497                    self.pagecount += 1
498                elif nborientations == self.pagecount - 1 :
499                    self.logdebug("Adjusting PageCount : -1")
500                    self.pagecount -= 1
501                   
502        self.pagecount = self.pagecount or nbmediasourcesdefault
503       
504       
505        defaultpjlcopies = 1   
506        defaultduplexmode = "Simplex"
507        defaultpapersize = ""
508        oldpjlcopies = -1
509        oldduplexmode = ""
510        oldpapersize = ""
511        for pnum in range(self.pagecount) :
512            # if no number of copies defined, take the preceding one else the one set before any page else 1.
513            page = self.pages.get(pnum, self.pages.get(pnum - 1, self.pages.get(0, { "copies" : 1, "mediasource" : "Main", "mediasize" : "Default", "mediatype" : "Plain", "orientation" : "Portrait", "escaped" : "", "duplex": 0})))
514            pjlstuff = page["escaped"]
515            if pjlstuff :
516                pjlparser = pjl.PJLParser(pjlstuff)
517                nbdefaultcopies = int(pjlparser.default_variables.get("COPIES", -1))
518                nbcopies = int(pjlparser.environment_variables.get("COPIES", -1))
519                nbdefaultqty = int(pjlparser.default_variables.get("QTY", -1))
520                nbqty = int(pjlparser.environment_variables.get("QTY", -1))
521                if nbdefaultcopies > -1 :
522                    defaultpjlcopies = nbdefaultcopies
523                if nbdefaultqty > -1 :
524                    defaultpjlcopies = nbdefaultqty
525                if nbcopies > -1 :
526                    pjlcopies = nbcopies
527                elif nbqty > -1 :
528                    pjlcopies = nbqty
529                else :
530                    if oldpjlcopies == -1 :   
531                        pjlcopies = defaultpjlcopies
532                    else :   
533                        pjlcopies = oldpjlcopies   
534                if page["duplex"] :       
535                    duplexmode = "Duplex"
536                else :   
537                    defaultdm = pjlparser.default_variables.get("DUPLEX", "")
538                    if defaultdm :
539                        if defaultdm.upper() == "ON" :
540                            defaultduplexmode = "Duplex"
541                        else :   
542                            defaultduplexmode = "Simplex"
543                    envdm = pjlparser.environment_variables.get("DUPLEX", "")
544                    if envdm :
545                        if envdm.upper() == "ON" :
546                            duplexmode = "Duplex"
547                        else :   
548                            duplexmode = "Simplex"
549                    else :       
550                        duplexmode = oldduplexmode or defaultduplexmode
551                defaultps = pjlparser.default_variables.get("PAPER", "")
552                if defaultps :
553                    defaultpapersize = defaultps
554                envps = pjlparser.environment_variables.get("PAPER", "")
555                if envps :
556                    papersize = envps
557                else :   
558                    if not oldpapersize :
559                        papersize = defaultpapersize
560                    else :   
561                        papersize = oldpapersize
562            else :       
563                if oldpjlcopies == -1 :
564                    pjlcopies = defaultpjlcopies
565                else :   
566                    pjlcopies = oldpjlcopies
567               
568                duplexmode = (page["duplex"] and "Duplex") or oldduplexmode or defaultduplexmode
569                if not oldpapersize :   
570                    papersize = defaultpapersize
571                else :   
572                    papersize = oldpapersize
573                papersize = oldpapersize or page["mediasize"]
574            if page["mediasize"] != "Default" :
575                papersize = page["mediasize"]
576            if not duplexmode :   
577                duplexmode = oldduplexmode or defaultduplexmode
578            oldpjlcopies = pjlcopies   
579            oldduplexmode = duplexmode
580            oldpapersize = papersize
581            copies = pjlcopies * page["copies"]       
582            self.pagecount += (copies - 1)
583            self.logdebug("%s*%s*%s*%s*%s*%s*BW" % (copies, \
584                                              page["mediatype"], \
585                                              papersize, \
586                                              page["orientation"], \
587                                              page["mediasource"], \
588                                              duplexmode))
589       
590        return self.pagecount
591       
592def test() :       
593    """Test function."""
594    if (len(sys.argv) < 2) or ((not sys.stdin.isatty()) and ("-" not in sys.argv[1:])) :
595        sys.argv.append("-")
596    totalsize = 0   
597    for arg in sys.argv[1:] :
598        if arg == "-" :
599            infile = sys.stdin
600            mustclose = 0
601        else :   
602            infile = open(arg, "rb")
603            mustclose = 1
604        try :
605            parser = Parser(infile, debug=1)
606            totalsize += parser.getJobSize()
607        except pdlparser.PDLParserError, msg :   
608            sys.stderr.write("ERROR: %s\n" % msg)
609            sys.stderr.flush()
610        if mustclose :   
611            infile.close()
612    print "%s" % totalsize
613   
614if __name__ == "__main__" :   
615    test()
Note: See TracBrowser for help on using the browser.