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

Revision 1356, 20.2 kB (checked in by jalet, 20 years ago)

Experimental ldapcache directive added

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