Changeset 527 for pkpgcounter

Timestamp:

11/28/07 18:28:30 (17 years ago)

Author:

jerome

Message:

Now the presence of executable dependencies is tested at runtime.

Location:

pkpgcounter/trunk

Files:

• pkpgpdls/analyzer.py (modified) (3 diffs)
• pkpgpdls/dvi.py (modified) (1 diff)
• pkpgpdls/inkcoverage.py (modified) (1 diff)
• pkpgpdls/mscrap.py (modified) (2 diffs)
• pkpgpdls/ooo.py (modified) (1 diff)
• pkpgpdls/pcl345.py (modified) (1 diff)
• pkpgpdls/pclxl.py (modified) (1 diff)
• pkpgpdls/pdf.py (modified) (1 diff)
• pkpgpdls/pdlparser.py (modified) (4 diffs)
• pkpgpdls/pil.py (modified) (1 diff)
• pkpgpdls/plain.py (modified) (1 diff)
• pkpgpdls/postscript.py (modified) (3 diffs)
• pkpgpdls/tiff.py (modified) (1 diff)
• README (modified) (1 diff)

pkpgcounter/trunk/pkpgpdls/analyzer.py

@@ -57 +57 @@
         self.mustclose = None
         
-    def findExecutable(self, command) :
-        """Finds an executable in the PATH and returns True if found else False."""
-        for path in os.environ.get("PATH", "").split(":") :
-            fullname = os.path.abspath(os.path.join(os.path.expanduser(path), command))
-            if os.path.isfile(fullname) and os.access(fullname, os.X_OK) :
-                return True
-        return False
-        
     def getJobSize(self) :    
         """Returns the job's size."""
@@ -74 +66 @@
                 size = pdlhandler.getJobSize()
             except pdlparser.PDLParserError, msg :    
-                raise pdlparser.PDLParserError, "Unknown file format for %s (%s)" % (self.filename, msg)
+                raise pdlparser.PDLParserError, "Unsupported file format for %s (%s)" % (self.filename, msg)
         finally :    
             self.closeFile()
@@ -98 +90 @@
                     dummyfile.close()
             except pdlparser.PDLParserError, msg :    
-                raise pdlparser.PDLParserError, "Unknown file format for %s (%s)" % (self.filename, msg)
+                raise pdlparser.PDLParserError, "Unsupported file format for %s (%s)" % (self.filename, msg)
         finally :
             self.closeFile()

pkpgcounter/trunk/pkpgpdls/dvi.py

@@ -33 +33 @@
     """A parser for DVI documents."""
     totiffcommands = [ 'dvips -q -o - "%(infname)s" | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r"%(dpi)i" -sOutputFile="%(outfname)s" -' ]
+    required = [ "dvips", "gs" ]
     def isValid(self) :        
         """Returns True if data is DVI, else False."""

pkpgcounter/trunk/pkpgpdls/inkcoverage.py

@@ -25 +25 @@
 import sys
 
-from PIL import Image
+import pdlparser
 
-import pdlparser
+try :
+    from PIL import Image
+except ImportError :    
+    sys.stderr.write("ERROR: You MUST install the Python Imaging Library (python-imaging) for pkpgcounter to work.\n")
+    raise pdlparser.PDLParserError, "The Python Imaging Library is missing."
 
 def getPercent(img, nbpix) :

pkpgcounter/trunk/pkpgpdls/mscrap.py

@@ -32 +32 @@
     """A parser for that MS crap thing."""
     totiffcommands = [ 'xvfb-run -a abiword --import-extension=.doc --print="| gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r\"%(dpi)i\" -sOutputFile=\"%(outfname)s\" -" "%(infname)s"' ]
