root / pykota / trunk / pykota / storage.py @ 2451

Revision 2451, 32.4 kB (checked in by jerome, 19 years ago)

Improved cache flushing

  • 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20#
21# $Id$
22#
23#
24
25from mx import DateTime
26
27class PyKotaStorageError(Exception):
28    """An exception for Quota Storage related stuff."""
29    def __init__(self, message = ""):
30        self.message = message
31        Exception.__init__(self, message)
32    def __repr__(self):
33        return self.message
34    __str__ = __repr__
35       
36class StorageObject :
37    """Object present in the Quota Storage."""
38    def __init__(self, parent) :
39        "Initialize minimal data."""
40        self.parent = parent
41        self.ident = None
42        self.Exists = 0
43       
44class StorageUser(StorageObject) :       
45    """User class."""
46    def __init__(self, parent, name) :
47        StorageObject.__init__(self, parent)
48        self.Name = name
49        self.LimitBy = None
50        self.AccountBalance = None
51        self.LifeTimePaid = None
52        self.Email = None
53        self.OverCharge = 1.0
54        self.Payments = [] # TODO : maybe handle this smartly for SQL, for now just don't retrieve them
55       
56    def consumeAccountBalance(self, amount) :     
57        """Consumes an amount of money from the user's account balance."""
58        self.parent.decreaseUserAccountBalance(self, amount)
59        self.AccountBalance = float(self.AccountBalance or 0.0) - amount
60       
61    def setAccountBalance(self, balance, lifetimepaid) :   
62        """Sets the user's account balance in case he pays more money."""
63        diff = float(lifetimepaid or 0.0) - float(self.LifeTimePaid or 0.0)
64        self.parent.beginTransaction()
65        try :
66            self.parent.writeUserAccountBalance(self, balance, lifetimepaid)
67            self.parent.writeNewPayment(self, diff)
68        except PyKotaStorageError, msg :   
69            self.parent.rollbackTransaction()
70            raise PyKotaStorageError, msg
71        else :   
72            self.parent.commitTransaction()
73            self.AccountBalance = balance
74            self.LifeTimePaid = lifetimepaid
75       
76    def setLimitBy(self, limitby) :   
77        """Sets the user's limiting factor."""
78        try :
79            limitby = limitby.lower()
80        except AttributeError :   
81            limitby = "quota"
82        if limitby in ["quota", "balance", "quota-then-balance", "balance-then-quota"] :
83            self.parent.writeUserLimitBy(self, limitby)
84            self.LimitBy = limitby
85       
86    def setOverChargeFactor(self, factor) :   
87        """Sets the user's overcharging coefficient."""
88        self.parent.writeUserOverCharge(self, factor)
89        self.OverCharge = factor
90       
91    def delete(self) :   
92        """Deletes an user from the Quota Storage."""
93        self.parent.beginTransaction()
94        try :
95            self.parent.deleteUser(self)
96        except PyKotaStorageError, msg :   
97            self.parent.rollbackTransaction()
98            raise PyKotaStorageError, msg
99        else :   
100            self.parent.commitTransaction()
101            self.parent.flushEntry("USERS", self.Name)
102            for (k, v) in self.parent.caches["USERPQUOTAS"].items() :
103                if v.User.Name == self.Name :
104                    self.parent.flushEntry("USERPQUOTAS", "%s@%s" % (v.User.Name, v.Printer.Name))
105            self.Exists = 0
106       
107class StorageGroup(StorageObject) :       
108    """User class."""
109    def __init__(self, parent, name) :
110        StorageObject.__init__(self, parent)
111        self.Name = name
112        self.LimitBy = None
113        self.AccountBalance = None
114        self.LifeTimePaid = None
115       
116    def setLimitBy(self, limitby) :   
117        """Sets the user's limiting factor."""
118        try :
119            limitby = limitby.lower()
120        except AttributeError :   
121            limitby = "quota"
122        if limitby in ["quota", "balance"] :
123            self.parent.writeGroupLimitBy(self, limitby)
124            self.LimitBy = limitby
125       
126    def delete(self) :   
127        """Deletes a group from the Quota Storage."""
128        self.parent.beginTransaction()
129        try :
130            self.parent.deleteGroup(self)
131        except PyKotaStorageError, msg :   
132            self.parent.rollbackTransaction()
133            raise PyKotaStorageError, msg
134        else :   
135            self.parent.commitTransaction()
136            self.parent.flushEntry("GROUPS", self.Name)
137            for (k, v) in self.parent.caches["GROUPPQUOTAS"].items() :
138                if v.Group.Name == self.Name :
139                    self.parent.flushEntry("GROUPPQUOTAS", "%s@%s" % (v.Group.Name, v.Printer.Name))
140            self.Exists = 0
141       
142class StoragePrinter(StorageObject) :
143    """Printer class."""
144    def __init__(self, parent, name) :
145        StorageObject.__init__(self, parent)
146        self.Name = name
147        self.PricePerPage = None
148        self.PricePerJob = None
149        self.Description = None
150        self.Coefficients = None
151       
152    def __getattr__(self, name) :   
153        """Delays data retrieval until it's really needed."""
154        if name == "LastJob" : 
155            self.LastJob = self.parent.getPrinterLastJob(self)
156            return self.LastJob
157        else :
158            raise AttributeError, name
159           
160    def addJobToHistory(self, jobid, user, pagecounter, action, jobsize=None, jobprice=None, filename=None, title=None, copies=None, options=None, clienthost=None, jobsizebytes=None, jobmd5sum=None, jobpages=None, jobbilling=None) :
161        """Adds a job to the printer's history."""
162        self.parent.writeJobNew(self, user, jobid, pagecounter, action, jobsize, jobprice, filename, title, copies, options, clienthost, jobsizebytes, jobmd5sum, jobpages, jobbilling)
163        # TODO : update LastJob object ? Probably not needed.
164       
165    def addPrinterToGroup(self, printer) :   
166        """Adds a printer to a printer group."""
167        if (printer not in self.parent.getParentPrinters(self)) and (printer.ident != self.ident) :
168            self.parent.writePrinterToGroup(self, printer)
169            # TODO : reset cached value for printer parents, or add new parent to cached value
170           
171    def delPrinterFromGroup(self, printer) :   
172        """Deletes a printer from a printer group."""
173        self.parent.removePrinterFromGroup(self, printer)
174        # TODO : reset cached value for printer parents, or add new parent to cached value
175       
176    def setPrices(self, priceperpage = None, priceperjob = None) :   
177        """Sets the printer's prices."""
178        if priceperpage is None :
179            priceperpage = self.PricePerPage or 0.0
180        else :   
181            self.PricePerPage = float(priceperpage)
182        if priceperjob is None :   
183            priceperjob = self.PricePerJob or 0.0
184        else :   
185            self.PricePerJob = float(priceperjob)
186        self.parent.writePrinterPrices(self)
187       
188    def setDescription(self, description=None) :
189        """Sets the printer's description."""
190        if description is None :
191            description = self.Description
192        else :   
193            self.Description = str(description)
194        self.parent.writePrinterDescription(self)
195       
196    def delete(self) :   
197        """Deletes a printer from the Quota Storage."""
198        self.parent.beginTransaction()
199        try :
200            self.parent.deletePrinter(self)
201        except PyKotaStorageError, msg :   
202            self.parent.rollbackTransaction()
203            raise PyKotaStorageError, msg
204        else :   
205            self.parent.commitTransaction()
206            self.parent.flushEntry("PRINTERS", self.Name)
207            for (k, v) in self.parent.caches["USERPQUOTAS"].items() :
208                if v.Printer.Name == self.Name :
209                    self.parent.flushEntry("USERPQUOTAS", "%s@%s" % (v.User.Name, v.Printer.Name))
210            for (k, v) in self.parent.caches["GROUPPQUOTAS"].items() :
211                if v.Printer.Name == self.Name :
212                    self.parent.flushEntry("GROUPPQUOTAS", "%s@%s" % (v.Group.Name, v.Printer.Name))
213            self.Exists = 0   
214       
215class StorageUserPQuota(StorageObject) :
216    """User Print Quota class."""
217    def __init__(self, parent, user, printer) :
218        StorageObject.__init__(self, parent)
219        self.User = user
220        self.Printer = printer
221        self.PageCounter = None
222        self.LifePageCounter = None
223        self.SoftLimit = None
224        self.HardLimit = None
225        self.DateLimit = None
226        self.WarnCount = None
227       
228    def __getattr__(self, name) :   
229        """Delays data retrieval until it's really needed."""
230        if name == "ParentPrintersUserPQuota" : 
231            self.ParentPrintersUserPQuota = (self.User.Exists and self.Printer.Exists and self.parent.getParentPrintersUserPQuota(self)) or []
232            return self.ParentPrintersUserPQuota
233        else :
234            raise AttributeError, name
235       
236    def setDateLimit(self, datelimit) :   
237        """Sets the date limit for this quota."""
238        date = "%04i-%02i-%02i %02i:%02i:%02i" % (datelimit.year, datelimit.month, datelimit.day, datelimit.hour, datelimit.minute, datelimit.second)
239        self.parent.writeUserPQuotaDateLimit(self, date)
240        self.DateLimit = date
241       
242    def setLimits(self, softlimit, hardlimit) :   
243        """Sets the soft and hard limit for this quota."""
244        self.parent.writeUserPQuotaLimits(self, softlimit, hardlimit)
245        self.SoftLimit = softlimit
246        self.HardLimit = hardlimit
247        self.DateLimit = None
248        self.WarnCount = 0
249       
250    def setUsage(self, used) :
251        """Sets the PageCounter and LifePageCounter to used, or if used is + or - prefixed, changes the values of {Life,}PageCounter by that amount."""
252        vused = int(used)
253        if used.startswith("+") or used.startswith("-") :
254            self.parent.beginTransaction()
255            try :
256                self.parent.increaseUserPQuotaPagesCounters(self, vused)
257                self.parent.writeUserPQuotaDateLimit(self, None)
258                self.parent.writeUserPQuotaWarnCount(self, 0)
259            except PyKotaStorageError, msg :   
260                self.parent.rollbackTransaction()
261                raise PyKotaStorageError, msg
262            else :
263                self.parent.commitTransaction()
264            self.PageCounter += vused
265            self.LifePageCounter += vused
266        else :
267            self.parent.writeUserPQuotaPagesCounters(self, vused, vused)
268            self.PageCounter = self.LifePageCounter = vused
269        self.DateLimit = None
270        self.WarnCount = 0
271
272    def incDenyBannerCounter(self) :
273        """Increment the deny banner counter for this user quota."""
274        self.parent.increaseUserPQuotaWarnCount(self)
275        self.WarnCount = (self.WarnCount or 0) + 1
276       
277    def resetDenyBannerCounter(self) :
278        """Resets the deny banner counter for this user quota."""
279        self.parent.writeUserPQuotaWarnCount(self, 0)
280        self.WarnCount = 0
281       
282    def reset(self) :   
283        """Resets page counter to 0."""
284        self.parent.writeUserPQuotaPagesCounters(self, 0, int(self.LifePageCounter or 0))
285        self.PageCounter = 0
286        self.DateLimit = None
287       
288    def hardreset(self) :   
289        """Resets actual and life time page counters to 0."""
290        self.parent.writeUserPQuotaPagesCounters(self, 0, 0)
291        self.PageCounter = self.LifePageCounter = 0
292        self.DateLimit = None
293       
294    def computeJobPrice(self, jobsize) :   
295        """Computes the job price as the sum of all parent printers' prices + current printer's ones."""
296        totalprice = 0.0   
297        if jobsize :
298            if self.User.OverCharge != 0.0 :    # optimization, but TODO : beware of rounding errors
299                for upq in [ self ] + self.ParentPrintersUserPQuota :
300                    price = (float(upq.Printer.PricePerPage or 0.0) * jobsize) + float(upq.Printer.PricePerJob or 0.0)
301                    totalprice += price
302        if self.User.OverCharge != 1.0 : # TODO : beware of rounding errors
303            overcharged = totalprice * self.User.OverCharge       
304            self.parent.tool.printInfo("Overcharging %s by a factor of %s ===> User %s will be charged for %s units." % (totalprice, self.User.OverCharge, self.User.Name, overcharged))
305            return overcharged
306        else :   
307            return totalprice
308           
309    def increasePagesUsage(self, jobsize) :
310        """Increase the value of used pages and money."""
311        jobprice = self.computeJobPrice(jobsize)
312        if jobsize :
313            if jobprice :
314                self.User.consumeAccountBalance(jobprice)
315            for upq in [ self ] + self.ParentPrintersUserPQuota :
316                self.parent.increaseUserPQuotaPagesCounters(upq, jobsize)
317                upq.PageCounter = int(upq.PageCounter or 0) + jobsize
318                upq.LifePageCounter = int(upq.LifePageCounter or 0) + jobsize
319        return jobprice
320       
321class StorageGroupPQuota(StorageObject) :
322    """Group Print Quota class."""
323    def __init__(self, parent, group, printer) :
324        StorageObject.__init__(self, parent)
325        self.Group = group
326        self.Printer = printer
327        self.PageCounter = None
328        self.LifePageCounter = None
329        self.SoftLimit = None
330        self.HardLimit = None
331        self.DateLimit = None
332       
333    def __getattr__(self, name) :   
334        """Delays data retrieval until it's really needed."""
335        if name == "ParentPrintersGroupPQuota" : 
336            self.ParentPrintersGroupPQuota = (self.Group.Exists and self.Printer.Exists and self.parent.getParentPrintersGroupPQuota(self)) or []
337            return self.ParentPrintersGroupPQuota
338        else :
339            raise AttributeError, name
340       
341    def reset(self) :   
342        """Resets page counter to 0."""
343        self.parent.beginTransaction()
344        try :
345            for user in self.parent.getGroupMembers(self.Group) :
346                uq = self.parent.getUserPQuota(user, self.Printer)
347                uq.reset()
348            self.parent.writeGroupPQuotaDateLimit(self, None)
349        except PyKotaStorageError, msg :   
350            self.parent.rollbackTransaction()
351            raise PyKotaStorageError, msg
352        else :   
353            self.parent.commitTransaction()
354        self.PageCounter = 0
355        self.DateLimit = None
356       
357    def hardreset(self) :   
358        """Resets actual and life time page counters to 0."""
359        self.parent.beginTransaction()
360        try :
361            for user in self.parent.getGroupMembers(self.Group) :
362                uq = self.parent.getUserPQuota(user, self.Printer)
363                uq.hardreset()
364            self.parent.writeGroupPQuotaDateLimit(self, None)
365        except PyKotaStorageError, msg :   
366            self.parent.rollbackTransaction()
367            raise PyKotaStorageError, msg
368        else :   
369            self.parent.commitTransaction()
370        self.PageCounter = self.LifePageCounter = 0
371        self.DateLimit = None
372       
373    def setDateLimit(self, datelimit) :   
374        """Sets the date limit for this quota."""
375        date = "%04i-%02i-%02i %02i:%02i:%02i" % (datelimit.year, \
376                                                  datelimit.month, \
377                                                  datelimit.day, \
378                                                  datelimit.hour, \
379                                                  datelimit.minute, \
380                                                  datelimit.second)
381        self.parent.writeGroupPQuotaDateLimit(self, date)
382        self.DateLimit = date
383       
384    def setLimits(self, softlimit, hardlimit) :   
385        """Sets the soft and hard limit for this quota."""
386        self.parent.writeGroupPQuotaLimits(self, softlimit, hardlimit)
387        self.SoftLimit = softlimit
388        self.HardLimit = hardlimit
389        self.DateLimit = None
390       
391class StorageJob(StorageObject) :
392    """Printer's Job class."""
393    def __init__(self, parent) :
394        StorageObject.__init__(self, parent)
395        self.UserName = None
396        self.PrinterName = None
397        self.JobId = None
398        self.PrinterPageCounter = None
399        self.JobSizeBytes = None
400        self.JobSize = None
401        self.JobAction = None
402        self.JobDate = None
403        self.JobPrice = None
404        self.JobFileName = None
405        self.JobTitle = None
406        self.JobCopies = None
407        self.JobOptions = None
408        self.JobHostName = None
409        self.JobMD5Sum = None
410        self.JobPages = None
411        self.JobBillingCode = None
412       
413    def __getattr__(self, name) :   
414        """Delays data retrieval until it's really needed."""
415        if name == "User" : 
416            self.User = self.parent.getUser(self.UserName)
417            return self.User
418        elif name == "Printer" :   
419            self.Printer = self.parent.getPrinter(self.PrinterName)
420            return self.Printer
421        else :
422            raise AttributeError, name
423       
424class StorageLastJob(StorageJob) :
425    """Printer's Last Job class."""
426    def __init__(self, parent, printer) :
427        StorageJob.__init__(self, parent)
428        self.PrinterName = printer.Name # not needed
429        self.Printer = printer
430       
431class StorageBillingCode(StorageObject) :
432    """Billing code class."""
433    def __init__(self, parent, name) :
434        StorageObject.__init__(self, parent)
435        self.BillingCode = name
436        self.Description = None
437        self.PageCounter = None
438        self.Balance = None
439       
440    def delete(self) :   
441        """Deletes the billing code from the database."""
442        self.parent.deleteBillingCode(self)
443        self.parent.flushEntry("BILLINGCODES", self.BillingCode)
444        self.Exists = 0
445       
446    def reset(self, balance=0.0, pagecounter=0) :   
447        """Resets the pagecounter and balance for this billing code."""
448        self.parent.setBillingCodeValues(self, pagecounter, balance)
449        self.Balance = balance
450        self.PageCounter = pagecounter
451       
452    def setDescription(self, description=None) :
453        """Modifies the description for this billing code."""
454        if description is None :
455            description = self.Description
456        else :   
457            self.Description = str(description)
458        self.parent.writeBillingCodeDescription(self)
459       
460    def consume(self, pages, price) :
461        """Consumes some pages and credits for this billing code."""
462        if pages :
463           self.parent.consumeBillingCode(self, pages, price)
464           self.PageCounter += pages
465           self.Balance -= price
466       
467class BaseStorage :
468    def __init__(self, pykotatool) :
469        """Opens the storage connection."""
470        self.closed = 1
471        self.tool = pykotatool
472        self.usecache = pykotatool.config.getCaching()
473        self.disablehistory = pykotatool.config.getDisableHistory()
474        self.privacy = pykotatool.config.getPrivacy()
475        if self.privacy :
476            pykotatool.logdebug("Jobs' title, filename and options will be hidden because of privacy concerns.")
477        if self.usecache :
478            self.tool.logdebug("Caching enabled.")
479            self.caches = { "USERS" : {}, \
480                            "GROUPS" : {}, \
481                            "PRINTERS" : {}, \
482                            "USERPQUOTAS" : {}, \
483                            "GROUPPQUOTAS" : {}, \
484                            "JOBS" : {}, \
485                            "LASTJOBS" : {}, \
486                            "BILLINGCODES" : {} }
487       
488    def close(self) :   
489        """Must be overriden in children classes."""
490        raise RuntimeError, "BaseStorage.close() must be overriden !"
491       
492    def __del__(self) :       
493        """Ensures that the database connection is closed."""
494        self.close()
495       
496    def getFromCache(self, cachetype, key) :
497        """Tries to extract something from the cache."""
498        if self.usecache :
499            entry = self.caches[cachetype].get(key)
500            if entry is not None :
501                self.tool.logdebug("Cache hit (%s->%s)" % (cachetype, key))
502            else :   
503                self.tool.logdebug("Cache miss (%s->%s)" % (cachetype, key))
504            return entry   
505           
506    def cacheEntry(self, cachetype, key, value) :       
507        """Puts an entry in the cache."""
508        if self.usecache and getattr(value, "Exists", 0) :
509            self.caches[cachetype][key] = value
510            self.tool.logdebug("Cache store (%s->%s)" % (cachetype, key))
511           
512    def flushEntry(self, cachetype, key) :       
513        """Removes an entry from the cache."""
514        if self.usecache :
515            try :
516                del self.caches[cachetype][key]
517            except KeyError :   
518                pass
519            else :   
520                self.tool.logdebug("Cache flush (%s->%s)" % (cachetype, key))
521           
522    def getUser(self, username) :       
523        """Returns the user from cache."""
524        user = self.getFromCache("USERS", username)
525        if user is None :
526            user = self.getUserFromBackend(username)
527            self.cacheEntry("USERS", username, user)
528        return user   
529       
530    def getGroup(self, groupname) :       
531        """Returns the group from cache."""
532        group = self.getFromCache("GROUPS", groupname)
533        if group is None :
534            group = self.getGroupFromBackend(groupname)
535            self.cacheEntry("GROUPS", groupname, group)
536        return group   
537       
538    def getPrinter(self, printername) :       
539        """Returns the printer from cache."""
540        printer = self.getFromCache("PRINTERS", printername)
541        if printer is None :
542            printer = self.getPrinterFromBackend(printername)
543            self.cacheEntry("PRINTERS", printername, printer)
544        return printer   
545       
546    def getUserPQuota(self, user, printer) :       
547        """Returns the user quota information from cache."""
548        useratprinter = "%s@%s" % (user.Name, printer.Name)
549        upquota = self.getFromCache("USERPQUOTAS", useratprinter)
550        if upquota is None :
551            upquota = self.getUserPQuotaFromBackend(user, printer)
552            self.cacheEntry("USERPQUOTAS", useratprinter, upquota)
553        return upquota   
554       
555    def getGroupPQuota(self, group, printer) :       
556        """Returns the group quota information from cache."""
557        groupatprinter = "%s@%s" % (group.Name, printer.Name)
558        gpquota = self.getFromCache("GROUPPQUOTAS", groupatprinter)
559        if gpquota is None :
560            gpquota = self.getGroupPQuotaFromBackend(group, printer)
561            self.cacheEntry("GROUPPQUOTAS", groupatprinter, gpquota)
562        return gpquota   
563       
564    def getPrinterLastJob(self, printer) :       
565        """Extracts last job information for a given printer from cache."""
566        lastjob = self.getFromCache("LASTJOBS", printer.Name)
567        if lastjob is None :
568            lastjob = self.getPrinterLastJobFromBackend(printer)
569            self.cacheEntry("LASTJOBS", printer.Name, lastjob)
570        return lastjob   
571       
572    def getBillingCode(self, label) :       
573        """Returns the user from cache."""
574        code = self.getFromCache("BILLINGCODES", label)
575        if code is None :
576            code = self.getBillingCodeFromBackend(label)
577            self.cacheEntry("BILLINGCODES", label, code)
578        return code
579       
580    def getParentPrinters(self, printer) :   
581        """Extracts parent printers information for a given printer from cache."""
582        if self.usecache :
583            if not hasattr(printer, "Parents") :
584                self.tool.logdebug("Cache miss (%s->Parents)" % printer.Name)
585                printer.Parents = self.getParentPrintersFromBackend(printer)
586                self.tool.logdebug("Cache store (%s->Parents)" % printer.Name)
587            else :
588                self.tool.logdebug("Cache hit (%s->Parents)" % printer.Name)
589        else :       
590            printer.Parents = self.getParentPrintersFromBackend(printer)
591        for parent in printer.Parents[:] :   
592            printer.Parents.extend(self.getParentPrinters(parent))
593        uniquedic = {}   
594        for parent in printer.Parents :
595            uniquedic[parent.Name] = parent
596        printer.Parents = uniquedic.values()   
597        return printer.Parents
598       
599    def getGroupMembers(self, group) :       
600        """Returns the group's members list from in-group cache."""
601        if self.usecache :
602            if not hasattr(group, "Members") :
603                self.tool.logdebug("Cache miss (%s->Members)" % group.Name)
604                group.Members = self.getGroupMembersFromBackend(group)
605                self.tool.logdebug("Cache store (%s->Members)" % group.Name)
606            else :
607                self.tool.logdebug("Cache hit (%s->Members)" % group.Name)
608        else :       
609            group.Members = self.getGroupMembersFromBackend(group)
610        return group.Members   
611       
612    def getUserGroups(self, user) :       
613        """Returns the user's groups list from in-user cache."""
614        if self.usecache :
615            if not hasattr(user, "Groups") :
616                self.tool.logdebug("Cache miss (%s->Groups)" % user.Name)
617                user.Groups = self.getUserGroupsFromBackend(user)
618                self.tool.logdebug("Cache store (%s->Groups)" % user.Name)
619            else :
620                self.tool.logdebug("Cache hit (%s->Groups)" % user.Name)
621        else :       
622            user.Groups = self.getUserGroupsFromBackend(user)
623        return user.Groups   
624       
625    def getParentPrintersUserPQuota(self, userpquota) :     
626        """Returns all user print quota on the printer and all its parents recursively."""
627        upquotas = [ ]
628        for printer in self.getParentPrinters(userpquota.Printer) :
629            upq = self.getUserPQuota(userpquota.User, printer)
630            if upq.Exists :
631                upquotas.append(upq)
632        return upquotas       
633       
634    def getParentPrintersGroupPQuota(self, grouppquota) :     
635        """Returns all group print quota on the printer and all its parents recursively."""
636        gpquotas = [ ]
637        for printer in self.getParentPrinters(grouppquota.Printer) :
638            gpq = self.getGroupPQuota(grouppquota.Group, printer)
639            if gpq.Exists :
640                gpquotas.append(gpq)
641        return gpquotas       
642       
643    def databaseToUserCharset(self, text) :
644        """Converts from database format (UTF-8) to user's charset."""
645        if text is not None :
646            try :
647                return unicode(text, "UTF-8").encode(self.tool.getCharset()) 
648            except UnicodeError :   
649                try :
650                    # Incorrect locale settings ?
651                    return unicode(text, "UTF-8").encode("ISO-8859-15") 
652                except UnicodeError :   
653                    pass
654        return text
655       
656    def userCharsetToDatabase(self, text) :
657        """Converts from user's charset to database format (UTF-8)."""
658        if text is not None :
659            try :
660                return unicode(text, self.tool.getCharset()).encode("UTF-8") 
661            except UnicodeError :   
662                try :
663                    # Incorrect locale settings ?
664                    return unicode(text, "ISO-8859-15").encode("UTF-8") 
665                except UnicodeError :   
666                    pass
667        return text
668       
669    def cleanDates(self, startdate, enddate) :   
670        """Clean the dates to create a correct filter."""
671        if startdate is None :
672            startdate = enddate
673        if enddate is None :   
674            enddate = startdate
675        if (startdate is None) and (enddate is None) :   
676            return (None, None)
677           
678        now = DateTime.now()   
679        nameddates = ('yesterday', 'today', 'now', 'tomorrow')
680        datedict = { "start" : startdate.lower(), "end" : enddate.lower() }   
681        for limit in datedict.keys() :
682            dateval = datedict[limit]
683            for name in nameddates :
684                if dateval.startswith(name) :
685                    try :
686                        offset = int(dateval[len(name):])
687                    except :   
688                        offset = 0
689                    dateval = dateval[:len(name)]   
690                    if limit == "start" :
691                        if dateval == "yesterday" :
692                            dateval = (now - 1 + offset).Format("%Y%m%d000000")
693                        elif dateval == "today" :
694                            dateval = (now + offset).Format("%Y%m%d000000")
695                        elif dateval == "now" :
696                            dateval = (now + offset).Format("%Y%m%d%H%M%S")
697                        else : # tomorrow
698                            dateval = (now + 1 + offset).Format("%Y%m%d000000")
699                    else :
700                        if dateval == "yesterday" :
701                            dateval = (now - 1 + offset).Format("%Y%m%d235959")
702                        elif dateval == "today" :
703                            dateval = (now + offset).Format("%Y%m%d235959")
704                        elif dateval == "now" :
705                            dateval = (now + offset).Format("%Y%m%d%H%M%S")
706                        else : # tomorrow
707                            dateval = (now + 1 + offset).Format("%Y%m%d235959")
708                    break
709                   
710            if not dateval.isdigit() :
711                dateval = None
712            else :   
713                lgdateval = len(dateval)
714                if lgdateval == 4 :
715                    if limit == "start" : 
716                        dateval = "%s0101 00:00:00" % dateval
717                    else : 
718                        dateval = "%s1231 23:59:59" % dateval
719                elif lgdateval == 6 :
720                    if limit == "start" : 
721                        dateval = "%s01 00:00:00" % dateval
722                    else : 
723                        mxdate = DateTime.ISO.ParseDateTime("%s01 00:00:00" % dateval)
724                        dateval = "%s%02i 23:59:59" % (dateval, mxdate.days_in_month)
725                elif lgdateval == 8 :
726                    if limit == "start" : 
727                        dateval = "%s 00:00:00" % dateval
728                    else : 
729                        dateval = "%s 23:59:59" % dateval
730                elif lgdateval == 10 :
731                    if limit == "start" : 
732                        dateval = "%s %s:00:00" % (dateval[:8], dateval[8:])
733                    else : 
734                        dateval = "%s %s:59:59" % (dateval[:8], dateval[8:])
735                elif lgdateval == 12 :
736                    if limit == "start" : 
737                        dateval = "%s %s:%s:00" % (dateval[:8], dateval[8:10], dateval[10:])
738                    else : 
739                        dateval = "%s %s:%s:59" % (dateval[:8], dateval[8:10], dateval[10:])
740                elif lgdateval == 14 :       
741                    dateval = "%s %s:%s:%s" % (dateval[:8], dateval[8:10], dateval[10:12], dateval[12:])
742                else :   
743                    dateval = None
744                try :   
745                    DateTime.ISO.ParseDateTime(dateval)
746                except :   
747                    dateval = None
748            datedict[limit] = dateval   
749        (start, end) = (datedict["start"], datedict["end"])
750        if start > end :
751            (start, end) = (end, start)
752        return (start, end)   
753       
754def openConnection(pykotatool) :
755    """Returns a connection handle to the appropriate Quota Storage Database."""
756    backendinfo = pykotatool.config.getStorageBackend()
757    backend = backendinfo["storagebackend"]
758    try :
759        exec "from pykota.storages import %s as storagebackend" % backend.lower()
760    except ImportError :
761        raise PyKotaStorageError, _("Unsupported quota storage backend %s") % backend
762    else :   
763        host = backendinfo["storageserver"]
764        database = backendinfo["storagename"]
765        admin = backendinfo["storageadmin"] or backendinfo["storageuser"]
766        adminpw = backendinfo["storageadminpw"] or backendinfo["storageuserpw"]
767        return storagebackend.Storage(pykotatool, host, database, admin, adminpw)
Note: See TracBrowser for help on using the browser.