root / pkpgcounter / trunk / pkpgpdls / analyzer.py @ 3436

Revision 3436, 10.4 kB (checked in by jerome, 15 years ago)

Removed spaces at EOL.

  • 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, 2004, 2005, 2006, 2007, 2008 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 is the main module of pkpgcounter.
23
24It defines the PDLAnalyzer class, which provides a generic way to parse
25input files, by automatically detecting the best parser to use."""
26
27import sys
28import os
29import tempfile
30
31import version, pdlparser, postscript, pdf, pcl345, pclxl, hbp, \
32       pil, mscrap, cfax, lidil, escp2, dvi, tiff, ooo, zjstream, \
33       pnmascii, bj, qpdl, spl1, escpages03, plain
34import inkcoverage
35
36class AnalyzerOptions :
37    """A class for use as the options parameter to PDLAnalyzer's constructor."""
38    def __init__(self, debug=None,
39                       colorspace=None,
40                       resolution=None) :
41        """Sets initial attributes."""
42        self.debug = debug
43        self.colorspace = colorspace
44        self.resolution = resolution
45
46
47class PDLAnalyzer :
48    """Class for PDL autodetection."""
49    def __init__(self, filename, options=AnalyzerOptions()) :
50        """Initializes the PDL analyzer.
51
52           filename is the name of the file or '-' for stdin.
53           filename can also be a file-like object which
54           supports read() and seek().
55        """
56        self.options = options
57        self.filename = filename
58        self.workfile = None
59        self.mustclose = None
60
61    def getJobSize(self) :
62        """Returns the job's size."""
63        size = 0
64        self.openFile()
65        try :
66            try :
67                pdlhandler = self.detectPDLHandler()
68                size = pdlhandler.getJobSize()
69            except pdlparser.PDLParserError, msg :
70                raise pdlparser.PDLParserError, "Unsupported file format for %s (%s)" % (self.filename, msg)
71        finally :
72            self.closeFile()
73        return size
74
75    def getInkCoverage(self, colorspace=None, resolution=None) :
76        """Extracts the percents of ink coverage from the input file."""
77        result = None
78        cspace = colorspace or self.options.colorspace
79        res = resolution or self.options.resolution
80        if (not cspace) or (not res) :
81            raise ValueError, "Invalid colorspace (%s) or resolution (%s)" % (cspace, res)
82        self.openFile()
83        try :
84            try :
85                pdlhandler = self.detectPDLHandler()
86                dummyfile = tempfile.NamedTemporaryFile(mode="w+b")
87                filename = dummyfile.name
88                try :
89                    pdlhandler.convertToTiffMultiPage24NC(filename, self.options.resolution)
90                    result = inkcoverage.getInkCoverage(filename, cspace)
91                finally :
92                    dummyfile.close()
93            except pdlparser.PDLParserError, msg :
94                raise pdlparser.PDLParserError, "Unsupported file format for %s (%s)" % (self.filename, msg)
95        finally :
96            self.closeFile()
97        return result
98
99    def openFile(self) :
100        """Opens the job's data stream for reading."""
101        self.mustclose = False  # by default we don't want to close the file when finished
102        if hasattr(self.filename, "read") and hasattr(self.filename, "seek") :
103            # filename is in fact a file-like object
104            infile = self.filename
105        elif self.filename == "-" :
106            # we must read from stdin
107            infile = sys.stdin
108        else :
109            # normal file
110            self.workfile = open(self.filename, "rb")
111            self.mustclose = True
112            return
113
114        # Use a temporary file, always seekable contrary to standard input.
115        self.workfile = tempfile.NamedTemporaryFile(mode="w+b")
116        self.filename = self.workfile.name
117        while True :
118            data = infile.read(pdlparser.MEGABYTE)
119            if not data :
120                break
121            self.workfile.write(data)
122        self.workfile.flush()
123        self.workfile.seek(0)
124
125    def closeFile(self) :
126        """Closes the job's data stream if we have to."""
127        if self.mustclose :
128            self.workfile.close()
129
130    def readFirstAndLastBlocks(self, inputfile) :
131        """Reads the first and last blocks of data."""
132        # Now read first and last block of the input file
133        # to be able to detect the real file format and the parser to use.
134        firstblock = inputfile.read(pdlparser.FIRSTBLOCKSIZE)
135        try :
136            inputfile.seek(-pdlparser.LASTBLOCKSIZE, 2)
137            lastblock = inputfile.read(pdlparser.LASTBLOCKSIZE)
138        except IOError :
139            lastblock = ""
140        return (firstblock, lastblock)
141
142    def detectPDLHandler(self) :
143        """Tries to autodetect the document format.
144
145           Returns the correct PDL handler class or None if format is unknown
146        """
147        if not os.stat(self.filename).st_size :
148            raise pdlparser.PDLParserError, "input file %s is empty !" % str(self.filename)
149        (firstblock, lastblock) = self.readFirstAndLastBlocks(self.workfile)
150
151        # IMPORTANT : the order is important below. FIXME.
152        for module in (postscript, \
153                       pclxl, \
154                       pdf, \
155                       qpdl, \
156                       spl1, \
157                       dvi, \
158                       tiff, \
159                       cfax, \
160                       zjstream, \
161                       ooo, \
162                       hbp, \
163                       lidil, \
164                       pcl345, \
165                       escp2, \
166                       escpages03, \
167                       bj, \
168                       pnmascii, \
169                       pil, \
170                       mscrap, \
171                       plain) :     # IMPORTANT : don't move this one up !
172            try :
173                return module.Parser(self, self.filename,
174                                           (firstblock, lastblock))
175            except pdlparser.PDLParserError :
176                pass # try next parser
177        raise pdlparser.PDLParserError, "Analysis of first data block failed."
178
179def main() :
180    """Entry point for PDL Analyzer."""
181    import optparse
182    from copy import copy
183
184    def check_cichoice(option, opt, value) :
185        """To add a CaseIgnore Choice option type."""
186        valower = value.lower()
187        if valower in [v.lower() for v in option.cichoices] :
188            return valower
189        else :
190            choices = ", ".join([repr(o) for o in option.cichoices])
191            raise optparse.OptionValueError(
192                "option %s: invalid choice: %r (choose from %s)"
193                % (opt, value, choices))
194
195    class MyOption(optparse.Option) :
196        """New Option class, with CaseIgnore Choice type."""
197        TYPES = optparse.Option.TYPES + ("cichoice",)
198        ATTRS = optparse.Option.ATTRS + ["cichoices"]
199        TYPE_CHECKER = copy(optparse.Option.TYPE_CHECKER)
200        TYPE_CHECKER["cichoice"] = check_cichoice
201
202    parser = optparse.OptionParser(option_class=MyOption,
203                                   usage="python analyzer.py [options] file1 [file2 ...]")
204    parser.add_option("-v", "--version",
205                            action="store_true",
206                            dest="version",
207                            help="Show pkpgcounter's version number and exit.")
208    parser.add_option("-d", "--debug",
209                            action="store_true",
210                            dest="debug",
211                            help="Activate debug mode.")
212    parser.add_option("-c", "--colorspace",
213                            dest="colorspace",
214                            type="cichoice",
215                            cichoices=["bw", "rgb", "cmyk", "cmy", "gc"],
216                            help="Activate the computation of ink usage, and defines the colorspace to use. Supported values are 'BW', 'RGB', 'CMYK', 'CMY', and 'GC'.")
217    parser.add_option("-r", "--resolution",
218                            type="int",
219                            default=72,
220                            dest="resolution",
221                            help="The resolution in DPI to use when checking ink usage. Lower resolution is faster but less accurate. Default is 72 dpi.")
222    (options, arguments) = parser.parse_args()
223    if options.version :
224        print "%s" % version.__version__
225    elif not (72 <= options.resolution <= 1200) :
226        sys.stderr.write("ERROR: the argument to the --resolution command line option must be between 72 and 1200.\n")
227        sys.stderr.flush()
228    else :
229        if (not arguments) or ((not sys.stdin.isatty()) and ("-" not in arguments)) :
230            arguments.append("-")
231        totalsize = 0
232        lines = []
233        try :
234            for arg in arguments :
235                try :
236                    parser = PDLAnalyzer(arg, options)
237                    if not options.colorspace :
238                        totalsize += parser.getJobSize()
239                    else :
240                        (cspace, pages) = parser.getInkCoverage()
241                        for page in pages :
242                            lineparts = []
243                            for k in cspace : # NB : this way we preserve the order of the planes
244                                try :
245                                    lineparts.append("%s : %s%%" % (k, ("%f" % page[k]).rjust(10)))
246                                except KeyError :
247                                    pass
248                            lines.append("      ".join(lineparts))
249                except (IOError, pdlparser.PDLParserError), msg :
250                    sys.stderr.write("ERROR: %s\n" % msg)
251                    sys.stderr.flush()
252        except KeyboardInterrupt :
253            sys.stderr.write("WARN: Aborted at user's request.\n")
254            sys.stderr.flush()
255        if not options.colorspace :
256            print "%i" % totalsize
257        else :
258            print "\n".join(lines)
259
260if __name__ == "__main__" :
261    main()
Note: See TracBrowser for help on using the browser.