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

Revision 3491, 30.0 kB (checked in by jerome, 15 years ago)

Fix for some strange looking PCLXL files, workaround until I receive the testcase...

  • Property svn:eol-style set to native
  • Property svn:keywords set to Auth Date Id Rev
Line 
1# -*- coding: utf-8 -*-
2#
3# pkpgcounter : a generic Page Description Language parser
4#
5# (c) 2003-2009 Jerome Alet <alet@librelogiciel.com>
6# This program is free software: you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation, either version 3 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program.  If not, see <http://www.gnu.org/licenses/>.
18#
19# $Id$
20#
21
22"""This modules implements a page counter for PCLXL (aka PCL6) documents."""
23
24import sys
25import os
26import mmap
27from struct import unpack
28
29import pdlparser
30import pjl
31
32class Parser(pdlparser.PDLParser) :
33    """A parser for PCLXL (aka PCL6) documents."""
34    totiffcommands = [ 'pcl6 -sDEVICE=pdfwrite -r"%(dpi)i" -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -sOutputFile=- "%(infname)s" | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r"%(dpi)i" -sOutputFile="%(outfname)s" -',
35                       'pcl6 -sDEVICE=pswrite -r"%(dpi)i" -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -sOutputFile=- "%(infname)s" | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r"%(dpi)i" -sOutputFile="%(outfname)s" -',
36                     ]
37    required = [ "pcl6", "gs" ]
38    format = "PCLXL (aka PCL6)"
39    mediasizes = {
40                    0 : "Letter",
41                    1 : "Legal",
42                    2 : "A4",
43                    3 : "Executive",
44                    4 : "Ledger",
45                    5 : "A3",
46                    6 : "COM10Envelope",
47                    7 : "MonarchEnvelope",
48                    8 : "C5Envelope",
49                    9 : "DLEnvelope",
50                    10 : "JB4",
51                    11 : "JB5",
52                    12 : "B5Envelope",
53                    12 : "B5",
54                    14 : "JPostcard",
55                    15 : "JDoublePostcard",
56                    16 : "A5",
57                    17 : "A6",
58                    18 : "JB6",
59                    19 : "JIS8K",
60                    20 : "JIS16K",
61                    21 : "JISExec",
62                    96 : "Default",
63                 }
64
65    mediasources = {
66                     0 : "Default",
67                     1 : "Auto",
68                     2 : "Manual",
69                     3 : "MultiPurpose",
70                     4 : "UpperCassette",
71                     5 : "LowerCassette",
72                     6 : "EnvelopeTray",
73                     7 : "ThirdCassette",
74                   }
75
76    orientations = {
77                     0 : "Portrait",
78                     1 : "Landscape",
79                     2 : "ReversePortrait",
80                     3 : "ReverseLandscape",
81                     4 : "Default",
82                   }
83
84    def isValid(self) :
85        """Returns True if data is HP PCLXL aka PCL6, or Brother's' XL2HB, else False."""
86        if (((self.firstblock[:128].find("\033%-12345X") != -1) and \
87             (self.firstblock.find(" HP-PCL XL;") != -1) and \
88             ((self.firstblock.find("LANGUAGE=PCLXL") != -1) or \
89              (self.firstblock.find("LANGUAGE = PCLXL") != -1)))) \
90             or ((self.firstblock.startswith(chr(0xcd)+chr(0xca)) and (self.firstblock.find(" HP-PCL XL;") != -1))) :
91            return True
92        elif (self.firstblock[:128].find("\033%-12345X") != -1) \
93            and (self.firstblock.find("BROTHER XL2HB;") != -1) :
94            self.format = "XL2HB"
95            return True
96        else :
97            return False
98
99    def beginPage(self, nextpos) :
100        """Indicates the beginning of a new page, and extracts media information."""
101        # self.logdebug("BeginPage at %x" % nextpos)
102        self.pagecount += 1
103
104        # Default values
105        mediatypelabel = "Plain"
106        mediasourcelabel = "Main"
107        mediasizelabel = "Default"
108        orientationlabel = "Portrait"
109        duplexmode = None
110
111        # Now go upstream to decode media type, size, source, and orientation
112        # this saves time because we don't need a complete parser !
113        minfile = self.minfile
114        pos = nextpos - 2
115        while pos > 0 : # safety check : don't go back to far !
116            val = ord(minfile[pos])
117            if val in (0x44, 0x48, 0x41) : # if previous endPage or openDataSource or beginSession (first page)
118                break
119            if val == 0x26 :
120                mediasource = ord(minfile[pos - 2])
121                mediasourcelabel = self.mediasources.get(mediasource, str(mediasource))
122                pos -= 4
123            elif val == 0x25 :
124                while (pos > 0) and (ord(minfile[pos]) != 0xc0) :
125                    # we search the preceding ubyte tag
126                    pos -= 1
127                if pos > 0 :
128                    if ord(minfile[pos-1]) == 0xc8 :
129                        # if we found an ubyte_array then the media
130                        # size is completely spelled
131                        arraylength = ord(minfile[pos+1])
132                        mediasizelabel = minfile[pos+2:pos+2+arraylength].title()
133                        pos -= 1
134                    else :
135                        # if we just found an ubyte, then the media
136                        # size is known by its index
137                        mediasize = ord(minfile[pos+1])
138                        mediasizelabel = self.mediasizes.get(mediasize, str(mediasize))
139                    pos -= 1
140                    # self.logdebug("Media size : %s" % mediasizelabel)
141            elif val == 0x28 :
142                orientation = ord(minfile[pos - 2])
143                orientationlabel = self.orientations.get(orientation, str(orientation))
144                pos -= 4
145            elif val == 0x27 :
146                savepos = pos
147                pos -= 1
148                startpos = size = None
149                while pos > 0 : # safety check : don't go back to far !
150                    val = ord(minfile[pos])
151                    pos -= 1
152                    if val == 0xc8 :
153                        length = self.tags[ord(minfile[pos+2])] # will probably always be a byte or uint16
154                        if length == 1 :
155                            startpos = pos + 4
156                            size = unpack("B", self.minfile[pos+3:startpos])[0]
157                        elif length == 2 :
158                            startpos = pos + 5
159                            size = unpack(self.unpackShort, self.minfile[pos+3:startpos])[0]
160                        elif length == 4 :
161                            startpos = pos + 7
162                            size = unpack(self.unpackLong, self.minfile[pos+3:startpos])[0]
163                        else :
164                            raise pdlparser.PDLParserError, "Error on size at %s : %s" % (pos+2, length)
165                        break
166                try :
167                    mediatypelabel = minfile[startpos:startpos+size]
168                except TypeError :
169                    self.logdebug("PCL/XL parser problem at %i" % savepos)
170                # self.logdebug("Media type : %s" % mediatypelabel)
171            elif val == 0x34 :
172                duplexmode = "Simplex"
173                pos -= 2
174            elif val in (0x35, 0x36) :
175                duplexmode = "Duplex"
176                pos -= 2
177            # else : TODO : CUSTOM MEDIA SIZE AND UNIT !
178            else :
179                pos -= 1  # ignored
180        self.pages[self.pagecount] = { "copies" : 1,
181                                       "orientation" : orientationlabel,
182                                       "mediatype" : mediatypelabel,
183                                       "mediasize" : mediasizelabel,
184                                       "mediasource" : mediasourcelabel,
185                                       "duplex" : duplexmode,
186                                     }
187        return 0
188
189    def endPage(self, nextpos) :
190        """Indicates the end of a page."""
191        # self.logdebug("EndPage at %x" % nextpos)
192        pos3 = nextpos - 3
193        minfile = self.minfile
194        if minfile[pos3:nextpos-1] == self.setNumberOfCopies :
195            # The EndPage operator may be preceded by a PageCopies attribute
196            # So set number of copies for current page.
197            # From what I read in PCLXL documentation, the number
198            # of copies is an unsigned 16 bits integer
199            try :
200                nbcopies = unpack(self.unpackShort, minfile[pos3-2:pos3])[0]
201                # self.logdebug("Number of copies : %i" % nbcopies)
202                self.pages[self.pagecount]["copies"] = nbcopies
203            except KeyError :
204                self.logdebug("It looks like this PCLXL file is corrupted.")
205        return 0
206
207    def setColorSpace(self, nextpos) :
208        """Changes the color space."""
209        if self.minfile[nextpos-4:nextpos-1] == self.RGBColorSpace : # TODO : doesn't seem to handle all cases !
210            self.iscolor = True
211        return 0
212
213    def array_Generic(self, nextpos, size) :
214        """Handles all arrays."""
215        pos = nextpos
216        datatype = ord(self.minfile[pos])
217        pos += 1
218        length = self.tags[datatype]
219        if callable(length) :
220            length = length(pos)
221        try :
222            return 1 + length + size * unpack(self.unpackType[length], self.minfile[pos:pos+length])[0]
223        except KeyError :
224            raise pdlparser.PDLParserError, "Error on array size at %x" % nextpos
225
226    def array_8(self, nextpos) :
227        """Handles byte arrays."""
228        return self.array_Generic(nextpos, 1)
229
230    def array_16(self, nextpos) :
231        """Handles 16 bits arrays."""
232        return self.array_Generic(nextpos, 2)
233
234    def array_32(self, nextpos) :
235        """Handles 32 bits arrays and Canon ImageRunner tags."""
236        minfile = self.minfile
237        irtag = minfile[nextpos-1:nextpos+3]
238        if irtag in (self.imagerunnermarker1, self.imagerunnermarker2) :
239            # This is the beginning of a Canon ImageRunner tag
240            # self.logdebug("Canon ImageRunner tag at %x" % (nextpos-1))
241            codop = minfile[nextpos+1:nextpos+3]
242            length = unpack(">H", minfile[nextpos+7:nextpos+9])[0]
243            # self.logdebug("Canon ImageRunner block length=%04x" % length)
244            toskip = 19
245            if irtag != self.imagerunnermarker2 :
246                toskip += length
247            # self.logdebug("Canon ImageRunner skip until %x" % (nextpos+toskip))
248            return toskip
249        else :
250            # This is a normal PCLXL array
251            return self.array_Generic(nextpos, 4)
252
253    def embeddedDataSmall(self, nextpos) :
254        """Handle small amounts of data."""
255        return 1 + ord(self.minfile[nextpos])
256
257    def embeddedData(self, nextpos) :
258        """Handle normal amounts of data."""
259        return 4 + unpack(self.unpackLong, self.minfile[nextpos:nextpos+4])[0]
260
261    def skipHPPCLXL(self, nextpos) :
262        """Skip the 'HP-PCL XL' statement if needed."""
263        minfile = self.minfile
264        if nextpos \
265           and ((minfile[nextpos:nextpos+11] == " HP-PCL XL;") \
266             or (minfile[nextpos:nextpos+14] == " BROTHER XLHB;")) :
267            pos = nextpos
268            while minfile[pos] != '\n' :
269                pos += 1
270            length = (pos - nextpos + 1)
271            # self.logdebug("Skip HP PCLXL statement until %x" % (nextpos + length))
272            return length
273        else :
274            return 0
275
276    def littleEndian(self, nextpos) :
277        """Toggles to little endianness."""
278        self.unpackType = { 1 : "B", 2 : "<H", 4 : "<I" }
279        self.unpackShort = self.unpackType[2]
280        self.unpackLong = self.unpackType[4]
281        # self.logdebug("LittleEndian at %x" % (nextpos - 1))
282        return self.skipHPPCLXL(nextpos)
283
284    def bigEndian(self, nextpos) :
285        """Toggles to big endianness."""
286        self.unpackType = { 1 : "B", 2 : ">H", 4 : ">I" }
287        self.unpackShort = self.unpackType[2]
288        self.unpackLong = self.unpackType[4]
289        # self.logdebug("BigEndian at %x" % (nextpos - 1))
290        return self.skipHPPCLXL(nextpos)
291
292    def reservedForFutureUse(self, nextpos) :
293        """Outputs something when a reserved byte is encountered."""
294        self.logdebug("Byte at %x is out of the PCLXL Protocol Class 2.0 Specification" % nextpos)
295        return 0
296
297    def x46_class3(self, nextpos) :
298        """Undocumented tag 0x46 in class 3.0 streams."""
299        pos = nextpos - 3
300        minfile = self.minfile
301        val = ord(minfile[pos])
302        while val == 0xf8 :
303            funcid = ord(minfile[pos+1])
304            try :
305                offset = self.x46_functions[funcid]
306            except KeyError :
307                self.logdebug("Unexpected subfunction 0x%02x for undocumented tag 0x46 at %x" % (funcid, nextpos))
308                break
309            else :
310                pos -= offset
311                length = self.tags[ord(self.minfile[pos])]
312                if callable(length) :
313                    length = length(pos+1)
314                if funcid == 0x92 : # we want to skip these blocks
315                    try :
316                        return unpack(self.unpackType[length], self.minfile[pos+1:pos+length+1])[0]
317                    except KeyError :
318                        raise pdlparser.PDLParserError, "Error on size '%s' at %x" % (length, pos+1)
319            val = ord(minfile[pos])
320        return 0
321
322    def escape(self, nextpos) :
323        """Handles the ESC code."""
324        pos = endpos = nextpos
325        minfile = self.minfile
326        if minfile[pos : pos+8] == r"%-12345X" :
327            endpos = pos + 9
328            endmark = chr(0x0c) + chr(0x00) + chr(0x1b)
329            asciilimit = chr(0x80)
330            quotes = 0
331            while (minfile[endpos] not in endmark) and \
332                   ((minfile[endpos] < asciilimit) or (quotes % 2)) :
333                if minfile[endpos] == '"' :
334                    quotes += 1
335                endpos += 1
336
337            # Store this in a per page mapping.
338            # NB : First time will be at page 0 (i.e. **before** page 1) !
339            stuff = self.escapedStuff.setdefault(self.pagecount, [])
340            stuff.append(minfile[pos : endpos])
341            self.logdebug("Escaped datas : [%s]" % repr(minfile[pos : endpos]))
342        return endpos - pos
343
344    def skipKyoceraPrescribe(self, nextpos) :
345        """Skips Kyocera Prescribe commands."""
346        pos = nextpos - 1
347        minfile = self.minfile
348        if minfile[pos:pos+3] == "!R!" :
349            while (pos - nextpos) < 1024 :   # This is a realistic upper bound, to avoid infinite loops
350                if (minfile[pos] == ";") and (minfile[pos-4:pos] == "EXIT") :
351                    pos += 1
352                    prescribe = self.prescribeStuff.setdefault(self.pagecount, [])
353                    prescribe.append(minfile[nextpos-1:pos])
354                    self.logdebug("Prescribe commands : [%s]" % repr(minfile[nextpos-1:pos]))
355                    break
356                pos += 1
357            return (pos - nextpos)
358        else :
359            return 0
360
361    def getJobSize(self) :
362        """Counts pages in a PCLXL (PCL6) document.
363
364           Algorithm by Jerome Alet.
365
366           The documentation used for this was :
367
368           HP PCL XL Feature Reference
369           Protocol Class 2.0
370           http://www.hpdevelopersolutions.com/downloads/64/358/xl_ref20r22.pdf
371
372           Protocol Class 2.1 Supplement
373           xl_ref21.pdf
374
375           Protocol Class 3.0 Supplement
376           xl_refsup30r089.pdf
377        """
378
379        infileno = self.infile.fileno()
380        self.minfile = minfile = mmap.mmap(infileno, os.fstat(infileno)[6], prot=mmap.PROT_READ, flags=mmap.MAP_SHARED)
381
382        self.iscolor = False
383
384        found = False
385        while not found :
386            line = self.infile.readline()
387            if not line :
388                break
389            pos = line.find(" HP-PCL XL;")
390            if pos == -1 :
391                pos = line.find(" BROTHER XL2HB;")
392            if pos != -1 :
393                found = True
394                endian = ord(line[pos - 1])
395                if endian == 0x29 :
396                    self.littleEndian(0)
397                elif endian == 0x28 :
398                    self.bigEndian(0)
399                # elif endian == 0x27 : # TODO : This is the ASCII binding code : what does it do exactly ?
400                #
401                else :
402                    raise pdlparser.PDLParserError, "Unknown endianness marker 0x%02x at start !" % endian
403        if not found :
404            raise pdlparser.PDLParserError, "This file doesn't seem to be PCLXL (aka PCL6)"
405
406        # Initialize Media Sources
407        for i in range(8, 256) :
408            self.mediasources[i] = "ExternalTray%03i" % (i - 7)
409
410        # Initialize table of tags
411        self.tags = [ 0 ] * 256
412
413        self.tags[0x1b] = self.escape # The escape code
414
415        self.tags[0x21] = self.skipKyoceraPrescribe # 0x21 is not normally used
416
417        # GhostScript's sources tell us that HP printers
418        # only accept little endianness, but we can handle both.
419        self.tags[0x28] = self.bigEndian    # BigEndian
420        self.tags[0x29] = self.littleEndian # LittleEndian
421
422        self.tags[0x43] = self.beginPage    # BeginPage
423        self.tags[0x44] = self.endPage      # EndPage
424        self.tags[0x45] = self.reservedForFutureUse # reserved
425
426        self.tags[0x46] = self.x46_class3
427
428        self.tags[0x4a] = self.reservedForFutureUse # reserved
429        self.tags[0x4b] = self.reservedForFutureUse # reserved
430        self.tags[0x4c] = self.reservedForFutureUse # reserved
431        self.tags[0x4d] = self.reservedForFutureUse # reserved
432        self.tags[0x4e] = self.reservedForFutureUse # reserved
433
434        self.tags[0x56] = self.reservedForFutureUse # TODO : documentation not clear about reserved status
435
436        self.tags[0x57] = self.reservedForFutureUse # reserved
437
438        self.tags[0x59] = self.reservedForFutureUse # reserved
439        self.tags[0x5a] = self.reservedForFutureUse # reserved
440
441        self.tags[0x6a] = self.setColorSpace    # to detect color/b&w mode
442
443        self.tags[0x87] = self.reservedForFutureUse # reserved
444        self.tags[0x88] = self.reservedForFutureUse # reserved
445        self.tags[0x89] = self.reservedForFutureUse # reserved
446        self.tags[0x8a] = self.reservedForFutureUse # reserved
447
448        self.tags[0x8b] = self.reservedForFutureUse # reserved
449
450        self.tags[0x8c] = self.reservedForFutureUse # reserved
451        self.tags[0x8d] = self.reservedForFutureUse # reserved
452        self.tags[0x8e] = self.reservedForFutureUse # reserved
453        self.tags[0x8f] = self.reservedForFutureUse # reserved
454        self.tags[0x90] = self.reservedForFutureUse # reserved
455
456        self.tags[0x9a] = self.reservedForFutureUse # reserved
457        self.tags[0x9c] = self.reservedForFutureUse # reserved
458
459        self.tags[0xa4] = self.reservedForFutureUse # reserved
460        self.tags[0xa5] = self.reservedForFutureUse # reserved
461        self.tags[0xa6] = self.reservedForFutureUse # reserved
462        self.tags[0xa7] = self.reservedForFutureUse # reserved
463
464        self.tags[0xaa] = self.reservedForFutureUse # reserved
465        self.tags[0xab] = self.reservedForFutureUse # reserved
466        self.tags[0xac] = self.reservedForFutureUse # reserved
467        self.tags[0xad] = self.reservedForFutureUse # reserved
468        self.tags[0xae] = self.reservedForFutureUse # reserved
469        self.tags[0xaf] = self.reservedForFutureUse # reserved
470
471        self.tags[0xb7] = self.reservedForFutureUse # reserved
472
473        self.tags[0xba] = self.reservedForFutureUse # reserved
474        self.tags[0xbb] = self.reservedForFutureUse # reserved
475        self.tags[0xbc] = self.reservedForFutureUse # reserved
476        self.tags[0xbd] = self.reservedForFutureUse # reserved
477        self.tags[0xbe] = self.reservedForFutureUse # reserved
478
479        # self.tags[0xbf] = self.passThrough # PassThrough mode should already be taken care of automatically
480
481        self.tags[0xc0] = 1 # ubyte
482        self.tags[0xc1] = 2 # uint16
483        self.tags[0xc2] = 4 # uint32
484        self.tags[0xc3] = 2 # sint16
485        self.tags[0xc4] = 4 # sint32
486        self.tags[0xc5] = 4 # real32
487
488        self.tags[0xc6] = self.reservedForFutureUse # reserved
489        self.tags[0xc7] = self.reservedForFutureUse # reserved
490
491        self.tags[0xc8] = self.array_8  # ubyte_array
492        self.tags[0xc9] = self.array_16 # uint16_array
493        self.tags[0xca] = self.array_32 # uint32_array
494        self.tags[0xcb] = self.array_16 # sint16_array
495        self.tags[0xcc] = self.array_32 # sint32_array
496        self.tags[0xcd] = self.array_32 # real32_array and unfortunately Canon ImageRunner
497
498        self.tags[0xce] = self.reservedForFutureUse # reserved
499        self.tags[0xcf] = self.reservedForFutureUse # reserved
500
501        self.tags[0xd0] = 2 # ubyte_xy
502        self.tags[0xd1] = 4 # uint16_xy
503        self.tags[0xd2] = 8 # uint32_xy
504        self.tags[0xd3] = 4 # sint16_xy
505        self.tags[0xd4] = 8 # sint32_xy
506        self.tags[0xd5] = 8 # real32_xy
507        self.tags[0xd6] = self.reservedForFutureUse # reserved
508        self.tags[0xd7] = self.reservedForFutureUse # reserved
509        self.tags[0xd8] = self.reservedForFutureUse # reserved
510        self.tags[0xd9] = self.reservedForFutureUse # reserved
511        self.tags[0xda] = self.reservedForFutureUse # reserved
512        self.tags[0xdb] = self.reservedForFutureUse # reserved
513        self.tags[0xdc] = self.reservedForFutureUse # reserved
514        self.tags[0xdd] = self.reservedForFutureUse # reserved
515        self.tags[0xde] = self.reservedForFutureUse # reserved
516        self.tags[0xdf] = self.reservedForFutureUse # reserved
517
518        self.tags[0xe0] = 4  # ubyte_box
519        self.tags[0xe1] = 8  # uint16_box
520        self.tags[0xe2] = 16 # uint32_box
521        self.tags[0xe3] = 8  # sint16_box
522        self.tags[0xe4] = 16 # sint32_box
523        self.tags[0xe5] = 16 # real32_box
524        self.tags[0xe6] = self.reservedForFutureUse # reserved
525        self.tags[0xe7] = self.reservedForFutureUse # reserved
526        self.tags[0xe8] = self.reservedForFutureUse # reserved
527        self.tags[0xe9] = self.reservedForFutureUse # reserved
528        self.tags[0xea] = self.reservedForFutureUse # reserved
529        self.tags[0xeb] = self.reservedForFutureUse # reserved
530        self.tags[0xec] = self.reservedForFutureUse # reserved
531        self.tags[0xed] = self.reservedForFutureUse # reserved
532        self.tags[0xee] = self.reservedForFutureUse # reserved
533        self.tags[0xef] = self.reservedForFutureUse # reserved
534
535        self.tags[0xf0] = self.reservedForFutureUse # reserved
536        self.tags[0xf1] = self.reservedForFutureUse # reserved
537        self.tags[0xf2] = self.reservedForFutureUse # reserved
538        self.tags[0xf3] = self.reservedForFutureUse # reserved
539        self.tags[0xf4] = self.reservedForFutureUse # reserved
540        self.tags[0xf5] = self.reservedForFutureUse # reserved
541        self.tags[0xf6] = self.reservedForFutureUse # reserved
542        self.tags[0xf7] = self.reservedForFutureUse # reserved
543
544        self.tags[0xf8] = 1 # attr_ubyte
545        self.tags[0xf9] = 2 # attr_uint16
546
547        self.tags[0xfa] = self.embeddedData      # dataLength
548        self.tags[0xfb] = self.embeddedDataSmall # dataLengthByte
549
550        self.tags[0xfc] = self.reservedForFutureUse # reserved
551        self.tags[0xfd] = self.reservedForFutureUse # reserved
552        self.tags[0xfe] = self.reservedForFutureUse # reserved
553        self.tags[0xff] = self.reservedForFutureUse # reserved
554
555        # color spaces
556        self.BWColorSpace = "".join([chr(0x00), chr(0xf8), chr(0x03)])
557        self.GrayColorSpace = "".join([chr(0x01), chr(0xf8), chr(0x03)])
558        self.RGBColorSpace = "".join([chr(0x02), chr(0xf8), chr(0x03)])
559
560        # set number of copies
561        self.setNumberOfCopies = "".join([chr(0xf8), chr(0x31)])
562
563        # subcodes for undocumented tag 0x46 and the negative
564        # offset to grab the value from.
565        self.x46_functions = { 0x91 : 5,
566                               0x92 : 5,
567                               0x93 : 3,
568                               0x94 : 3,
569                               0x95 : 5,
570                               0x96 : 2,
571                               0x97 : 2,
572                               0x98 : 2,
573                             }
574
575        # Markers for Canon ImageRunner printers
576        self.imagerunnermarker1 = chr(0xcd) + chr(0xca) + chr(0x10) + chr(0x00)
577        self.imagerunnermarker2 = chr(0xcd) + chr(0xca) + chr(0x10) + chr(0x02)
578
579        self.pages = { 0 : { "copies" : 1,
580                             "orientation" : "Default",
581                             "mediatype" : "Plain",
582                             "mediasize" : "Default",
583                             "mediasource" : "Default",
584                             "duplex" : None,
585                           }
586                     }
587        tags = self.tags
588        self.pagecount = 0
589        self.escapedStuff = {}   # For escaped datas, mostly PJL commands
590        self.prescribeStuff = {} # For Kyocera Prescribe commands
591        pos = oldpos = 0
592        try :
593            try :
594                while 1 :
595                    try :
596                        tag = ord(minfile[pos])
597                    except OverflowError :
598                        pos = oldpos + 1
599                    pos += 1
600                    length = tags[tag]
601                    if length :
602                        if callable(length) :
603                            length = length(pos)
604                        oldpos = pos
605                        pos += length
606            except IndexError : # EOF ?
607                pass
608        finally :
609            self.minfile.close()
610
611        # now handle number of copies for each page (may differ).
612        if self.iscolor :
613            colormode = "Color"
614        else :
615            colormode = "BW"
616
617        defaultduplexmode = "Simplex"
618        defaultpapersize = ""
619        defaultpjlcopies = 1
620        oldpjlcopies = -1
621        oldduplexmode = ""
622        oldpapersize = ""
623        for pnum in range(1, self.pagecount + 1) :
624            # if no number of copies defined, take 1, as explained
625            # in PCLXL documentation.
626            # NB : is number of copies is 0, the page won't be output
627            # but the formula below is still correct : we want
628            # to decrease the total number of pages in this case.
629            page = self.pages.get(pnum, self.pages.get(1, { "copies" : 1, "mediasize" : "Default", "duplex" : None }))
630            pjlstuff = self.escapedStuff.get(pnum, self.escapedStuff.get(0, []))
631            if pjlstuff :
632                pjlparser = pjl.PJLParser("".join(pjlstuff))
633                nbdefaultcopies = int(pjlparser.default_variables.get("COPIES", -1))
634                nbcopies = int(pjlparser.environment_variables.get("COPIES", -1))
635                nbdefaultqty = int(pjlparser.default_variables.get("QTY", -1))
636                nbqty = int(pjlparser.environment_variables.get("QTY", -1))
637                if nbdefaultcopies > -1 :
638                    defaultpjlcopies = nbdefaultcopies
639                if nbdefaultqty > -1 :
640                    defaultpjlcopies = nbdefaultqty
641                if nbcopies > -1 :
642                    pjlcopies = nbcopies
643                elif nbqty > -1 :
644                    pjlcopies = nbqty
645                else :
646                    if oldpjlcopies == -1 :
647                        pjlcopies = defaultpjlcopies
648                    else :
649                        pjlcopies = oldpjlcopies
650                if page["duplex"] :
651                    duplexmode = page["duplex"]
652                else :
653                    defaultdm = pjlparser.default_variables.get("DUPLEX", "")
654                    if defaultdm :
655                        if defaultdm.upper() == "ON" :
656                            defaultduplexmode = "Duplex"
657                        else :
658                            defaultduplexmode = "Simplex"
659                    envdm = pjlparser.environment_variables.get("DUPLEX", "")
660                    if envdm :
661                        if envdm.upper() == "ON" :
662                            duplexmode = "Duplex"
663                        else :
664                            duplexmode = "Simplex"
665                    else :
666                        if not oldduplexmode :
667                            duplexmode = defaultduplexmode
668                        else :
669                            duplexmode = oldduplexmode
670                defaultps = pjlparser.default_variables.get("PAPER", "")
671                if defaultps :
672                    defaultpapersize = defaultps
673                envps = pjlparser.environment_variables.get("PAPER", "")
674                if envps :
675                    papersize = envps
676                else :
677                    if not oldpapersize :
678                        papersize = defaultpapersize
679                    else :
680                        papersize = oldpapersize
681            else :
682                if oldpjlcopies == -1 :
683                    pjlcopies = defaultpjlcopies
684                else :
685                    pjlcopies = oldpjlcopies
686                if not oldduplexmode :
687                    duplexmode = defaultduplexmode
688                else :
689                    duplexmode = oldduplexmode
690                if not oldpapersize :
691                    papersize = defaultpapersize
692                else :
693                    papersize = oldpapersize
694                duplexmode = oldduplexmode
695                papersize = oldpapersize or page["mediasize"]
696            if page["mediasize"] != "Default" :
697                papersize = page["mediasize"]
698            if not duplexmode :
699                duplexmode = oldduplexmode or defaultduplexmode
700            oldpjlcopies = pjlcopies
701            oldduplexmode = duplexmode
702            oldpapersize = papersize
703            copies = max(pjlcopies, page["copies"]) # Was : pjlcopies * page["copies"]
704            self.pagecount += (copies - 1)
705            self.logdebug("%s*%s*%s*%s*%s*%s*%s" % (copies,
706                                                 page["mediatype"],
707                                                 papersize,
708                                                 page["orientation"],
709                                                 page["mediasource"],
710                                                 duplexmode,
711                                                 colormode))
712        return self.pagecount
Note: See TracBrowser for help on using the browser.