Changeset 1582

Timestamp:

07/01/04 19:45:49 (20 years ago)

Author:

jalet

Message:

Added code to handle the description field for printers

Location:

pykota/trunk

Files:

• bin/pkprinters (modified) (9 diffs)
• cgi-bin/printquota.cgi (modified) (2 diffs)
• man/edpykota.1 (modified) (1 diff)
• man/pkhint.1 (modified) (1 diff)
• man/pkprinters.1 (modified) (4 diffs)
• man/pykotme.1 (modified) (1 diff)
• man/repykota.1 (modified) (1 diff)
• man/warnpykota.1 (modified) (1 diff)
• NEWS (modified) (1 diff)
• pykota/reporter.py (modified) (3 diffs)
• pykota/storage.py (modified) (3 diffs)
• pykota/storages/ldapstorage.py (modified) (6 diffs)
• pykota/storages/sql.py (modified) (4 diffs)
• pykota/tool.py (modified) (2 diffs)

pykota/trunk/bin/pkprinters

@@ -24 +24 @@
 #
 # $Log$
+# Revision 1.12  2004/07/01 17:45:47  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.11  2004/06/18 13:34:48  jalet
 # Now all tracebacks include PyKota's version number
@@ -87 +90 @@
                        
   -d | --delete        Deletes printers from the quota storage.
+  
+  -D | --description   Adds a textual description to printers.
                        
   -c | --charge p[,j]  Sets the price per page and per job to charge.
@@ -122 +127 @@
 examples :                              
 
-  $ pkprinters --add --charge 0.05,0.1 hp2100 hp2200 hp8000
+  $ pkprinters --add -D "HP Printer" --charge 0.05,0.1 hp2100 hp2200 hp8000
   
   Will create three printers named hp2100, hp2200 and hp8000.
@@ -128 +133 @@
   per job will be set at 0.1 unit. Units are in your own currency,
   or whatever you want them to mean.
-  If any of these printers already exists, it is not modified at
-  all.
+  All of their descriptions will be set to the string "HP Printer".
+  If any of these printers already exists, it will also be modified 
+  unless the -s|--skipexisting command line option is also used.
             
   $ pkprinters --delete "*"
@@ -191 +197 @@
                 if printer.Exists :
                     if options["skipexisting"] :
-                        self.logger.log_message(_("Printer %s already exists, skipping.") % printer.Name, "warn")
+                        self.printError(_("Printer %s already exists, skipping.") % printer.Name)
                     else :    
-                        self.logger.log_message(_("Printer %s already exists, will be modified.") % printer.Name, "warn")
+                        self.printError(_("Printer %s already exists, will be modified.") % printer.Name)
                         printers.append(printer)
                 else :
@@ -216 +222 @@
                 if parents : 
                     parents = "%s %s" % (_("in"), parents)