+    required = [ "xvfb-run", "xauth", "abiword", "gs" ]
     def isValid(self) :    
         """Returns True if data is MS crap, else False.
@@ -46 +47 @@
            or self.firstblock[2112:].startswith("MSWordDoc") :
             self.logdebug("DEBUG: Input file seems to be in a Microsoft shitty file format.")
-            return True
+            # Here we do the missing test because all commands will be needed even in page counting mode
+            if self.isMissing(self.required) :
+                return False
+            else :    
+                return True
         else :    
             return False

pkpgcounter/trunk/pkpgpdls/ooo.py

@@ -31 +31 @@
     """A parser for OpenOffice.org documents."""
     totiffcommands = [ 'xvfb-run -a abiword --import-extension=.odt --print="| gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r\"%(dpi)i\" -sOutputFile=\"%(outfname)s\" -" "%(infname)s"' ]
+    required = [ "xvfb-run", "xauth", "abiword", "gs" ]
     def isValid(self) :        
         """Returns True if data is OpenDocument, else False."""

pkpgcounter/trunk/pkpgpdls/pcl345.py

@@ -42 +42 @@
                        '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" -',
                      ]
+    required = [ "pcl6", "gs" ]
     mediasizes = {  # ESC&l####A
                     0 : "Default",

pkpgcounter/trunk/pkpgpdls/pclxl.py

@@ -36 +36 @@
                        '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" -',
                      ]
+    required = [ "pcl6", "gs" ]
     mediasizes = { 
                     0 : "Letter",

pkpgcounter/trunk/pkpgpdls/pdf.py

@@ -44 +44 @@
     """A parser for PDF documents."""
     totiffcommands = [ 'gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r"%(dpi)i" -sOutputFile="%(outfname)s" "%(infname)s"' ]
+    required = [ "gs" ]
     openmode = "rU"
     def isValid(self) :    

pkpgcounter/trunk/pkpgpdls/pdlparser.py

@@ -23 +23 @@
 import sys
 import os
-import popen2
 
 KILOBYTE = 1024    
@@ -41 +40 @@
 class PDLParser :
     """Generic PDL parser."""
-    totiffcommands = None        # Default command to convert to TIFF
-    openmode = "rb"              # Default file opening mode
+    totiffcommands = None       # Default command to convert to TIFF
+    required = []               # Default list of required commands
+    openmode = "rb"             # Default file opening mode
     def __init__(self, parent, (firstblock, lastblock)) :
         """Initialize the generic parser."""
@@ -71 +71 @@
             self.infile.close()
             
+    def findExecutable(self, command) :
+        """Finds an executable in the PATH and returns True if found else False."""
+        for cmd in [p.strip() for p in command.split("|")] : # | can separate alternatives for similar commands (e.g. a2ps|enscript)
+            for path in os.environ.get("PATH", "").split(":") :
+                fullname = os.path.abspath(os.path.join(os.path.expanduser(path), cmd))
+                if os.path.isfile(fullname) and os.access(fullname, os.X_OK) :
+                    return True
+        return False
+        
+    def isMissing(self, commands) :    
+        """Returns True if some required commands are missing, else False.""" 
+        howmanythere = 0
+        for command in commands :
+            if not self.findExecutable(command) :
+                sys.stderr.write("ERROR: %(command)s is missing or not executable. You MUST install it for pkpgcounter to be able to do what you want.\n" % locals())
+                sys.stderr.flush()
+            else :    
+                howmanythere += 1
+        if howmanythere == len(commands) :
+            return False
+        else :   
+            return True
+        
     def logdebug(self, message) :       
         """Logs a debug message if needed."""
@@ -89 +112 @@
         """   
         if self.totiffcommands :
+            if self.isMissing(self.required) :
+                raise PDLParserError, "At least one of the following commands is missing and should be installed for the computation of ink coverage : %s" % repr(self.required)
             infname = self.filename
             for totiffcommand in self.totiffcommands :

pkpgcounter/trunk/pkpgpdls/pil.py

@@ -23 +23 @@
 """This modules implements a page counter for image formats supported by the Python Imaging Library."""
 
-from PIL import Image
+import pdlparser
 
-import pdlparser
+try :
+    from PIL import Image
+except ImportError :    
+    sys.stderr.write("ERROR: You MUST install the Python Imaging Library (python-imaging) for pkpgcounter to work.\n")
+    raise pdlparser.PDLParserError, "The Python Imaging Library is missing."
+
 import version
 
 class Parser(pdlparser.PDLParser) :
     """A parser for plain text documents."""
