root / pykota / trunk / pykota / tool.py @ 3287

Revision 3287, 33.3 kB (checked in by jerome, 16 years ago)

Removed the dependency on python-chardet entirely. Now uses unicode
or UTF-8 strings all over the place : UTF-8 still used for datas
coming from/going to the database (TODO). Conversion to end user's
locale charset is now only done when needed. PyKota Exceptions need
a base class which, for now, will handle the charset translation,
until we get the time to replace internal loggers with Python's
logging module...

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
RevLine 
[3260]1# -*- coding: UTF-8 -*-
[695]2#
[3260]3# PyKota : Print Quotas for CUPS
4#
[3275]5# (c) 2003, 2004, 2005, 2006, 2007, 2008 Jerome Alet <alet@librelogiciel.com>
[3260]6# This program is free software: you can redistribute it and/or modify
[873]7# it under the terms of the GNU General Public License as published by
[3260]8# the Free Software Foundation, either version 3 of the License, or
[873]9# (at your option) any later version.
[3260]10#
[873]11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
[3260]17# along with this program.  If not, see <http://www.gnu.org/licenses/>.
[695]18#
19# $Id$
20#
[2093]21#
[695]22
[3184]23"""This module defines the base classes for PyKota command line tools."""
24
[695]25import sys
[1193]26import os
[1960]27import pwd
[817]28import fnmatch
[715]29import getopt
[695]30import smtplib
[772]31import gettext
[782]32import locale
[1469]33import socket
[2783]34import time
[2643]35from email.MIMEText import MIMEText
36from email.Header import Header
[3013]37import email.Utils
[695]38
[708]39from mx import DateTime
40
[2830]41from pykota import config, storage, logger
[2344]42from pykota.version import __version__, __author__, __years__, __gplblurb__
[695]43
[1795]44def N_(message) :
45    """Fake translation marker for translatable strings extraction."""
46    return message
47
[695]48class PyKotaToolError(Exception):
[2512]49    """An exception for PyKota related stuff."""
[695]50    def __init__(self, message = ""):
51        self.message = message
52        Exception.__init__(self, message)
53    def __repr__(self):
[3287]54        return self.message.encode(sys.stdout.encoding or "UTF-8", "replace")
[695]55    __str__ = __repr__
56   
[2512]57class PyKotaCommandLineError(PyKotaToolError) :   
58    """An exception for Pykota command line tools."""
59    pass
60   
[2229]61def crashed(message="Bug in PyKota") :   
[1546]62    """Minimal crash method."""
63    import traceback
64    lines = []
65    for line in traceback.format_exception(*sys.exc_info()) :
66        lines.extend([l for l in line.split("\n") if l])
[2344]67    msg = "ERROR: ".join(["%s\n" % l for l in (["ERROR: PyKota v%s" % __version__, message] + lines)])
[1546]68    sys.stderr.write(msg)
69    sys.stderr.flush()
70    return msg
71
[2782]72class Percent :
73    """A class to display progress."""
[2783]74    def __init__(self, app, size=None) :
[2782]75        """Initializes the engine."""
76        self.app = app
[2783]77        self.size = None
78        if size :
79            self.setSize(size)
80        self.previous = None
81        self.before = time.time()
82       
83    def setSize(self, size) :     
84        """Sets the total size."""
85        self.number = 0
[2782]86        self.size = size
[2793]87        if size :
88            self.factor = 100.0 / float(size)
[2782]89       
90    def display(self, msg) :   
91        """Displays the value."""
92        self.app.display(msg)
93       
94    def oneMore(self) :   
95        """Increments internal counter."""
[2783]96        if self.size :
97            self.number += 1
98            percent = "%.02f" % (float(self.number) * self.factor)
99            if percent != self.previous : # optimize for large number of items
100                self.display("\r%s%%" % percent)
101                self.previous = percent
[2782]102           
103    def done(self) :         
104        """Displays the 'done' message."""
[2783]105        after = time.time()
106        if self.size :
[3251]107            try :
[3286]108                speed = self.size / ((after - self.before) + 0.00000000001) # adds an epsilon to avoid an user's problem I can't reproduce...
[3251]109            except ZeroDivisionError :   
[3271]110                speed = 1 # Fake value in case of division by zero, shouldn't happen anyway with the epsilon above...
[2788]111            self.display("\r100.00%%\r        \r%s. %s : %.2f %s.\n" \
[2783]112                     % (_("Done"), _("Average speed"), speed, _("entries per second")))
113        else :             
114            self.display("\r100.00%%\r        \r%s.\n" % _("Done"))
[2782]115       
[1911]116class Tool :
117    """Base class for tools with no database access."""
[2344]118    def __init__(self, lang="", charset=None, doc="PyKota v%(__version__)s (c) %(__years__)s %(__author__)s") :
[695]119        """Initializes the command line tool."""
[3187]120        self.debug = True # in case of early failure
[3188]121        self.logger = logger.openLogger("stderr")
[3187]122       
[772]123        # locale stuff
[788]124        try :
[3055]125            locale.setlocale(locale.LC_ALL, (lang, charset))
[788]126        except (locale.Error, IOError) :
[3055]127            locale.setlocale(locale.LC_ALL, None)
128        (self.language, self.charset) = locale.getlocale()
129        self.language = self.language or "C"
[3061]130        try :
131            self.charset = self.charset or locale.getpreferredencoding()
132        except locale.Error :   
[3287]133            self.charset = sys.stdout.encoding or sys.getfilesystemencoding()
[3055]134       
[3173]135        # Dirty hack : if the charset is ASCII, we can safely use UTF-8 instead
136        # This has the advantage of allowing transparent support for recent
137        # versions of CUPS which (en-)force charset to UTF-8 when printing.
138        # This should be needed only when printing, but is probably (?) safe
139        # to do when using interactive commands.
140        if self.charset.upper() in ('ASCII', 'ANSI_X3.4-1968') :
141            self.charset = "UTF-8"
142       
[3055]143        # translation stuff
[1898]144        try :
[3055]145            try :
146                trans = gettext.translation("pykota", languages=["%s.%s" % (self.language, self.charset)], codeset=self.charset)
147            except TypeError : # Python <2.4
148                trans = gettext.translation("pykota", languages=["%s.%s" % (self.language, self.charset)])
[3287]149            trans.install(unicode=True)
[1898]150        except :
[3287]151            gettext.NullTranslations().install(unicode=True)
[772]152   
153        # pykota specific stuff
[715]154        self.documentation = doc
[1960]155       
[3276]156        # Extract the effective username
157        uid = os.geteuid()
158        try :
159            self.effectiveUserName = pwd.getpwuid(uid)[0]
160        except (KeyError, IndexError), msg :   
161            self.printInfo(_("Strange problem with uid(%s) : %s") % (uid, msg), "warn")
162            self.effectiveUserName = os.getlogin()
163       
[2210]164    def deferredInit(self) :       
165        """Deferred initialization."""
[3045]166        confdir = os.environ.get("PYKOTA_HOME")
167        environHome = True
168        missingUser = False
169        if confdir is None :
170            environHome = False
171            # check for config files in the 'pykota' user's home directory.
172            try :
173                self.pykotauser = pwd.getpwnam("pykota")
174                confdir = self.pykotauser[5]
175            except KeyError :   
176                self.pykotauser = None
177                confdir = "/etc/pykota"
178                missingUser = True
[1960]179           
[2210]180        self.config = config.PyKotaConfig(confdir)
181        self.debug = self.config.getDebug()
182        self.smtpserver = self.config.getSMTPServer()
183        self.maildomain = self.config.getMailDomain()
184        self.logger = logger.openLogger(self.config.getLoggingBackend())
[1542]185           
[1960]186        # We NEED this here, even when not in an accounting filter/backend   
[1497]187        self.softwareJobSize = 0
[1495]188        self.softwareJobPrice = 0.0
[1960]189       
[3045]190        if environHome :
191            self.printInfo("PYKOTA_HOME environment variable is set. Configuration files were searched in %s" % confdir, "info")
192        else :
193            if missingUser :     
194                self.printInfo("The 'pykota' system account is missing. Configuration files were searched in %s instead." % confdir, "warn")
[1960]195       
[3055]196        self.logdebug("Language in use : %s" % self.language)
[1761]197        self.logdebug("Charset in use : %s" % self.charset)
[3055]198       
[1872]199        arguments = " ".join(['"%s"' % arg for arg in sys.argv])
200        self.logdebug("Command line arguments : %s" % arguments)
[695]201       
[2804]202    def UTF8ToUserCharset(self, text) :
203        """Converts from UTF-8 to user's charset."""
[3006]204        if text is None :
205            return None
[3287]206        else :   
207            return text.decode("UTF-8", "replace").encode(self.charset, "replace") 
[2804]208       
209    def userCharsetToUTF8(self, text) :
210        """Converts from user's charset to UTF-8."""
[3006]211        if text is None :
212            return None
[3287]213        else :   
214            return text.decode(self.charset, "replace").encode("UTF-8", "replace")   
[2804]215       
[2657]216    def display(self, message) :
217        """Display a message but only if stdout is a tty."""
218        if sys.stdout.isatty() :
[3287]219            sys.stdout.write(message.encode(sys.stdout.encoding or "UTF-8", \
220                                            "replace"))
[2657]221            sys.stdout.flush()
222           
[1130]223    def logdebug(self, message) :   
224        """Logs something to debug output if debug is enabled."""
225        if self.debug :
[3287]226            self.logger.log_message(message.encode(sys.stdout.encoding \
227                                                       or "UTF-8", \
228                                                   "replace"), \
229                                    "debug")
[1582]230           
[1584]231    def printInfo(self, message, level="info") :       
[1582]232        """Sends a message to standard error."""
[3287]233        sys.stderr.write("%s: %s\n" % (level.upper(), \
234                                       message.encode(sys.stdout.encoding \
235                                                          or "UTF-8", \
236                                                      "replace")))
[1582]237        sys.stderr.flush()
[1130]238       
[2210]239    def matchString(self, s, patterns) :
[2650]240        """Returns True if the string s matches one of the patterns, else False."""
241        if not patterns :
242            return True # No pattern, always matches.
243        else :   
244            for pattern in patterns :
245                if fnmatch.fnmatchcase(s, pattern) :
246                    return True
247            return False
[2210]248       
[2762]249    def sanitizeNames(self, options, names) :
250        """Ensures that an user can only see the datas he is allowed to see, by modifying the list of names."""
251        if not self.config.isAdmin :
252            username = pwd.getpwuid(os.geteuid())[0]
253            if not options["list"] :
254                raise PyKotaCommandLineError, "%s : %s" % (username, _("You're not allowed to use this command."))
255            else :
256                if options["groups"] :
257                    user = self.storage.getUser(username)
258                    if user.Exists :
259                        return [ g.Name for g in self.storage.getUserGroups(user) ]
260                return [ username ]
261        elif not names :       
262            return ["*"]
263        else :   
264            return names
265       
[715]266    def display_version_and_quit(self) :
267        """Displays version number, then exists successfully."""
[1923]268        try :
269            self.clean()
270        except AttributeError :   
271            pass
[2344]272        print __version__
[715]273        sys.exit(0)
274   
275    def display_usage_and_quit(self) :
276        """Displays command line usage, then exists successfully."""
[1923]277        try :
278            self.clean()
279        except AttributeError :   
280            pass
[2344]281        print _(self.documentation) % globals()
282        print __gplblurb__
283        print
284        print _("Please report bugs to :"), __author__
[715]285        sys.exit(0)
286       
[2229]287    def crashed(self, message="Bug in PyKota") :   
[1517]288        """Outputs a crash message, and optionally sends it to software author."""
[1546]289        msg = crashed(message)
[2229]290        fullmessage = "========== Traceback :\n\n%s\n\n========== sys.argv :\n\n%s\n\n========== Environment :\n\n%s\n" % \
291                        (msg, \
292                         "\n".join(["    %s" % repr(a) for a in sys.argv]), \
293                         "\n".join(["    %s=%s" % (k, v) for (k, v) in os.environ.items()]))
[1541]294        try :
295            crashrecipient = self.config.getCrashRecipient()
296            if crashrecipient :
[1517]297                admin = self.config.getAdminMail("global") # Nice trick, isn't it ?
298                server = smtplib.SMTP(self.smtpserver)
[2795]299                msg = MIMEText(fullmessage, _charset=self.charset)
[3136]300                msg["Subject"] = Header("PyKota v%s crash traceback !" \
301                                        % __version__, charset=self.charset)
[2795]302                msg["From"] = admin
303                msg["To"] = crashrecipient
304                msg["Cc"] = admin
[3013]305                msg["Date"] = email.Utils.formatdate(localtime=True)
[2795]306                server.sendmail(admin, [admin, crashrecipient], msg.as_string())
[1517]307                server.quit()
[1541]308        except :
309            pass
[2229]310        return fullmessage   
[1517]311       
[729]312    def parseCommandline(self, argv, short, long, allownothing=0) :
[715]313        """Parses the command line, controlling options."""
314        # split options in two lists: those which need an argument, those which don't need any
[2605]315        short = "%sA:" % short
316        long.append("arguments=")
[715]317        withoutarg = []
318        witharg = []
319        lgs = len(short)
320        i = 0
321        while i < lgs :
322            ii = i + 1
323            if (ii < lgs) and (short[ii] == ':') :
324                # needs an argument
325                witharg.append(short[i])
326                ii = ii + 1 # skip the ':'
327            else :
328                # doesn't need an argument
329                withoutarg.append(short[i])
330            i = ii
331               
332        for option in long :
333            if option[-1] == '=' :
334                # needs an argument
335                witharg.append(option[:-1])
336            else :
337                # doesn't need an argument
338                withoutarg.append(option)
339       
340        # then we parse the command line
[2605]341        done = 0
342        while not done :
343            # we begin with all possible options unset
344            parsed = {}
345            for option in withoutarg + witharg :
346                parsed[option] = None
347            args = []       # to not break if something unexpected happened
348            try :
349                options, args = getopt.getopt(argv, short, long)
350                if options :
351                    for (o, v) in options :
352                        # we skip the '-' chars
353                        lgo = len(o)
354                        i = 0
355                        while (i < lgo) and (o[i] == '-') :
356                            i = i + 1
357                        o = o[i:]
358                        if o in witharg :
359                            # needs an argument : set it
360                            parsed[o] = v
361                        elif o in withoutarg :
362                            # doesn't need an argument : boolean
363                            parsed[o] = 1
364                        else :
365                            # should never occur
[2610]366                            raise PyKotaCommandLineError, "Unexpected problem when parsing command line"
[2605]367                elif (not args) and (not allownothing) and sys.stdin.isatty() : # no option and no argument, we display help if we are a tty
368                    self.display_usage_and_quit()
369            except getopt.error, msg :
[2610]370                raise PyKotaCommandLineError, str(msg)
[2605]371            else :   
372                if parsed["arguments"] or parsed["A"] :
373                    # arguments are in a file, we ignore all other arguments
374                    # and reset the list of arguments to the lines read from
375                    # the file.
376                    argsfile = open(parsed["arguments"] or parsed["A"], "r")
377                    argv = [ l.strip() for l in argsfile.readlines() ]
378                    argsfile.close()
379                    for i in range(len(argv)) :
380                        argi = argv[i]
381                        if argi.startswith('"') and argi.endswith('"') :
382                            argv[i] = argi[1:-1]
383                else :   
384                    done = 1
[715]385        return (parsed, args)
386   
[1911]387class PyKotaTool(Tool) :   
388    """Base class for all PyKota command line tools."""
[2344]389    def __init__(self, lang="", charset=None, doc="PyKota v%(__version__)s (c) %(__years__)s %(__author__)s") :
[1911]390        """Initializes the command line tool and opens the database."""
391        Tool.__init__(self, lang, charset, doc)
[2210]392       
393    def deferredInit(self) :   
394        """Deferred initialization."""
395        Tool.deferredInit(self)
396        self.storage = storage.openConnection(self)
397        if self.config.isAdmin : # TODO : We don't know this before, fix this !
398            self.logdebug("Beware : running as a PyKota administrator !")
[2093]399        else :   
[2210]400            self.logdebug("Don't Panic : running as a mere mortal !")
[1911]401       
402    def clean(self) :   
403        """Ensures that the database is closed."""
404        try :
405            self.storage.close()
406        except (TypeError, NameError, AttributeError) :   
407            pass
408           
[764]409    def isValidName(self, name) :
410        """Checks if a user or printer name is valid."""
[1725]411        invalidchars = "/@?*,;&|"
[1637]412        for c in list(invalidchars) :
[1593]413            if c in name :
[1394]414                return 0
415        return 1       
[764]416       
[802]417    def sendMessage(self, adminmail, touser, fullmessage) :
[695]418        """Sends an email message containing headers to some user."""
[1469]419        try :   
420            server = smtplib.SMTP(self.smtpserver)
421        except socket.error, msg :   
[1584]422            self.printInfo(_("Impossible to connect to SMTP server : %s") % msg, "error")
[1469]423        else :
424            try :
[2795]425                server.sendmail(adminmail, [touser], fullmessage)
[1469]426            except smtplib.SMTPException, answer :   
427                for (k, v) in answer.recipients.items() :
[1584]428                    self.printInfo(_("Impossible to send mail to %s, error %s : %s") % (k, v[0], v[1]), "error")
[1469]429            server.quit()
[695]430       
[1079]431    def sendMessageToUser(self, admin, adminmail, user, subject, message) :
[695]432        """Sends an email message to a user."""
[802]433        message += _("\n\nPlease contact your system administrator :\n\n\t%s - <%s>\n") % (admin, adminmail)
[2795]434        usermail = user.Email or user.Name
435        if "@" not in usermail :
436            usermail = "%s@%s" % (usermail, self.maildomain or self.smtpserver or "localhost")
437        msg = MIMEText(message, _charset=self.charset)
[3136]438        msg["Subject"] = Header(subject, charset=self.charset)
[2795]439        msg["From"] = adminmail
440        msg["To"] = usermail
[3013]441        msg["Date"] = email.Utils.formatdate(localtime=True)
[2795]442        self.sendMessage(adminmail, usermail, msg.as_string())
[695]443       
[802]444    def sendMessageToAdmin(self, adminmail, subject, message) :
[695]445        """Sends an email message to the Print Quota administrator."""
[2795]446        if "@" not in adminmail :
447            adminmail = "%s@%s" % (adminmail, self.maildomain or self.smtpserver or "localhost")
448        msg = MIMEText(message, _charset=self.charset)
[3136]449        msg["Subject"] = Header(subject, charset=self.charset)
[2795]450        msg["From"] = adminmail
451        msg["To"] = adminmail
452        self.sendMessage(adminmail, adminmail, msg.as_string())
[695]453       
[1365]454    def _checkUserPQuota(self, userpquota) :           
455        """Checks the user quota on a printer and deny or accept the job."""
456        # then we check the user's own quota
457        # if we get there we are sure that policy is not EXTERNAL
458        user = userpquota.User
459        printer = userpquota.Printer
[1495]460        enforcement = self.config.getPrinterEnforcement(printer.Name)
[1365]461        self.logdebug("Checking user %s's quota on printer %s" % (user.Name, printer.Name))
462        (policy, dummy) = self.config.getPrinterPolicy(userpquota.Printer.Name)
463        if not userpquota.Exists :
464            # Unknown userquota
465            if policy == "ALLOW" :
466                action = "POLICY_ALLOW"
467            else :   
468                action = "POLICY_DENY"
[1584]469            self.printInfo(_("Unable to match user %s on printer %s, applying default policy (%s)") % (user.Name, printer.Name, action))
[1365]470        else :   
471            pagecounter = int(userpquota.PageCounter or 0)
[1495]472            if enforcement == "STRICT" :
473                pagecounter += self.softwareJobSize
[1365]474            if userpquota.SoftLimit is not None :
475                softlimit = int(userpquota.SoftLimit)
476                if pagecounter < softlimit :
477                    action = "ALLOW"
478                else :   
479                    if userpquota.HardLimit is None :
480                        # only a soft limit, this is equivalent to having only a hard limit
481                        action = "DENY"
482                    else :   
483                        hardlimit = int(userpquota.HardLimit)
484                        if softlimit <= pagecounter < hardlimit :   
485                            now = DateTime.now()
486                            if userpquota.DateLimit is not None :
[3050]487                                datelimit = DateTime.ISO.ParseDateTime(str(userpquota.DateLimit)[:19])
[1365]488                            else :
489                                datelimit = now + self.config.getGraceDelay(printer.Name)
490                                userpquota.setDateLimit(datelimit)
491                            if now < datelimit :
492                                action = "WARN"
493                            else :   
494                                action = "DENY"
495                        else :         
496                            action = "DENY"
497            else :       
498                if userpquota.HardLimit is not None :
499                    # no soft limit, only a hard one.
500                    hardlimit = int(userpquota.HardLimit)
501                    if pagecounter < hardlimit :
502                        action = "ALLOW"
503                    else :     
504                        action = "DENY"
505                else :
506                    # Both are unset, no quota, i.e. accounting only
507                    action = "ALLOW"
508        return action
509   
[1041]510    def checkGroupPQuota(self, grouppquota) :   
[927]511        """Checks the group quota on a printer and deny or accept the job."""
[1041]512        group = grouppquota.Group
513        printer = grouppquota.Printer
[1495]514        enforcement = self.config.getPrinterEnforcement(printer.Name)
[1365]515        self.logdebug("Checking group %s's quota on printer %s" % (group.Name, printer.Name))
[1061]516        if group.LimitBy and (group.LimitBy.lower() == "balance") : 
[1666]517            val = group.AccountBalance or 0.0
[1495]518            if enforcement == "STRICT" : 
519                val -= self.softwareJobPrice # use precomputed size.
[2692]520            balancezero = self.config.getBalanceZero()
521            if val <= balancezero :
[1041]522                action = "DENY"
[1495]523            elif val <= self.config.getPoorMan() :   
[1077]524                action = "WARN"
[927]525            else :   
[1041]526                action = "ALLOW"
[2692]527            if (enforcement == "STRICT") and (val == balancezero) :
[1529]528                action = "WARN" # we can still print until account is 0
[927]529        else :
[1665]530            val = grouppquota.PageCounter or 0
[1495]531            if enforcement == "STRICT" :
[2992]532                val += int(self.softwareJobSize) # TODO : this is not a fix, problem is elsewhere in grouppquota.PageCounter
[1041]533            if grouppquota.SoftLimit is not None :
534                softlimit = int(grouppquota.SoftLimit)
[1495]535                if val < softlimit :
[1041]536                    action = "ALLOW"
[927]537                else :   
[1041]538                    if grouppquota.HardLimit is None :
539                        # only a soft limit, this is equivalent to having only a hard limit
540                        action = "DENY"
[927]541                    else :   
[1041]542                        hardlimit = int(grouppquota.HardLimit)
[1495]543                        if softlimit <= val < hardlimit :   
[1041]544                            now = DateTime.now()
545                            if grouppquota.DateLimit is not None :
[3050]546                                datelimit = DateTime.ISO.ParseDateTime(str(grouppquota.DateLimit)[:19])
[1041]547                            else :
548                                datelimit = now + self.config.getGraceDelay(printer.Name)
549                                grouppquota.setDateLimit(datelimit)
550                            if now < datelimit :
551                                action = "WARN"
552                            else :   
[927]553                                action = "DENY"
[1041]554                        else :         
[927]555                            action = "DENY"
[1041]556            else :       
557                if grouppquota.HardLimit is not None :
558                    # no soft limit, only a hard one.
559                    hardlimit = int(grouppquota.HardLimit)
[1495]560                    if val < hardlimit :
[927]561                        action = "ALLOW"
[1041]562                    else :     
563                        action = "DENY"
564                else :
565                    # Both are unset, no quota, i.e. accounting only
566                    action = "ALLOW"
[927]567        return action
568   
[1041]569    def checkUserPQuota(self, userpquota) :
[1365]570        """Checks the user quota on a printer and all its parents and deny or accept the job."""
[1041]571        user = userpquota.User
572        printer = userpquota.Printer
573       
[1365]574        # indicates that a warning needs to be sent
575        warned = 0               
576       
[927]577        # first we check any group the user is a member of
[1041]578        for group in self.storage.getUserGroups(user) :
[2452]579            # No need to check anything if the group is in noquota mode
580            if group.LimitBy != "noquota" :
581                grouppquota = self.storage.getGroupPQuota(group, printer)
582                # for the printer and all its parents
583                for gpquota in [ grouppquota ] + grouppquota.ParentPrintersGroupPQuota :
584                    if gpquota.Exists :
585                        action = self.checkGroupPQuota(gpquota)
586                        if action == "DENY" :
587                            return action
588                        elif action == "WARN" :   
589                            warned = 1
[1365]590                       
591        # Then we check the user's account balance
[1152]592        # if we get there we are sure that policy is not EXTERNAL
593        (policy, dummy) = self.config.getPrinterPolicy(printer.Name)
[1061]594        if user.LimitBy and (user.LimitBy.lower() == "balance") : 
[1365]595            self.logdebug("Checking account balance for user %s" % user.Name)
[1041]596            if user.AccountBalance is None :
[956]597                if policy == "ALLOW" :
[925]598                    action = "POLICY_ALLOW"
599                else :   
600                    action = "POLICY_DENY"
[1584]601                self.printInfo(_("Unable to find user %s's account balance, applying default policy (%s) for printer %s") % (user.Name, action, printer.Name))
[1365]602                return action       
[713]603            else :   
[2054]604                if user.OverCharge == 0.0 :
605                    self.printInfo(_("User %s will not be charged for printing.") % user.Name)
606                    action = "ALLOW"
[1529]607                else :
[2054]608                    val = float(user.AccountBalance or 0.0)
609                    enforcement = self.config.getPrinterEnforcement(printer.Name)
610                    if enforcement == "STRICT" : 
611                        val -= self.softwareJobPrice # use precomputed size.
[2692]612                    balancezero = self.config.getBalanceZero()   
613                    if val <= balancezero :
[2054]614                        action = "DENY"
615                    elif val <= self.config.getPoorMan() :   
616                        action = "WARN"
617                    else :
618                        action = "ALLOW"
[2692]619                    if (enforcement == "STRICT") and (val == balancezero) :
[2054]620                        action = "WARN" # we can still print until account is 0
[1529]621                return action   
[925]622        else :
[1365]623            # Then check the user quota on current printer and all its parents.               
624            policyallowed = 0
625            for upquota in [ userpquota ] + userpquota.ParentPrintersUserPQuota :               
626                action = self._checkUserPQuota(upquota)
627                if action in ("DENY", "POLICY_DENY") :
628                    return action
629                elif action == "WARN" :   
630                    warned = 1
631                elif action == "POLICY_ALLOW" :   
632                    policyallowed = 1
633            if warned :       
634                return "WARN"
635            elif policyallowed :   
636                return "POLICY_ALLOW" 
[925]637            else :   
[1365]638                return "ALLOW"
639               
[1196]640    def externalMailTo(self, cmd, action, user, printer, message) :
[1192]641        """Warns the user with an external command."""
642        username = user.Name
[1196]643        printername = printer.Name
[1192]644        email = user.Email or user.Name
645        if "@" not in email :
[1353]646            email = "%s@%s" % (email, self.maildomain or self.smtpserver)
[1192]647        os.system(cmd % locals())
648   
[1196]649    def formatCommandLine(self, cmd, user, printer) :
650        """Executes an external command."""
651        username = user.Name
652        printername = printer.Name
653        return cmd % locals()
654       
[1041]655    def warnGroupPQuota(self, grouppquota) :
[927]656        """Checks a group quota and send messages if quota is exceeded on current printer."""
[1041]657        group = grouppquota.Group
658        printer = grouppquota.Printer
659        admin = self.config.getAdmin(printer.Name)
660        adminmail = self.config.getAdminMail(printer.Name)
[1192]661        (mailto, arguments) = self.config.getMailTo(printer.Name)
[2547]662        if group.LimitBy in ("noquota", "nochange") :
663            action = "ALLOW"
664        else :   
665            action = self.checkGroupPQuota(grouppquota)
666            if action.startswith("POLICY_") :
667                action = action[7:]
668            if action == "DENY" :
669                adminmessage = _("Print Quota exceeded for group %s on printer %s") % (group.Name, printer.Name)
670                self.printInfo(adminmessage)
671                if mailto in [ "BOTH", "ADMIN" ] :
672                    self.sendMessageToAdmin(adminmail, _("Print Quota"), adminmessage)
673                if mailto in [ "BOTH", "USER", "EXTERNAL" ] :
674                    for user in self.storage.getGroupMembers(group) :
675                        if mailto != "EXTERNAL" :
676                            self.sendMessageToUser(admin, adminmail, user, _("Print Quota Exceeded"), self.config.getHardWarn(printer.Name))
677                        else :   
678                            self.externalMailTo(arguments, action, user, printer, self.config.getHardWarn(printer.Name))
679            elif action == "WARN" :   
680                adminmessage = _("Print Quota low for group %s on printer %s") % (group.Name, printer.Name)
681                self.printInfo(adminmessage)
682                if mailto in [ "BOTH", "ADMIN" ] :
683                    self.sendMessageToAdmin(adminmail, _("Print Quota"), adminmessage)
684                if group.LimitBy and (group.LimitBy.lower() == "balance") : 
685                    message = self.config.getPoorWarn()
686                else :     
687                    message = self.config.getSoftWarn(printer.Name)
688                if mailto in [ "BOTH", "USER", "EXTERNAL" ] :
689                    for user in self.storage.getGroupMembers(group) :
690                        if mailto != "EXTERNAL" :
691                            self.sendMessageToUser(admin, adminmail, user, _("Print Quota Exceeded"), message)
692                        else :   
693                            self.externalMailTo(arguments, action, user, printer, message)
[927]694        return action       
[728]695       
[1041]696    def warnUserPQuota(self, userpquota) :
[728]697        """Checks a user quota and send him a message if quota is exceeded on current printer."""
[1041]698        user = userpquota.User
[1245]699        printer = userpquota.Printer
700        admin = self.config.getAdmin(printer.Name)
701        adminmail = self.config.getAdminMail(printer.Name)
702        (mailto, arguments) = self.config.getMailTo(printer.Name)
[2547]703       
704        if user.LimitBy in ("noquota", "nochange") :
705            action = "ALLOW"
706        elif user.LimitBy == "noprint" :
707            action = "DENY"
[2558]708            message = _("User %s is not allowed to print at this time.") % user.Name
709            self.printInfo(message)
[1245]710            if mailto in [ "BOTH", "USER", "EXTERNAL" ] :
711                if mailto != "EXTERNAL" :
[2547]712                    self.sendMessageToUser(admin, adminmail, user, _("Printing denied."), message)
[1245]713                else :   
714                    self.externalMailTo(arguments, action, user, printer, message)
715            if mailto in [ "BOTH", "ADMIN" ] :
[2547]716                self.sendMessageToAdmin(adminmail, _("Print Quota"), message)
717        else :
718            action = self.checkUserPQuota(userpquota)
719            if action.startswith("POLICY_") :
720                action = action[7:]
721               
722            if action == "DENY" :
723                adminmessage = _("Print Quota exceeded for user %s on printer %s") % (user.Name, printer.Name)
724                self.printInfo(adminmessage)
725                if mailto in [ "BOTH", "USER", "EXTERNAL" ] :
726                    message = self.config.getHardWarn(printer.Name)
727                    if mailto != "EXTERNAL" :
728                        self.sendMessageToUser(admin, adminmail, user, _("Print Quota Exceeded"), message)
729                    else :   
730                        self.externalMailTo(arguments, action, user, printer, message)
731                if mailto in [ "BOTH", "ADMIN" ] :
732                    self.sendMessageToAdmin(adminmail, _("Print Quota"), adminmessage)
733            elif action == "WARN" :   
734                adminmessage = _("Print Quota low for user %s on printer %s") % (user.Name, printer.Name)
735                self.printInfo(adminmessage)
736                if mailto in [ "BOTH", "USER", "EXTERNAL" ] :
737                    if user.LimitBy and (user.LimitBy.lower() == "balance") : 
738                        message = self.config.getPoorWarn()
739                    else :     
740                        message = self.config.getSoftWarn(printer.Name)
741                    if mailto != "EXTERNAL" :   
742                        self.sendMessageToUser(admin, adminmail, user, _("Print Quota Low"), message)
743                    else :   
744                        self.externalMailTo(arguments, action, user, printer, message)
745                if mailto in [ "BOTH", "ADMIN" ] :
746                    self.sendMessageToAdmin(adminmail, _("Print Quota"), adminmessage)
[1245]747        return action       
[1196]748       
Note: See TracBrowser for help on using the browser.