Changeset 2759

Timestamp:

02/27/06 19:00:44 (19 years ago)

Author:

jerome

Message:

Added support for an extended syntax for the 'onbackenderror' directive.

Location:

pykota/trunk

Files:

• bin/cupspykota (modified) (6 diffs)
• conf/pykota.conf.sample (modified) (2 diffs)
• NEWS (modified) (1 diff)
• pykota/config.py (modified) (1 diff)
• pykota/version.py (modified) (1 diff)

pykota/trunk/bin/cupspykota

@@ -27 +27 @@
 import sys
 import os
+import time
 import errno
 import tempfile
@@ -1018 +1019 @@
                 self.Action = "PROBLEM"
                 self.exportReason()
-                if onbackenderror == "NOCHARGE" :
+                if "NOCHARGE" in onbackenderror :
                     self.JobSize = 0
                     self.printInfo(_("Job size forced to 0 because the real CUPS backend failed. No accounting will be done."), "warn")
@@ -1033 +1034 @@
             else :    
                 self.UserPQuota.resetDenyBannerCounter()
-                if (self.Action != "PROBLEM") or (onbackenderror == "CHARGE") : 
+                if (self.Action != "PROBLEM") or ("CHARGE" in onbackenderror) : 
                     self.JobSize = self.accounter.getJobSize(self.Printer)
                     self.sanitizeJobSize()
@@ -1039 +1040 @@
             self.printInfo(_("Job size : %i") % self.JobSize)
             
-            if ((self.Action == "PROBLEM") and (onbackenderror == "NOCHARGE")) or \
+            if ((self.Action == "PROBLEM") and ("NOCHARGE" in onbackenderror)) or \
                 (self.Action in ("DENY", "CANCEL")) :
                 self.JobPrice = 0.0
@@ -1061 +1062 @@
             if hasattr(self, "BillingCode") and self.BillingCode and self.BillingCode.Exists :
                 if (self.Action in ("ALLOW", "WARN")) or \
-                   ((self.Action == "PROBLEM") and (onbackenderror == "CHARGE")) :
+                   ((self.Action == "PROBLEM") and ("CHARGE" in onbackenderror)) :
                     self.BillingCode.consume(self.JobSize, self.JobPrice)
                     self.printInfo(_("Billing code %s was updated.") % self.BillingCode.BillingCode)
@@ -1087 +1088 @@
         """Sends the job's datas to the real backend."""
         self.logdebug("Sending job's datas to real backend...")
-        if self.InputFile is None :
-            infile = open(self.DataFile, "rb")
-        else :    
-            infile = None
-        retcode = self.runOriginalBackend(infile)
-        if self.InputFile is None :
-            infile.close()
+        
+        delay = 0
+        number = 1
+        for onb in self.config.getPrinterOnBackendError(self.PrinterName) :
+            if onb.startswith("RETRY:") :
+                try :
+                    (number, delay) = [int(p) for p in onb[6:].split(":", 2)]
+                    if (number < 0) or (delay < 0) :
+                        raise ValueError
+                except ValueError :    
+                    self.printInfo(_("Incorrect value for the 'onbackenderror' directive in section [%s]") % self.PrinterName, "error")
+                    delay = 0
+                    number = 1
+                else :    
+                    break
+        loopcnt = 1 
+        while True :            
+            if self.InputFile is None :
+                infile = open(self.DataFile, "rb")
+            else :    
+                infile = None
+            retcode = self.runOriginalBackend(infile)
+            if self.InputFile is None :
+                infile.close()
+            if not retcode :
+                break
+            else :
+                if (not number) or (loopcnt < number) :
+                    self.logdebug(_("The real backend produced an error, we will try again in %s seconds.") % delay)
+                    time.sleep(delay)
+                    loopcnt += 1
+                else :    
+                    break
+            
         self.logdebug("Job's datas sent to real backend.")
         return retcode

pykota/trunk/conf/pykota.conf.sample

@@ -327 +327 @@
 # When the real CUPS backend fail, should we modify the
 # user's page counters and account balance or not ?
+# Also should we retry and if yes then how often and how many times ?
 # If you trust your users, set it to "nocharge".
 # If you think they found some mean to kill the real CUPS backend, 
 # then set it to "charge".
+# If your print queues get regularly disabled by CUPS when the printers
+# are switched off, you might want to set it to "retry:N:S" where
+# N is the number of times the operation should be retried, and S is
+# the delay in seconds during which PyKota will sleep before trying again.
+# If N is 0, PyKota will retry indefinitely each S seconds until the
+# backend succeeds, so you should use this with caution. If N is 0,
+# of course neither "charge" nor "nocharge" will be honored.
+# You can combine "charge" or "nocharge" with "retry:N:S" if you want,
+# by separating the values with a comma as shown in the examples below.
 # If unset, the default value is "nocharge", meaning that users won't be
 # charged whenever a CUPS backend fails. This is the OPPOSITE
@@ -335 +345 @@
 # This value can be set either globally or on a per printer basis
 # If both are defined, the printer option has priority.
+# onbackenderror : charge,retry:5:60
+# onbackenderror : retry:0:300
+# onbackenderror : retry:3:300,nocharge
 # onbackenderror : charge
 onbackenderror : nocharge

pykota/trunk/NEWS

@@ -22 +22 @@
 PyKota NEWS :
        
+    - 1.24alpha15 :
+    
+        - Extended the functionnality of the 'onbackenderror' directive to
+          allow for configurable retries.
+          
     - 1.24alpha14 :
     

pykota/trunk/pykota/config.py

@@ -299 +299 @@
             action = self.getPrinterOption(printername, "onbackenderror")
         except PyKotaConfigError :    
-            return "NOCHARGE"
-        else :    
-            action = action.upper()
-            if action not in validactions :
-                raise PyKotaConfigError, _("Option onbackenderror in section %s only supports values in %s") % (printername, str(validactions))
+            return ["NOCHARGE"]
+        else :    
+            action = action.upper().split(",")
+            error = False
+            for act in action :
+                if act not in validactions :
+                    if act.startswith("RETRY:") :
+                        try :
+                            (num, delay) = [int(p) for p in act[6:].split(":", 2)]
+                        except ValueError :    
+                            error = True
+                    else :        
+                        error = True
+            if error :
+                raise PyKotaConfigError, _("Option onbackenderror in section %s only supports values 'charge', 'nocharge', and 'retry:num:delay'") % printername
             return action  
             

pykota/trunk/pykota/version.py

@@ -22 +22 @@
 #
 
-__version__ = "1.24alpha14_unofficial"
+__version__ = "1.24alpha15_unofficial"
 
 __doc__ = "PyKota : a complete Printing Quota Solution for CUPS."