Changeset 1746

Timestamp:

09/27/04 21:56:27 (20 years ago)

Author:

jalet

Message:

Added internal handling for PJL queries over port tcp/9100. Now waits
for printer being idle before asking, just like with SNMP.

Location:

pykota/trunk

Files:

• conf/pykota.conf.sample (modified) (3 diffs)
• NEWS (modified) (1 diff)
• pykota/accounters/hardware.py (modified) (5 diffs)
• pykota/version.py (modified) (1 diff)

pykota/trunk/conf/pykota.conf.sample

@@ -213 +213 @@
 #                 e.g. myprinter.example.com
 #
-#         Example : 
+#         Recommended values :
+#
+#             accounter: hardware(snmp)
+#
+#               Extracts the printer's internal page counter via SNMP.
+#
+#         Or :
+#
+#             accounter: hardware(pjl)
+# 
+#               Extracts the printer's internal page counter via PJL queries over port tcp/9100.
+#
+#         Other Examples : 
 #         
 #             accounter: hardware(/usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ")
@@ -221 +233 @@
 #             accounter: hardware(/usr/bin/npadmin --pagecount %(printer)s)
 #         
-#         Another example, using the special 'snmp' value, which doesn't launch
-#         any subprocess but instead all SNMP processing is done from PyKota's main
-#         code (this is less configurable, but requires less CPU and can prevent zombies) : 
-#
-#             accounter: hardware(snmp)
-#
 #         Another example, for AppleTalk printers which works fine :
 #         (You may need the pap CUPS backend installed, and copy the 
@@ -275 +281 @@
 #         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
-#
-#         SOME OF THE ABOVE EXAMPLES DON'T USE SUCH A SCRIPT, YOU HAVE BEEN WARNED
+#   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
+#
+#   SOME OF THE ABOVE EXAMPLES DON'T USE SUCH A SCRIPT, YOU HAVE BEEN WARNED
+#
+#
+#   WITH THE SPECIAL MAGIC hardware(snmp) AND hardware(pjl) VALUES, PYKOTA
+#   TAKES CARE OF ALL THIS FOR YOU, SO PLEASE UNDERSTAND THAT IT IS PREFERABLE
+#   TO USE THESE TWO METHODS : THEY WORK FINE, REQUIRE LITTLE TO NO CPU,
+#   AND DO ALL THE HARD WORK AUTOMATICALLY. IF YOU REALLY NEED TO YOU CAN USE
+#   YOUR OWN EXTERNAL COMMANDS AS DESCRIBED ABOVE, JUST BE CAREFUL WITH THIS.
 #         
 #

pykota/trunk/NEWS

@@ -22 +22 @@
 PyKota NEWS :
 
+    - 1.20alpha16 :
+    
+        - Internal handling of socket based PJL queries over
+          port tcp/9100 is now available with the magic
+          'pjl' value in the hardware accounter.
+          
     - 1.20alpha15 :
     

pykota/trunk/pykota/accounters/hardware.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.26  2004/09/27 19:56:27  jalet
+# Added internal handling for PJL queries over port tcp/9100. Now waits
+# for printer being idle before asking, just like with SNMP.
+#
 # Revision 1.25  2004/09/27 09:21:37  jalet
 # Now includes printer's hostname in SNMP error messages
@@ -111 +115 @@
 
 import os
+import socket
 import time
 import signal
@@ -208 +213 @@
                 self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.printername)    
                 time.sleep(SNMPDELAY)
