Changeset 2895

Timestamp:

05/23/06 23:28:39 (19 years ago)

Author:

jerome

Message:

Introduced the 'askconfirmation' directive in pykota.conf

Location:

pykota/trunk

Files:

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

pykota/trunk/bin/cupspykota

@@ -371 +371 @@
         self.logdebug("Job's attributes sanitizing done.")
                 
+    def didUserConfirm(self) :
+        """Asks for user confirmation through an external script.
+        
+           returns False if the end user wants to cancel the job, else True.
+        """
+        self.logdebug("Checking if we have to ask for user's confirmation...")
+        answer = None                         
+        confirmationcommand = self.config.getAskConfirmation(self.PrinterName)
+        if confirmationcommand :
+            self.logdebug("Launching subprocess [%s] to ask for user confirmation." \
+                                     % confirmationcommand)
+            inputfile = os.popen(confirmationcommand, "r")
+            try :
+                for answer in inputfile.xreadlines() :
+                    answer = answer.strip().upper()
+                    if answer == "CANCEL" :
+                        break
+            except IOError, msg :            
+                self.logdebug("IOError while reading subprocess' output : %s" % msg)
+            inputfile.close()    
+            self.logdebug("User's confirmation received : %s" % (((answer == "CANCEL") and "CANCEL") or "CONTINUE"))
+        else :    
+            self.logdebug("No need to ask for user's confirmation, job processing will continue.")
+        return (answer != "CANCEL")    
+        
     def overwriteJobTicket(self) :    
         """Should we overwrite the job's ticket (username and billingcode) ?"""
         self.logdebug("Checking if we need to overwrite the job ticket...")
         jobticketcommand = self.config.getOverwriteJobTicket(self.PrinterName)
-        if jobticketcommand is not None :
+        if jobticketcommand :
             username = billingcode = action = None
             self.logdebug("Launching subprocess [%s] to overwrite the job ticket." \
@@ -1020 +1045 @@
         
         if self.Action not in ("DENY", "CANCEL") : 
+            if not self.didUserConfirm() :
+                self.Action = "CANCEL"
+                self.Reason = _("Print job cancelled.")
+                os.environ["PYKOTASTATUS"] = "CANCELLED"
+                
+        if self.Action not in ("DENY", "CANCEL") : 
             if self.Printer.MaxJobSize and (self.softwareJobSize > self.Printer.MaxJobSize) :
                 # This printer was set to refuse jobs this large.

pykota/trunk/conf/pykota.conf.sample

@@ -459 +459 @@
 #    CANCEL
 #
-# NB : the output is entirely read, and the latest value
-# seen is used, so you command can output several usernames
+# NB : the output of your command is entirely read, and the latest 
+# value seen is used, so you command can output several usernames
 # or billing codes and only the latest ones will be used.
 # If only USERNAME= lines are printed, the billing code,
@@ -475 +475 @@
 # overwrite_jobticket : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 180 --denyafter 3 --checkauth --ask "Username:username:$PYKOTAUSERNAME" "Password:password:"
 # overwrite_jobticket : /path/to/some/script/or/command
+
+
+
+# Should we ask the end user for a confirmation about their print job ?
+#
+# Any script can be launched here. If your script prints CANCEL on
+# its standard output, the job is cancelled, else processing of the
+# job continues to next step.
+#
+# NB : the output of your command is read until CANCEL is found
+# or all lines have been read.
+#
+# This value can be set either globally or on a per printer basis
+# If both are defined, the printer option has priority.
+#
+# examples :
+#
+# askconfirmation : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 120 --confirm "Hello $PYKOTAUSERNAME.\nPrint job $PYKOTAJOBID send to printer $PYKOTAPRINTERNAME is $PYKOTAPRECOMPUTEDJOBSIZE pages long\nand will cost you $PYKOTAPRECOMPUTEDJOBPRICE credits.\n\nYou currently have $PYKOTABALANCE credits.\n\nDo you really want to print ?"
 
 

pykota/trunk/NEWS

@@ -24 +24 @@
     - 1.25alpha4 (2006-05-22) :
     
+        - Introduced the 'askconfirmation' directive to interact with
+          the end user through any script (pknotify is recommended)
+          and see if he really wants to print when knowing the cost
+          of the job.
+          
         - Now uses pkipplib if present to directly retrieve the job
           information from the CUPS server over IPP.

pykota/trunk/pykota/config.py

@@ -249 +249 @@
             return      # No prefix to strip off
             
+    def getAskConfirmation(self, printername) :        
+        """Returns the askconfirmation directive's content, or None if unset."""
+        try :
+            return self.getPrinterOption(printername, "askconfirmation").strip()
+        except PyKotaConfigError :    
+            return      # No overwriting will be done
+            
     def getOverwriteJobTicket(self, printername) :        
         """Returns the overwrite_jobticket directive's content, or None if unset."""