-                print "%s (%s + #*%s) %s" % \
-                      (printer.Name, printer.PricePerJob, \
+                print "%s [%s] (%s + #*%s) %s" % \
+                      (printer.Name, printer.Description, printer.PricePerJob, \
                        printer.PricePerPage, parents)
             else :    
                 if options["charge"] :
                     printer.setPrices(perpage, perjob)    
+                if options["description"] is not None :
+                    printer.setDescription(options["description"].strip())
                 if options["groups"] :    
                     for pgroup in printersgroups :
@@ -232 +240 @@
     retcode = 0
     try :
-        short_options = "hvac:dg:lrs"
-        long_options = ["help", "version", "add", "charge=", "delete", "groups=", "list", "remove", "skipexisting"]
+        short_options = "hvac:D:dg:lrs"
+        long_options = ["help", "version", "add", "charge=", "description=", "delete", "groups=", "list", "remove", "skipexisting"]
         
         # Initializes the command line tool
@@ -246 +254 @@
         options["add"] = options["a"] or options["add"]
         options["charge"] = options["c"] or options["charge"]
+        options["description"] = options["D"] or options["description"]
         options["delete"] = options["d"] or options["delete"] 
         options["groups"] = options["g"] or options["groups"]
@@ -256 +265 @@
         elif options["version"] :
             manager.display_version_and_quit()
-        elif (options["delete"] and (options["add"] or options["groups"] or options["charge"] or options["remove"])) \
+        elif (options["delete"] and (options["add"] or options["groups"] or options["charge"] or options["remove"] or options["description"])) \
            or (options["skipexisting"] and not options["add"]) \
-           or (options["list"] and (options["add"] or options["delete"] or options["groups"] or options["charge"] or options["remove"])) :
+           or (options["list"] and (options["add"] or options["delete"] or options["groups"] or options["charge"] or options["remove"] or options["description"])) :
             raise PyKotaToolError, _("incompatible options, see help.")
         elif options["remove"] and not options["groups"] :    

pykota/trunk/cgi-bin/printquota.cgi

@@ -23 +23 @@
 #
 # $Log$
+# Revision 1.30  2004/07/01 17:45:48  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.29  2004/06/06 21:07:55  jalet
 # Improved CGI script to allow history on printers and hostnames.
@@ -189 +192 @@
         for printer in printers :
             if printer.Name in selectednames :
-                message += '<option value="%s" selected="selected">%s</option>' % (printer.Name, printer.Name)
+                message += '<option value="%s" selected="selected">%s (%s)</option>' % (printer.Name, printer.Name, printer.Description)
             else :
-                message += '<option value="%s">%s</option>' % (printer.Name, printer.Name)
+                message += '<option value="%s">%s (%s)</option>' % (printer.Name, printer.Name, printer.Description)
         message += '</select></td></tr></table>'
         return message

pykota/trunk/man/edpykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH EDPYKOTA "1" "June 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH EDPYKOTA "1" "July 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
 edpykota \- manual page for edpykota 1.19alpha28_unofficial

pykota/trunk/man/pkhint.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH PKHINT "1" "June 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKHINT "1" "July 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
 pkhint \- manual page for pkhint 1.19alpha28_unofficial

pykota/trunk/man/pkprinters.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH PKPRINTERS "1" "June 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PKPRINTERS "1" "July 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
 pkprinters \- manual page for pkprinters 1.19alpha28_unofficial
@@ -26 +26 @@
 \fB\-d\fR | \fB\-\-delete\fR
 Deletes printers from the quota storage.
+.TP
+\fB\-D\fR | \fB\-\-description\fR
+Adds a textual description to printers.
 .TP
 \fB\-c\fR | \fB\-\-charge\fR p[,j]
@@ -65 +68 @@
 examples :
 .IP
-\f(CW$ pkprinters --add --charge 0.05,0.1 hp2100 hp2200 hp8000\fR
+\f(CW$ pkprinters --add -D "HP Printer" --charge 0.05,0.1 hp2100 hp2200 hp8000\fR
 .IP
 Will create three printers named hp2100, hp2200 and hp8000.
@@ -71 +74 @@
 per job will be set at 0.1 unit. Units are in your own currency,
 or whatever you want them to mean.
-If any of these printers already exists, it is not modified at
-all.
+All of their descriptions will be set to the string "HP Printer".
+If any of these printers already exists, it will also be modified
+unless the \fB\-s\fR|--skipexisting command line option is also used.
 .IP
 \f(CW$ pkprinters --delete "*"\fR

pykota/trunk/man/pykotme.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH PYKOTME "1" "June 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH PYKOTME "1" "July 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
 pykotme \- manual page for pykotme 1.19alpha28_unofficial

pykota/trunk/man/repykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH REPYKOTA "1" "June 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH REPYKOTA "1" "July 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
 repykota \- manual page for repykota 1.19alpha28_unofficial

pykota/trunk/man/warnpykota.1

@@ -1 +1 @@
 .\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.33.
-.TH WARNPYKOTA "1" "June 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
+.TH WARNPYKOTA "1" "July 2004" "C@LL - Conseil Internet & Logiciels Libres" "User Commands"
 .SH NAME
 warnpykota \- manual page for warnpykota 1.19alpha28_unofficial

pykota/trunk/NEWS

@@ -24 +24 @@
     - 1.19alpha28 :
     
+        - The description field for printers can now be set,
+          and is displayed in reports.
+          
+        - Fixed a small problem in SQL backend code.
+          
         - Improved pkhint
         

pykota/trunk/pykota/reporter.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.9  2004/07/01 17:45:49  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.8  2004/03/24 15:15:24  jalet
 # Began integration of Henrik Janhagen's work on quota-then-balance
@@ -70 +73 @@
         
     def getPrinterTitle(self, printer) :     
-        return _("Report for %s quota on printer %s") % ((self.isgroup and "group") or "user", printer.Name)
+        return (_("Report for %s quota on printer %s") % ((self.isgroup and "group") or "user", printer.Name)) + (" (%s)" % printer.Description)
         
     def getPrinterGraceDelay(self, printer) :    
@@ -100 +103 @@
         balance = float(entry.AccountBalance or 0.0)
         lifetimepaid = float(entry.LifeTimePaid or 0.0)
-        
+        
         #balance
         if entry.LimitBy and (entry.LimitBy.lower() == "balance") :    

pykota/trunk/pykota/storage.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.56  2004/07/01 17:45:49  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.55  2004/06/05 22:18:04  jalet
 # Now catches some exceptions earlier.
@@ -317 +320 @@
         self.PricePerPage = None
         self.PricePerJob = None
+        self.Description = None
         
     def __getattr__(self, name) :    
@@ -353 +357 @@
             self.PricePerJob = float(priceperjob)
         self.parent.writePrinterPrices(self)
+        
+    def setDescription(self, description = None) :    
+        """Sets the printer's prices."""
+        if description is None :
+            description = self.Description
+        else :    
+            self.Description = str(description)
+        self.parent.writePrinterDescription(self)
         
     def delete(self) :    

pykota/trunk/pykota/storages/ldapstorage.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.71  2004/07/01 17:45:49  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.70  2004/06/10 20:50:25  jalet
 # Better log message
@@ -535 +538 @@
         """Extracts printer information given its name : returns first matching printer."""
         printer = StoragePrinter(self, printername)
-        result = self.doSearch("(&(objectClass=pykotaPrinter)(|(pykotaPrinterName=%s)(%s=%s)))" % (printername, self.info["printerrdn"], printername), ["pykotaPrinterName", "pykotaPricePerPage", "pykotaPricePerJob", "uniqueMember"], base=self.info["printerbase"])
+        result = self.doSearch("(&(objectClass=pykotaPrinter)(|(pykotaPrinterName=%s)(%s=%s)))" % (printername, self.info["printerrdn"], printername), ["pykotaPrinterName", "pykotaPricePerPage", "pykotaPricePerJob", "uniqueMember", "description"], base=self.info["printerbase"])
         if result :
             fields = result[0][1]       # take only first matching printer, ignore the rest
@@ -543 +546 @@
             printer.PricePerPage = float(fields.get("pykotaPricePerPage", [0.0])[0] or 0.0)
             printer.uniqueMember = fields.get("uniqueMember", [])
+            printer.Description = fields.get("description", [""])[0]
             printer.Exists = 1
         return printer    
@@ -700 +704 @@
         printers = []
         # see comment at the same place in pgstorage.py
-        result = self.doSearch("(&(objectClass=pykotaPrinter)(|%s))" % "".join(["(pykotaPrinterName=%s)(%s=%s)" % (pname, self.info["printerrdn"], pname) for pname in printerpattern.split(",")]), ["pykotaPrinterName", "pykotaPricePerPage", "pykotaPricePerJob", "uniqueMember"], base=self.info["printerbase"])
+        result = self.doSearch("(&(objectClass=pykotaPrinter)(|%s))" % "".join(["(pykotaPrinterName=%s)(%s=%s)" % (pname, self.info["printerrdn"], pname) for pname in printerpattern.split(",")]), ["pykotaPrinterName", "pykotaPricePerPage", "pykotaPricePerJob", "uniqueMember", "description"], base=self.info["printerbase"])
         if result :
             for (printerid, fields) in result :
@@ -709 +713 @@
                 printer.PricePerPage = float(fields.get("pykotaPricePerPage", [0.0])[0] or 0.0)
                 printer.uniqueMember = fields.get("uniqueMember", [])
+                printer.Description = fields.get("description", [""])[0]
                 printer.Exists = 1
                 printers.append(printer)
@@ -895 +900 @@
                    "pykotaPricePerPage" : str(printer.PricePerPage),
                    "pykotaPricePerJob" : str(printer.PricePerJob),
+                 }
+        self.doModify(printer.ident, fields)
+        
+    def writePrinterDescription(self, printer) :    
+        """Write the printer's description back into the storage."""
+        fields = {
+                   "description" : str(printer.Description),
                  }
         self.doModify(printer.ident, fields)

pykota/trunk/pykota/storages/sql.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.43  2004/07/01 17:45:49  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.42  2004/06/08 17:44:43  jalet
 # Payment now gets deleted when the user is deleted
@@ -115 +118 @@
             printer.ident = fields.get("id")
             printer.Name = fields.get("printername", printername)
-            printer.PricePerJob = fields.get("priceperjob")
-            printer.PricePerPage = fields.get("priceperpage")
+            printer.PricePerJob = fields.get("priceperjob") or 0.0
+            printer.PricePerPage = fields.get("priceperpage") or 0.0
+            printer.Description = fields.get("description") or ""
             printer.Exists = 1
         return printer    
@@ -228 +232 @@
                     printer = StoragePrinter(self, record["printername"])
                     printer.ident = record.get("id")
-                    printer.PricePerJob = record.get("priceperjob")
-                    printer.PricePerPage = record.get("priceperpage")
+                    printer.PricePerJob = record.get("priceperjob") or 0.0
+                    printer.PricePerPage = record.get("priceperpage") or 0.0
+                    printer.Description = record.get("description") or ""
                     printer.Exists = 1
                     printers.append(printer)
@@ -313 +318 @@
         self.doModify("UPDATE printers SET priceperpage=%s, priceperjob=%s WHERE id=%s" % (self.doQuote(printer.PricePerPage), self.doQuote(printer.PricePerJob), self.doQuote(printer.ident)))
         
+    def writePrinterDescription(self, printer) :    
+        """Write the printer's description back into the storage."""
+        self.doModify("UPDATE printers SET description=%s WHERE id=%s" % (self.doQuote(printer.Description), self.doQuote(printer.ident)))
+        
     def writeUserLimitBy(self, user, limitby) :    
         """Sets the user's limiting factor."""

pykota/trunk/pykota/tool.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.109  2004/07/01 17:45:49  jalet
+# Added code to handle the description field for printers
+#
 # Revision 1.108  2004/06/24 23:09:30  jalet
 # Also prints read size on last block
@@ -475 +478 @@
         if self.debug :
             self.logger.log_message(message, "debug")
+            
+    def printError(self, message) :        
+        """Sends a message to standard error."""
+        sys.stderr.write("%s\n" % message)
+        sys.stderr.flush()
         
     def clean(self) :