+                
+pjlMessage = "\033%-12345X@PJL USTATUSOFF\r\n@PJL USTATUS DEVICE=ON\r\n@PJL INFO STATUS\r\n@PJL INFO PAGECOUNT\r\n\033%-12345X"
+pjlStatusValues = {
+                    "10000" : "Powersave Mode",
+                    "10001" : "Ready Online",
+                    "10002" : "Ready Offline",
+                    "10003" : "Warming Up",
+                    "10004" : "Self Test",
+                    "10005" : "Reset",
+                    "10023" : "Printing",
+                  }
+class PJLAccounter :
+    """A class for PJL print accounting."""
+    def __init__(self, parent, printerhostname) :
+        self.parent = parent
+        self.printerHostname = printerhostname
+        self.printerInternalPageCounter = self.printerStatus = None
+        self.printerInternalPageCounter = self.printerStatus = None
+        self.timedout = 0
+        
+    def alarmHandler(self, signum, frame) :    
+        """Query has timedout, handle this."""
+        self.timedout = 1
+        raise IOError, "Waiting for PJL answer timed out. Please try again later."
+        
+    def retrievePJLValues(self) :    
+        """Retrieves a printer's internal page counter and status via PJL."""
+        port = 9100
+        sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        try :
+            sock.connect((self.printerHostname, port))
+        except socket.error, msg :
+            self.parent.filter.printInfo(_("Problem during connection to %s:%s : %s") % (self.printerHostname, port, msg), "warn")
+        else :
+            try :
+                sock.send(pjlMessage)
+            except socket.error, msg :
+                self.parent.filter.printInfo(_("Problem while sending PJL query to %s:%s : %s") % (self.printerHostname, port, msg), "warn")
+            else :    
+                actualpagecount = self.printerStatus = None
+                self.timedout = 0
+                while (self.timedout = 0) or (actualpagecount is None) or (self.printerStatus is None) :
+                    signal.signal(signal.SIGALRM, self.alarmHandler)
+                    signal.alarm(5)
+                    try :
+                        answer = sock.recv(1024)
+                    except IOError, msg :    
+                        break   # our alarm handler was launched, probably
+                    else :    
+                        readnext = 0
+                        for line in [l.strip() for l in answer.split()] : 
+                            if line.startswith("CODE=") :
+                                self.printerStatus = line.split("=")[1]
+                            elif line.startswith("PAGECOUNT") :    
+                                readnext = 1 # page counter is on next line
+                            elif readnext :    
+                                actualpagecount = int(line.strip())
+                                readnext = 0
+                    signal.alarm(0)
+                self.printerInternalPageCounter = max(actualpagecount, self.printerInternalPageCounter)
+        sock.close()
+        
+    def waitPrinting(self) :
+        """Waits for printer status being 'printing'."""
+        while 1:
+            self.retrievePJLValues()
+            if self.printerStatus in ('10000', '10001', '10023') :
+                break
+            # In reality, and if I'm not mistaken, we will NEVER get there.    
+            self.parent.filter.logdebug(_("Waiting for printer %s to be idle or printing...") % self.parent.filter.printername)
+            time.sleep(ITERATIONDELAY)
+        
+    def waitIdle(self) :
+        """Waits for printer status being 'idle'."""
+        idle_num = idle_flag = 0
+        while 1 :
+            self.retrievePJLValues()
+            idle_flag = 0
+            if self.printerStatus in ('10000', '10001',) :
+                idle_flag = 1
+            if idle_flag :    
+                idle_num += 1
+                if idle_num > STABILIZATIONDELAY :
+                    # printer status is stable, we can exit
+                    break
+            else :    
+                idle_num = 0
+            self.parent.filter.logdebug(_("Waiting for printer %s's idle status to stabilize...") % self.parent.filter.printername)
+            time.sleep(ITERATIONDELAY)
     
 class Accounter(AccounterBase) :
@@ -289 +383 @@
         """
         commandline = self.arguments.strip() % locals()
-        if commandline.lower() == "snmp" :
+        cmdlower = commandline.lower()
+        if cmdlower == "snmp" :
             if hasSNMP :
                 return self.askWithSNMP(printer)
             else :    
                 raise PyKotaAccounterError, _("Internal SNMP accounting asked, but Python-SNMP is not available. Please download it from http://pysnmp.sourceforge.net")
+        elif cmdlower == "pjl" :
+            return self.askWithPJL(printer)
             
         if printer is None :
@@ -355 +452 @@
                 self.filter.printInfo(_("SNMP querying stage interrupted. Using latest value seen for internal page counter (%s) on printer %s.") % (acc.printerInternalPageCounter, self.filter.printername), "warn")
         return acc.printerInternalPageCounter
+        
+    def askWithPJL(self, printer) :
+        """Returns the page counter from the printer via internal PJL handling."""
+        acc = PJLAccounter(self, printer)
+        try :
+            if (os.environ.get("PYKOTASTATUS") != "CANCELLED") and \
+               (os.environ.get("PYKOTAACTION") != "DENY") and \
+               (os.environ.get("PYKOTAPHASE") == "AFTER") :
+                acc.waitPrinting()
+            acc.waitIdle()    
+        except :    
+            if acc.printerInternalPageCounter is None :
+                raise
+            else :    
+                self.filter.printInfo(_("PJL querying stage interrupted. Using latest value seen for internal page counter (%s) on printer %s.") % (acc.printerInternalPageCounter, self.filter.printername), "warn")
+        return acc.printerInternalPageCounter

pykota/trunk/pykota/version.py

@@ -22 +22 @@
 #
 
-__version__ = "1.20alpha15_unofficial"
+__version__ = "1.20alpha16_unofficial"
 
 __doc__ = """PyKota : a complete Printing Quota Solution for CUPS and LPRng."""