root / pykota / trunk / pykota / storages / sql.py @ 1327

Revision 1327, 23.8 kB (checked in by jalet, 20 years ago)

Preliminary work on Relationnal Database Independance via DB-API 2.0

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1# PyKota
2# -*- coding: ISO-8859-15 -*-
3#
4# PyKota : Print Quotas for CUPS and LPRng
5#
6# (c) 2003-2004 Jerome Alet <alet@librelogiciel.com>
7# This program is free software; you can redistribute it and/or modify
8# it under the terms of the GNU General Public License as published by
9# the Free Software Foundation; either version 2 of the License, or
10# (at your option) any later version.
11#
12# This program is distributed in the hope that it will be useful,
13# but WITHOUT ANY WARRANTY; without even the implied warranty of
14# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15# GNU General Public License for more details.
16#
17# You should have received a copy of the GNU General Public License
18# along with this program; if not, write to the Free Software
19# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
20#
21# $Id$
22#
23# $Log$
24# Revision 1.34  2004/02/02 22:44:16  jalet
25# Preliminary work on Relationnal Database Independance via DB-API 2.0
26#
27#
28#
29
30from pykota.storage import PyKotaStorageError,BaseStorage,StorageObject,StorageUser,StorageGroup,StoragePrinter,StorageJob,StorageLastJob,StorageUserPQuota,StorageGroupPQuota
31
32class SQLStorage :
33    def getAllUsersNames(self) :   
34        """Extracts all user names."""
35        usernames = []
36        result = self.doSearch("SELECT username FROM users")
37        if result :
38            usernames = [record["username"] for record in result]
39        return usernames
40       
41    def getAllGroupsNames(self) :   
42        """Extracts all group names."""
43        groupnames = []
44        result = self.doSearch("SELECT groupname FROM groups")
45        if result :
46            groupnames = [record["groupname"] for record in result]
47        return groupnames
48       
49    def getUserFromBackend(self, username) :   
50        """Extracts user information given its name."""
51        user = StorageUser(self, username)
52        result = self.doSearch("SELECT * FROM users WHERE username=%s LIMIT 1" % self.doQuote(username))
53        if result :
54            fields = result[0]
55            user.ident = fields.get("id")
56            user.LimitBy = fields.get("limitby")
57            user.AccountBalance = fields.get("balance")
58            user.LifeTimePaid = fields.get("lifetimepaid")
59            user.Email = fields.get("email")
60            user.Exists = 1
61        return user
62       
63    def getGroupFromBackend(self, groupname) :   
64        """Extracts group information given its name."""
65        group = StorageGroup(self, groupname)
66        result = self.doSearch("SELECT * FROM groups WHERE groupname=%s LIMIT 1" % self.doQuote(groupname))
67        if result :
68            fields = result[0]
69            group.ident = fields.get("id")
70            group.LimitBy = fields.get("limitby")
71            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))
72            if result :
73                fields = result[0]
74                group.AccountBalance = fields.get("balance")
75                group.LifeTimePaid = fields.get("lifetimepaid")
76            group.Exists = 1
77        return group
78       
79    def getPrinterFromBackend(self, printername) :       
80        """Extracts printer information given its name."""
81        printer = StoragePrinter(self, printername)
82        result = self.doSearch("SELECT * FROM printers WHERE printername=%s LIMIT 1" % self.doQuote(printername))
83        if result :
84            fields = result[0]
85            printer.ident = fields.get("id")
86            printer.PricePerJob = fields.get("priceperjob")
87            printer.PricePerPage = fields.get("priceperpage")
88            printer.LastJob = self.getPrinterLastJob(printer)
89            printer.Exists = 1
90        return printer   
91       
92    def getUserPQuotaFromBackend(self, user, printer) :       
93        """Extracts a user print quota."""
94        userpquota = StorageUserPQuota(self, user, printer)
95        if printer.Exists and user.Exists :
96            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)))
97            if result :
98                fields = result[0]
99                userpquota.ident = fields.get("id")
100                userpquota.PageCounter = fields.get("pagecounter")
101                userpquota.LifePageCounter = fields.get("lifepagecounter")
102                userpquota.SoftLimit = fields.get("softlimit")
103                userpquota.HardLimit = fields.get("hardlimit")
104                userpquota.DateLimit = fields.get("datelimit")
105                userpquota.Exists = 1
106        return userpquota
107       
108    def getGroupPQuotaFromBackend(self, group, printer) :       
109        """Extracts a group print quota."""
110        grouppquota = StorageGroupPQuota(self, group, printer)
111        if group.Exists :
112            result = self.doSearch("SELECT id, softlimit, hardlimit, datelimit FROM grouppquota WHERE groupid=%s AND printerid=%s" % (self.doQuote(group.ident), self.doQuote(printer.ident)))
113            if result :
114                fields = result[0]
115                grouppquota.ident = fields.get("id")
116                grouppquota.SoftLimit = fields.get("softlimit")
117                grouppquota.HardLimit = fields.get("hardlimit")
118                grouppquota.DateLimit = fields.get("datelimit")
119                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)))
120                if result :
121                    fields = result[0]
122                    grouppquota.PageCounter = fields.get("pagecounter")
123                    grouppquota.LifePageCounter = fields.get("lifepagecounter")
124                grouppquota.Exists = 1
125        return grouppquota
126       
127    def getPrinterLastJobFromBackend(self, printer) :       
128        """Extracts a printer's last job information."""
129        lastjob = StorageLastJob(self, printer)
130        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))
131        if result :
132            fields = result[0]
133            lastjob.ident = fields.get("id")
134            lastjob.JobId = fields.get("jobid")
135            lastjob.User = self.getUser(fields.get("username"))
136            lastjob.PrinterPageCounter = fields.get("pagecounter")
137            lastjob.JobSize = fields.get("jobsize")
138            lastjob.JobPrice = fields.get("jobprice")
139            lastjob.JobAction = fields.get("action")
140            lastjob.JobFileName = fields.get("filename")
141            lastjob.JobTitle = fields.get("title")
142            lastjob.JobCopies = fields.get("copies")
143            lastjob.JobOptions = fields.get("options")
144            lastjob.JobDate = fields.get("jobdate")
145            lastjob.Exists = 1
146        return lastjob
147           
148    def getGroupMembersFromBackend(self, group) :       
149        """Returns the group's members list."""
150        groupmembers = []
151        result = self.doSearch("SELECT * FROM groupsmembers JOIN users ON groupsmembers.userid=users.id WHERE groupid=%s" % self.doQuote(group.ident))
152        if result :
153            for record in result :
154                user = StorageUser(self, record.get("username"))
155                user.ident = record.get("userid")
156                user.LimitBy = record.get("limitby")
157                user.AccountBalance = record.get("balance")
158                user.LifeTimePaid = record.get("lifetimepaid")
159                user.Email = record.get("email")
160                user.Exists = 1
161                groupmembers.append(user)
162                self.cacheEntry("USERS", user.Name, user)
163        return groupmembers       
164       
165    def getUserGroupsFromBackend(self, user) :       
166        """Returns the user's groups list."""
167        groups = []
168        result = self.doSearch("SELECT groupname FROM groupsmembers JOIN groups ON groupsmembers.groupid=groups.id WHERE userid=%s" % self.doQuote(user.ident))
169        if result :
170            for record in result :
171                groups.append(self.getGroup(record.get("groupname")))
172        return groups       
173       
174    def getParentPrintersFromBackend(self, printer) :   
175        """Get all the printer groups this printer is a member of."""
176        pgroups = []
177        result = self.doSearch("SELECT groupid,printername FROM printergroupsmembers JOIN printers ON groupid=id WHERE printerid=%s" % self.doQuote(printer.ident))
178        if result :
179            for record in result :
180                if record["groupid"] != printer.ident : # in case of integrity violation
181                    parentprinter = self.getPrinter(record.get("printername"))
182                    if parentprinter.Exists :
183                        pgroups.append(parentprinter)
184        return pgroups
185       
186    def getMatchingPrinters(self, printerpattern) :
187        """Returns the list of all printers for which name matches a certain pattern."""
188        printers = []
189        # We 'could' do a SELECT printername FROM printers WHERE printername LIKE ...
190        # but we don't because other storages semantics may be different, so every
191        # storage should use fnmatch to match patterns and be storage agnostic
192        result = self.doSearch("SELECT * FROM printers")
193        if result :
194            for record in result :
195                if self.tool.matchString(record["printername"], printerpattern.split(",")) :
196                    printer = StoragePrinter(self, record["printername"])
197                    printer.ident = record.get("id")
198                    printer.PricePerJob = record.get("priceperjob")
199                    printer.PricePerPage = record.get("priceperpage")
200                    printer.LastJob = self.getPrinterLastJob(printer)
201                    printer.Exists = 1
202                    printers.append(printer)
203                    self.cacheEntry("PRINTERS", printer.Name, printer)
204        return printers       
205       
206    def getPrinterUsersAndQuotas(self, printer, names=["*"]) :       
207        """Returns the list of users who uses a given printer, along with their quotas."""
208        usersandquotas = []
209        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))
210        if result :
211            for record in result :
212                if self.tool.matchString(record.get("username"), names) :
213                    user = StorageUser(self, record.get("username"))
214                    user.ident = record.get("uid")
215                    user.LimitBy = record.get("limitby")
216                    user.AccountBalance = record.get("balance")
217                    user.LifeTimePaid = record.get("lifetimepaid")
218                    user.Email = record.get("email") 
219                    user.Exists = 1
220                    userpquota = StorageUserPQuota(self, user, printer)
221                    userpquota.ident = record.get("id")
222                    userpquota.PageCounter = record.get("pagecounter")
223                    userpquota.LifePageCounter = record.get("lifepagecounter")
224                    userpquota.SoftLimit = record.get("softlimit")
225                    userpquota.HardLimit = record.get("hardlimit")
226                    userpquota.DateLimit = record.get("datelimit")
227                    userpquota.Exists = 1
228                    usersandquotas.append((user, userpquota))
229                    self.cacheEntry("USERS", user.Name, user)
230                    self.cacheEntry("USERPQUOTAS", "%s@%s" % (user.Name, printer.Name), userpquota)
231        return usersandquotas
232               
233    def getPrinterGroupsAndQuotas(self, printer, names=["*"]) :       
234        """Returns the list of groups which uses a given printer, along with their quotas."""
235        groupsandquotas = []
236        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))
237        if result :
238            for record in result :
239                if self.tool.matchString(record.get("groupname"), names) :
240                    group = self.getGroup(record.get("groupname"))
241                    grouppquota = self.getGroupPQuota(group, printer)
242                    groupsandquotas.append((group, grouppquota))
243        return groupsandquotas
244       
245    def addPrinter(self, printername) :       
246        """Adds a printer to the quota storage, returns it."""
247        self.doModify("INSERT INTO printers (printername) VALUES (%s)" % self.doQuote(printername))
248        return self.getPrinter(printername)
249       
250    def addUser(self, user) :       
251        """Adds a user to the quota storage, returns its id."""
252        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)))
253        return self.getUser(user.Name)
254       
255    def addGroup(self, group) :       
256        """Adds a group to the quota storage, returns its id."""
257        self.doModify("INSERT INTO groups (groupname, limitby) VALUES (%s, %s)" % (self.doQuote(group.Name), self.doQuote(group.LimitBy)))
258        return self.getGroup(group.Name)
259
260    def addUserToGroup(self, user, group) :   
261        """Adds an user to a group."""
262        result = self.doSearch("SELECT COUNT(*) AS mexists FROM groupsmembers WHERE groupid=%s AND userid=%s" % (self.doQuote(group.ident), self.doQuote(user.ident)))
263        try :
264            mexists = int(result[0].get("mexists"))
265        except (IndexError, TypeError) :   
266            mexists = 0
267        if not mexists :   
268            self.doModify("INSERT INTO groupsmembers (groupid, userid) VALUES (%s, %s)" % (self.doQuote(group.ident), self.doQuote(user.ident)))
269           
270    def addUserPQuota(self, user, printer) :
271        """Initializes a user print quota on a printer."""
272        self.doModify("INSERT INTO userpquota (userid, printerid) VALUES (%s, %s)" % (self.doQuote(user.ident), self.doQuote(printer.ident)))
273        return self.getUserPQuota(user, printer)
274       
275    def addGroupPQuota(self, group, printer) :
276        """Initializes a group print quota on a printer."""
277        self.doModify("INSERT INTO grouppquota (groupid, printerid) VALUES (%s, %s)" % (self.doQuote(group.ident), self.doQuote(printer.ident)))
278        return self.getGroupPQuota(group, printer)
279       
280    def writePrinterPrices(self, printer) :   
281        """Write the printer's prices back into the storage."""
282        self.doModify("UPDATE printers SET priceperpage=%s, priceperjob=%s WHERE id=%s" % (self.doQuote(printer.PricePerPage), self.doQuote(printer.PricePerJob), self.doQuote(printer.ident)))
283       
284    def writeUserLimitBy(self, user, limitby) :   
285        """Sets the user's limiting factor."""
286        self.doModify("UPDATE users SET limitby=%s WHERE id=%s" % (self.doQuote(limitby), self.doQuote(user.ident)))
287       
288    def writeGroupLimitBy(self, group, limitby) :   
289        """Sets the group's limiting factor."""
290        self.doModify("UPDATE groups SET limitby=%s WHERE id=%s" % (self.doQuote(limitby), self.doQuote(group.ident)))
291       
292    def writeUserPQuotaDateLimit(self, userpquota, datelimit) :   
293        """Sets the date limit permanently for a user print quota."""
294        self.doModify("UPDATE userpquota SET datelimit=%s WHERE id=%s" % (self.doQuote(datelimit), self.doQuote(userpquota.ident)))
295           
296    def writeGroupPQuotaDateLimit(self, grouppquota, datelimit) :   
297        """Sets the date limit permanently for a group print quota."""
298        self.doModify("UPDATE grouppquota SET datelimit=%s WHERE id=%s" % (self.doQuote(datelimit), self.doQuote(grouppquota.ident)))
299       
300    def increaseUserPQuotaPagesCounters(self, userpquota, nbpages) :   
301        """Increase page counters for a user print quota."""
302        self.doModify("UPDATE userpquota SET pagecounter=pagecounter+%s,lifepagecounter=lifepagecounter+%s WHERE id=%s" % (self.doQuote(nbpages), self.doQuote(nbpages), self.doQuote(userpquota.ident)))
303       
304    def writeUserPQuotaPagesCounters(self, userpquota, newpagecounter, newlifepagecounter) :   
305        """Sets the new page counters permanently for a user print quota."""
306        self.doModify("UPDATE userpquota SET pagecounter=%s,lifepagecounter=%s WHERE id=%s" % (self.doQuote(newpagecounter), self.doQuote(newlifepagecounter), self.doQuote(userpquota.ident)))
307       
308    def decreaseUserAccountBalance(self, user, amount) :   
309        """Decreases user's account balance from an amount."""
310        self.doModify("UPDATE users SET balance=balance-%s WHERE id=%s" % (self.doQuote(amount), self.doQuote(user.ident)))
311       
312    def writeUserAccountBalance(self, user, newbalance, newlifetimepaid=None) :   
313        """Sets the new account balance and eventually new lifetime paid."""
314        if newlifetimepaid is not None :
315            self.doModify("UPDATE users SET balance=%s, lifetimepaid=%s WHERE id=%s" % (self.doQuote(newbalance), self.doQuote(newlifetimepaid), self.doQuote(user.ident)))
316        else :   
317            self.doModify("UPDATE users SET balance=%s WHERE id=%s" % (self.doQuote(newbalance), self.doQuote(user.ident)))
318           
319    def writeLastJobSize(self, lastjob, jobsize, jobprice) :       
320        """Sets the last job's size permanently."""
321        self.doModify("UPDATE jobhistory SET jobsize=%s, jobprice=%s WHERE id=%s" % (self.doQuote(jobsize), self.doQuote(jobprice), self.doQuote(lastjob.ident)))
322       
323    def writeJobNew(self, printer, user, jobid, pagecounter, action, jobsize=None, jobprice=None, filename=None, title=None, copies=None, options=None) :   
324        """Adds a job in a printer's history."""
325        if (not self.disablehistory) or (not printer.LastJob.Exists) :
326            if jobsize is not None :
327                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)))
328            else :   
329                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)))
330        else :       
331            # here we explicitly want to reset jobsize to NULL if needed
332            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)))
333           
334    def writeUserPQuotaLimits(self, userpquota, softlimit, hardlimit) :
335        """Sets soft and hard limits for a user quota."""
336        self.doModify("UPDATE userpquota SET softlimit=%s, hardlimit=%s, datelimit=NULL WHERE id=%s" % (self.doQuote(softlimit), self.doQuote(hardlimit), self.doQuote(userpquota.ident)))
337       
338    def writeGroupPQuotaLimits(self, grouppquota, softlimit, hardlimit) :
339        """Sets soft and hard limits for a group quota on a specific printer."""
340        self.doModify("UPDATE grouppquota SET softlimit=%s, hardlimit=%s, datelimit=NULL WHERE id=%s" % (self.doQuote(softlimit), self.doQuote(hardlimit), self.doQuote(grouppquota.ident)))
341
342    def writePrinterToGroup(self, pgroup, printer) :
343        """Puts a printer into a printer group."""
344        children = []
345        result = self.doSearch("SELECT printerid FROM printergroupsmembers WHERE groupid=%s" % self.doQuote(pgroup.ident))
346        if result :
347            for record in result :
348                children.append(record.get("printerid")) # TODO : put this into the database integrity rules
349        if printer.ident not in children :       
350            self.doModify("INSERT INTO printergroupsmembers (groupid, printerid) VALUES (%s, %s)" % (self.doQuote(pgroup.ident), self.doQuote(printer.ident)))
351       
352    def retrieveHistory(self, user=None, printer=None, datelimit=None, limit=100) :   
353        """Retrieves all print jobs for user on printer (or all) before date, limited to first 100 results."""
354        query = "SELECT jobhistory.*,username,printername FROM jobhistory,users,printers WHERE users.id=userid AND printers.id=printerid"
355        where = []
356        if (user is not None) and user.Exists :
357            where.append("userid=%s" % self.doQuote(user.ident))
358        if (printer is not None) and printer.Exists :
359            where.append("printerid=%s" % self.doQuote(printer.ident))
360        if datelimit is not None :   
361            where.append("jobdate<=%s" % self.doQuote(datelimit))
362        if where :   
363            query += " AND %s" % " AND ".join(where)
364        query += " ORDER BY id DESC"
365        if limit :
366            query += " LIMIT %s" % self.doQuote(int(limit))
367        jobs = []   
368        result = self.doSearch(query)   
369        if result :
370            for fields in result :
371                job = StorageJob(self)
372                job.ident = fields.get("id")
373                job.JobId = fields.get("jobid")
374                job.PrinterPageCounter = fields.get("pagecounter")
375                job.JobSize = fields.get("jobsize")
376                job.JobPrice = fields.get("jobprice")
377                job.JobAction = fields.get("action")
378                job.JobFileName = fields.get("filename")
379                job.JobTitle = fields.get("title")
380                job.JobCopies = fields.get("copies")
381                job.JobOptions = fields.get("options")
382                job.JobDate = fields.get("jobdate")
383                job.User = self.getUser(fields.get("username"))
384                job.Printer = self.getPrinter(fields.get("printername"))
385                job.Exists = 1
386                jobs.append(job)
387        return jobs
388       
389    def deleteUser(self, user) :   
390        """Completely deletes an user from the Quota Storage."""
391        # TODO : What should we do if we delete the last person who used a given printer ?
392        # TODO : we can't reassign the last job to the previous one, because next user would be
393        # TODO : incorrectly charged (overcharged).
394        for q in [ 
395                    "DELETE FROM groupsmembers WHERE userid=%s" % self.doQuote(user.ident),
396                    "DELETE FROM jobhistory WHERE userid=%s" % self.doQuote(user.ident),
397                    "DELETE FROM userpquota WHERE userid=%s" % self.doQuote(user.ident),
398                    "DELETE FROM users WHERE id=%s" % self.doQuote(user.ident),
399                  ] :
400            self.doModify(q)
401       
402    def deleteGroup(self, group) :   
403        """Completely deletes a group from the Quota Storage."""
404        for q in [
405                   "DELETE FROM groupsmembers WHERE groupid=%s" % self.doQuote(group.ident),
406                   "DELETE FROM grouppquota WHERE groupid=%s" % self.doQuote(group.ident),
407                   "DELETE FROM groups WHERE id=%s" % self.doQuote(group.ident),
408                 ] : 
409            self.doModify(q)
410       
Note: See TracBrowser for help on using the browser.