Changeset 3056

Timestamp:

11/13/06 23:24:01 (17 years ago)

Author:

jerome

Message:

The code to refund jobs is there and works (at least with PostgreSQL).
Only the pkrefund command line tool (and CGI script ?) is missing.

Location:

pykota/trunk

Files:

• cgi-bin/printquota.cgi (modified) (1 diff)
• pykota/storage.py (modified) (11 diffs)
• pykota/storages/ldapstorage.py (modified) (3 diffs)
• pykota/storages/sql.py (modified) (3 diffs)

pykota/trunk/cgi-bin/printquota.cgi

@@ -210 +210 @@
                     billingcode = None
                 self.report = ["<h2>%s</h2>" % _("History")]    
-                history = self.storage.retrieveHistory(user, printer, hostname, billingcode, end=datelimit)
+                history = self.storage.retrieveHistory(user=user, printer=printer, hostname=hostname, billingcode=billingcode, end=datelimit)
                 if not history :
                     self.report.append("<h3>%s</h3>" % _("Empty"))

pykota/trunk/pykota/storage.py

@@ -23 +23 @@
 #
 
+"""This module is the database abstraction layer for PyKota."""
+
 import os
 import imp
@@ -36 +38 @@
     __str__ = __repr__
         
+        
 class StorageObject :
     """Object present in the database."""
@@ -57 +60 @@
             getattr(self.parent, "save%s" % self.__class__.__name__[7:])(self)
             self.isDirty = False
+            
         
 class StorageUser(StorageObject) :        
@@ -124 +128 @@
         self.isDirty = False            
         
+    def refund(self, amount) :
+        """Refunds a number of credits to an user."""
+        self.consumeAccountBalance(-amount)
+        
+        
 class StorageGroup(StorageObject) :        
     """User class."""
@@ -161 +170 @@
         self.Exists = False
         self.isDirty = False            
+        
         
 class StoragePrinter(StorageObject) :
@@ -236 +246 @@
         self.Exists = False
         self.isDirty = False            
+        
         
 class StorageUserPQuota(StorageObject) :
@@ -360 +371 @@
         self.isDirty = False
         
+    def refund(self, nbpages) :    
+        """Refunds a number of pages to an user on a particular printer."""
+        self.parent.increaseUserPQuotaPagesCounters(self, -nbpages)
+        self.PageCounter = int(self.PageCounter or 0) - nbpages
+        self.LifePageCounter = int(self.LifePageCounter or 0) - nbpages
+        
+        
 class StorageGroupPQuota(StorageObject) :
     """Group Print Quota class."""
@@ -427 +445 @@
         self.Exists = False
         self.isDirty = False
+        
         
 class StorageJob(StorageObject) :
@@ -462 +481 @@
         else :
             raise AttributeError, name
+            
+    def refund(self) :        
+        """Refund a particular print job."""
+        if (not self.JobSize) or (self.JobAction in ("DENY", "REFUND")) :
+            return
+        self.parent.beginTransaction()
+        try :
+            if self.JobBillingCode :
+                bcode = self.parent.getBillingCode(self.JobBillingCode)
+                bcode.refund(self.JobSize, self.JobPrice)
+                
+            if self.User.Exists :
+                self.User.refund(self.JobPrice)
+                if self.Printer.Exists :    
+                    upq = self.parent.getUserPQuota(self.User, self.Printer)    
+                    if upq.Exists :
+                        upq.refund(self.JobSize)
+            self.parent.refundJob(self.ident)
+        except :        
+            self.parent.rollbackTransaction()
+            raise
+        else :    
+            self.parent.commitTransaction()
+        
         
 class StorageLastJob(StorageJob) :
@@ -469 +512 @@
         self.PrinterName = printer.Name # not needed
         self.Printer = printer
+        
         
 class StorageBillingCode(StorageObject) :
@@ -494 +538 @@
         """Consumes some pages and credits for this billing code."""
         if pages :
-           self.parent.consumeBillingCode(self, pages, price)
-           self.PageCounter += pages
-           self.Balance -= price
+            self.parent.consumeBillingCode(self, pages, price)
+            self.PageCounter += pages
+            self.Balance -= price
+           
+    def refund(self, pages, price) :
+        """Refunds a particular billing code."""
+        self.consume(-pages, -price)
+        
         
 class BaseStorage :

pykota/trunk/pykota/storages/ldapstorage.py

@@ -1303 +1303 @@
             self.doModify(pgroup.ident, fields)         
             
-    def retrieveHistory(self, user=None, printer=None, hostname=None, billingcode=None, limit=100, start=None, end=None) :
+    def retrieveHistory(self, user=None, printer=None, hostname=None, billingcode=None, jobid=None, limit=100, start=None, end=None) :
         """Retrieves all print jobs for user on printer (or all) between start and end date, limited to first 100 results."""
         precond = "(objectClass=pykotaJob)"
@@ -1315 +1315 @@
         if billingcode is not None :
             where.append("(pykotaBillingCode=%s)" % self.userCharsetToDatabase(billingcode))
+        if jobid is not None :
+            where.append("(pykotaJobId=%s)" % jobid) # TODO : jobid is text, so self.userCharsetToDatabase(jobid) but do all of them as well.
         if where :    
             where = "(&%s)" % "".join([precond] + where)
@@ -1778 +1780 @@
         return self.doModify(bcode.ident, fields)         
 
+    def refundJob(self, jobident) :   
+        """Marks a job as refunded in the history."""
+        dn = "cn=%s,%s" % (ident, self.info["jobbase"])
+        fields = {
+                     "pykotaAction" : "REFUND",
+                 }    
+        self.doModify(dn, fields)         
+        
     def storageUserFromRecord(self, username, record) :
         """Returns a StorageUser instance from a database record."""

pykota/trunk/pykota/storages/sql.py

@@ -688 +688 @@
         self.doModify("UPDATE billingcodes SET balance=balance + %s, pagecounter=pagecounter + %s WHERE id=%s" % (self.doQuote(balance), self.doQuote(pagecounter), self.doQuote(bcode.ident)))
        
+    def refundJob(self, jobident) :   
+        """Marks a job as refunded in the history."""
+        self.doModify("UPDATE jobhistory SET action='REFUND' WHERE id=%s;" % self.doQuote(jobident))
+        
     def decreaseUserAccountBalance(self, user, amount) :    
         """Decreases user's account balance from an amount."""
@@ -763 +767 @@
         self.doModify("DELETE FROM printergroupsmembers WHERE groupid=%s AND printerid=%s" % (self.doQuote(pgroup.ident), self.doQuote(printer.ident)))
         
-    def retrieveHistory(self, user=None, printer=None, hostname=None, billingcode=None, limit=100, start=None, end=None) :
+    def retrieveHistory(self, user=None, printer=None, hostname=None, billingcode=None, jobid=None, limit=100, start=None, end=None) :
         """Retrieves all print jobs for user on printer (or all) between start and end date, limited to first 100 results."""
         query = "SELECT jobhistory.*,username,printername FROM jobhistory,users,printers WHERE users.id=userid AND printers.id=printerid"
@@ -775 +779 @@
         if billingcode is not None :    
             where.append("billingcode=%s" % self.doQuote(self.userCharsetToDatabase(billingcode)))
+        if jobid is not None :    
+            where.append("jobid=%s" % self.doQuote(jobid)) # TODO : jobid is text, so self.userCharsetToDatabase(jobid) but do all of them as well.
         if start is not None :    
             where.append("jobdate>=%s" % self.doQuote(start))