Changeset 2385

Timestamp:

07/25/05 19:13:11 (19 years ago)

Author:

jerome

Message:

Added two new directives :

unknown_billingcode : defines what to do when printing if the billing code

used is not present in the database.

overwrite_jobticket : defines a command to launch when overwriting the username

or the billing code used is desirable (for example when
an user interaction should take place, see the work
of George Farris)

Severity : no support for this in the backend right now, so be patient (again).

Location:

pykota/trunk

Files:

• conf/pykota.conf.sample (modified) (1 diff)
• pykota/config.py (modified) (1 diff)

pykota/trunk/conf/pykota.conf.sample

@@ -307 +307 @@
 # If both are defined, the printer option has priority.
 # striptitle : smbprn.??????
+
+# Should we launch a command to overwrite the job's ticket ?
+# This allows a command to overwrite the username and/or the
+# billing code used.
+# If unset no command is launched and the job's username and
+# billing code are used as they are received.
+# If set, the command is launched.
+# To overwrite the job's ticket, the command has to print
+# on its standard output one or more of the following lines,
+# without any prefix or space character :
+#
+#    USERNAME=the_username_we_want_to_overwrite_with
+#    BILLINGCODE=the_billingcode_we_want_to_overwrite_with
+#
+# NB : the output 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,
+# if any, is used unchanged.
+# If only BILLINGCODE= lines are printed, the username is
+# used unchanged.
+#
+# This value can be set either globally or on a per printer basis
+# If both are defined, the printer option has priority.
+#
+# overwrite_jobticket : /path/to/some/script/or/command
+
+# What should we do when we print and the billing code used is
+# not present in the database ?
+# The default value is 'create' which adds the billing code to the
+# database.
+# Other values can be :
+#       deny
+#     which silently rejects the job.
+# or :
+#       deny(your script here)
+#     if you put the path to a script or command here, it is executed, for
+#     example you can open a popup window explaining why the job was
+#     rejected.
+#
+# This value can be set either globally or on a per printer basis
+# If both are defined, the printer option has priority.
+#
+# unknown_billingcode : create
 
 # What is the accounting backend to use

pykota/trunk/pykota/config.py

@@ -205 +205 @@
             return      # No prefix to strip off
             
+    def getOverwriteJobTicket(self, printername) :        
+        """Returns the overwrite_jobticket directive's content, or None if unset."""
+        try :
+            return self.getPrinterOption(printername, "overwrite_jobticket").strip()
+        except PyKotaConfigError :    
+            return      # No overwriting will be done
+        
+    def getUnknownBillingCode(self, printername) :        
+        """Returns the unknown_billingcode directive's content, or the default value if unset."""
+        validvalues = [ "CREATE", "DENY" ]
+        try :
+            fullvalue = self.getPrinterOption(printername, "unknown_billingcode")
+        except PyKotaConfigError :    
+            return ("CREATE", None)
+        else :    
+            try :
+                value = [x.strip() for x in fullvalue.split('(', 1)]
+            except ValueError :    
+                raise PyKotaConfigError, _("Invalid unknown_billingcode directive %s for printer %s") % (fullvalue, printername)
+            if len(value) == 1 :    
+                value.append("")
+            (value, args) = value    
+            if args.endswith(')') :
+                args = args[:-1]
+            value = value.upper()    
+            if (value == "DENY") and not args :
+                return ("DENY", None)
+            if value not in validvalues :
+                raise PyKotaConfigError, _("Directive unknown_billingcode in section %s only supports values in %s") % (printername, str(validvalues))
+            return (value, args)
+        
     def getPrinterEnforcement(self, printername) :    
         """Returns if quota enforcement should be strict or laxist for the current printer."""