Changeset 1475

Timestamp:

05/13/04 15:59:30 (20 years ago)

Author:

jalet

Message:

Code simplifications

Location:

pykota/trunk

Files:

• bin/pkhint (modified) (3 diffs)
• conf/pykota.conf.sample (modified) (8 diffs)
• docs/filterpykota.sgml (modified) (4 diffs)
• NEWS (modified) (1 diff)
• pykota/accounters/external.py (deleted)
• pykota/accounters/hardware.py (added)
• pykota/accounters/Makefile.am (modified) (1 diff)
• pykota/accounters/querying.py (deleted)
• pykota/accounters/software.py (added)
• pykota/accounters/stupid.py (deleted)
• pykota/config.py (modified) (4 diffs)
• pykota/requesters/external.py (modified) (3 diffs)
• pykota/requesters/Makefile.am (modified) (1 diff)
• pykota/requesters/snmp.py (deleted)
• pykota/tool.py (modified) (3 diffs)
• pykota/version.py (modified) (1 diff)
• README (modified) (5 diffs)
• setup.py (modified) (5 diffs)

pykota/trunk/bin/pkhint

@@ -24 +24 @@
 #
 # $Log$
+# Revision 1.7  2004/05/13 13:59:27  jalet
+# Code simplifications
+#
 # Revision 1.6  2004/03/30 12:59:47  jalet
 # Fixed path problem
@@ -211 +214 @@
                     snmpcommand = self.accepts(SNMPTESTS, hostname)
                     if snmpcommand is not None :
-                        accounter = "querying"
+                        accounter = "hardware"
                         requester = 'external(/usr/share/pykota/waitprinter.sh %(printer)s && ' + snmpcommand + ')'
                         configuration.append((printer, accounter, requester))
@@ -217 +220 @@
                         netpjlcommand = self.accepts(NETPJLTESTS, hostname, port)
                         if netpjlcommand is not None :
-                            accounter = "querying"
+                            accounter = "hardware"
                             requester = 'external(' + netpjlcommand + ')'
                             configuration.append((printer, accounter, requester))

pykota/trunk/conf/pykota.conf.sample

@@ -182 +182 @@
 # supported values :
 #
-#    - querying : asks the printer for its lifetime page counter
+#    - hardware : asks the printer for its lifetime page counter
 #                 via either SNMP, AppleTalk, or any external
 #                 command. This method is the method used by
 #                 default in PyKota since its beginning.
 #
-#    - external : delegates the job's size computation to any 
-#                 external command of your choice. A stupid and 
-#                 completely unreliable example, but which
-#                 shows what this command may be is :
-#
-#                   accounter: external(/bin/grep -c showpage)
-#
-#                 Another one, which should work with all DSC
-#                 compliant Postscript files :
-#
-#                   accounter: external(/bin/grep -c "%%Page:")
-#
-#                 Finally the new smart external accounter which
-#                 can handle both PostScript and PCL documents :
-#
-#                   accounter: external(/usr/bin/pkpgcounter)
-# 
-#    - stupid : counts the occurences of the 'showpage' postscript
-#               statement in the document to be printed.
-#               THIS IS NOT RELIABLE. This is just to serve as
-#               an example on how to implement your own accounting
-#               method. Use pkpgcounter instead.
-#
+#    - software : delegates the job's size computation to any 
+#                 external command of your choice. 
+#
+#                 best choice for this is probably to set it
+#                 this way :
+#
+#                   accounter: software(/usr/bin/pkpgcounter)
+#
+#                 pkpgcounter is a command line tool which is
+#                 part of PyKota and which can handle both
+#                 DSC compliant PostScript documents and PCL5
+#                 documents. More file formats will be added
+#                 in the future, as time permits.
+#
+#                 while pkpgcounter is the recommended value
+#                 you can use whatever command you want provided
+#                 that your command accepts the job's data on its
+#                 standard input and prints the job's size in pages
+#                 as a single integer on its standard output.
+# 
 # This value can be set either globally or on a per printer basis
 # If both are defined, the printer option has priority.
