Changeset 1327 for pykota

Timestamp:

02/02/04 23:44:16 (21 years ago)

Author:

jalet

Message:

Preliminary work on Relationnal Database Independance via DB-API 2.0

Location:

pykota/trunk/pykota/storages

Files:

• dbistorage.py (added)
• pgstorage.py (modified) (4 diffs)
• sql.py (added)

pykota/trunk/pykota/storages/pgstorage.py

@@ -22 +22 @@
 #
 # $Log$
+# Revision 1.35  2004/02/02 22:44:16  jalet
+# Preliminary work on Relationnal Database Independance via DB-API 2.0
+#
 # Revision 1.34  2004/01/12 15:12:50  jalet
 # Small fix for history
@@ -138 +141 @@
 
 from pykota.storage import PyKotaStorageError,BaseStorage,StorageObject,StorageUser,StorageGroup,StoragePrinter,StorageJob,StorageLastJob,StorageUserPQuota,StorageGroupPQuota
+from pykota.storages.sql import SQLStorage
 
 try :
@@ -146 +150 @@
     raise PyKotaStorageError, "This python version (%s) doesn't seem to have the PygreSQL module installed correctly." % sys.version.split()[0]
 
-class Storage(BaseStorage) :
+class Storage(BaseStorage, SQLStorage) :
     def __init__(self, pykotatool, host, dbname, user, passwd) :
         """Opens the PostgreSQL database connection."""
@@ -222 +226 @@
             typ = "text"
         return pg._quote(field, typ)
