root / pykota / trunk / pykota / config.py @ 2635

Revision 2635, 26.5 kB (checked in by jerome, 18 years ago)

Introduced the 'preaccounter' directive.

  • 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, 2005, 2006 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
25import os
26import tempfile
27import ConfigParser
28
29class PyKotaConfigError(Exception):
30    """An exception for PyKota config related stuff."""
31    def __init__(self, message = ""):
32        self.message = message
33        Exception.__init__(self, message)
34    def __repr__(self):
35        return self.message
36    __str__ = __repr__
37   
38class PyKotaConfig :
39    """A class to deal with PyKota's configuration."""
40    def __init__(self, directory) :
41        """Reads and checks the configuration file."""
42        self.isAdmin = 0
43        self.directory = directory
44        self.filename = os.path.join(directory, "pykota.conf")
45        self.adminfilename = os.path.join(directory, "pykotadmin.conf")
46        if not os.access(self.filename, os.R_OK) :
47            raise PyKotaConfigError, _("Configuration file %s can't be read. Please check that the file exists and that your permissions are sufficient.") % self.filename
48        if not os.path.isfile(self.adminfilename) :
49            raise PyKotaConfigError, _("Configuration file %s not found.") % self.adminfilename
50        if os.access(self.adminfilename, os.R_OK) :   
51            self.isAdmin = 1
52        self.config = ConfigParser.ConfigParser()
53        self.config.read([self.filename])
54           
55    def isTrue(self, option) :       
56        """Returns 1 if option is set to true, else 0."""
57        if (option is not None) and (option.strip().upper() in ['Y', 'YES', '1', 'ON', 'T', 'TRUE']) :
58            return 1
59        else :   
60            return 0
61                       
62    def isFalse(self, option) :       
63        """Returns 1 if option is set to false, else 0."""
64        if (option is not None) and (option.strip().upper() in ['N', 'NO', '0', 'OFF', 'F', 'FALSE']) :
65            return 1
66        else :   
67            return 0
68                       
69    def getPrinterNames(self) :   
70        """Returns the list of configured printers, i.e. all sections names minus 'global'."""
71        return [pname for pname in self.config.sections() if pname != "global"]
72       
73    def getGlobalOption(self, option, ignore=0) :   
74        """Returns an option from the global section, or raises a PyKotaConfigError if ignore is not set, else returns None."""
75        try :
76            return self.config.get("global", option, raw=1)
77        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
78            if ignore :
79                return
80            else :
81                raise PyKotaConfigError, _("Option %s not found in section global of %s") % (option, self.filename)
82               
83    def getPrinterOption(self, printername, option) :   
84        """Returns an option from the printer section, or the global section, or raises a PyKotaConfigError."""
85        globaloption = self.getGlobalOption(option, ignore=1)
86        try :
87            return self.config.get(printername, option, raw=1)
88        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
89            if globaloption is not None :
90                return globaloption
91            else :
92                raise PyKotaConfigError, _("Option %s not found in section %s of %s") % (option, printername, self.filename)
93       
94    def getStorageBackend(self) :   
95        """Returns the storage backend information as a Python mapping."""       
96        backendinfo = {}
97        backend = self.getGlobalOption("storagebackend").lower()
98        backendinfo["storagebackend"] = backend
99        if backend == "sqlitestorage" :
100            issqlite = 1
101            backendinfo["storagename"] = self.getGlobalOption("storagename")
102            for option in ["storageserver", "storageuser", "storageuserpw"] :
103                backendinfo[option] = None         
104        else :
105            issqlite = 0
106            for option in ["storageserver", "storagename", "storageuser"] :
107                backendinfo[option] = self.getGlobalOption(option)
108            backendinfo["storageuserpw"] = self.getGlobalOption("storageuserpw", ignore=1)  # password is optional
109           
110        backendinfo["storageadmin"] = None
111        backendinfo["storageadminpw"] = None
112        if self.isAdmin :
113            adminconf = ConfigParser.ConfigParser()
114            adminconf.read([self.adminfilename])
115            if adminconf.sections() : # were we able to read the file ?
116                try :
117                    backendinfo["storageadmin"] = adminconf.get("global", "storageadmin", raw=1)
118                except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
119                    if not issqlite :
120                        raise PyKotaConfigError, _("Option %s not found in section global of %s") % ("storageadmin", self.adminfilename)
121                try :
122                    backendinfo["storageadminpw"] = adminconf.get("global", "storageadminpw", raw=1)
123                except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
124                    pass # Password is optional
125                # Now try to overwrite the storagebackend, storageserver
126                # and storagename. This allows admins to use the master LDAP
127                # server directly and users to use the replicas transparently.
128                try :
129                    backendinfo["storagebackend"] = adminconf.get("global", "storagebackend", raw=1)
130                except ConfigParser.NoOptionError :
131                    pass
132                try :
133                    backendinfo["storageserver"] = adminconf.get("global", "storageserver", raw=1)
134                except ConfigParser.NoOptionError :
135                    pass
136                try :
137                    backendinfo["storagename"] = adminconf.get("global", "storagename", raw=1)
138                except ConfigParser.NoOptionError :
139                    pass
140        return backendinfo
141       
142    def getLDAPInfo(self) :   
143        """Returns some hints for the LDAP backend."""       
144        ldapinfo = {}
145        for option in [ "userbase", "userrdn", \
146                        "balancebase", "balancerdn", \
147                        "groupbase", "grouprdn", "groupmembers", \
148                        "printerbase", "printerrdn", \
149                        "userquotabase", "groupquotabase", \
150                        "jobbase", "lastjobbase", "billingcodebase", \
151                        "newuser", "newgroup", \
152                        "usermail", \
153                      ] :
154            ldapinfo[option] = self.getGlobalOption(option).strip()
155        for field in ["newuser", "newgroup"] :
156            if ldapinfo[field].lower().startswith('attach(') :
157                ldapinfo[field] = ldapinfo[field][7:-1]
158               
159        # should we use TLS, by default (if unset) value is NO       
160        ldapinfo["ldaptls"] = self.isTrue(self.getGlobalOption("ldaptls", ignore=1))
161        ldapinfo["cacert"] = self.getGlobalOption("cacert", ignore=1)
162        if ldapinfo["cacert"] :
163            ldapinfo["cacert"] = ldapinfo["cacert"].strip()
164        if ldapinfo["ldaptls"] :   
165            if not os.access(ldapinfo["cacert"] or "", os.R_OK) :
166                raise PyKotaConfigError, _("Option ldaptls is set, but certificate %s is not readable.") % str(ldapinfo["cacert"])
167        return ldapinfo
168       
169    def getLoggingBackend(self) :   
170        """Returns the logging backend information."""
171        validloggers = [ "stderr", "system" ] 
172        try :
173            logger = self.getGlobalOption("logger").lower()
174        except PyKotaConfigError :   
175            logger = "system"
176        if logger not in validloggers :             
177            raise PyKotaConfigError, _("Option logger only supports values in %s") % str(validloggers)
178        return logger   
179       
180    def getLogoURL(self) :
181        """Returns the URL to use for the logo in the CGI scripts."""
182        url = self.getGlobalOption("logourl", ignore=1) or \
183                   "http://www.librelogiciel.com/software/PyKota/pykota.png"
184        return url.strip()           
185       
186    def getLogoLink(self) :
187        """Returns the URL to go to when the user clicks on the logo in the CGI scripts."""
188        url = self.getGlobalOption("logolink", ignore=1) or \
189                   "http://www.librelogiciel.com/software/"
190        return url.strip()           
191   
192    def getPreAccounterBackend(self, printername) :   
193        """Returns the preaccounter backend to use for a given printer."""
194        validaccounters = [ "software" ]     
195        try :
196            fullaccounter = self.getPrinterOption(printername, "preaccounter").strip()
197        except PyKotaConfigError :   
198            return ("software", "")
199        else :   
200            flower = fullaccounter.lower()
201            if flower.startswith("software") :   
202                try :
203                    (accounter, args) = [x.strip() for x in fullaccounter.split('(', 1)]
204                except ValueError :   
205                    raise PyKotaConfigError, _("Invalid preaccounter %s for printer %s") % (fullaccounter, printername)
206                if args.endswith(')') :
207                    args = args[:-1].strip()
208                return ("software", args)
209            else :
210                raise PyKotaConfigError, _("Option preaccounter in section %s only supports values in %s") % (printername, str(validaccounters))
211       
212    def getAccounterBackend(self, printername) :   
213        """Returns the accounter backend to use for a given printer."""
214        validaccounters = [ "hardware", "software" ]     
215        fullaccounter = self.getPrinterOption(printername, "accounter").strip()
216        flower = fullaccounter.lower()
217        if flower.startswith("software") or flower.startswith("hardware") :   
218            try :
219                (accounter, args) = [x.strip() for x in fullaccounter.split('(', 1)]
220            except ValueError :   
221                raise PyKotaConfigError, _("Invalid accounter %s for printer %s") % (fullaccounter, printername)
222            if args.endswith(')') :
223                args = args[:-1].strip()
224            if (accounter == "hardware") and not args :
225                raise PyKotaConfigError, _("Invalid accounter %s for printer %s") % (fullaccounter, printername)
226            return (accounter.lower(), args)
227        else :
228            raise PyKotaConfigError, _("Option accounter in section %s only supports values in %s") % (printername, str(validaccounters))
229       
230    def getPreHook(self, printername) :   
231        """Returns the prehook command line to launch, or None if unset."""
232        try :
233            return self.getPrinterOption(printername, "prehook").strip()
234        except PyKotaConfigError :   
235            return      # No command to launch in the pre-hook
236           
237    def getPostHook(self, printername) :   
238        """Returns the posthook command line to launch, or None if unset."""
239        try :
240            return self.getPrinterOption(printername, "posthook").strip()
241        except PyKotaConfigError :   
242            return      # No command to launch in the post-hook
243           
244    def getStripTitle(self, printername) :   
245        """Returns the striptitle directive's content, or None if unset."""
246        try :
247            return self.getPrinterOption(printername, "striptitle").strip()
248        except PyKotaConfigError :   
249            return      # No prefix to strip off
250           
251    def getOverwriteJobTicket(self, printername) :       
252        """Returns the overwrite_jobticket directive's content, or None if unset."""
253        try :
254            return self.getPrinterOption(printername, "overwrite_jobticket").strip()
255        except PyKotaConfigError :   
256            return      # No overwriting will be done
257       
258    def getUnknownBillingCode(self, printername) :       
259        """Returns the unknown_billingcode directive's content, or the default value if unset."""
260        validvalues = [ "CREATE", "DENY" ]
261        try :
262            fullvalue = self.getPrinterOption(printername, "unknown_billingcode")
263        except PyKotaConfigError :   
264            return ("CREATE", None)
265        else :   
266            try :
267                value = [x.strip() for x in fullvalue.split('(', 1)]
268            except ValueError :   
269                raise PyKotaConfigError, _("Invalid unknown_billingcode directive %s for printer %s") % (fullvalue, printername)
270            if len(value) == 1 :   
271                value.append("")
272            (value, args) = value   
273            if args.endswith(')') :
274                args = args[:-1]
275            value = value.upper()   
276            if (value == "DENY") and not args :
277                return ("DENY", None)
278            if value not in validvalues :
279                raise PyKotaConfigError, _("Directive unknown_billingcode in section %s only supports values in %s") % (printername, str(validvalues))
280            return (value, args)
281       
282    def getPrinterEnforcement(self, printername) :   
283        """Returns if quota enforcement should be strict or laxist for the current printer."""
284        validenforcements = [ "STRICT", "LAXIST" ]     
285        try :
286            enforcement = self.getPrinterOption(printername, "enforcement")
287        except PyKotaConfigError :   
288            return "LAXIST"
289        else :   
290            enforcement = enforcement.upper()
291            if enforcement not in validenforcements :
292                raise PyKotaConfigError, _("Option enforcement in section %s only supports values in %s") % (printername, str(validenforcements))
293            return enforcement   
294           
295    def getPrinterOnBackendError(self, printername) :   
296        """Returns what must be done whenever the real CUPS backend fails."""
297        validactions = [ "CHARGE", "NOCHARGE" ]     
298        try :
299            action = self.getPrinterOption(printername, "onbackenderror")
300        except PyKotaConfigError :   
301            return "NOCHARGE"
302        else :   
303            action = action.upper()
304            if action not in validactions :
305                raise PyKotaConfigError, _("Option onbackenderror in section %s only supports values in %s") % (printername, str(validactions))
306            return action 
307           
308    def getPrinterOnAccounterError(self, printername) :   
309        """Returns what must be done whenever the accounter fails."""
310        validactions = [ "CONTINUE", "STOP" ]     
311        try :
312            action = self.getPrinterOption(printername, "onaccountererror")
313        except PyKotaConfigError :   
314            return "STOP"
315        else :   
316            action = action.upper()
317            if action not in validactions :
318                raise PyKotaConfigError, _("Option onaccountererror in section %s only supports values in %s") % (printername, str(validactions))
319            return action 
320           
321    def getPrinterPolicy(self, printername) :   
322        """Returns the default policy for the current printer."""
323        validpolicies = [ "ALLOW", "DENY", "EXTERNAL" ]     
324        try :
325            fullpolicy = self.getPrinterOption(printername, "policy")
326        except PyKotaConfigError :   
327            return ("DENY", None)
328        else :   
329            try :
330                policy = [x.strip() for x in fullpolicy.split('(', 1)]
331            except ValueError :   
332                raise PyKotaConfigError, _("Invalid policy %s for printer %s") % (fullpolicy, printername)
333            if len(policy) == 1 :   
334                policy.append("")
335            (policy, args) = policy   
336            if args.endswith(')') :
337                args = args[:-1]
338            policy = policy.upper()   
339            if (policy == "EXTERNAL") and not args :
340                raise PyKotaConfigError, _("Invalid policy %s for printer %s") % (fullpolicy, printername)
341            if policy not in validpolicies :
342                raise PyKotaConfigError, _("Option policy in section %s only supports values in %s") % (printername, str(validpolicies))
343            return (policy, args)
344       
345    def getCrashRecipient(self) :   
346        """Returns the email address of the software crash messages recipient."""
347        try :
348            return self.getGlobalOption("crashrecipient")
349        except :   
350            return
351           
352    def getSMTPServer(self) :   
353        """Returns the SMTP server to use to send messages to users."""
354        try :
355            return self.getGlobalOption("smtpserver")
356        except PyKotaConfigError :   
357            return "localhost"
358       
359    def getMailDomain(self) :   
360        """Returns the mail domain to use to send messages to users."""
361        try :
362            return self.getGlobalOption("maildomain")
363        except PyKotaConfigError :   
364            return 
365       
366    def getAdminMail(self, printername) :   
367        """Returns the Email address of the Print Quota Administrator."""
368        try :
369            return self.getPrinterOption(printername, "adminmail")
370        except PyKotaConfigError :   
371            return "root@localhost"
372       
373    def getAdmin(self, printername) :   
374        """Returns the full name of the Print Quota Administrator."""
375        try :
376            return self.getPrinterOption(printername, "admin")
377        except PyKotaConfigError :   
378            return "root"
379       
380    def getMailTo(self, printername) :   
381        """Returns the recipient of email messages."""
382        validmailtos = [ "EXTERNAL", "NOBODY", "NONE", "NOONE", "BITBUCKET", "DEVNULL", "BOTH", "USER", "ADMIN" ]
383        try :
384            fullmailto = self.getPrinterOption(printername, "mailto")
385        except PyKotaConfigError :   
386            return ("BOTH", None)
387        else :   
388            try :
389                mailto = [x.strip() for x in fullmailto.split('(', 1)]
390            except ValueError :   
391                raise PyKotaConfigError, _("Invalid option mailto %s for printer %s") % (fullmailto, printername)
392            if len(mailto) == 1 :   
393                mailto.append("")
394            (mailto, args) = mailto   
395            if args.endswith(')') :
396                args = args[:-1]
397            mailto = mailto.upper()   
398            if (mailto == "EXTERNAL") and not args :
399                raise PyKotaConfigError, _("Invalid option mailto %s for printer %s") % (fullmailto, printername)
400            if mailto not in validmailtos :
401                raise PyKotaConfigError, _("Option mailto in section %s only supports values in %s") % (printername, str(validmailtos))
402            return (mailto, args)
403       
404    def getMaxDenyBanners(self, printername) :   
405        """Returns the maximum number of deny banners to be printed for a particular user on a particular printer."""
406        try :
407            maxdb = self.getPrinterOption(printername, "maxdenybanners")
408        except PyKotaConfigError :   
409            return 0 # default value is to forbid printing a deny banner.
410        try :
411            value = int(maxdb.strip())
412            if value < 0 :
413                raise ValueError
414        except (TypeError, ValueError) :   
415            raise PyKotaConfigError, _("Invalid maximal deny banners counter %s") % maxdb
416        else :   
417            return value
418           
419    def getGraceDelay(self, printername) :   
420        """Returns the grace delay in days."""
421        try :
422            gd = self.getPrinterOption(printername, "gracedelay")
423        except PyKotaConfigError :   
424            gd = 7      # default value of 7 days
425        try :
426            return int(gd)
427        except (TypeError, ValueError) :   
428            raise PyKotaConfigError, _("Invalid grace delay %s") % gd
429           
430    def getPoorMan(self) :   
431        """Returns the poor man's threshold."""
432        try :
433            pm = self.getGlobalOption("poorman")
434        except PyKotaConfigError :   
435            pm = 1.0    # default value of 1 unit
436        try :
437            return float(pm)
438        except (TypeError, ValueError) :   
439            raise PyKotaConfigError, _("Invalid poor man's threshold %s") % pm
440           
441    def getPoorWarn(self) :   
442        """Returns the poor man's warning message."""
443        try :
444            return self.getGlobalOption("poorwarn")
445        except PyKotaConfigError :   
446            return _("Your Print Quota account balance is Low.\nSoon you'll not be allowed to print anymore.\nPlease contact the Print Quota Administrator to solve the problem.")
447           
448    def getHardWarn(self, printername) :   
449        """Returns the hard limit error message."""
450        try :
451            return self.getPrinterOption(printername, "hardwarn")
452        except PyKotaConfigError :   
453            return _("You are not allowed to print anymore because\nyour Print Quota is exceeded on printer %s.") % printername
454           
455    def getSoftWarn(self, printername) :   
456        """Returns the soft limit error message."""
457        try :
458            return self.getPrinterOption(printername, "softwarn")
459        except PyKotaConfigError :   
460            return _("You will soon be forbidden to print anymore because\nyour Print Quota is almost reached on printer %s.") % printername
461           
462    def getPrivacy(self) :       
463        """Returns 1 if privacy is activated, else 0."""
464        return self.isTrue(self.getGlobalOption("privacy", ignore=1))
465       
466    def getDebug(self) :         
467        """Returns 1 if debugging is activated, else 0."""
468        return self.isTrue(self.getGlobalOption("debug", ignore=1))
469           
470    def getCaching(self) :         
471        """Returns 1 if database caching is enabled, else 0."""
472        return self.isTrue(self.getGlobalOption("storagecaching", ignore=1))
473           
474    def getLDAPCache(self) :         
475        """Returns 1 if low-level LDAP caching is enabled, else 0."""
476        return self.isTrue(self.getGlobalOption("ldapcache", ignore=1))
477           
478    def getDisableHistory(self) :         
479        """Returns 1 if we want to disable history, else 0."""
480        return self.isTrue(self.getGlobalOption("disablehistory", ignore=1))
481           
482    def getUserNameToLower(self) :         
483        """Returns 1 if we want to convert usernames to lowercase when printing, else 0."""
484        return self.isTrue(self.getGlobalOption("utolower", ignore=1))
485       
486    def getRejectUnknown(self) :         
487        """Returns 1 if we want to reject the creation of unknown users or groups, else 0."""
488        return self.isTrue(self.getGlobalOption("reject_unknown", ignore=1))
489       
490    def getPrinterKeepFiles(self, printername) :         
491        """Returns 1 if files must be kept on disk, else 0."""
492        try : 
493            return self.isTrue(self.getPrinterOption(printername, "keepfiles"))
494        except PyKotaConfigError :   
495            return 0
496           
497    def getPrinterDirectory(self, printername) :         
498        """Returns the path to our working directory, else a directory suitable for temporary files."""
499        try : 
500            return self.getPrinterOption(printername, "directory").strip()
501        except PyKotaConfigError :   
502            return tempfile.gettempdir()
503           
504    def getDenyDuplicates(self, printername) :         
505        """Returns 1 or a command if we want to deny duplicate jobs, else 0."""
506        try : 
507            denyduplicates = self.getPrinterOption(printername, "denyduplicates")
508        except PyKotaConfigError :   
509            return 0
510        else :   
511            if self.isTrue(denyduplicates) :
512                return 1
513            elif self.isFalse(denyduplicates) :
514                return 0
515            else :   
516                # it's a command to run.
517                return denyduplicates
518       
519    def getWinbindSeparator(self) :         
520        """Returns the winbind separator's value if it is set, else None."""
521        return self.getGlobalOption("winbind_separator", ignore=1)
522
523    def getAccountBanner(self, printername) :
524        """Returns which banner(s) to account for: NONE, BOTH, STARTING, ENDING."""
525        validvalues = [ "NONE", "BOTH", "STARTING", "ENDING" ]     
526        try :
527            value = self.getPrinterOption(printername, "accountbanner")
528        except PyKotaConfigError :   
529            return "BOTH"       # Default value of BOTH
530        else :   
531            value = value.strip().upper()
532            if value not in validvalues :
533                raise PyKotaConfigError, _("Option accountbanner in section %s only supports values in %s") % (printername, str(validvalues))
534            return value 
535
536    def getStartingBanner(self, printername) :
537        """Returns the startingbanner value if set, else None."""
538        try :
539            return self.getPrinterOption(printername, "startingbanner").strip()
540        except PyKotaConfigError :
541            return None
542
543    def getEndingBanner(self, printername) :
544        """Returns the endingbanner value if set, else None."""
545        try :
546            return self.getPrinterOption(printername, "endingbanner").strip()
547        except PyKotaConfigError :
548            return None
549           
550    def getTrustJobSize(self, printername) :
551        """Returns the normalized value of the trustjobsize's directive."""
552        try :
553            value = self.getPrinterOption(printername, "trustjobsize").strip().upper()
554        except PyKotaConfigError :
555            return (None, "YES")
556        else :   
557            if value == "YES" :
558                return (None, "YES")
559            try :   
560                (limit, replacement) = [p.strip() for p in value.split(">")[1].split(":")]
561                limit = int(limit)
562                try :
563                    replacement = int(replacement) 
564                except ValueError :   
565                    if replacement != "PRECOMPUTED" :
566                        raise
567                if limit < 0 :
568                    raise ValueError
569                if (replacement != "PRECOMPUTED") and (replacement < 0) :
570                    raise ValueError
571            except (IndexError, ValueError, TypeError) :
572                raise PyKotaConfigError, _("Option trustjobsize for printer %s is incorrect") % printername
573            return (limit, replacement)   
Note: See TracBrowser for help on using the browser.