-# if not set it defaults to 'querying'.
-#
-# A script which seems to be accurate, copy it from the
-# untested/postscript directory to another place.
-# accounter: external(/usr/share/pykota/pagecount.sh)
-# WARNING : it may not work when multiple copies are asked.
-#           this breaks ghostscript, I don't know why yet.
+# if not set it defaults to 'hardware'.
 #
 # default value 
-accounter: querying
+accounter: hardware
+# accounter: software(/usr/bin/pkpgcounter)
 
 # Print Quota administrator
@@ -326 +318 @@
 
 # How to query the hpmarketing printer for its page counter.
-# THIS IS ONLY USED IF YOU HAVE SET 'accounter' TO 'querying'
+# THIS IS ONLY USED IF YOU HAVE SET 'accounter' TO 'hardware'
 # JUST COMMENT IT OUT IF YOU USE ANY OTHER ACCOUNTING METHOD.
 # (it would be ignored anyway)
@@ -332 +324 @@
 # In the lines below "%(printer)s" is automatically replaced
 # at run time with your printer's Fully Qualified Domain Name
+# for network printers.
 # e.g. myprinter.example.com
 #
-# Only snmp(community, oid) and external(command) are supported
+# Only value supported is : external(... your command here...) 
 #
 # Example : 
+#
 #     requester: external(/usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ")
-# and :
-#     requester: snmp(public, mib-2.43.10.2.1.4.1.1)
-# are equivalent
-#
-#################################################
-# NB : the 'snmp()' requester is now deprecated #
-# because it has some accuracy problems.        #
-# please use 'external()' instead.              #
-#################################################
 #
 # Another untested example, using npadmin :
+#
 #     requester: external(/usr/bin/npadmin --pagecount %(printer)s)
 #
@@ -355 +341 @@
 # pagecount.ps file from untested/netatalk into /etc or any 
 # appropriate location)
+#
 #     requester: external(/usr/share/pykota/papwaitprinter.sh "MyPrinter:LaserWriter@*" && /usr/bin/pap -p "MyPrinter:LaserWriter@*" /usr/share/pykota/pagecount.ps  2>/dev/null | /bin/grep -v status | /bin/grep -v Connect | /usr/bin/tail -1)
 #
@@ -361 +348 @@
 #     requester: external(/bin/cat /usr/share/pykota/pagecount.pjl >/dev/lp0 && /usr/bin/head -2 </dev/lp0 | /usr/bin/tail -1)
 # 
-# 
 # This value can be set either globally or per printer or both.
 # If both are defined, the printer option has priority.
-#
-# NB : The SNMP oid mib-2.43.10.2.1.4.1.1 works on HP Laserjet Printers, but it may
-#      be different with other brands, refer to your printer's documentation 
-#      for details. Also you may have to specify -v2c or -v3 depending on your 
-#      printer's support for different versions of the SNMP specification.
-#
 #
 # Some examples and comments provided by Bob Martel from csuohio.edu
@@ -382 +362 @@
 #
 # requester: external(/opt/local/net-snmp/bin/snmpwalk -v 1 -Cc -c public -Ov %(printer)s | grep Counter32 | tail -2 | head -1 | cut -d " " -f2)
-#
 #
 # An example using netcat and a preformatted PJL job which you can find
@@ -390 +369 @@
 # requester: external(/bin/nc -w 2 %(printer)s 9100 </usr/share/pykota/pagecount.pjl | /usr/bin/tail -2)
 #
-#
 # An example using the contributed pagecount.pl script which does 
 # the same as above, but should work on more printers : 
 #
 # requester: external(/usr/share/pykota/pagecount.pl %(printer)s 9100)
-#
 #
 # WARNING : In any case, when using an external requester, please test the command line outside
@@ -404 +381 @@
 # not yet finished (not all pages are printed, but the complete job is in 
 # the printer)