-    totiffcommands = [ 'convert "%(infname)s" "%(outfname)s"',
-                     ]  
+    totiffcommands = [ 'convert "%(infname)s" "%(outfname)s"' ]  
+    required = [ "convert" ]
     def isValid(self) :    
         """Returns True if data is an image format supported by PIL, else False."""   

pkpgcounter/trunk/pkpgpdls/plain.py

@@ -31 +31 @@
                        'a2ps --borders 0 --quiet --portrait --no-header --columns 1 --output - "%(infname)s" | gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r"%(dpi)i" -sOutputFile="%(outfname)s" -',
                      ]  
+    required = [ "a2ps | enscript", "gs" ]
     openmode = "rU"                 
     def isValid(self) :    

pkpgcounter/trunk/pkpgpdls/postscript.py

@@ -25 +25 @@
 import sys
 import os
-import tempfile
-import popen2
 
 import pdlparser
@@ -34 +32 @@
     """A parser for PostScript documents."""
     totiffcommands = [ 'gs -sDEVICE=tiff24nc -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET -r"%(dpi)i" -sOutputFile="%(outfname)s" "%(infname)s"' ]
+    required = [ "gs" ]
     openmode = "rU"
     def isValid(self) :    
@@ -53 +52 @@
         """Get the count through GhostScript, useful for non-DSC compliant PS files."""
         self.logdebug("Internal parser sucks, using GhostScript instead...")
+        if self.isMissing(self.required) :
+            raise pdlparser.PDLParserError, "The gs interpreter is nowhere to be found in your PATH (%s)" % os.environ.get("PATH", "")
         infname = self.filename
         command = 'gs -sDEVICE=bbox -dPARANOIDSAFER -dNOPAUSE -dBATCH -dQUIET "%(infname)s" 2>&1 | grep -c "%%HiResBoundingBox:" 2>/dev/null'

pkpgcounter/trunk/pkpgpdls/tiff.py

@@ -32 +32 @@
 class Parser(pdlparser.PDLParser) :
     """A parser for TIFF documents."""
-    totiffcommands = [ '/bin/cp "%(infname)s" "%(outfname)s"' ]
+    totiffcommands = [ 'cp "%(infname)s" "%(outfname)s"' ]
+    required = [ "cp" ]
     def isValid(self) :        
         """Returns True if data is TIFF, else False."""

pkpgcounter/trunk/README

@@ -107 +107 @@
   3 - That's all !    
   
+DEPENDENCIES :
+
+  Depending on the file formats you plan to work with, and on the accounting
+  mode you want to use (pages vs ink), you may need to install some or all
+  of the additional software listed below. Usually, if one is needed then
+  pkpgcounter will complain. So your best bet is probably to not install
+  anything until pkpgcounter asks you to do so on its standard error
+  stream. Here's the list of software which may be needed for some
+  operations with pkpgcounter :
+
+  - GhostScript (gs)
   
-IMPORTANT : To compute ink coverage, pkpgcounter relies on third party
-software which must be installed. These third party software are :
+  - The Python Imaging Library (python-imaging)
+  
+  - The X Virtual Frame Buffer (xvfb)
+  
+  - The X authority file utility xauth (xbase-clients)
+  
+  - The dvips converter from TeX DVI to PostScript (tetex-bin)
+  
+  - The ImageMagick image manipulation toolkit (imagemagick)
+  
+  - The AbiWord word processor (abiword)
 
-        - GhostScript (this one is needed for all file formats).
-        
-        - The Python Imaging Library, aka PIL (this one is needed for all
-          file formats).
-        
-        - GhostPCL (this one is needed for the PCL3/4/5 and PCLXL formats)
-          
-        - The LaTeX typesetting software, in particular the dvips command
-          (this one is needed for the DVI file format).
-          
-        - ImageMagick (this one is needed for image file formats)  
+  - The GhostPCL/GhostPDL's pcl6 converter from PCL to PostScript
         
 =============================================================================