-        
-    def getAllUsersNames(self) :    
-        """Extracts all user names."""
-        usernames = []
-        result = self.doSearch("SELECT username FROM users")
-        if result :
-            usernames = [record["username"] for record in result]
-        return usernames
-        
-    def getAllGroupsNames(self) :    
-        """Extracts all group names."""
-        groupnames = []
-        result = self.doSearch("SELECT groupname FROM groups")
-        if result :
-            groupnames = [record["groupname"] for record in result]
-        return groupnames
-        
-    def getUserFromBackend(self, username) :    
-        """Extracts user information given its name."""
-        user = StorageUser(self, username)
-        result = self.doSearch("SELECT * FROM users WHERE username=%s LIMIT 1" % self.doQuote(username))
-        if result :
-            fields = result[0]
-            user.ident = fields.get("id")
-            user.LimitBy = fields.get("limitby")
-            user.AccountBalance = fields.get("balance")
-            user.LifeTimePaid = fields.get("lifetimepaid")
-            user.Email = fields.get("email")
-            user.Exists = 1
-        return user
-       
-    def getGroupFromBackend(self, groupname) :    
-        """Extracts group information given its name."""
-        group = StorageGroup(self, groupname)
-        result = self.doSearch("SELECT * FROM groups WHERE groupname=%s LIMIT 1" % self.doQuote(groupname))
-        if result :
-            fields = result[0]
-            group.ident = fields.get("id")
-            group.LimitBy = fields.get("limitby")
-            result = self.doSearch("SELECT SUM(balance) AS balance, SUM(lifetimepaid) AS lifetimepaid FROM users WHERE id IN (SELECT userid FROM groupsmembers WHERE groupid=%s)" % self.doQuote(group.ident))
-            if result :
-                fields = result[0]
-                group.AccountBalance = fields.get("balance")
-                group.LifeTimePaid = fields.get("lifetimepaid")
-            group.Exists = 1
-        return group
-       
-    def getPrinterFromBackend(self, printername) :        
-        """Extracts printer information given its name."""
-        printer = StoragePrinter(self, printername)
-        result = self.doSearch("SELECT * FROM printers WHERE printername=%s LIMIT 1" % self.doQuote(printername))
-        if result :
-            fields = result[0]
-            printer.ident = fields.get("id")
-            printer.PricePerJob = fields.get("priceperjob")
-            printer.PricePerPage = fields.get("priceperpage")
-            printer.LastJob = self.getPrinterLastJob(printer)
-            printer.Exists = 1
-        return printer    
-        
-    def getUserPQuotaFromBackend(self, user, printer) :        
-        """Extracts a user print quota."""
-        userpquota = StorageUserPQuota(self, user, printer)
-        if printer.Exists and user.Exists :
-            result = self.doSearch("SELECT id, lifepagecounter, pagecounter, softlimit, hardlimit, datelimit FROM userpquota WHERE userid=%s AND printerid=%s" % (self.doQuote(user.ident), self.doQuote(printer.ident)))
-            if result :
-                fields = result[0]
-                userpquota.ident = fields.get("id")
-                userpquota.PageCounter = fields.get("pagecounter")
-                userpquota.LifePageCounter = fields.get("lifepagecounter")
-                userpquota.SoftLimit = fields.get("softlimit")
-                userpquota.HardLimit = fields.get("hardlimit")
-                userpquota.DateLimit = fields.get("datelimit")
-                userpquota.Exists = 1
-        return userpquota
-        
-    def getGroupPQuotaFromBackend(self, group, printer) :        
-        """Extracts a group print quota."""
-        grouppquota = StorageGroupPQuota(self, group, printer)
-        if group.Exists :
-            result = self.doSearch("SELECT id, softlimit, hardlimit, datelimit FROM grouppquota WHERE groupid=%s AND printerid=%s" % (self.doQuote(group.ident), self.doQuote(printer.ident)))
-            if result :
-                fields = result[0]
-                grouppquota.ident = fields.get("id")
-                grouppquota.SoftLimit = fields.get("softlimit")
-                grouppquota.HardLimit = fields.get("hardlimit")
-                grouppquota.DateLimit = fields.get("datelimit")
-                result = self.doSearch("SELECT SUM(lifepagecounter) AS lifepagecounter, SUM(pagecounter) AS pagecounter FROM userpquota WHERE printerid=%s AND userid IN (SELECT userid FROM groupsmembers WHERE groupid=%s)" % (self.doQuote(printer.ident), self.doQuote(group.ident)))
-                if result :
-                    fields = result[0]
-                    grouppquota.PageCounter = fields.get("pagecounter")
-                    grouppquota.LifePageCounter = fields.get("lifepagecounter")
-                grouppquota.Exists = 1
-        return grouppquota
-        
-    def getPrinterLastJobFromBackend(self, printer) :        
-        """Extracts a printer's last job information."""
-        lastjob = StorageLastJob(self, printer)
-        result = self.doSearch("SELECT jobhistory.id, jobid, userid, username, pagecounter, jobsize, jobprice, filename, title, copies, options, jobdate FROM jobhistory, users WHERE printerid=%s AND userid=users.id ORDER BY jobdate DESC LIMIT 1" % self.doQuote(printer.ident))
-        if result :
-            fields = result[0]
-            lastjob.ident = fields.get("id")
-            lastjob.JobId = fields.get("jobid")
-            lastjob.User = self.getUser(fields.get("username"))
-            lastjob.PrinterPageCounter = fields.get("pagecounter")
-            lastjob.JobSize = fields.get("jobsize")
-            lastjob.JobPrice = fields.get("jobprice")
-            lastjob.JobAction = fields.get("action")
-            lastjob.JobFileName = fields.get("filename")
-            lastjob.JobTitle = fields.get("title")
-            lastjob.JobCopies = fields.get("copies")
-            lastjob.JobOptions = fields.get("options")
-            lastjob.JobDate = fields.get("jobdate")
-            lastjob.Exists = 1
-        return lastjob
-            
-    def getGroupMembersFromBackend(self, group) :        
-        """Returns the group's members list."""
-        groupmembers = []
-        result = self.doSearch("SELECT * FROM groupsmembers JOIN users ON groupsmembers.userid=users.id WHERE groupid=%s" % self.doQuote(group.ident))
-        if result :
-            for record in result :
-                user = StorageUser(self, record.get("username"))
-                user.ident = record.get("userid")
-                user.LimitBy = record.get("limitby")
-                user.AccountBalance = record.get("balance")
-                user.LifeTimePaid = record.get("lifetimepaid")
-                user.Email = record.get("email")
-                user.Exists = 1
-                groupmembers.append(user)
-                self.cacheEntry("USERS", user.Name, user)
-        return groupmembers        
-        
-    def getUserGroupsFromBackend(self, user) :        
-        """Returns the user's groups list."""
-        groups = []
-        result = self.doSearch("SELECT groupname FROM groupsmembers JOIN groups ON groupsmembers.groupid=groups.id WHERE userid=%s" % self.doQuote(user.ident))
-        if result :
-            for record in result :
-                groups.append(self.getGroup(record.get("groupname")))
-        return groups        
-        
-    def getParentPrintersFromBackend(self, printer) :    
-        """Get all the printer groups this printer is a member of."""
-        pgroups = []
-        result = self.doSearch("SELECT groupid,printername FROM printergroupsmembers JOIN printers ON groupid=id WHERE printerid=%s" % self.doQuote(printer.ident))
-        if result :
-            for record in result :
-                if record["groupid"] != printer.ident : # in case of integrity violation
-                    parentprinter = self.getPrinter(record.get("printername"))
-                    if parentprinter.Exists :
-                        pgroups.append(parentprinter)
-        return pgroups
-        
-    def getMatchingPrinters(self, printerpattern) :
-        """Returns the list of all printers for which name matches a certain pattern."""
-        printers = []
-        # We 'could' do a SELECT printername FROM printers WHERE printername LIKE ...
-        # but we don't because other storages semantics may be different, so every
-        # storage should use fnmatch to match patterns and be storage agnostic
-        result = self.doSearch("SELECT * FROM printers")
-        if result :
-            for record in result :
-                if self.tool.matchString(record["printername"], printerpattern.split(",")) :
-                    printer = StoragePrinter(self, record["printername"])
-                    printer.ident = record.get("id")
-                    printer.PricePerJob = record.get("priceperjob")
-                    printer.PricePerPage = record.get("priceperpage")
-                    printer.LastJob = self.getPrinterLastJob(printer)
-                    printer.Exists = 1
-                    printers.append(printer)
-                    self.cacheEntry("PRINTERS", printer.Name, printer)
-        return printers        
-        
-    def getPrinterUsersAndQuotas(self, printer, names=["*"]) :        
-        """Returns the list of users who uses a given printer, along with their quotas."""
-        usersandquotas = []
-        result = self.doSearch("SELECT users.id as uid,username,balance,lifetimepaid,limitby,email,userpquota.id,lifepagecounter,pagecounter,softlimit,hardlimit,datelimit FROM users JOIN userpquota ON users.id=userpquota.userid AND printerid=%s ORDER BY username ASC" % self.doQuote(printer.ident))
-        if result :
-            for record in result :
-                if self.tool.matchString(record.get("username"), names) :
-                    user = StorageUser(self, record.get("username"))
-                    user.ident = record.get("uid")
-                    user.LimitBy = record.get("limitby")
-                    user.AccountBalance = record.get("balance")
-                    user.LifeTimePaid = record.get("lifetimepaid")
-                    user.Email = record.get("email") 
-                    user.Exists = 1
-                    userpquota = StorageUserPQuota(self, user, printer)
-                    userpquota.ident = record.get("id")
-                    userpquota.PageCounter = record.get("pagecounter")
-                    userpquota.LifePageCounter = record.get("lifepagecounter")
-                    userpquota.SoftLimit = record.get("softlimit")
-                    userpquota.HardLimit = record.get("hardlimit")
-                    userpquota.DateLimit = record.get("datelimit")
-                    userpquota.Exists = 1
-                    usersandquotas.append((user, userpquota))
-                    self.cacheEntry("USERS", user.Name, user)
-                    self.cacheEntry("USERPQUOTAS", "%s@%s" % (user.Name, printer.Name), userpquota)
-        return usersandquotas
-                
-    def getPrinterGroupsAndQuotas(self, printer, names=["*"]) :        
-        """Returns the list of groups which uses a given printer, along with their quotas."""
-        groupsandquotas = []
-        result = self.doSearch("SELECT groupname FROM groups JOIN grouppquota ON groups.id=grouppquota.groupid AND printerid=%s ORDER BY groupname ASC" % self.doQuote(printer.ident))
-        if result :
-            for record in result :
-                if self.tool.matchString(record.get("groupname"), names) :
-                    group = self.getGroup(record.get("groupname"))
-                    grouppquota = self.getGroupPQuota(group, printer)
-                    groupsandquotas.append((group, grouppquota))
-        return groupsandquotas
-        
-    def addPrinter(self, printername) :        
-        """Adds a printer to the quota storage, returns it."""
-        self.doModify("INSERT INTO printers (printername) VALUES (%s)" % self.doQuote(printername))
-        return self.getPrinter(printername)
-        
-    def addUser(self, user) :        
-        """Adds a user to the quota storage, returns its id."""
-        self.doModify("INSERT INTO users (username, limitby, balance, lifetimepaid, email) VALUES (%s, %s, %s, %s, %s)" % (self.doQuote(user.Name), self.doQuote(user.LimitBy), self.doQuote(user.AccountBalance), self.doQuote(user.LifeTimePaid), self.doQuote(user.Email)))
-        return self.getUser(user.Name)
-        
-    def addGroup(self, group) :        
-        """Adds a group to the quota storage, returns its id."""
-        self.doModify("INSERT INTO groups (groupname, limitby) VALUES (%s, %s)" % (self.doQuote(group.Name), self.doQuote(group.LimitBy)))
-        return self.getGroup(group.Name)
-
-    def addUserToGroup(self, user, group) :    
-        """Adds an user to a group."""
-        result = self.doSearch("SELECT COUNT(*) AS mexists FROM groupsmembers WHERE groupid=%s AND userid=%s" % (self.doQuote(group.ident), self.doQuote(user.ident)))
-        try :
-            mexists = int(result[0].get("mexists"))
-        except (IndexError, TypeError) :    
-            mexists = 0
-        if not mexists :    
-            self.doModify("INSERT INTO groupsmembers (groupid, userid) VALUES (%s, %s)" % (self.doQuote(group.ident), self.doQuote(user.ident)))
-            
-    def addUserPQuota(self, user, printer) :
-        """Initializes a user print quota on a printer."""
-        self.doModify("INSERT INTO userpquota (userid, printerid) VALUES (%s, %s)" % (self.doQuote(user.ident), self.doQuote(printer.ident)))
-        return self.getUserPQuota(user, printer)
-        
-    def addGroupPQuota(self, group, printer) :
-        """Initializes a group print quota on a printer."""
-        self.doModify("INSERT INTO grouppquota (groupid, printerid) VALUES (%s, %s)" % (self.doQuote(group.ident), self.doQuote(printer.ident)))
-        return self.getGroupPQuota(group, printer)
-        
-    def writePrinterPrices(self, printer) :    
-        """Write the printer's prices back into the storage."""
-        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 writeUserLimitBy(self, user, limitby) :    
-        """Sets the user's limiting factor."""
-        self.doModify("UPDATE users SET limitby=%s WHERE id=%s" % (self.doQuote(limitby), self.doQuote(user.ident)))
-        
-    def writeGroupLimitBy(self, group, limitby) :    
-        """Sets the group's limiting factor."""
-        self.doModify("UPDATE groups SET limitby=%s WHERE id=%s" % (self.doQuote(limitby), self.doQuote(group.ident)))
-        
-    def writeUserPQuotaDateLimit(self, userpquota, datelimit) :    
-        """Sets the date limit permanently for a user print quota."""
-        self.doModify("UPDATE userpquota SET datelimit=%s WHERE id=%s" % (self.doQuote(datelimit), self.doQuote(userpquota.ident)))
-            
-    def writeGroupPQuotaDateLimit(self, grouppquota, datelimit) :    
-        """Sets the date limit permanently for a group print quota."""
-        self.doModify("UPDATE grouppquota SET datelimit=%s WHERE id=%s" % (self.doQuote(datelimit), self.doQuote(grouppquota.ident)))
-        
-    def increaseUserPQuotaPagesCounters(self, userpquota, nbpages) :    
-        """Increase page counters for a user print quota."""
-        self.doModify("UPDATE userpquota SET pagecounter=pagecounter+%s,lifepagecounter=lifepagecounter+%s WHERE id=%s" % (self.doQuote(nbpages), self.doQuote(nbpages), self.doQuote(userpquota.ident)))
-       
-    def writeUserPQuotaPagesCounters(self, userpquota, newpagecounter, newlifepagecounter) :    
-        """Sets the new page counters permanently for a user print quota."""
-        self.doModify("UPDATE userpquota SET pagecounter=%s,lifepagecounter=%s WHERE id=%s" % (self.doQuote(newpagecounter), self.doQuote(newlifepagecounter), self.doQuote(userpquota.ident)))
-       
-    def decreaseUserAccountBalance(self, user, amount) :    
-        """Decreases user's account balance from an amount."""
-        self.doModify("UPDATE users SET balance=balance-%s WHERE id=%s" % (self.doQuote(amount), self.doQuote(user.ident)))
-       
-    def writeUserAccountBalance(self, user, newbalance, newlifetimepaid=None) :    
-        """Sets the new account balance and eventually new lifetime paid."""
-        if newlifetimepaid is not None :
-            self.doModify("UPDATE users SET balance=%s, lifetimepaid=%s WHERE id=%s" % (self.doQuote(newbalance), self.doQuote(newlifetimepaid), self.doQuote(user.ident)))
-        else :    
-            self.doModify("UPDATE users SET balance=%s WHERE id=%s" % (self.doQuote(newbalance), self.doQuote(user.ident)))
-            
-    def writeLastJobSize(self, lastjob, jobsize, jobprice) :        
-        """Sets the last job's size permanently."""
-        self.doModify("UPDATE jobhistory SET jobsize=%s, jobprice=%s WHERE id=%s" % (self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(lastjob.ident)))
-        
-    def writeJobNew(self, printer, user, jobid, pagecounter, action, jobsize=None, jobprice=None, filename=None, title=None, copies=None, options=None) :    
-        """Adds a job in a printer's history."""
-        if (not self.disablehistory) or (not printer.LastJob.Exists) :
-            if jobsize is not None :
-                self.doModify("INSERT INTO jobhistory (userid, printerid, jobid, pagecounter, action, jobsize, jobprice, filename, title, copies, options) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)" % (self.doQuote(user.ident), self.doQuote(printer.ident), self.doQuote(jobid), self.doQuote(pagecounter), self.doQuote(action), self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(filename), self.doQuote(title), self.doQuote(copies), self.doQuote(options)))
-            else :    
-                self.doModify("INSERT INTO jobhistory (userid, printerid, jobid, pagecounter, action, filename, title, copies, options) VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)" % (self.doQuote(user.ident), self.doQuote(printer.ident), self.doQuote(jobid), self.doQuote(pagecounter), self.doQuote(action), self.doQuote(filename), self.doQuote(title), self.doQuote(copies), self.doQuote(options)))
-        else :        
-            # here we explicitly want to reset jobsize to NULL if needed
-            self.doModify("UPDATE jobhistory SET userid=%s, jobid=%s, pagecounter=%s, action=%s, jobsize=%s, jobprice=%s, filename=%s, title=%s, copies=%s, options=%s, jobdate=now() WHERE id=%s" % (self.doQuote(user.ident), self.doQuote(jobid), self.doQuote(pagecounter), self.doQuote(action), self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(filename), self.doQuote(title), self.doQuote(copies), self.doQuote(options), self.doQuote(printer.LastJob.ident)))
-            
-    def writeUserPQuotaLimits(self, userpquota, softlimit, hardlimit) :
-        """Sets soft and hard limits for a user quota."""
-        self.doModify("UPDATE userpquota SET softlimit=%s, hardlimit=%s, datelimit=NULL WHERE id=%s" % (self.doQuote(softlimit), self.doQuote(hardlimit), self.doQuote(userpquota.ident)))
-        
-    def writeGroupPQuotaLimits(self, grouppquota, softlimit, hardlimit) :
-        """Sets soft and hard limits for a group quota on a specific printer."""
-        self.doModify("UPDATE grouppquota SET softlimit=%s, hardlimit=%s, datelimit=NULL WHERE id=%s" % (self.doQuote(softlimit), self.doQuote(hardlimit), self.doQuote(grouppquota.ident)))
-
-    def writePrinterToGroup(self, pgroup, printer) :
-        """Puts a printer into a printer group."""
-        children = []
-        result = self.doSearch("SELECT printerid FROM printergroupsmembers WHERE groupid=%s" % self.doQuote(pgroup.ident))
-        if result :
-            for record in result :
-                children.append(record.get("printerid")) # TODO : put this into the database integrity rules
-        if printer.ident not in children :        
-            self.doModify("INSERT INTO printergroupsmembers (groupid, printerid) VALUES (%s, %s)" % (self.doQuote(pgroup.ident), self.doQuote(printer.ident)))
-        
-    def retrieveHistory(self, user=None, printer=None, datelimit=None, limit=100) :    
-        """Retrieves all print jobs for user on printer (or all) before date, limited to first 100 results."""
-        query = "SELECT jobhistory.*,username,printername FROM jobhistory,users,printers WHERE users.id=userid AND printers.id=printerid"
-        where = []
-        if (user is not None) and user.Exists :
-            where.append("userid=%s" % self.doQuote(user.ident))
-        if (printer is not None) and printer.Exists :
-            where.append("printerid=%s" % self.doQuote(printer.ident))
-        if datelimit is not None :    
-            where.append("jobdate<=%s" % self.doQuote(datelimit))
-        if where :    
-            query += " AND %s" % " AND ".join(where)
-        query += " ORDER BY id DESC"
-        if limit :
-            query += " LIMIT %s" % self.doQuote(int(limit))
-        jobs = []    
-        result = self.doSearch(query)    
-        if result :
-            for fields in result :
-                job = StorageJob(self)
-                job.ident = fields.get("id")
-                job.JobId = fields.get("jobid")
-                job.PrinterPageCounter = fields.get("pagecounter")
-                job.JobSize = fields.get("jobsize")
-                job.JobPrice = fields.get("jobprice")
-                job.JobAction = fields.get("action")
-                job.JobFileName = fields.get("filename")
-                job.JobTitle = fields.get("title")
-                job.JobCopies = fields.get("copies")
-                job.JobOptions = fields.get("options")
-                job.JobDate = fields.get("jobdate")
-                job.User = self.getUser(fields.get("username"))
-                job.Printer = self.getPrinter(fields.get("printername"))
-                job.Exists = 1
-                jobs.append(job)
-        return jobs
-        
-    def deleteUser(self, user) :    
-        """Completely deletes an user from the Quota Storage."""
-        # TODO : What should we do if we delete the last person who used a given printer ?
-        # TODO : we can't reassign the last job to the previous one, because next user would be
-        # TODO : incorrectly charged (overcharged).
-        for q in [ 
-                    "DELETE FROM groupsmembers WHERE userid=%s" % self.doQuote(user.ident),
-                    "DELETE FROM jobhistory WHERE userid=%s" % self.doQuote(user.ident),
-                    "DELETE FROM userpquota WHERE userid=%s" % self.doQuote(user.ident),
-                    "DELETE FROM users WHERE id=%s" % self.doQuote(user.ident),
-                  ] :
-            self.doModify(q)
-        
-    def deleteGroup(self, group) :    
-        """Completely deletes a group from the Quota Storage."""
-        for q in [
-                   "DELETE FROM groupsmembers WHERE groupid=%s" % self.doQuote(group.ident),
-                   "DELETE FROM grouppquota WHERE groupid=%s" % self.doQuote(group.ident),
-                   "DELETE FROM groups WHERE id=%s" % self.doQuote(group.ident),
-                 ] :  
-            self.doModify(q)
-