+#
+# YOU ABSOLUTELY HAVE TO BE SURE YOU HAVE A SCRIPT WHICH WAITS FOR THE
+# PRINTER BEING READY BEFORE ASKING FOR ITS INTERNAL PAGE COUNTER.
+#
+# PYKOTA INCLUDES SUCH SCRIPTS FOR SNMP AND APPLETALK PRINTERS, MORE TO COME
+#
+# default value
 requester: external(/usr/share/pykota/waitprinter.sh %(printer)s && /usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ")
 

pykota/trunk/docs/filterpykota.sgml

@@ -72 +72 @@
   
   <para>
-    When using the <literal>querying</literal> accounting method,
+    When using the <literal>hardware</literal> accounting method,
     <application>pykota</application> asks the printer for its internal page counter, reads from the Quota DataBase the internal
     page counter for this printer when the previous job was launched, computes the difference, and report it as the 
@@ -86 +86 @@
   
   <para>
-    When using the <literal>external</literal> accounting method,
+    When using the <literal>software</literal> accounting method,
     and if the user is still allowed to print,
     the command you specified is launched with the job's data on its 
@@ -92 +92 @@
     pages on a single line on its standard output. This number is then
     read by PyKota and used to update the current user's quota information.
-    Of course checks are also done like with the <literal>querying</literal>
+    Of course checks are also done like with the <literal>hardware</literal>
     accounting method, to see if the current job is allowed to be printed or not.
   </para>
@@ -108 +108 @@
 
 $Log$
+Revision 1.10  2004/05/13 13:59:28  jalet
+Code simplifications
+
 Revision 1.9  2004/03/03 19:35:36  jalet
 Spelling problem. Thanks to Jurandy Martins

pykota/trunk/NEWS

@@ -22 +22 @@
 PyKota NEWS :
 
+    - 1.19alpha8 :
+    
+        - 'querying' accounting method is now called 'hardware'
+        
+        - 'external' accounting method is now called 'software'
+        
+        - 'stupid' accounting method doesn't exist anymore
+        
+        - 'snmp' requester doesn't exist anymore
+        
+        - code simplifications in external requester
+        
     - 1.19alpha7 :
      

pykota/trunk/pykota/accounters/Makefile.am

@@ -2 +2 @@
 
 pykota_accounters_PYTHON =      \
-        external.py                             \
+        software.py                             \
         __init__.py                             \
-        querying.py                             \
-        stupid.py                               
+        hardware.py
 

pykota/trunk/pykota/config.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.46  2004/05/13 13:59:28  jalet
+# Code simplifications
+#
 # Revision 1.45  2004/03/01 10:22:30  jalet
 # Can now extract per printer pre and post hooks from the configuration file
@@ -303 +306 @@
         """Returns the accounter backend to use for a given printer.
         
-           if it is not set, it defaults to 'querying' which means ask printer
+           if it is not set, it defaults to 'hardware' which means ask printer
            for its internal lifetime page counter.
         """   
-        validaccounters = [ "querying", "stupid", "external" ]     
+        validaccounters = [ "hardware", "software" ]     
         fullaccounter = self.getPrinterOption(printername, "accounter").strip()
-        if fullaccounter.lower().startswith("external") :    
+        if fullaccounter.lower().startswith("software") :    
             try :
                 (accounter, args) = [x.strip() for x in fullaccounter.split('(', 1)]
@@ -343 +346 @@
         except PyKotaConfigError :    
             # No requester defined, maybe it is not needed if accounting method
-            # is not set to 'querying', but if we are called, then the accounting
-            # method really IS 'querying', and so there's a big problem.
+            # is not set to 'hardware', but if we are called, then the accounting
+            # method really IS 'hardware', and so there's a big problem.
             raise PyKotaConfigError, _("Option requester for printer %s was not set") % printername
         else :    
@@ -355 +358 @@
             if not args :
                 raise PyKotaConfigError, _("Invalid requester %s for printer %s") % (fullrequester, printername)
-            validrequesters = [ "snmp", "external" ] # TODO : add more requesters
+            validrequesters = [ "external" ] 
             requester = requester.lower()
             if requester not in validrequesters :

pykota/trunk/pykota/requesters/external.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.12  2004/05/13 13:59:30  jalet
+# Code simplifications
+#
 # Revision 1.11  2004/04/09 22:24:47  jalet
 # Began work on correct handling of child processes when jobs are cancelled by
@@ -63 +66 @@
 #
 
+import sys
 import os
+import popen2
+import signal
 from pykota.requester import PyKotaRequesterError
 
@@ -82 +88 @@
         if printer is None :
             raise PyKotaRequesterError, _("Unknown printer address in EXTERNAL(%s) for printer %s") % (commandline, self.printername)
-        answer = os.popen(commandline)
+        error = 1
+        pagecounter = None
+        child = popen2.Popen4(commandline)    
         try :
-            pagecounter = int(answer.readline().strip())
+            pagecounter = int(child.fromchild.readline().strip())
         except ValueError :    
+            pass
+        except IOError :    
+            # we were interrupted by a signal, certainely a SIGTERM
+            # caused by the user cancelling the current job
+            try :
+                os.kill(child.pid, signal.SIGTERM)
+            except :    
+                pass # already killed ?
+            self.kotabackend.logger.log_message(_("SIGTERM was sent to external requester %s (pid: %s)") % (commandline, child.pid), "info")
+        else :    
+            error = 0
+        child.fromchild.close()    
+        child.tochild.close()
+        status = child.wait()
+        if (not error) and os.WIFEXITED(status) and (not os.WEXITSTATUS(status)) :
+            return pagecounter
+        else :    
             raise PyKotaRequesterError, _("Unable to query printer %s via EXTERNAL(%s)") % (printer, commandline) 
-        answer.close()
-        return pagecounter
         

pykota/trunk/pykota/requesters/Makefile.am

@@ -3 +3 @@
 pykota_requesters_PYTHON =      \
         external.py                             \
-        __init__.py                             \
-        snmp.py
+        __init__.py
 

pykota/trunk/pykota/tool.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.86  2004/05/13 13:59:28  jalet
+# Code simplifications
+#
 # Revision 1.85  2004/05/11 08:26:27  jalet
 # Now catches connection problems to SMTP server
@@ -809 +812 @@
             
     def prehook(self, userpquota) :
-        """Allows pluging of an external hook before the job gets printed."""
+        """Allows plugging of an external hook before the job gets printed."""
         prehook = self.config.getPreHook(userpquota.Printer.Name)
         if prehook :
@@ -816 +819 @@
         
     def posthook(self, userpquota) :
-        """Allows pluging of an external hook after the job gets printed and/or denied."""
+        """Allows plugging of an external hook after the job gets printed and/or denied."""
         posthook = self.config.getPostHook(userpquota.Printer.Name)
         if posthook :

pykota/trunk/pykota/version.py

@@ -22 +22 @@
 #
 
-__version__ = "1.19alpha7_unofficial"
+__version__ = "1.19alpha8_unofficial"
 
 __doc__ = """PyKota : a complete Printing Quota Solution for CUPS and LPRng."""

pykota/trunk/README

@@ -43 +43 @@
         
         - Supports OpenLDAP as the Quota Storage backend.
-          Complete LDAP schema and sample tree are included.
+          Complete LDAP schema and sample empty tree are included.
           Plugging PyKota into your existing LDAP infrastructure
           is really easy thanks to PyKota's great configurability.
@@ -49 +49 @@
     Printers :        
     
+        - Hardware or Software accounting methods are completely
+          configurable.
+          
         - Supports any printer which can report its internal
-          page counter.
+          page counter. Can ask printers for their internal 
+          page counter via SNMP, Netatalk, or any other way.
+          This is completely configurable.
+          
+        - Supports PostScript and PCL5 printers natively,
+          more formats to come.
           
         - Supports any other printer via GhostScript.
           Depending on the printer some configuration may
           be needed.
-        
-        - Can ask printers for their internal page counter
-          via SNMP, Netatalk, or any other mean of your
-          choice. This is completely configurable.
-          
-        - External accounting methods are configurable.
             
     Quota systems :        
@@ -156 +158 @@
 implemented :
 
-  - The 'querying' method consists in querying the printer (via SNMP
+  - The 'hardware' method consists in querying the printer (via SNMP
     or Netatalk or any other method of your choice) for its total pages 
     counter.
@@ -168 +170 @@
     of one print job, but this is generally ok.
     
-  - The 'external' method consists in delegating the computation of the
+  - The 'software' method consists in delegating the computation of the
     job's size in number of pages to any external command of your choice.
     The command can read the job's data from its standard input and MUST
@@ -174 +176 @@
     account are reported immediately, both with CUPS and LPRng.
     
-  - The 'stupid' method consists in counting the 'showpage' PostSript  
-    statements in the job. THIS IS UNRELIABLE, SO DON'T USE IT, but 
-    can serve as an example if you plan to write your own accounting 
-    method for integration into PyKota. It basically works like the 
-    'external' method, but does the computation internally and in
-    a non-reliable way.
-  
 PyKota is known to work fine with HP Laserjet 2100 and 2200, and 
 Apple LaserWriter 16/600 PS, both with CUPS and LPRng, under 

pykota/trunk/setup.py

@@ -24 +24 @@
 #
 # $Log$
+# Revision 1.40  2004/05/13 13:59:27  jalet
+# Code simplifications
+#
 # Revision 1.39  2004/04/08 17:07:41  jalet
 # pkpgcounter added
@@ -173 +176 @@
     sys.exit(-1)
 
+from distutils import sysconfig
 sys.path.insert(0, "pykota")
 from pykota.version import __version__, __doc__
@@ -179 +183 @@
 ACTION_ABORT = 1
 
+def checkOldModule(path) :
+    """Checks if an old PyKota module is still in the destination (in case of upgrade)."""
+    fname = os.path.join(sysconfig.get_python_lib(), "pykota", path)
+    for ext in ["py", "pyc", "pyo"] :
+        fullname = "%s.%s" % (fname, ext)
+        if os.path.isfile(fullname) :
+            sys.stderr.write("ERROR : old module %s still exists. Remove it and restart installation.\n" % fullname)
+            sys.stderr.write("INSTALLATION ABORTED !\n")
+            sys.exit(-1)
+    
 def checkOldScript(cmd) :
     """Checks if an old shell script is still around in /usr/bin."""
@@ -282 +296 @@
                 sys.stderr.write("\nINSTALLATION ABORTED !\nPlease correct the problem and restart installation.\n")
                 sys.exit(-1)
+                
+        # now checks if pre-1.19alpha8 code is still there       
+        for module in ["accounters/querying", "accounters/external", "requesters/snmp"] :
+            checkOldModule(module)
         
     # Second stage, we will fail if onfiguration is incorrect for security reasons
@@ -348 +366 @@
     
     # WARNING MESSAGE    
-    sys.stdout.write("WARNING : IF YOU ARE UPGRADING FROM A PRE-1.14 TO 1.16 OR ABOVE\n")
+    sys.stdout.write("WARNING : IF YOU ARE UPGRADING FROM A PRE-1.19alpha7 TO 1.19alpha7 OR ABOVE\n")
     sys.stdout.write("AND USE THE POSTGRESQL BACKEND, THEN YOU HAVE TO MODIFY YOUR\n")
-    sys.stdout.write("DATABASE SCHEMA USING initscripts/postgresql/upgrade-to-1.14.sql\n")
-    sys.stdout.write("AND initscripts/postgresql/upgrade-to-1.16.sql\n")
+    sys.stdout.write("DATABASE SCHEMA USING initscripts/postgresql/upgrade-to-1.19.sql\n")
     sys.stdout.write("PLEASE READ DOCUMENTATION IN initscripts/postgresql/ TO LEARN HOW TO DO.\n")
     sys.stdout.write("YOU CAN DO THAT AFTER THE INSTALLATION IS FINISHED, OR PRESS CTRL+C NOW.\n")
-    sys.stdout.write("\n\nYOU DON'T HAVE ANYTHING SPECIAL TO DO IF THIS IS YOUR FIRST INSTALLATION\nOR IF YOU ARE ALREADY RUNNING VERSION 1.16 OR ABOVE.\n\n")
+    sys.stdout.write("\n\nYOU DON'T HAVE ANYTHING SPECIAL TO DO IF THIS IS YOUR FIRST INSTALLATION\nOR IF YOU ARE ALREADY RUNNING VERSION 1.19alpha7 OR ABOVE.\n\n")
     dummy = raw_input("Please press ENTER when you have read the message above. ")