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

Revision 952, 21.3 kB (checked in by jalet, 21 years ago)

Preliminary support for LPRng added BUT STILL UNTESTED.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1# PyKota
2#
3# PyKota : Print Quotas for CUPS and LPRng
4#
5# (c) 2003 Jerome Alet <alet@librelogiciel.com>
6# This program is free software; you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation; either version 2 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program; if not, write to the Free Software
18# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
19#
20# $Id$
21#
22# $Log$
23# Revision 1.29  2003/04/23 22:13:57  jalet
24# Preliminary support for LPRng added BUT STILL UNTESTED.
25#
26# Revision 1.28  2003/04/17 09:26:21  jalet
27# repykota now reports account balances too.
28#
29# Revision 1.27  2003/04/16 12:35:49  jalet
30# Groups quota work now !
31#
32# Revision 1.26  2003/04/16 08:53:14  jalet
33# Printing can now be limited either by user's account balance or by
34# page quota (the default). Quota report doesn't include account balance
35# yet, though.
36#
37# Revision 1.25  2003/04/15 21:58:33  jalet
38# edpykota now accepts a --delete option.
39# Preparation to allow edpykota to accept much more command line options
40# (WARNING : docstring is OK, but code isn't !)
41#
42# Revision 1.24  2003/04/15 13:55:28  jalet
43# Options --limitby and --balance added to edpykota
44#
45# Revision 1.23  2003/04/15 11:30:57  jalet
46# More work done on money print charging.
47# Minor bugs corrected.
48# All tools now access to the storage as priviledged users, repykota excepted.
49#
50# Revision 1.22  2003/04/10 21:47:20  jalet
51# Job history added. Upgrade script neutralized for now !
52#
53# Revision 1.21  2003/04/08 20:38:08  jalet
54# The last job Id is saved now for each printer, this will probably
55# allow other accounting methods in the future.
56#
57# Revision 1.20  2003/03/29 13:45:27  jalet
58# GPL paragraphs were incorrectly (from memory) copied into the sources.
59# Two README files were added.
60# Upgrade script for PostgreSQL pre 1.01 schema was added.
61#
62# Revision 1.19  2003/02/27 08:41:49  jalet
63# DATETIME is not supported anymore in PostgreSQL 7.3 it seems, but
64# TIMESTAMP is.
65#
66# Revision 1.18  2003/02/10 12:07:31  jalet
67# Now repykota should output the recorded total page number for each printer too.
68#
69# Revision 1.17  2003/02/10 08:41:36  jalet
70# edpykota's --reset command line option resets the limit date too.
71#
72# Revision 1.16  2003/02/08 22:39:46  jalet
73# --reset command line option added
74#
75# Revision 1.15  2003/02/08 22:12:09  jalet
76# Life time counter for users and groups added.
77#
78# Revision 1.14  2003/02/07 22:13:13  jalet
79# Perhaps edpykota is now able to add printers !!! Oh, stupid me !
80#
81# Revision 1.13  2003/02/07 00:08:52  jalet
82# Typos
83#
84# Revision 1.12  2003/02/06 23:20:03  jalet
85# warnpykota doesn't need any user/group name argument, mimicing the
86# warnquota disk quota tool.
87#
88# Revision 1.11  2003/02/06 15:05:13  jalet
89# self was forgotten
90#
91# Revision 1.10  2003/02/06 15:03:11  jalet
92# added a method to set the limit date
93#
94# Revision 1.9  2003/02/06 14:52:35  jalet
95# Forgotten import
96#
97# Revision 1.8  2003/02/06 14:49:04  jalet
98# edpykota should be ok now
99#
100# Revision 1.7  2003/02/06 14:28:59  jalet
101# edpykota should be ok, minus some typos
102#
103# Revision 1.6  2003/02/06 09:19:02  jalet
104# More robust behavior (hopefully) when the user or printer is not managed
105# correctly by the Quota System : e.g. cupsFilter added in ppd file, but
106# printer and/or user not 'yet?' in storage.
107#
108# Revision 1.5  2003/02/05 23:26:22  jalet
109# Incorrect handling of grace delay
110#
111# Revision 1.4  2003/02/05 23:02:10  jalet
112# Typo
113#
114# Revision 1.3  2003/02/05 23:00:12  jalet
115# Forgotten import
116# Bad datetime conversion
117#
118# Revision 1.2  2003/02/05 22:28:38  jalet
119# More robust storage
120#
121# Revision 1.1  2003/02/05 21:28:17  jalet
122# Initial import into CVS
123#
124#
125#
126
127import fnmatch
128
129class SQLStorage :   
130    def getMatchingPrinters(self, printerpattern) :
131        """Returns the list of all printers as tuples (id, name) for printer names which match a certain pattern."""
132        printerslist = []
133        # We 'could' do a SELECT printername FROM printers WHERE printername LIKE ...
134        # but we don't because other storages semantics may be different, so every
135        # storage should use fnmatch to match patterns and be storage agnostic
136        result = self.doQuery("SELECT id, printername FROM printers")
137        result = self.doParseResult(result)
138        if result is not None :
139            for printer in result :
140                if fnmatch.fnmatchcase(printer["printername"], printerpattern) :
141                    printerslist.append((printer["id"], printer["printername"]))
142        return printerslist       
143           
144    def getPrinterId(self, printername) :       
145        """Returns a printerid given a printername."""
146        result = self.doQuery("SELECT id FROM printers WHERE printername=%s" % self.doQuote(printername))
147        try :
148            return self.doParseResult(result)[0]["id"]
149        except TypeError :      # Not found   
150            return
151           
152    def getPrinterPrices(self, printerid) :       
153        """Returns a printer prices per page and per job given a printerid."""
154        result = self.doQuery("SELECT priceperpage, priceperjob FROM printers WHERE id=%s" % self.doQuote(printerid))
155        try :
156            printerprices = self.doParseResult(result)[0]
157            return (printerprices["priceperpage"], printerprices["priceperjob"])
158        except TypeError :      # Not found   
159            return
160           
161    def setPrinterPrices(self, printerid, perpage, perjob) :
162        """Sets prices per job and per page for a given printer."""
163        self.doQuery("UPDATE printers SET priceperpage=%s, priceperjob=%s WHERE id=%s" % (self.doQuote(perpage), self.doQuote(perjob), self.doQuote(printerid)))
164   
165    def getUserId(self, username) :
166        """Returns a userid given a username."""
167        result = self.doQuery("SELECT id FROM users WHERE username=%s" % self.doQuote(username))
168        try :
169            return self.doParseResult(result)[0]["id"]
170        except TypeError :      # Not found
171            return
172           
173    def getGroupId(self, groupname) :
174        """Returns a groupid given a grupname."""
175        result = self.doQuery("SELECT id FROM groups WHERE groupname=%s" % self.doQuote(groupname))
176        try :
177            return self.doParseResult(result)[0]["id"]
178        except TypeError :      # Not found
179            return
180           
181    def getJobHistoryId(self, jobid, userid, printerid) :       
182        """Returns the history line's id given a (jobid, userid, printerid)."""
183        result = self.doQuery("SELECT id FROM jobhistory WHERE jobid=%s AND userid=%s AND printerid=%s" % (self.doQuote(jobid), self.doQuote(userid), self.doQuote(printerid)))
184        try :
185            return self.doParseResult(result)[0]["id"]
186        except TypeError :      # Not found   
187            return
188           
189    def getPrinterUsers(self, printerid) :       
190        """Returns the list of usernames which uses a given printer."""
191        result = self.doQuery("SELECT DISTINCT id, username FROM users WHERE id IN (SELECT userid FROM userpquota WHERE printerid=%s) ORDER BY username" % self.doQuote(printerid))
192        result = self.doParseResult(result)
193        if result is None :
194            return []
195        else :   
196            return [(record["id"], record["username"]) for record in result]
197       
198    def getPrinterGroups(self, printerid) :       
199        """Returns the list of groups which uses a given printer."""
200        result = self.doQuery("SELECT DISTINCT id, groupname FROM groups WHERE id IN (SELECT groupid FROM grouppquota WHERE printerid=%s)" % self.doQuote(printerid))
201        result = self.doParseResult(result)
202        if result is None :
203            return []
204        else :   
205            return [(record["id"], record["groupname"]) for record in result]
206       
207    def getGroupMembersNames(self, groupname) :       
208        """Returns the list of user's names which are member of this group."""
209        groupid = self.getGroupId(groupname)
210        if groupid is None :
211            return []
212        else :
213            result = self.doQuery("SELECT DISTINCT username FROM users WHERE id IN (SELECT userid FROM groupsmembers WHERE groupid=%s)" % self.doQuote(groupid))
214            return [record["username"] for record in (self.doParseResult(result) or [])]
215       
216    def getUserGroupsNames(self, userid) :       
217        """Returns the list of groups' names the user is a member of."""
218        result = self.doQuery("SELECT DISTINCT groupname FROM groups WHERE id IN (SELECT groupid FROM groupsmembers WHERE userid=%s)" % self.doQuote(userid))
219        return [record["groupname"] for record in (self.doParseResult(result) or [])]
220       
221    def addPrinter(self, printername) :       
222        """Adds a printer to the quota storage, returns its id."""
223        self.doQuery("INSERT INTO printers (printername) VALUES (%s)" % self.doQuote(printername))
224        return self.getPrinterId(printername)
225       
226    def addUser(self, username) :       
227        """Adds a user to the quota storage, returns its id."""
228        self.doQuery("INSERT INTO users (username) VALUES (%s)" % self.doQuote(username))
229        return self.getUserId(username)
230       
231    def addGroup(self, groupname) :       
232        """Adds a group to the quota storage, returns its id."""
233        self.doQuery("INSERT INTO groups (groupname) VALUES (%s)" % self.doQuote(groupname))
234        return self.getGroupId(groupname)
235       
236    def addUserPQuota(self, username, printerid) :
237        """Initializes a user print quota on a printer, adds the user to the quota storage if needed."""
238        userid = self.getUserId(username)     
239        if userid is None :   
240            userid = self.addUser(username)
241        uqexists = (self.getUserPQuota(userid, printerid) is not None)   
242        if not uqexists : 
243            self.doQuery("INSERT INTO userpquota (userid, printerid) VALUES (%s, %s)" % (self.doQuote(userid), self.doQuote(printerid)))
244        return (userid, printerid)
245       
246    def addGroupPQuota(self, groupname, printerid) :
247        """Initializes a group print quota on a printer, adds the group to the quota storage if needed."""
248        groupid = self.getGroupId(groupname)     
249        if groupid is None :   
250            groupid = self.addGroup(groupname)
251        gqexists = (self.getGroupPQuota(groupid, printerid) is not None)   
252        if not gqexists : 
253            self.doQuery("INSERT INTO grouppquota (groupid, printerid) VALUES (%s, %s)" % (self.doQuote(groupid), self.doQuote(printerid)))
254        return (groupid, printerid)
255       
256    def increaseUserBalance(self, userid, amount) :   
257        """Increases (or decreases) an user's account balance by a given amount."""
258        self.doQuery("UPDATE users SET balance=balance+(%s), lifetimepaid=lifetimepaid+(%s) WHERE id=%s" % (self.doQuote(amount), self.doQuote(amount), self.doQuote(userid)))
259       
260    def getUserBalance(self, userid) :   
261        """Returns the current account balance for a given user."""
262        result = self.doQuery("SELECT balance, lifetimepaid FROM users WHERE id=%s" % self.doQuote(userid))
263        try :
264            result = self.doParseResult(result)[0]
265        except TypeError :      # Not found   
266            return
267        else :   
268            return (result["balance"], result["lifetimepaid"])
269       
270    def getGroupBalance(self, groupid) :   
271        """Returns the current account balance for a given group, as the sum of each of its users' account balance."""
272        result = self.doQuery("SELECT SUM(balance) AS balance, SUM(lifetimepaid) AS lifetimepaid FROM users WHERE id in (SELECT userid FROM groupsmembers WHERE groupid=%s)" % self.doQuote(groupid))
273        try :
274            result = self.doParseResult(result)[0]
275        except TypeError :      # Not found   
276            return
277        else :   
278            return (result["balance"], result["lifetimepaid"])
279       
280    def getUserLimitBy(self, userid) :   
281        """Returns the way in which user printing is limited."""
282        result = self.doQuery("SELECT limitby FROM users WHERE id=%s" % self.doQuote(userid))
283        try :
284            return self.doParseResult(result)[0]["limitby"]
285        except TypeError :      # Not found   
286            return
287       
288    def getGroupLimitBy(self, groupid) :   
289        """Returns the way in which group printing is limited."""
290        result = self.doQuery("SELECT limitby FROM groups WHERE id=%s" % self.doQuote(groupid))
291        try :
292            return self.doParseResult(result)[0]["limitby"]
293        except TypeError :      # Not found   
294            return
295       
296    def setUserBalance(self, userid, balance) :   
297        """Sets the account balance for a given user to a fixed value."""
298        (current, lifetimepaid) = self.getUserBalance(userid)
299        difference = balance - current
300        self.increaseUserBalance(userid, difference)
301       
302    def limitUserBy(self, userid, limitby) :   
303        """Limits a given user based either on print quota or on account balance."""
304        self.doQuery("UPDATE users SET limitby=%s WHERE id=%s" % (self.doQuote(limitby), self.doQuote(userid)))
305       
306    def limitGroupBy(self, groupid, limitby) :   
307        """Limits a given group based either on print quota or on sum of its users' account balances."""
308        self.doQuery("UPDATE groups SET limitby=%s WHERE id=%s" % (self.doQuote(limitby), self.doQuote(groupid)))
309       
310    def setUserPQuota(self, userid, printerid, softlimit, hardlimit) :
311        """Sets soft and hard limits for a user quota on a specific printer given (userid, printerid)."""
312        self.doQuery("UPDATE userpquota SET softlimit=%s, hardlimit=%s, datelimit=NULL WHERE userid=%s AND printerid=%s" % (self.doQuote(softlimit), self.doQuote(hardlimit), self.doQuote(userid), self.doQuote(printerid)))
313       
314    def setGroupPQuota(self, groupid, printerid, softlimit, hardlimit) :
315        """Sets soft and hard limits for a group quota on a specific printer given (groupid, printerid)."""
316        self.doQuery("UPDATE grouppquota SET softlimit=%s, hardlimit=%s, datelimit=NULL WHERE groupid=%s AND printerid=%s" % (self.doQuote(softlimit), self.doQuote(hardlimit), self.doQuote(groupid), self.doQuote(printerid)))
317       
318    def resetUserPQuota(self, userid, printerid) :   
319        """Resets the page counter to zero for a user on a printer. Life time page counter is kept unchanged."""
320        self.doQuery("UPDATE userpquota SET pagecounter=0, datelimit=NULL WHERE userid=%s AND printerid=%s" % (self.doQuote(userid), self.doQuote(printerid)))
321       
322    def resetGroupPQuota(self, groupid, printerid) :   
323        """Resets the page counter to zero for a group on a printer. Life time page counter is kept unchanged."""
324        self.doQuery("UPDATE grouppquota SET pagecounter=0, datelimit=NULL WHERE groupid=%s AND printerid=%s" % (self.doQuote(groupid), self.doQuote(printerid)))
325       
326    def updateUserPQuota(self, userid, printerid, pagecount) :
327        """Updates the used user Quota information given (userid, printerid) and a job size in pages."""
328        jobprice = self.computePrinterJobPrice(printerid, pagecount)
329        queries = []   
330        queries.append("UPDATE userpquota SET lifepagecounter=lifepagecounter+(%s), pagecounter=pagecounter+(%s) WHERE userid=%s AND printerid=%s" % (self.doQuote(pagecount), self.doQuote(pagecount), self.doQuote(userid), self.doQuote(printerid)))
331        queries.append("UPDATE users SET balance=balance-(%s) WHERE id=%s" % (self.doQuote(jobprice), self.doQuote(userid)))
332        self.doQuery(queries)
333       
334    def getUserPQuota(self, userid, printerid) :
335        """Returns the Print Quota information for a given (userid, printerid)."""
336        result = self.doQuery("SELECT lifepagecounter, pagecounter, softlimit, hardlimit, datelimit FROM userpquota WHERE userid=%s AND printerid=%s" % (self.doQuote(userid), self.doQuote(printerid)))
337        try :
338            return self.doParseResult(result)[0]
339        except TypeError :      # Not found   
340            return
341       
342    def getGroupPQuota(self, groupid, printerid) :
343        """Returns the Print Quota information for a given (groupid, printerid)."""
344        result = self.doQuery("SELECT softlimit, hardlimit, datelimit FROM grouppquota WHERE groupid=%s AND printerid=%s" % (self.doQuote(groupid), self.doQuote(printerid)))
345        try :
346            grouppquota = self.doParseResult(result)[0]
347        except TypeError :   
348            return
349        else :   
350            result = self.doQuery("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(printerid), self.doQuote(groupid)))
351            try :
352                result = self.doParseResult(result)[0]
353            except TypeError :      # Not found   
354                return
355            else :   
356                grouppquota.update({"lifepagecounter": result["lifepagecounter"], "pagecounter": result["pagecounter"]})
357                return grouppquota
358       
359    def setUserDateLimit(self, userid, printerid, datelimit) :
360        """Sets the limit date for a soft limit to become an hard one given (userid, printerid)."""
361        self.doQuery("UPDATE userpquota SET datelimit=%s::TIMESTAMP WHERE userid=%s AND printerid=%s" % (self.doQuote("%04i-%02i-%02i %02i:%02i:%02i" % (datelimit.year, datelimit.month, datelimit.day, datelimit.hour, datelimit.minute, datelimit.second)), self.doQuote(userid), self.doQuote(printerid)))
362       
363    def setGroupDateLimit(self, groupid, printerid, datelimit) :
364        """Sets the limit date for a soft limit to become an hard one given (groupid, printerid)."""
365        self.doQuery("UPDATE grouppquota SET datelimit=%s::TIMESTAMP WHERE groupid=%s AND printerid=%s" % (self.doQuote("%04i-%02i-%02i %02i:%02i:%02i" % (datelimit.year, datelimit.month, datelimit.day, datelimit.hour, datelimit.minute, datelimit.second)), self.doQuote(groupid), self.doQuote(printerid)))
366       
367    def addJobToHistory(self, jobid, userid, printerid, pagecounter, action) :
368        """Adds a job to the history: (jobid, userid, printerid, last page counter taken from requester)."""
369        self.doQuery("INSERT INTO jobhistory (jobid, userid, printerid, pagecounter, action) VALUES (%s, %s, %s, %s, %s)" % (self.doQuote(jobid), self.doQuote(userid), self.doQuote(printerid), self.doQuote(pagecounter), self.doQuote(action)))
370        return self.getJobHistoryId(jobid, userid, printerid) # in case jobid is not sufficient
371   
372    def updateJobSizeInHistory(self, historyid, jobsize) :
373        """Updates a job size in the history given the history line's id."""
374        self.doQuery("UPDATE jobhistory SET jobsize=%s WHERE id=%s" % (self.doQuote(jobsize), self.doQuote(historyid)))
375   
376    def getPrinterPageCounter(self, printerid) :
377        """Returns the last page counter value for a printer given its id, also returns last username, last jobid and history line id."""
378        result = self.doQuery("SELECT jobhistory.id, jobid, userid, username, pagecounter FROM jobhistory, users WHERE printerid=%s AND userid=users.id ORDER BY jobdate DESC LIMIT 1" % self.doQuote(printerid))
379        try :
380            return self.doParseResult(result)[0]
381        except TypeError :      # Not found
382            return
383       
384    def addUserToGroup(self, userid, groupid) :   
385        """Adds an user to a group."""
386        result = self.doQuery("SELECT COUNT(*) AS mexists FROM groupsmembers WHERE groupid=%s AND userid=%s" % (self.doQuote(groupid), self.doQuote(userid)))
387        try :
388            mexists = self.doParseResult(result)[0]["mexists"]
389        except TypeError :   
390            mexists = 0
391        if not mexists :   
392            self.doQuery("INSERT INTO groupsmembers (groupid, userid) VALUES (%s, %s)" % (self.doQuote(groupid), self.doQuote(userid)))
393       
394    def deleteUser(self, userid) :   
395        """Completely deletes an user from the Quota Storage."""
396        queries = []
397        queries.append("DELETE FROM groupsmembers WHERE userid=%s" % self.doQuote(userid))
398        queries.append("DELETE FROM jobhistory WHERE userid=%s" % self.doQuote(userid))
399        queries.append("DELETE FROM userpquota WHERE userid=%s" % self.doQuote(userid))
400        queries.append("DELETE FROM users WHERE id=%s" % self.doQuote(userid))
401        # TODO : What should we do if we delete the last person who used a given printer ?
402        self.doQuery(queries)
403       
404    def deleteGroup(self, groupid) :   
405        """Completely deletes an user from the Quota Storage."""
406        queries = []
407        queries.append("DELETE FROM groupsmembers WHERE groupid=%s" % self.doQuote(groupid))
408        queries.append("DELETE FROM grouppquota WHERE groupid=%s" % self.doQuote(groupid))
409        queries.append("DELETE FROM groups WHERE id=%s" % self.doQuote(groupid))
410        self.doQuery(queries)
411       
412    def computePrinterJobPrice(self, printerid, jobsize) :   
413        """Returns the price for a job on a given printer."""
414        prices = self.getPrinterPrices(printerid)
415        if prices is None :
416            perpage = perjob = 0.0
417        else :   
418            (perpage, perjob) = prices
419        return perjob + (perpage * jobsize)
Note: See TracBrowser for help on using the browser.