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

Revision 1646, 20.8 kB (checked in by jalet, 20 years ago)

Typo : treshold ==> threshold

  • 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.50  2004/07/27 07:07:27  jalet
25# Typo : treshold ==> threshold
26#
27# Revision 1.49  2004/06/03 21:53:24  jalet
28# crashrecipient directive
29#
30# Revision 1.48  2004/05/24 22:45:49  jalet
31# New 'enforcement' directive added
32# Polling loop improvements
33#
34# Revision 1.47  2004/05/18 14:49:20  jalet
35# Big code changes to completely remove the need for "requester" directives,
36# jsut use "hardware(... your previous requester directive's content ...)"
37#
38# Revision 1.46  2004/05/13 13:59:28  jalet
39# Code simplifications
40#
41# Revision 1.45  2004/03/01 10:22:30  jalet
42# Can now extract per printer pre and post hooks from the configuration file
43#
44# Revision 1.44  2004/02/20 14:42:21  jalet
45# Experimental ldapcache directive added
46#
47# Revision 1.43  2004/02/19 14:20:21  jalet
48# maildomain pykota.conf directive added.
49# Small improvements on mail headers quality.
50#
51# Revision 1.42  2004/01/08 14:10:32  jalet
52# Copyright year changed.
53#
54# Revision 1.41  2003/11/29 20:06:20  jalet
55# Added 'utolower' configuration option to convert all usernames to
56# lowercase when printing. All database accesses are still and will
57# remain case sensitive though.
58#
59# Revision 1.40  2003/11/18 23:43:12  jalet
60# Mailto can be any external command now, as usual.
61#
62# Revision 1.39  2003/10/08 21:41:38  jalet
63# External policies for printers works !
64# We can now auto-add users on first print, and do other useful things if needed.
65#
66# Revision 1.38  2003/10/07 22:06:05  jalet
67# Preliminary code to disable job history
68#
69# Revision 1.37  2003/10/07 09:07:28  jalet
70# Character encoding added to please latest version of Python
71#
72# Revision 1.36  2003/10/02 20:23:18  jalet
73# Storage caching mechanism added.
74#
75# Revision 1.35  2003/07/29 09:54:03  jalet
76# Added configurable LDAP mail attribute support
77#
78# Revision 1.34  2003/07/28 09:11:12  jalet
79# PyKota now tries to add its attributes intelligently in existing LDAP
80# directories.
81#
82# Revision 1.33  2003/07/16 21:53:07  jalet
83# Really big modifications wrt new configuration file's location and content.
84#
85# Revision 1.32  2003/07/08 19:43:51  jalet
86# Configurable warning messages.
87# Poor man's treshold value added.
88#
89# Revision 1.31  2003/07/07 11:49:24  jalet
90# Lots of small fixes with the help of PyChecker
91#
92# Revision 1.30  2003/06/25 14:10:01  jalet
93# Hey, it may work (edpykota --reset excepted) !
94#
95# Revision 1.29  2003/06/14 22:44:21  jalet
96# More work on LDAP storage backend.
97#
98# Revision 1.28  2003/06/10 16:37:54  jalet
99# Deletion of the second user which is not needed anymore.
100# Added a debug configuration field in /etc/pykota.conf
101# All queries can now be sent to the logger in debug mode, this will
102# greatly help improve performance when time for this will come.
103#
104# Revision 1.27  2003/05/27 23:00:21  jalet
105# Big rewrite of external accounting methods.
106# Should work well now.
107#
108# Revision 1.26  2003/04/30 19:53:58  jalet
109# 1.05
110#
111# Revision 1.25  2003/04/30 13:36:40  jalet
112# Stupid accounting method was added.
113#
114# Revision 1.24  2003/04/29 18:37:54  jalet
115# Pluggable accounting methods (actually doesn't support external scripts)
116#
117# Revision 1.23  2003/04/24 11:53:48  jalet
118# Default policy for unknown users/groups is to DENY printing instead
119# of the previous default to ALLOW printing. This is to solve an accuracy
120# problem. If you set the policy to ALLOW, jobs printed by in nexistant user
121# (from PyKota's POV) will be charged to the next user who prints on the
122# same printer.
123#
124# Revision 1.22  2003/04/23 22:13:57  jalet
125# Preliminary support for LPRng added BUT STILL UNTESTED.
126#
127# Revision 1.21  2003/03/29 13:45:27  jalet
128# GPL paragraphs were incorrectly (from memory) copied into the sources.
129# Two README files were added.
130# Upgrade script for PostgreSQL pre 1.01 schema was added.
131#
132# Revision 1.20  2003/03/29 13:08:28  jalet
133# Configuration is now expected to be found in /etc/pykota.conf instead of
134# in /etc/cups/pykota.conf
135# Installation script can move old config files to the new location if needed.
136# Better error handling if configuration file is absent.
137#
138# Revision 1.19  2003/03/16 09:56:52  jalet
139# Mailto option now accepts some additional values which all mean that
140# nobody will receive any email message.
141# Mailto option now works. Version 1.01 is now officially out.
142#
143# Revision 1.18  2003/03/16 08:00:50  jalet
144# Default hard coded options are now used if they are not set in the
145# configuration file.
146#
147# Revision 1.17  2003/03/15 23:01:28  jalet
148# New mailto option in configuration file added.
149# No time to test this tonight (although it should work).
150#
151# Revision 1.16  2003/02/17 23:01:56  jalet
152# Typos
153#
154# Revision 1.15  2003/02/17 22:55:01  jalet
155# More options can now be set per printer or globally :
156#
157#       admin
158#       adminmail
159#       gracedelay
160#       requester
161#
162# the printer option has priority when both are defined.
163#
164# Revision 1.14  2003/02/17 22:05:50  jalet
165# Storage backend now supports admin and user passwords (untested)
166#
167# Revision 1.13  2003/02/10 11:47:39  jalet
168# Moved some code down into the requesters
169#
170# Revision 1.12  2003/02/10 10:36:33  jalet
171# Small problem wrt external requester
172#
173# Revision 1.11  2003/02/10 08:50:45  jalet
174# External requester seems to be finally ok now
175#
176# Revision 1.10  2003/02/10 08:19:57  jalet
177# tell ConfigParser to return raw data, this allows our own strings
178# interpolations in the requester
179#
180# Revision 1.9  2003/02/10 00:44:38  jalet
181# Typos
182#
183# Revision 1.8  2003/02/10 00:42:17  jalet
184# External requester should be ok (untested)
185# New syntax for configuration file wrt requesters
186#
187# Revision 1.7  2003/02/09 13:05:43  jalet
188# Internationalization continues...
189#
190# Revision 1.6  2003/02/07 22:00:09  jalet
191# Bad cut&paste
192#
193# Revision 1.5  2003/02/06 23:58:05  jalet
194# repykota should be ok
195#
196# Revision 1.4  2003/02/06 09:19:02  jalet
197# More robust behavior (hopefully) when the user or printer is not managed
198# correctly by the Quota System : e.g. cupsFilter added in ppd file, but
199# printer and/or user not 'yet?' in storage.
200#
201# Revision 1.3  2003/02/05 23:26:22  jalet
202# Incorrect handling of grace delay
203#
204# Revision 1.2  2003/02/05 23:09:20  jalet
205# Name conflict
206#
207# Revision 1.1  2003/02/05 21:28:17  jalet
208# Initial import into CVS
209#
210#
211#
212
213import os
214import ConfigParser
215
216class PyKotaConfigError(Exception):
217    """An exception for PyKota config related stuff."""
218    def __init__(self, message = ""):
219        self.message = message
220        Exception.__init__(self, message)
221    def __repr__(self):
222        return self.message
223    __str__ = __repr__
224   
225class PyKotaConfig :
226    """A class to deal with PyKota's configuration."""
227    def __init__(self, directory) :
228        """Reads and checks the configuration file."""
229        self.filename = os.path.join(directory, "pykota.conf")
230        if not os.path.isfile(self.filename) :
231            raise PyKotaConfigError, _("Configuration file %s not found.") % self.filename
232        self.config = ConfigParser.ConfigParser()
233        self.config.read([self.filename])
234           
235    def isTrue(self, option) :       
236        """Returns 1 if option is set to true, else 0."""
237        if (option is not None) and (option.upper().strip() in ['Y', 'YES', '1', 'ON', 'T', 'TRUE']) :
238            return 1
239        else :   
240            return 0
241                       
242    def getPrinterNames(self) :   
243        """Returns the list of configured printers, i.e. all sections names minus 'global'."""
244        return [pname for pname in self.config.sections() if pname != "global"]
245       
246    def getGlobalOption(self, option, ignore=0) :   
247        """Returns an option from the global section, or raises a PyKotaConfigError if ignore is not set, else returns None."""
248        try :
249            return self.config.get("global", option, raw=1)
250        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
251            if ignore :
252                return
253            else :
254                raise PyKotaConfigError, _("Option %s not found in section global of %s") % (option, self.filename)
255               
256    def getPrinterOption(self, printername, option) :   
257        """Returns an option from the printer section, or the global section, or raises a PyKotaConfigError."""
258        globaloption = self.getGlobalOption(option, ignore=1)
259        try :
260            return self.config.get(printername, option, raw=1)
261        except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
262            if globaloption is not None :
263                return globaloption
264            else :
265                raise PyKotaConfigError, _("Option %s not found in section %s of %s") % (option, printername, self.filename)
266       
267    def getStorageBackend(self) :   
268        """Returns the storage backend information as a Python mapping."""       
269        backendinfo = {}
270        for option in [ "storagebackend", "storageserver", \
271                        "storagename", "storageuser", \
272                      ] :
273            backendinfo[option] = self.getGlobalOption(option)
274        backendinfo["storageuserpw"] = self.getGlobalOption("storageuserpw", ignore=1)  # password is optional
275        backendinfo["storageadmin"] = None
276        backendinfo["storageadminpw"] = None
277        adminconf = ConfigParser.ConfigParser()
278        adminconf.read(["/etc/pykota/pykotadmin.conf"])
279        if adminconf.sections() : # were we able to read the file ?
280            try :
281                backendinfo["storageadmin"] = adminconf.get("global", "storageadmin", raw=1)
282            except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
283                raise PyKotaConfigError, _("Option %s not found in section global of %s") % ("storageadmin", "/etc/pykota/pykotadmin.conf")
284            try :
285                backendinfo["storageadminpw"] = adminconf.get("global", "storageadminpw", raw=1)
286            except (ConfigParser.NoSectionError, ConfigParser.NoOptionError) :   
287                pass # Password is optional
288        return backendinfo
289       
290    def getLDAPInfo(self) :   
291        """Returns some hints for the LDAP backend."""       
292        ldapinfo = {}
293        for option in [ "userbase", "userrdn", \
294                        "balancebase", "balancerdn", \
295                        "groupbase", "grouprdn", "groupmembers", \
296                        "printerbase", "printerrdn", \
297                        "userquotabase", "groupquotabase", \
298                        "jobbase", "lastjobbase", \
299                        "newuser", "newgroup", \
300                        "usermail", \
301                      ] :
302            ldapinfo[option] = self.getGlobalOption(option).strip()
303        for field in ["newuser", "newgroup"] :
304            if ldapinfo[field].lower().startswith('attach(') :
305                ldapinfo[field] = ldapinfo[field][7:-1]
306        return ldapinfo
307       
308    def getLoggingBackend(self) :   
309        """Returns the logging backend information."""
310        validloggers = [ "stderr", "system" ] 
311        try :
312            logger = self.getGlobalOption("logger").lower()
313        except PyKotaConfigError :   
314            logger = "system"
315        if logger not in validloggers :             
316            raise PyKotaConfigError, _("Option logger only supports values in %s") % str(validloggers)
317        return logger   
318       
319    def getAccounterBackend(self, printername) :   
320        """Returns the accounter backend to use for a given printer.
321       
322           if it is not set, it defaults to 'hardware' which means ask printer
323           for its internal lifetime page counter.
324        """   
325        validaccounters = [ "hardware", "software" ]     
326        fullaccounter = self.getPrinterOption(printername, "accounter").strip()
327        flower = fullaccounter.lower()
328        if flower.startswith("software") or flower.startswith("hardware") :   
329            try :
330                (accounter, args) = [x.strip() for x in fullaccounter.split('(', 1)]
331            except ValueError :   
332                raise PyKotaConfigError, _("Invalid accounter %s for printer %s") % (fullaccounter, printername)
333            if args.endswith(')') :
334                args = args[:-1]
335            if not args :
336                raise PyKotaConfigError, _("Invalid accounter %s for printer %s") % (fullaccounter, printername)
337            return (accounter.lower(), args)   
338        else :
339            raise PyKotaConfigError, _("Option accounter in section %s only supports values in %s") % (printername, str(validaccounters))
340       
341    def getPreHook(self, printername) :   
342        """Returns the prehook command line to launch, or None if unset."""
343        try :
344            return self.getPrinterOption(printername, "prehook").strip()
345        except PyKotaConfigError :   
346            return      # No command to launch in the pre-hook
347           
348    def getPostHook(self, printername) :   
349        """Returns the posthook command line to launch, or None if unset."""
350        try :
351            return self.getPrinterOption(printername, "posthook").strip()
352        except PyKotaConfigError :   
353            return      # No command to launch in the post-hook
354           
355    def getPrinterEnforcement(self, printername) :   
356        """Returns if quota enforcement should be strict or laxist for the current printer."""
357        validenforcements = [ "STRICT", "LAXIST" ]     
358        try :
359            enforcement = self.getPrinterOption(printername, "enforcement")
360        except PyKotaConfigError :   
361            return "LAXIST"
362        else :   
363            enforcement = enforcement.upper()
364            if enforcement not in validenforcements :
365                raise PyKotaConfigError, _("Option enforcement in section %s only supports values in %s") % (printername, str(validenforcements))
366            return enforcement   
367           
368    def getPrinterPolicy(self, printername) :   
369        """Returns the default policy for the current printer."""
370        validpolicies = [ "ALLOW", "DENY", "EXTERNAL" ]     
371        try :
372            fullpolicy = self.getPrinterOption(printername, "policy")
373        except PyKotaConfigError :   
374            return ("DENY", None)
375        else :   
376            try :
377                policy = [x.strip() for x in fullpolicy.split('(', 1)]
378            except ValueError :   
379                raise PyKotaConfigError, _("Invalid policy %s for printer %s") % (fullpolicy, printername)
380            if len(policy) == 1 :   
381                policy.append("")
382            (policy, args) = policy   
383            if args.endswith(')') :
384                args = args[:-1]
385            policy = policy.upper()   
386            if (policy == "EXTERNAL") and not args :
387                raise PyKotaConfigError, _("Invalid policy %s for printer %s") % (fullpolicy, printername)
388            if policy not in validpolicies :
389                raise PyKotaConfigError, _("Option policy in section %s only supports values in %s") % (printername, str(validpolicies))
390            return (policy, args)
391       
392    def getCrashRecipient(self) :   
393        """Returns the email address of the software crash messages recipient."""
394        try :
395            return self.getGlobalOption("crashrecipient")
396        except :   
397            return
398           
399    def getSMTPServer(self) :   
400        """Returns the SMTP server to use to send messages to users."""
401        try :
402            return self.getGlobalOption("smtpserver")
403        except PyKotaConfigError :   
404            return "localhost"
405       
406    def getMailDomain(self) :   
407        """Returns the mail domain to use to send messages to users."""
408        try :
409            return self.getGlobalOption("maildomain")
410        except PyKotaConfigError :   
411            return 
412       
413    def getAdminMail(self, printername) :   
414        """Returns the Email address of the Print Quota Administrator."""
415        try :
416            return self.getPrinterOption(printername, "adminmail")
417        except PyKotaConfigError :   
418            return "root@localhost"
419       
420    def getAdmin(self, printername) :   
421        """Returns the full name of the Print Quota Administrator."""
422        try :
423            return self.getPrinterOption(printername, "admin")
424        except PyKotaConfigError :   
425            return "root"
426       
427    def getMailTo(self, printername) :   
428        """Returns the recipient of email messages."""
429        validmailtos = [ "EXTERNAL", "NOBODY", "NONE", "NOONE", "BITBUCKET", "DEVNULL", "BOTH", "USER", "ADMIN" ]
430        try :
431            fullmailto = self.getPrinterOption(printername, "mailto")
432        except PyKotaConfigError :   
433            return ("BOTH", None)
434        else :   
435            try :
436                mailto = [x.strip() for x in fullmailto.split('(', 1)]
437            except ValueError :   
438                raise PyKotaConfigError, _("Invalid option mailto %s for printer %s") % (fullmailto, printername)
439            if len(mailto) == 1 :   
440                mailto.append("")
441            (mailto, args) = mailto   
442            if args.endswith(')') :
443                args = args[:-1]
444            mailto = mailto.upper()   
445            if (mailto == "EXTERNAL") and not args :
446                raise PyKotaConfigError, _("Invalid option mailto %s for printer %s") % (fullmailto, printername)
447            if mailto not in validmailtos :
448                raise PyKotaConfigError, _("Option mailto in section %s only supports values in %s") % (printername, str(validmailtos))
449            return (mailto, args)
450       
451    def getGraceDelay(self, printername) :   
452        """Returns the grace delay in days."""
453        try :
454            gd = self.getPrinterOption(printername, "gracedelay")
455        except PyKotaConfigError :   
456            gd = 7
457        try :
458            return int(gd)
459        except (TypeError, ValueError) :   
460            raise PyKotaConfigError, _("Invalid grace delay %s") % gd
461           
462    def getPoorMan(self) :   
463        """Returns the poor man's threshold."""
464        try :
465            pm = self.getGlobalOption("poorman")
466        except PyKotaConfigError :   
467            pm = 1.0
468        try :
469            return float(pm)
470        except (TypeError, ValueError) :   
471            raise PyKotaConfigError, _("Invalid poor man's threshold %s") % pm
472           
473    def getPoorWarn(self) :   
474        """Returns the poor man's warning message."""
475        try :
476            return self.getGlobalOption("poorwarn")
477        except PyKotaConfigError :   
478            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.")
479           
480    def getHardWarn(self, printername) :   
481        """Returns the hard limit error message."""
482        try :
483            return self.getPrinterOption(printername, "hardwarn")
484        except PyKotaConfigError :   
485            return _("You are not allowed to print anymore because\nyour Print Quota is exceeded on printer %s.") % printername
486           
487    def getSoftWarn(self, printername) :   
488        """Returns the soft limit error message."""
489        try :
490            return self.getPrinterOption(printername, "softwarn")
491        except PyKotaConfigError :   
492            return _("You will soon be forbidden to print anymore because\nyour Print Quota is almost reached on printer %s.") % printername
493           
494    def getDebug(self) :         
495        """Returns 1 if debugging is activated, else 0."""
496        return self.isTrue(self.getGlobalOption("debug", ignore=1))
497           
498    def getCaching(self) :         
499        """Returns 1 if database caching is enabled, else 0."""
500        return self.isTrue(self.getGlobalOption("storagecaching", ignore=1))
501           
502    def getLDAPCache(self) :         
503        """Returns 1 if low-level LDAP caching is enabled, else 0."""
504        return self.isTrue(self.getGlobalOption("ldapcache", ignore=1))
505           
506    def getDisableHistory(self) :         
507        """Returns 1 if we want to disable history, else 0."""
508        return self.isTrue(self.getGlobalOption("disablehistory", ignore=1))
509           
510    def getUserNameToLower(self) :         
511        """Returns 1 if we want to convert usernames to lowercase when printing, else 0."""
512        return self.isTrue(self.getGlobalOption("utolower", ignore=1))
Note: See TracBrowser for help on using the browser.